Compare commits
2 Commits
a3ba05a426
...
0318fb048b
| Author | SHA1 | Date |
|---|---|---|
 sairate
|
0318fb048b | |
|
sairate
|
0caccd41cf |
|
|
@ -5,9 +5,8 @@
|
||||||
</component>
|
</component>
|
||||||
<component name="ChangeListManager">
|
<component name="ChangeListManager">
|
||||||
<list default="true" id="c512d54a-7f5f-4cfb-af24-29d5821a33bf" name="更改" comment="Signed-off-by: sairate <sairate@sina.cn>">
|
<list default="true" id="c512d54a-7f5f-4cfb-af24-29d5821a33bf" name="更改" comment="Signed-off-by: sairate <sairate@sina.cn>">
|
||||||
<change afterPath="$PROJECT_DIR$/app.py" afterDir="false" />
|
|
||||||
<change afterPath="$PROJECT_DIR$/templates/index.html" afterDir="false" />
|
|
||||||
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/app.py" beforeDir="false" afterPath="$PROJECT_DIR$/app.py" afterDir="false" />
|
||||||
<change beforePath="$PROJECT_DIR$/captured_faces/face_1.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_1.jpg" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/captured_faces/face_1.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_1.jpg" afterDir="false" />
|
||||||
<change beforePath="$PROJECT_DIR$/captured_faces/face_10.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_10.jpg" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/captured_faces/face_10.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_10.jpg" afterDir="false" />
|
||||||
<change beforePath="$PROJECT_DIR$/captured_faces/face_2.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_2.jpg" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/captured_faces/face_2.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_2.jpg" afterDir="false" />
|
||||||
|
|
@ -19,7 +18,10 @@
|
||||||
<change beforePath="$PROJECT_DIR$/captured_faces/face_8.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_8.jpg" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/captured_faces/face_8.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_8.jpg" afterDir="false" />
|
||||||
<change beforePath="$PROJECT_DIR$/captured_faces/face_9.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_9.jpg" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/captured_faces/face_9.jpg" beforeDir="false" afterPath="$PROJECT_DIR$/captured_faces/face_9.jpg" afterDir="false" />
|
||||||
<change beforePath="$PROJECT_DIR$/face_database.db" beforeDir="false" />
|
<change beforePath="$PROJECT_DIR$/face_database.db" beforeDir="false" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/match_log.txt" beforeDir="false" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/requirements.txt" beforeDir="false" afterPath="$PROJECT_DIR$/requirements.txt" afterDir="false" />
|
||||||
<change beforePath="$PROJECT_DIR$/scanf_face.py" beforeDir="false" afterPath="$PROJECT_DIR$/scanf_face.py" afterDir="false" />
|
<change beforePath="$PROJECT_DIR$/scanf_face.py" beforeDir="false" afterPath="$PROJECT_DIR$/scanf_face.py" afterDir="false" />
|
||||||
|
<change beforePath="$PROJECT_DIR$/templates/index.html" beforeDir="false" afterPath="$PROJECT_DIR$/templates/index.html" afterDir="false" />
|
||||||
</list>
|
</list>
|
||||||
<option name="SHOW_DIALOG" value="false" />
|
<option name="SHOW_DIALOG" value="false" />
|
||||||
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
<option name="HIGHLIGHT_CONFLICTS" value="true" />
|
||||||
|
|
@ -60,29 +62,33 @@
|
||||||
<option name="hideEmptyMiddlePackages" value="true" />
|
<option name="hideEmptyMiddlePackages" value="true" />
|
||||||
<option name="showLibraryContents" value="true" />
|
<option name="showLibraryContents" value="true" />
|
||||||
</component>
|
</component>
|
||||||
<component name="PropertiesComponent"><![CDATA[{
|
<component name="PropertiesComponent">{
|
||||||
"keyToString": {
|
"keyToString": {
|
||||||
"ASKED_ADD_EXTERNAL_FILES": "true",
|
"ASKED_ADD_EXTERNAL_FILES": "true",
|
||||||
"DefaultHtmlFileTemplate": "HTML File",
|
"DefaultHtmlFileTemplate": "HTML File",
|
||||||
"Python.add_face.executor": "Run",
|
"JavaScript 调试.index.html.executor": "Run",
|
||||||
"Python.app.executor": "Run",
|
"Python.add_face.executor": "Run",
|
||||||
"Python.match_face.executor": "Run",
|
"Python.app.executor": "Run",
|
||||||
"Python.scanf_face.executor": "Run",
|
"Python.match_face.executor": "Run",
|
||||||
"Python.sqlite.executor": "Run",
|
"Python.scanf_face.executor": "Run",
|
||||||
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
"Python.sqlite.executor": "Run",
|
||||||
"RunOnceActivity.ShowReadmeOnStart": "true",
|
"RunOnceActivity.OpenProjectViewOnStart": "true",
|
||||||
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
"RunOnceActivity.ShowReadmeOnStart": "true",
|
||||||
"git-widget-placeholder": "master",
|
"SHARE_PROJECT_CONFIGURATION_FILES": "true",
|
||||||
"node.js.detected.package.eslint": "true",
|
"git-widget-placeholder": "master",
|
||||||
"node.js.detected.package.tslint": "true",
|
"node.js.detected.package.eslint": "true",
|
||||||
"node.js.selected.package.eslint": "(autodetect)",
|
"node.js.detected.package.tslint": "true",
|
||||||
"node.js.selected.package.tslint": "(autodetect)",
|
"node.js.selected.package.eslint": "(autodetect)",
|
||||||
"nodejs_package_manager_path": "npm",
|
"node.js.selected.package.tslint": "(autodetect)",
|
||||||
"settings.editor.selected.configurable": "com.jetbrains.python.configuration.PyActiveSdkModuleConfigurable",
|
"nodejs_package_manager_path": "npm",
|
||||||
"vue.rearranger.settings.migration": "true"
|
"settings.editor.selected.configurable": "com.jetbrains.python.configuration.PyActiveSdkModuleConfigurable",
|
||||||
|
"vue.rearranger.settings.migration": "true"
|
||||||
}
|
}
|
||||||
}]]></component>
|
}</component>
|
||||||
<component name="RunManager" selected="Python.scanf_face">
|
<component name="RunManager" selected="Python.app">
|
||||||
|
<configuration name="index.html" type="JavascriptDebugType" temporary="true" nameIsGenerated="true" uri="http://localhost:63342/face/templates/index.html" useBuiltInWebServerPort="true">
|
||||||
|
<method v="2" />
|
||||||
|
</configuration>
|
||||||
<configuration name="add_face" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
|
<configuration name="add_face" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
|
||||||
<module name="face" />
|
<module name="face" />
|
||||||
<option name="ENV_FILES" value="" />
|
<option name="ENV_FILES" value="" />
|
||||||
|
|
@ -175,36 +181,13 @@
|
||||||
<option name="INPUT_FILE" value="" />
|
<option name="INPUT_FILE" value="" />
|
||||||
<method v="2" />
|
<method v="2" />
|
||||||
</configuration>
|
</configuration>
|
||||||
<configuration name="sqlite" type="PythonConfigurationType" factoryName="Python" temporary="true" nameIsGenerated="true">
|
|
||||||
<module name="face" />
|
|
||||||
<option name="ENV_FILES" value="" />
|
|
||||||
<option name="INTERPRETER_OPTIONS" value="" />
|
|
||||||
<option name="PARENT_ENVS" value="true" />
|
|
||||||
<envs>
|
|
||||||
<env name="PYTHONUNBUFFERED" value="1" />
|
|
||||||
</envs>
|
|
||||||
<option name="SDK_HOME" value="" />
|
|
||||||
<option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
|
|
||||||
<option name="IS_MODULE_SDK" value="true" />
|
|
||||||
<option name="ADD_CONTENT_ROOTS" value="true" />
|
|
||||||
<option name="ADD_SOURCE_ROOTS" value="true" />
|
|
||||||
<EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
|
|
||||||
<option name="SCRIPT_NAME" value="$PROJECT_DIR$/sqlite.py" />
|
|
||||||
<option name="PARAMETERS" value="" />
|
|
||||||
<option name="SHOW_COMMAND_LINE" value="false" />
|
|
||||||
<option name="EMULATE_TERMINAL" value="false" />
|
|
||||||
<option name="MODULE_MODE" value="false" />
|
|
||||||
<option name="REDIRECT_INPUT" value="false" />
|
|
||||||
<option name="INPUT_FILE" value="" />
|
|
||||||
<method v="2" />
|
|
||||||
</configuration>
|
|
||||||
<recent_temporary>
|
<recent_temporary>
|
||||||
<list>
|
<list>
|
||||||
<item itemvalue="Python.scanf_face" />
|
|
||||||
<item itemvalue="Python.app" />
|
<item itemvalue="Python.app" />
|
||||||
|
<item itemvalue="Python.scanf_face" />
|
||||||
|
<item itemvalue="JavaScript 调试.index.html" />
|
||||||
<item itemvalue="Python.match_face" />
|
<item itemvalue="Python.match_face" />
|
||||||
<item itemvalue="Python.add_face" />
|
<item itemvalue="Python.add_face" />
|
||||||
<item itemvalue="Python.sqlite" />
|
|
||||||
</list>
|
</list>
|
||||||
</recent_temporary>
|
</recent_temporary>
|
||||||
</component>
|
</component>
|
||||||
|
|
@ -240,6 +223,8 @@
|
||||||
<workItem from="1724487223382" duration="3000" />
|
<workItem from="1724487223382" duration="3000" />
|
||||||
<workItem from="1724487238846" duration="322000" />
|
<workItem from="1724487238846" duration="322000" />
|
||||||
<workItem from="1724546711749" duration="3708000" />
|
<workItem from="1724546711749" duration="3708000" />
|
||||||
|
<workItem from="1724557160088" duration="579000" />
|
||||||
|
<workItem from="1724557783554" duration="4073000" />
|
||||||
</task>
|
</task>
|
||||||
<task id="LOCAL-00001" summary="sairate">
|
<task id="LOCAL-00001" summary="sairate">
|
||||||
<option name="closed" value="true" />
|
<option name="closed" value="true" />
|
||||||
|
|
@ -296,8 +281,8 @@
|
||||||
<component name="com.intellij.coverage.CoverageDataManagerImpl">
|
<component name="com.intellij.coverage.CoverageDataManagerImpl">
|
||||||
<SUITE FILE_PATH="coverage/face$sqlite.coverage" NAME="sqlite 覆盖结果" MODIFIED="1724310603865" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
<SUITE FILE_PATH="coverage/face$sqlite.coverage" NAME="sqlite 覆盖结果" MODIFIED="1724310603865" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
||||||
<SUITE FILE_PATH="coverage/face$match_face.coverage" NAME="match_face 覆盖结果" MODIFIED="1724314395402" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
<SUITE FILE_PATH="coverage/face$match_face.coverage" NAME="match_face 覆盖结果" MODIFIED="1724314395402" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
||||||
<SUITE FILE_PATH="coverage/face$app.coverage" NAME="app 覆盖结果" MODIFIED="1724556824546" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
<SUITE FILE_PATH="coverage/face$app.coverage" NAME="app 覆盖结果" MODIFIED="1724561714860" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
||||||
<SUITE FILE_PATH="coverage/face$scanf_face.coverage" NAME="scanf_face 覆盖结果" MODIFIED="1724556840774" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
<SUITE FILE_PATH="coverage/face$scanf_face.coverage" NAME="scanf_face 覆盖结果" MODIFIED="1724563001115" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
||||||
<SUITE FILE_PATH="coverage/face$add_face.coverage" NAME="add_face 覆盖结果" MODIFIED="1724311005030" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
<SUITE FILE_PATH="coverage/face$add_face.coverage" NAME="add_face 覆盖结果" MODIFIED="1724311005030" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" />
|
||||||
</component>
|
</component>
|
||||||
</project>
|
</project>
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Miguel Grinberg
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
@ -0,0 +1,77 @@
|
||||||
|
Metadata-Version: 2.1
|
||||||
|
Name: Flask-SocketIO
|
||||||
|
Version: 5.3.6
|
||||||
|
Summary: Socket.IO integration for Flask applications
|
||||||
|
Home-page: https://github.com/miguelgrinberg/flask-socketio
|
||||||
|
Author: Miguel Grinberg
|
||||||
|
Author-email: miguel.grinberg@gmail.com
|
||||||
|
Project-URL: Bug Tracker, https://github.com/miguelgrinberg/flask-socketio/issues
|
||||||
|
Classifier: Environment :: Web Environment
|
||||||
|
Classifier: Intended Audience :: Developers
|
||||||
|
Classifier: Programming Language :: Python :: 3
|
||||||
|
Classifier: License :: OSI Approved :: MIT License
|
||||||
|
Classifier: Operating System :: OS Independent
|
||||||
|
Requires-Python: >=3.6
|
||||||
|
Description-Content-Type: text/markdown
|
||||||
|
License-File: LICENSE
|
||||||
|
Requires-Dist: Flask >=0.9
|
||||||
|
Requires-Dist: python-socketio >=5.0.2
|
||||||
|
Provides-Extra: docs
|
||||||
|
Requires-Dist: sphinx ; extra == 'docs'
|
||||||
|
|
||||||
|
Flask-SocketIO
|
||||||
|
==============
|
||||||
|
|
||||||
|
[](https://github.com/miguelgrinberg/Flask-SocketIO/actions) [](https://codecov.io/gh/miguelgrinberg/flask-socketio)
|
||||||
|
|
||||||
|
Socket.IO integration for Flask applications.
|
||||||
|
|
||||||
|
Sponsors
|
||||||
|
--------
|
||||||
|
|
||||||
|
The following organizations are funding this project:
|
||||||
|
|
||||||
|
<br>[Socket.IO](https://socket.io) | [Add your company here!](https://github.com/sponsors/miguelgrinberg)|
|
||||||
|
-|-
|
||||||
|
|
||||||
|
Many individual sponsors also support this project through small ongoing contributions. Why not [join them](https://github.com/sponsors/miguelgrinberg)?
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
You can install this package as usual with pip:
|
||||||
|
|
||||||
|
pip install flask-socketio
|
||||||
|
|
||||||
|
Example
|
||||||
|
-------
|
||||||
|
|
||||||
|
```py
|
||||||
|
from flask import Flask, render_template
|
||||||
|
from flask_socketio import SocketIO, emit
|
||||||
|
|
||||||
|
app = Flask(__name__)
|
||||||
|
app.config['SECRET_KEY'] = 'secret!'
|
||||||
|
socketio = SocketIO(app)
|
||||||
|
|
||||||
|
@app.route('/')
|
||||||
|
def index():
|
||||||
|
return render_template('index.html')
|
||||||
|
|
||||||
|
@socketio.event
|
||||||
|
def my_event(message):
|
||||||
|
emit('my response', {'data': 'got it!'})
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
socketio.run(app)
|
||||||
|
```
|
||||||
|
|
||||||
|
Resources
|
||||||
|
---------
|
||||||
|
|
||||||
|
- [Tutorial](http://blog.miguelgrinberg.com/post/easy-websockets-with-flask-and-gevent)
|
||||||
|
- [Documentation](http://flask-socketio.readthedocs.io/en/latest/)
|
||||||
|
- [PyPI](https://pypi.python.org/pypi/Flask-SocketIO)
|
||||||
|
- [Change Log](https://github.com/miguelgrinberg/Flask-SocketIO/blob/main/CHANGES.md)
|
||||||
|
- Questions? See the [questions](https://stackoverflow.com/questions/tagged/flask-socketio) others have asked on Stack Overflow, or [ask](https://stackoverflow.com/questions/ask?tags=python+flask-socketio+python-socketio) your own question.
|
||||||
|
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/LICENSE,sha256=aNCWbkgKjS_T1cJtACyZbvCM36KxWnfQ0LWTuavuYKQ,1082
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/METADATA,sha256=vmIOzjkNLXRjmocRXtso6hLV27aiJgH7_A55TVJyD4k,2631
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/RECORD,,
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
|
||||||
|
Flask_SocketIO-5.3.6.dist-info/top_level.txt,sha256=C1ugzQBJ3HHUJsWGzyt70XRVOX-y4CUAR8MWKjwJOQ8,15
|
||||||
|
flask_socketio/__init__.py,sha256=ea3QXRYKBje4JQGcNSEOmj42qlf2peRNbCzZZWfD9DE,54731
|
||||||
|
flask_socketio/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
flask_socketio/__pycache__/namespace.cpython-312.pyc,,
|
||||||
|
flask_socketio/__pycache__/test_client.cpython-312.pyc,,
|
||||||
|
flask_socketio/namespace.py,sha256=b3oyXEemu2po-wpoy4ILTHQMVuVQqicogCDxfymfz_w,2020
|
||||||
|
flask_socketio/test_client.py,sha256=9_R1y_vP8yr8wzimQUEMAUyVqX12FMXurLj8t1ecDdc,11034
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: bdist_wheel (0.41.2)
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
flask_socketio
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
pip
|
||||||
|
|
@ -0,0 +1,376 @@
|
||||||
|
Mozilla Public License Version 2.0
|
||||||
|
==================================
|
||||||
|
|
||||||
|
Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
|
||||||
|
|
||||||
|
1. Definitions
|
||||||
|
--------------
|
||||||
|
|
||||||
|
1.1. "Contributor"
|
||||||
|
means each individual or legal entity that creates, contributes to
|
||||||
|
the creation of, or owns Covered Software.
|
||||||
|
|
||||||
|
1.2. "Contributor Version"
|
||||||
|
means the combination of the Contributions of others (if any) used
|
||||||
|
by a Contributor and that particular Contributor's Contribution.
|
||||||
|
|
||||||
|
1.3. "Contribution"
|
||||||
|
means Covered Software of a particular Contributor.
|
||||||
|
|
||||||
|
1.4. "Covered Software"
|
||||||
|
means Source Code Form to which the initial Contributor has attached
|
||||||
|
the notice in Exhibit A, the Executable Form of such Source Code
|
||||||
|
Form, and Modifications of such Source Code Form, in each case
|
||||||
|
including portions thereof.
|
||||||
|
|
||||||
|
1.5. "Incompatible With Secondary Licenses"
|
||||||
|
means
|
||||||
|
|
||||||
|
(a) that the initial Contributor has attached the notice described
|
||||||
|
in Exhibit B to the Covered Software; or
|
||||||
|
|
||||||
|
(b) that the Covered Software was made available under the terms of
|
||||||
|
version 1.1 or earlier of the License, but not also under the
|
||||||
|
terms of a Secondary License.
|
||||||
|
|
||||||
|
1.6. "Executable Form"
|
||||||
|
means any form of the work other than Source Code Form.
|
||||||
|
|
||||||
|
1.7. "Larger Work"
|
||||||
|
means a work that combines Covered Software with other material, in
|
||||||
|
a separate file or files, that is not Covered Software.
|
||||||
|
|
||||||
|
1.8. "License"
|
||||||
|
means this document.
|
||||||
|
|
||||||
|
1.9. "Licensable"
|
||||||
|
means having the right to grant, to the maximum extent possible,
|
||||||
|
whether at the time of the initial grant or subsequently, any and
|
||||||
|
all of the rights conveyed by this License.
|
||||||
|
|
||||||
|
1.10. "Modifications"
|
||||||
|
means any of the following:
|
||||||
|
|
||||||
|
(a) any file in Source Code Form that results from an addition to,
|
||||||
|
deletion from, or modification of the contents of Covered
|
||||||
|
Software; or
|
||||||
|
|
||||||
|
(b) any new file in Source Code Form that contains any Covered
|
||||||
|
Software.
|
||||||
|
|
||||||
|
1.11. "Patent Claims" of a Contributor
|
||||||
|
means any patent claim(s), including without limitation, method,
|
||||||
|
process, and apparatus claims, in any patent Licensable by such
|
||||||
|
Contributor that would be infringed, but for the grant of the
|
||||||
|
License, by the making, using, selling, offering for sale, having
|
||||||
|
made, import, or transfer of either its Contributions or its
|
||||||
|
Contributor Version.
|
||||||
|
|
||||||
|
1.12. "Secondary License"
|
||||||
|
means either the GNU General Public License, Version 2.0, the GNU
|
||||||
|
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||||
|
Public License, Version 3.0, or any later versions of those
|
||||||
|
licenses.
|
||||||
|
|
||||||
|
1.13. "Source Code Form"
|
||||||
|
means the form of the work preferred for making modifications.
|
||||||
|
|
||||||
|
1.14. "You" (or "Your")
|
||||||
|
means an individual or a legal entity exercising rights under this
|
||||||
|
License. For legal entities, "You" includes any entity that
|
||||||
|
controls, is controlled by, or is under common control with You. For
|
||||||
|
purposes of this definition, "control" means (a) the power, direct
|
||||||
|
or indirect, to cause the direction or management of such entity,
|
||||||
|
whether by contract or otherwise, or (b) ownership of more than
|
||||||
|
fifty percent (50%) of the outstanding shares or beneficial
|
||||||
|
ownership of such entity.
|
||||||
|
|
||||||
|
2. License Grants and Conditions
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
2.1. Grants
|
||||||
|
|
||||||
|
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||||
|
non-exclusive license:
|
||||||
|
|
||||||
|
(a) under intellectual property rights (other than patent or trademark)
|
||||||
|
Licensable by such Contributor to use, reproduce, make available,
|
||||||
|
modify, display, perform, distribute, and otherwise exploit its
|
||||||
|
Contributions, either on an unmodified basis, with Modifications, or
|
||||||
|
as part of a Larger Work; and
|
||||||
|
|
||||||
|
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||||
|
for sale, have made, import, and otherwise transfer either its
|
||||||
|
Contributions or its Contributor Version.
|
||||||
|
|
||||||
|
2.2. Effective Date
|
||||||
|
|
||||||
|
The licenses granted in Section 2.1 with respect to any Contribution
|
||||||
|
become effective for each Contribution on the date the Contributor first
|
||||||
|
distributes such Contribution.
|
||||||
|
|
||||||
|
2.3. Limitations on Grant Scope
|
||||||
|
|
||||||
|
The licenses granted in this Section 2 are the only rights granted under
|
||||||
|
this License. No additional rights or licenses will be implied from the
|
||||||
|
distribution or licensing of Covered Software under this License.
|
||||||
|
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||||
|
Contributor:
|
||||||
|
|
||||||
|
(a) for any code that a Contributor has removed from Covered Software;
|
||||||
|
or
|
||||||
|
|
||||||
|
(b) for infringements caused by: (i) Your and any other third party's
|
||||||
|
modifications of Covered Software, or (ii) the combination of its
|
||||||
|
Contributions with other software (except as part of its Contributor
|
||||||
|
Version); or
|
||||||
|
|
||||||
|
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||||
|
its Contributions.
|
||||||
|
|
||||||
|
This License does not grant any rights in the trademarks, service marks,
|
||||||
|
or logos of any Contributor (except as may be necessary to comply with
|
||||||
|
the notice requirements in Section 3.4).
|
||||||
|
|
||||||
|
2.4. Subsequent Licenses
|
||||||
|
|
||||||
|
No Contributor makes additional grants as a result of Your choice to
|
||||||
|
distribute the Covered Software under a subsequent version of this
|
||||||
|
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||||
|
permitted under the terms of Section 3.3).
|
||||||
|
|
||||||
|
2.5. Representation
|
||||||
|
|
||||||
|
Each Contributor represents that the Contributor believes its
|
||||||
|
Contributions are its original creation(s) or it has sufficient rights
|
||||||
|
to grant the rights to its Contributions conveyed by this License.
|
||||||
|
|
||||||
|
2.6. Fair Use
|
||||||
|
|
||||||
|
This License is not intended to limit any rights You have under
|
||||||
|
applicable copyright doctrines of fair use, fair dealing, or other
|
||||||
|
equivalents.
|
||||||
|
|
||||||
|
2.7. Conditions
|
||||||
|
|
||||||
|
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||||
|
in Section 2.1.
|
||||||
|
|
||||||
|
3. Responsibilities
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
3.1. Distribution of Source Form
|
||||||
|
|
||||||
|
All distribution of Covered Software in Source Code Form, including any
|
||||||
|
Modifications that You create or to which You contribute, must be under
|
||||||
|
the terms of this License. You must inform recipients that the Source
|
||||||
|
Code Form of the Covered Software is governed by the terms of this
|
||||||
|
License, and how they can obtain a copy of this License. You may not
|
||||||
|
attempt to alter or restrict the recipients' rights in the Source Code
|
||||||
|
Form.
|
||||||
|
|
||||||
|
3.2. Distribution of Executable Form
|
||||||
|
|
||||||
|
If You distribute Covered Software in Executable Form then:
|
||||||
|
|
||||||
|
(a) such Covered Software must also be made available in Source Code
|
||||||
|
Form, as described in Section 3.1, and You must inform recipients of
|
||||||
|
the Executable Form how they can obtain a copy of such Source Code
|
||||||
|
Form by reasonable means in a timely manner, at a charge no more
|
||||||
|
than the cost of distribution to the recipient; and
|
||||||
|
|
||||||
|
(b) You may distribute such Executable Form under the terms of this
|
||||||
|
License, or sublicense it under different terms, provided that the
|
||||||
|
license for the Executable Form does not attempt to limit or alter
|
||||||
|
the recipients' rights in the Source Code Form under this License.
|
||||||
|
|
||||||
|
3.3. Distribution of a Larger Work
|
||||||
|
|
||||||
|
You may create and distribute a Larger Work under terms of Your choice,
|
||||||
|
provided that You also comply with the requirements of this License for
|
||||||
|
the Covered Software. If the Larger Work is a combination of Covered
|
||||||
|
Software with a work governed by one or more Secondary Licenses, and the
|
||||||
|
Covered Software is not Incompatible With Secondary Licenses, this
|
||||||
|
License permits You to additionally distribute such Covered Software
|
||||||
|
under the terms of such Secondary License(s), so that the recipient of
|
||||||
|
the Larger Work may, at their option, further distribute the Covered
|
||||||
|
Software under the terms of either this License or such Secondary
|
||||||
|
License(s).
|
||||||
|
|
||||||
|
3.4. Notices
|
||||||
|
|
||||||
|
You may not remove or alter the substance of any license notices
|
||||||
|
(including copyright notices, patent notices, disclaimers of warranty,
|
||||||
|
or limitations of liability) contained within the Source Code Form of
|
||||||
|
the Covered Software, except that You may alter any license notices to
|
||||||
|
the extent required to remedy known factual inaccuracies.
|
||||||
|
|
||||||
|
3.5. Application of Additional Terms
|
||||||
|
|
||||||
|
You may choose to offer, and to charge a fee for, warranty, support,
|
||||||
|
indemnity or liability obligations to one or more recipients of Covered
|
||||||
|
Software. However, You may do so only on Your own behalf, and not on
|
||||||
|
behalf of any Contributor. You must make it absolutely clear that any
|
||||||
|
such warranty, support, indemnity, or liability obligation is offered by
|
||||||
|
You alone, and You hereby agree to indemnify every Contributor for any
|
||||||
|
liability incurred by such Contributor as a result of warranty, support,
|
||||||
|
indemnity or liability terms You offer. You may include additional
|
||||||
|
disclaimers of warranty and limitations of liability specific to any
|
||||||
|
jurisdiction.
|
||||||
|
|
||||||
|
4. Inability to Comply Due to Statute or Regulation
|
||||||
|
---------------------------------------------------
|
||||||
|
|
||||||
|
If it is impossible for You to comply with any of the terms of this
|
||||||
|
License with respect to some or all of the Covered Software due to
|
||||||
|
statute, judicial order, or regulation then You must: (a) comply with
|
||||||
|
the terms of this License to the maximum extent possible; and (b)
|
||||||
|
describe the limitations and the code they affect. Such description must
|
||||||
|
be placed in a text file included with all distributions of the Covered
|
||||||
|
Software under this License. Except to the extent prohibited by statute
|
||||||
|
or regulation, such description must be sufficiently detailed for a
|
||||||
|
recipient of ordinary skill to be able to understand it.
|
||||||
|
|
||||||
|
5. Termination
|
||||||
|
--------------
|
||||||
|
|
||||||
|
5.1. The rights granted under this License will terminate automatically
|
||||||
|
if You fail to comply with any of its terms. However, if You become
|
||||||
|
compliant, then the rights granted under this License from a particular
|
||||||
|
Contributor are reinstated (a) provisionally, unless and until such
|
||||||
|
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||||
|
ongoing basis, if such Contributor fails to notify You of the
|
||||||
|
non-compliance by some reasonable means prior to 60 days after You have
|
||||||
|
come back into compliance. Moreover, Your grants from a particular
|
||||||
|
Contributor are reinstated on an ongoing basis if such Contributor
|
||||||
|
notifies You of the non-compliance by some reasonable means, this is the
|
||||||
|
first time You have received notice of non-compliance with this License
|
||||||
|
from such Contributor, and You become compliant prior to 30 days after
|
||||||
|
Your receipt of the notice.
|
||||||
|
|
||||||
|
5.2. If You initiate litigation against any entity by asserting a patent
|
||||||
|
infringement claim (excluding declaratory judgment actions,
|
||||||
|
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||||
|
directly or indirectly infringes any patent, then the rights granted to
|
||||||
|
You by any and all Contributors for the Covered Software under Section
|
||||||
|
2.1 of this License shall terminate.
|
||||||
|
|
||||||
|
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||||
|
end user license agreements (excluding distributors and resellers) which
|
||||||
|
have been validly granted by You or Your distributors under this License
|
||||||
|
prior to termination shall survive termination.
|
||||||
|
|
||||||
|
************************************************************************
|
||||||
|
* *
|
||||||
|
* 6. Disclaimer of Warranty *
|
||||||
|
* ------------------------- *
|
||||||
|
* *
|
||||||
|
* Covered Software is provided under this License on an "as is" *
|
||||||
|
* basis, without warranty of any kind, either expressed, implied, or *
|
||||||
|
* statutory, including, without limitation, warranties that the *
|
||||||
|
* Covered Software is free of defects, merchantable, fit for a *
|
||||||
|
* particular purpose or non-infringing. The entire risk as to the *
|
||||||
|
* quality and performance of the Covered Software is with You. *
|
||||||
|
* Should any Covered Software prove defective in any respect, You *
|
||||||
|
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||||
|
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||||
|
* essential part of this License. No use of any Covered Software is *
|
||||||
|
* authorized under this License except under this disclaimer. *
|
||||||
|
* *
|
||||||
|
************************************************************************
|
||||||
|
|
||||||
|
************************************************************************
|
||||||
|
* *
|
||||||
|
* 7. Limitation of Liability *
|
||||||
|
* -------------------------- *
|
||||||
|
* *
|
||||||
|
* Under no circumstances and under no legal theory, whether tort *
|
||||||
|
* (including negligence), contract, or otherwise, shall any *
|
||||||
|
* Contributor, or anyone who distributes Covered Software as *
|
||||||
|
* permitted above, be liable to You for any direct, indirect, *
|
||||||
|
* special, incidental, or consequential damages of any character *
|
||||||
|
* including, without limitation, damages for lost profits, loss of *
|
||||||
|
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||||
|
* and all other commercial damages or losses, even if such party *
|
||||||
|
* shall have been informed of the possibility of such damages. This *
|
||||||
|
* limitation of liability shall not apply to liability for death or *
|
||||||
|
* personal injury resulting from such party's negligence to the *
|
||||||
|
* extent applicable law prohibits such limitation. Some *
|
||||||
|
* jurisdictions do not allow the exclusion or limitation of *
|
||||||
|
* incidental or consequential damages, so this exclusion and *
|
||||||
|
* limitation may not apply to You. *
|
||||||
|
* *
|
||||||
|
************************************************************************
|
||||||
|
|
||||||
|
8. Litigation
|
||||||
|
-------------
|
||||||
|
|
||||||
|
Any litigation relating to this License may be brought only in the
|
||||||
|
courts of a jurisdiction where the defendant maintains its principal
|
||||||
|
place of business and such litigation shall be governed by laws of that
|
||||||
|
jurisdiction, without reference to its conflict-of-law provisions.
|
||||||
|
Nothing in this Section shall prevent a party's ability to bring
|
||||||
|
cross-claims or counter-claims.
|
||||||
|
|
||||||
|
9. Miscellaneous
|
||||||
|
----------------
|
||||||
|
|
||||||
|
This License represents the complete agreement concerning the subject
|
||||||
|
matter hereof. If any provision of this License is held to be
|
||||||
|
unenforceable, such provision shall be reformed only to the extent
|
||||||
|
necessary to make it enforceable. Any law or regulation which provides
|
||||||
|
that the language of a contract shall be construed against the drafter
|
||||||
|
shall not be used to construe this License against a Contributor.
|
||||||
|
|
||||||
|
10. Versions of the License
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
10.1. New Versions
|
||||||
|
|
||||||
|
Mozilla Foundation is the license steward. Except as provided in Section
|
||||||
|
10.3, no one other than the license steward has the right to modify or
|
||||||
|
publish new versions of this License. Each version will be given a
|
||||||
|
distinguishing version number.
|
||||||
|
|
||||||
|
10.2. Effect of New Versions
|
||||||
|
|
||||||
|
You may distribute the Covered Software under the terms of the version
|
||||||
|
of the License under which You originally received the Covered Software,
|
||||||
|
or under the terms of any subsequent version published by the license
|
||||||
|
steward.
|
||||||
|
|
||||||
|
10.3. Modified Versions
|
||||||
|
|
||||||
|
If you create software not governed by this License, and you want to
|
||||||
|
create a new license for such software, you may create and use a
|
||||||
|
modified version of this License if you rename the license and remove
|
||||||
|
any references to the name of the license steward (except to note that
|
||||||
|
such modified license differs from this License).
|
||||||
|
|
||||||
|
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||||
|
Licenses
|
||||||
|
|
||||||
|
If You choose to distribute Source Code Form that is Incompatible With
|
||||||
|
Secondary Licenses under the terms of this version of the License, the
|
||||||
|
notice described in Exhibit B of this License must be attached.
|
||||||
|
|
||||||
|
Exhibit A - Source Code Form License Notice
|
||||||
|
-------------------------------------------
|
||||||
|
|
||||||
|
This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
If it is not possible or desirable to put the notice in a particular
|
||||||
|
file, then You may include the notice in a location (such as a LICENSE
|
||||||
|
file in a relevant directory) where a recipient would be likely to look
|
||||||
|
for such a notice.
|
||||||
|
|
||||||
|
You may add additional accurate notices of copyright ownership.
|
||||||
|
|
||||||
|
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||||
|
---------------------------------------------------------
|
||||||
|
|
||||||
|
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||||
|
defined by the Mozilla Public License, v. 2.0.
|
||||||
|
|
@ -0,0 +1,260 @@
|
||||||
|
Metadata-Version: 2.1
|
||||||
|
Name: bidict
|
||||||
|
Version: 0.23.1
|
||||||
|
Summary: The bidirectional mapping library for Python.
|
||||||
|
Author-email: Joshua Bronson <jabronson@gmail.com>
|
||||||
|
License: MPL 2.0
|
||||||
|
Project-URL: Changelog, https://bidict.readthedocs.io/changelog.html
|
||||||
|
Project-URL: Documentation, https://bidict.readthedocs.io
|
||||||
|
Project-URL: Funding, https://bidict.readthedocs.io/#sponsoring
|
||||||
|
Project-URL: Repository, https://github.com/jab/bidict
|
||||||
|
Keywords: bidict,bimap,bidirectional,dict,dictionary,mapping,collections
|
||||||
|
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
|
||||||
|
Classifier: Operating System :: OS Independent
|
||||||
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
||||||
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
||||||
|
Classifier: Typing :: Typed
|
||||||
|
Requires-Python: >=3.8
|
||||||
|
Description-Content-Type: text/x-rst
|
||||||
|
License-File: LICENSE
|
||||||
|
|
||||||
|
.. role:: doc
|
||||||
|
.. (Forward declaration for the "doc" role that Sphinx defines for interop with renderers that
|
||||||
|
are often used to show this doc and that are unaware of Sphinx (GitHub.com, PyPI.org, etc.).
|
||||||
|
Use :doc: rather than :ref: here for better interop as well.)
|
||||||
|
|
||||||
|
|
||||||
|
bidict
|
||||||
|
======
|
||||||
|
|
||||||
|
*The bidirectional mapping library for Python.*
|
||||||
|
|
||||||
|
|
||||||
|
Status
|
||||||
|
------
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/pypi/v/bidict.svg
|
||||||
|
:target: https://pypi.org/project/bidict
|
||||||
|
:alt: Latest release
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/readthedocs/bidict/main.svg
|
||||||
|
:target: https://bidict.readthedocs.io/en/main/
|
||||||
|
:alt: Documentation
|
||||||
|
|
||||||
|
.. image:: https://github.com/jab/bidict/actions/workflows/test.yml/badge.svg
|
||||||
|
:target: https://github.com/jab/bidict/actions/workflows/test.yml?query=branch%3Amain
|
||||||
|
:alt: GitHub Actions CI status
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/pypi/l/bidict.svg
|
||||||
|
:target: https://raw.githubusercontent.com/jab/bidict/main/LICENSE
|
||||||
|
:alt: License
|
||||||
|
|
||||||
|
.. image:: https://static.pepy.tech/badge/bidict
|
||||||
|
:target: https://pepy.tech/project/bidict
|
||||||
|
:alt: PyPI Downloads
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/badge/GitHub-sponsor-ff69b4
|
||||||
|
:target: https://github.com/sponsors/jab
|
||||||
|
:alt: Sponsor
|
||||||
|
|
||||||
|
|
||||||
|
Features
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Mature: Depended on by
|
||||||
|
Google, Venmo, CERN, Baidu, Tencent,
|
||||||
|
and teams across the world since 2009
|
||||||
|
|
||||||
|
- Familiar, Pythonic APIs
|
||||||
|
that are carefully designed for
|
||||||
|
safety, simplicity, flexibility, and ergonomics
|
||||||
|
|
||||||
|
- Lightweight, with no runtime dependencies
|
||||||
|
outside Python's standard library
|
||||||
|
|
||||||
|
- Implemented in
|
||||||
|
concise, well-factored, fully type-hinted Python code
|
||||||
|
that is optimized for running efficiently
|
||||||
|
as well as for long-term maintenance and stability
|
||||||
|
(as well as `joy <#learning-from-bidict>`__)
|
||||||
|
|
||||||
|
- Extensively `documented <https://bidict.readthedocs.io>`__
|
||||||
|
|
||||||
|
- 100% test coverage
|
||||||
|
running continuously across all supported Python versions
|
||||||
|
(including property-based tests and benchmarks)
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
``pip install bidict``
|
||||||
|
|
||||||
|
|
||||||
|
Quick Start
|
||||||
|
-----------
|
||||||
|
|
||||||
|
.. code:: python
|
||||||
|
|
||||||
|
>>> from bidict import bidict
|
||||||
|
>>> element_by_symbol = bidict({'H': 'hydrogen'})
|
||||||
|
>>> element_by_symbol['H']
|
||||||
|
'hydrogen'
|
||||||
|
>>> element_by_symbol.inverse['hydrogen']
|
||||||
|
'H'
|
||||||
|
|
||||||
|
|
||||||
|
For more usage documentation,
|
||||||
|
head to the :doc:`intro` [#fn-intro]_
|
||||||
|
and proceed from there.
|
||||||
|
|
||||||
|
|
||||||
|
Enterprise Support
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Enterprise-level support for bidict can be obtained via the
|
||||||
|
`Tidelift subscription <https://tidelift.com/subscription/pkg/pypi-bidict?utm_source=pypi-bidict&utm_medium=referral&utm_campaign=readme>`__
|
||||||
|
or by `contacting me directly <mailto:jabronson@gmail.com>`__.
|
||||||
|
|
||||||
|
I have a US-based LLC set up for invoicing,
|
||||||
|
and I have 15+ years of professional experience
|
||||||
|
delivering software and support to companies successfully.
|
||||||
|
|
||||||
|
You can also sponsor my work through several platforms, including GitHub Sponsors.
|
||||||
|
See the `Sponsoring <#sponsoring>`__ section below for details,
|
||||||
|
including rationale and examples of companies
|
||||||
|
supporting the open source projects they depend on.
|
||||||
|
|
||||||
|
|
||||||
|
Voluntary Community Support
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
Please search through already-asked questions and answers
|
||||||
|
in `GitHub Discussions <https://github.com/jab/bidict/discussions>`__
|
||||||
|
and the `issue tracker <https://github.com/jab/bidict/issues?q=is%3Aissue>`__
|
||||||
|
in case your question has already been addressed.
|
||||||
|
|
||||||
|
Otherwise, please feel free to
|
||||||
|
`start a new discussion <https://github.com/jab/bidict/discussions>`__
|
||||||
|
or `create a new issue <https://github.com/jab/bidict/issues/new>`__ on GitHub
|
||||||
|
for voluntary community support.
|
||||||
|
|
||||||
|
|
||||||
|
Notice of Usage
|
||||||
|
---------------
|
||||||
|
|
||||||
|
If you use bidict,
|
||||||
|
and especially if your usage or your organization is significant in some way,
|
||||||
|
please let me know in any of the following ways:
|
||||||
|
|
||||||
|
- `star bidict on GitHub <https://github.com/jab/bidict>`__
|
||||||
|
- post in `GitHub Discussions <https://github.com/jab/bidict/discussions>`__
|
||||||
|
- `email me <mailto:jabronson@gmail.com>`__
|
||||||
|
|
||||||
|
|
||||||
|
Changelog
|
||||||
|
---------
|
||||||
|
|
||||||
|
For bidict release notes, see the :doc:`changelog`. [#fn-changelog]_
|
||||||
|
|
||||||
|
|
||||||
|
Release Notifications
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. duplicated in CHANGELOG.rst:
|
||||||
|
(Would use `.. include::` but GitHub's renderer doesn't support it.)
|
||||||
|
|
||||||
|
Watch `bidict releases on GitHub <https://github.com/jab/bidict/releases>`__
|
||||||
|
to be notified when new versions of bidict are published.
|
||||||
|
Click the "Watch" dropdown, choose "Custom", and then choose "Releases".
|
||||||
|
|
||||||
|
|
||||||
|
Learning from bidict
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
One of the best things about bidict
|
||||||
|
is that it touches a surprising number of
|
||||||
|
interesting Python corners,
|
||||||
|
especially given its small size and scope.
|
||||||
|
|
||||||
|
Check out :doc:`learning-from-bidict` [#fn-learning]_
|
||||||
|
if you're interested in learning more.
|
||||||
|
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
------------
|
||||||
|
|
||||||
|
I have been bidict's sole maintainer
|
||||||
|
and `active contributor <https://github.com/jab/bidict/graphs/contributors>`__
|
||||||
|
since I started the project ~15 years ago.
|
||||||
|
|
||||||
|
Your help would be most welcome!
|
||||||
|
See the :doc:`contributors-guide` [#fn-contributing]_
|
||||||
|
for more information.
|
||||||
|
|
||||||
|
|
||||||
|
Sponsoring
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. duplicated in CONTRIBUTING.rst
|
||||||
|
(Would use `.. include::` but GitHub's renderer doesn't support it.)
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/badge/GitHub-sponsor-ff69b4
|
||||||
|
:target: https://github.com/sponsors/jab
|
||||||
|
:alt: Sponsor through GitHub
|
||||||
|
|
||||||
|
Bidict is the product of thousands of hours of my unpaid work
|
||||||
|
over the 15+ years that I've been the sole maintainer.
|
||||||
|
|
||||||
|
If bidict has helped you or your company accomplish your work,
|
||||||
|
please sponsor my work through one of the following,
|
||||||
|
and/or ask your company to do the same:
|
||||||
|
|
||||||
|
- `GitHub <https://github.com/sponsors/jab>`__
|
||||||
|
- `PayPal <https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=jabronson%40gmail%2ecom&lc=US&item_name=Sponsor%20bidict>`__
|
||||||
|
- `Tidelift <https://tidelift.com>`__
|
||||||
|
- `thanks.dev <https://thanks.dev>`__
|
||||||
|
- `Gumroad <https://gumroad.com/l/bidict>`__
|
||||||
|
- `a support engagement with my LLC <#enterprise-support>`__
|
||||||
|
|
||||||
|
If you're not sure which to use, GitHub is an easy option,
|
||||||
|
especially if you already have a GitHub account.
|
||||||
|
Just choose a monthly or one-time amount, and GitHub handles everything else.
|
||||||
|
Your bidict sponsorship on GitHub will automatically go
|
||||||
|
on the same regular bill as any other GitHub charges you pay for.
|
||||||
|
PayPal is another easy option for one-time contributions.
|
||||||
|
|
||||||
|
See the following for rationale and examples of companies
|
||||||
|
supporting the open source projects they depend on
|
||||||
|
in this manner:
|
||||||
|
|
||||||
|
- `<https://engineering.atspotify.com/2022/04/announcing-the-spotify-foss-fund/>`__
|
||||||
|
- `<https://blog.sentry.io/2021/10/21/we-just-gave-154-999-dollars-and-89-cents-to-open-source-maintainers>`__
|
||||||
|
- `<https://engineering.indeedblog.com/blog/2019/07/foss-fund-six-months-in/>`__
|
||||||
|
|
||||||
|
.. - `<https://sethmlarson.dev/blog/people-in-your-software-supply-chain>`__
|
||||||
|
.. - `<https://www.cognitect.com/blog/supporting-open-source-developers>`__
|
||||||
|
.. - `<https://vorpus.org/blog/the-unreasonable-effectiveness-of-investment-in-open-source-infrastructure/>`__
|
||||||
|
|
||||||
|
|
||||||
|
Finding Documentation
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
If you're viewing this on `<https://bidict.readthedocs.io>`__,
|
||||||
|
note that multiple versions of the documentation are available,
|
||||||
|
and you can choose a different version using the popup menu at the bottom-right.
|
||||||
|
Please make sure you're viewing the version of the documentation
|
||||||
|
that corresponds to the version of bidict you'd like to use.
|
||||||
|
|
||||||
|
If you're viewing this on GitHub, PyPI, or some other place
|
||||||
|
that can't render and link this documentation properly
|
||||||
|
and are seeing broken links,
|
||||||
|
try these alternate links instead:
|
||||||
|
|
||||||
|
.. [#fn-intro] `<https://bidict.readthedocs.io/intro.html>`__ | `<docs/intro.rst>`__
|
||||||
|
|
||||||
|
.. [#fn-changelog] `<https://bidict.readthedocs.io/changelog.html>`__ | `<CHANGELOG.rst>`__
|
||||||
|
|
||||||
|
.. [#fn-learning] `<https://bidict.readthedocs.io/learning-from-bidict.html>`__ | `<docs/learning-from-bidict.rst>`__
|
||||||
|
|
||||||
|
.. [#fn-contributing] `<https://bidict.readthedocs.io/contributors-guide.html>`__ | `<CONTRIBUTING.rst>`__
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
bidict-0.23.1.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||||
|
bidict-0.23.1.dist-info/LICENSE,sha256=8_U63OyqSNc6ZuI4-lupBstBh2eDtF0ooTRrMULuvZo,16784
|
||||||
|
bidict-0.23.1.dist-info/METADATA,sha256=2ovIRm6Df8gdwAMekGqkeBSF5TWj2mv1jpmh4W4ks7o,8704
|
||||||
|
bidict-0.23.1.dist-info/RECORD,,
|
||||||
|
bidict-0.23.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
|
||||||
|
bidict-0.23.1.dist-info/top_level.txt,sha256=WuQO02jp0ODioS7sJoaHg3JJ5_3h6Sxo9RITvNGPYmc,7
|
||||||
|
bidict/__init__.py,sha256=pL87KsrDpBsl3AG09LQk1t1TSFt0hIJVYa2POMdErN8,4398
|
||||||
|
bidict/__pycache__/__init__.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_abc.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_base.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_bidict.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_dup.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_exc.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_frozen.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_iter.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_orderedbase.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_orderedbidict.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/_typing.cpython-312.pyc,,
|
||||||
|
bidict/__pycache__/metadata.cpython-312.pyc,,
|
||||||
|
bidict/_abc.py,sha256=SMCNdCsmqSWg0OGnMZtnnXY8edjXcyZup5tva4HBm_c,3172
|
||||||
|
bidict/_base.py,sha256=YiauA0aj52fNB6cfZ4gBt6OV-CRQoZm7WVhuw1nT-Cg,24439
|
||||||
|
bidict/_bidict.py,sha256=Sr-RoEzWOaxpnDRbDJ7ngaGRIsyGnqZgzvR-NyT4jl4,6923
|
||||||
|
bidict/_dup.py,sha256=YAn5gWA6lwMBA5A6ebVF19UTZyambGS8WxmbK4TN1Ww,2079
|
||||||
|
bidict/_exc.py,sha256=HnD_WgteI5PrXa3zBx9RUiGlgnZTO6CF4nIU9p3-njk,1066
|
||||||
|
bidict/_frozen.py,sha256=p4TaRHKeyTs0KmlpwSnZiTlN_CR4J97kAgBpNdZHQMs,1771
|
||||||
|
bidict/_iter.py,sha256=zVUx-hJ1M4YuJROoFWRjPKlcaFnyo1AAuRpOaKAFhOQ,1530
|
||||||
|
bidict/_orderedbase.py,sha256=M7v5rHa7vrym9Z3DxQBFQDxjnrr39Z8p26V0c1PggoE,8942
|
||||||
|
bidict/_orderedbidict.py,sha256=pPnmC19mIISrj8_yjnb-4r_ti1B74tD5eTd08DETNuI,7080
|
||||||
|
bidict/_typing.py,sha256=AylMZpBhEFTQegfziPSxfKkKLk7oUsH6o3awDIg2z_k,1289
|
||||||
|
bidict/metadata.py,sha256=BMIKu6fBY_OKeV_q48EpumE7MdmFw8rFcdaUz8kcIYk,573
|
||||||
|
bidict/py.typed,sha256=RJao5SVFYIp8IfbxhL_SpZkBQYe3XXzPlobSRdh4B_c,16
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
Wheel-Version: 1.0
|
||||||
|
Generator: bdist_wheel (0.42.0)
|
||||||
|
Root-Is-Purelib: true
|
||||||
|
Tag: py3-none-any
|
||||||
|
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
bidict
|
||||||
|
|
@ -0,0 +1,103 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# ============================================================================
|
||||||
|
# * Welcome to the bidict source code *
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
# Reading through the code? You'll find a "Code review nav" comment like the one
|
||||||
|
# below at the top and bottom of the key source files. Follow these cues to take
|
||||||
|
# a path through the code that's optimized for familiarizing yourself with it.
|
||||||
|
#
|
||||||
|
# If you're not reading this on https://github.com/jab/bidict already, go there
|
||||||
|
# to ensure you have the latest version of the code. While there, you can also
|
||||||
|
# star the project, watch it for updates, fork the code, and submit an issue or
|
||||||
|
# pull request with any proposed changes. More information can be found linked
|
||||||
|
# from README.rst, which is also shown on https://github.com/jab/bidict.
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# Current: __init__.py Next: _abc.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
"""The bidirectional mapping library for Python.
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
bidict by example:
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
>>> from bidict import bidict
|
||||||
|
>>> element_by_symbol = bidict({'H': 'hydrogen'})
|
||||||
|
>>> element_by_symbol['H']
|
||||||
|
'hydrogen'
|
||||||
|
>>> element_by_symbol.inverse['hydrogen']
|
||||||
|
'H'
|
||||||
|
|
||||||
|
|
||||||
|
Please see https://github.com/jab/bidict for the most up-to-date code and
|
||||||
|
https://bidict.readthedocs.io for the most up-to-date documentation
|
||||||
|
if you are reading this elsewhere.
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
.. :copyright: (c) 2009-2024 Joshua Bronson.
|
||||||
|
.. :license: MPLv2. See LICENSE for details.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Use private aliases to not re-export these publicly (for Sphinx automodule with imported-members).
|
||||||
|
from __future__ import annotations as _annotations
|
||||||
|
|
||||||
|
from contextlib import suppress as _suppress
|
||||||
|
|
||||||
|
from ._abc import BidirectionalMapping as BidirectionalMapping
|
||||||
|
from ._abc import MutableBidirectionalMapping as MutableBidirectionalMapping
|
||||||
|
from ._base import BidictBase as BidictBase
|
||||||
|
from ._base import BidictKeysView as BidictKeysView
|
||||||
|
from ._base import GeneratedBidictInverse as GeneratedBidictInverse
|
||||||
|
from ._bidict import MutableBidict as MutableBidict
|
||||||
|
from ._bidict import bidict as bidict
|
||||||
|
from ._dup import DROP_NEW as DROP_NEW
|
||||||
|
from ._dup import DROP_OLD as DROP_OLD
|
||||||
|
from ._dup import ON_DUP_DEFAULT as ON_DUP_DEFAULT
|
||||||
|
from ._dup import ON_DUP_DROP_OLD as ON_DUP_DROP_OLD
|
||||||
|
from ._dup import ON_DUP_RAISE as ON_DUP_RAISE
|
||||||
|
from ._dup import RAISE as RAISE
|
||||||
|
from ._dup import OnDup as OnDup
|
||||||
|
from ._dup import OnDupAction as OnDupAction
|
||||||
|
from ._exc import BidictException as BidictException
|
||||||
|
from ._exc import DuplicationError as DuplicationError
|
||||||
|
from ._exc import KeyAndValueDuplicationError as KeyAndValueDuplicationError
|
||||||
|
from ._exc import KeyDuplicationError as KeyDuplicationError
|
||||||
|
from ._exc import ValueDuplicationError as ValueDuplicationError
|
||||||
|
from ._frozen import frozenbidict as frozenbidict
|
||||||
|
from ._iter import inverted as inverted
|
||||||
|
from ._orderedbase import OrderedBidictBase as OrderedBidictBase
|
||||||
|
from ._orderedbidict import OrderedBidict as OrderedBidict
|
||||||
|
from .metadata import __author__ as __author__
|
||||||
|
from .metadata import __copyright__ as __copyright__
|
||||||
|
from .metadata import __description__ as __description__
|
||||||
|
from .metadata import __license__ as __license__
|
||||||
|
from .metadata import __url__ as __url__
|
||||||
|
from .metadata import __version__ as __version__
|
||||||
|
|
||||||
|
|
||||||
|
# Set __module__ of re-exported classes to the 'bidict' top-level module, so that e.g.
|
||||||
|
# 'bidict.bidict' shows up as 'bidict.bidict` rather than 'bidict._bidict.bidict'.
|
||||||
|
for _obj in tuple(locals().values()): # pragma: no cover
|
||||||
|
if not getattr(_obj, '__module__', '').startswith('bidict.'):
|
||||||
|
continue
|
||||||
|
with _suppress(AttributeError):
|
||||||
|
_obj.__module__ = 'bidict'
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# Current: __init__.py Next: _abc.py →
|
||||||
|
# ============================================================================
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,79 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# (see comments in __init__.py)
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: __init__.py Current: _abc.py Next: _base.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide the :class:`BidirectionalMapping` abstract base class."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
from abc import abstractmethod
|
||||||
|
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import VT
|
||||||
|
|
||||||
|
|
||||||
|
class BidirectionalMapping(t.Mapping[KT, VT]):
|
||||||
|
"""Abstract base class for bidirectional mapping types.
|
||||||
|
|
||||||
|
Extends :class:`collections.abc.Mapping` primarily by adding the
|
||||||
|
(abstract) :attr:`inverse` property,
|
||||||
|
which implementers of :class:`BidirectionalMapping`
|
||||||
|
should override to return a reference to the inverse
|
||||||
|
:class:`BidirectionalMapping` instance.
|
||||||
|
"""
|
||||||
|
|
||||||
|
__slots__ = ()
|
||||||
|
|
||||||
|
@property
|
||||||
|
@abstractmethod
|
||||||
|
def inverse(self) -> BidirectionalMapping[VT, KT]:
|
||||||
|
"""The inverse of this bidirectional mapping instance.
|
||||||
|
|
||||||
|
*See also* :attr:`bidict.BidictBase.inverse`, :attr:`bidict.BidictBase.inv`
|
||||||
|
|
||||||
|
:raises NotImplementedError: Meant to be overridden in subclasses.
|
||||||
|
"""
|
||||||
|
# The @abstractmethod decorator prevents subclasses from being instantiated unless they
|
||||||
|
# override this method. But an overriding implementation may merely return super().inverse,
|
||||||
|
# in which case this implementation is used. Raise NotImplementedError to indicate that
|
||||||
|
# subclasses must actually provide their own implementation.
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
def __inverted__(self) -> t.Iterator[tuple[VT, KT]]:
|
||||||
|
"""Get an iterator over the items in :attr:`inverse`.
|
||||||
|
|
||||||
|
This is functionally equivalent to iterating over the items in the
|
||||||
|
forward mapping and inverting each one on the fly, but this provides a
|
||||||
|
more efficient implementation: Assuming the already-inverted items
|
||||||
|
are stored in :attr:`inverse`, just return an iterator over them directly.
|
||||||
|
|
||||||
|
Providing this default implementation enables external functions,
|
||||||
|
particularly :func:`~bidict.inverted`, to use this optimized
|
||||||
|
implementation when available, instead of having to invert on the fly.
|
||||||
|
|
||||||
|
*See also* :func:`bidict.inverted`
|
||||||
|
"""
|
||||||
|
return iter(self.inverse.items())
|
||||||
|
|
||||||
|
|
||||||
|
class MutableBidirectionalMapping(BidirectionalMapping[KT, VT], t.MutableMapping[KT, VT]):
|
||||||
|
"""Abstract base class for mutable bidirectional mapping types."""
|
||||||
|
|
||||||
|
__slots__ = ()
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: __init__.py Current: _abc.py Next: _base.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
@ -0,0 +1,556 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# (see comments in __init__.py)
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _abc.py Current: _base.py Next: _frozen.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide :class:`BidictBase`."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
import weakref
|
||||||
|
from itertools import starmap
|
||||||
|
from operator import eq
|
||||||
|
from types import MappingProxyType
|
||||||
|
|
||||||
|
from ._abc import BidirectionalMapping
|
||||||
|
from ._dup import DROP_NEW
|
||||||
|
from ._dup import DROP_OLD
|
||||||
|
from ._dup import ON_DUP_DEFAULT
|
||||||
|
from ._dup import RAISE
|
||||||
|
from ._dup import OnDup
|
||||||
|
from ._exc import DuplicationError
|
||||||
|
from ._exc import KeyAndValueDuplicationError
|
||||||
|
from ._exc import KeyDuplicationError
|
||||||
|
from ._exc import ValueDuplicationError
|
||||||
|
from ._iter import inverted
|
||||||
|
from ._iter import iteritems
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import MISSING
|
||||||
|
from ._typing import OKT
|
||||||
|
from ._typing import OVT
|
||||||
|
from ._typing import VT
|
||||||
|
from ._typing import Maplike
|
||||||
|
from ._typing import MapOrItems
|
||||||
|
|
||||||
|
|
||||||
|
OldKV = t.Tuple[OKT[KT], OVT[VT]]
|
||||||
|
DedupResult = t.Optional[OldKV[KT, VT]]
|
||||||
|
Unwrites = t.List[t.Tuple[t.Any, ...]]
|
||||||
|
BT = t.TypeVar('BT', bound='BidictBase[t.Any, t.Any]')
|
||||||
|
|
||||||
|
|
||||||
|
class BidictKeysView(t.KeysView[KT], t.ValuesView[KT]):
|
||||||
|
"""Since the keys of a bidict are the values of its inverse (and vice versa),
|
||||||
|
the :class:`~collections.abc.ValuesView` result of calling *bi.values()*
|
||||||
|
is also a :class:`~collections.abc.KeysView` of *bi.inverse*.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class BidictBase(BidirectionalMapping[KT, VT]):
|
||||||
|
"""Base class implementing :class:`BidirectionalMapping`."""
|
||||||
|
|
||||||
|
#: The default :class:`~bidict.OnDup`
|
||||||
|
#: that governs behavior when a provided item
|
||||||
|
#: duplicates the key or value of other item(s).
|
||||||
|
#:
|
||||||
|
#: *See also*
|
||||||
|
#: :ref:`basic-usage:Values Must Be Unique` (https://bidict.rtfd.io/basic-usage.html#values-must-be-unique),
|
||||||
|
#: :doc:`extending` (https://bidict.rtfd.io/extending.html)
|
||||||
|
on_dup = ON_DUP_DEFAULT
|
||||||
|
|
||||||
|
_fwdm: t.MutableMapping[KT, VT] #: the backing forward mapping (*key* → *val*)
|
||||||
|
_invm: t.MutableMapping[VT, KT] #: the backing inverse mapping (*val* → *key*)
|
||||||
|
|
||||||
|
# Use Any rather than KT/VT in the following to avoid "ClassVar cannot contain type variables" errors:
|
||||||
|
_fwdm_cls: t.ClassVar[type[t.MutableMapping[t.Any, t.Any]]] = dict #: class of the backing forward mapping
|
||||||
|
_invm_cls: t.ClassVar[type[t.MutableMapping[t.Any, t.Any]]] = dict #: class of the backing inverse mapping
|
||||||
|
|
||||||
|
#: The class of the inverse bidict instance.
|
||||||
|
_inv_cls: t.ClassVar[type[BidictBase[t.Any, t.Any]]]
|
||||||
|
|
||||||
|
def __init_subclass__(cls) -> None:
|
||||||
|
super().__init_subclass__()
|
||||||
|
cls._init_class()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _init_class(cls) -> None:
|
||||||
|
cls._ensure_inv_cls()
|
||||||
|
cls._set_reversed()
|
||||||
|
|
||||||
|
__reversed__: t.ClassVar[t.Any]
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _set_reversed(cls) -> None:
|
||||||
|
"""Set __reversed__ for subclasses that do not set it explicitly
|
||||||
|
according to whether backing mappings are reversible.
|
||||||
|
"""
|
||||||
|
if cls is not BidictBase:
|
||||||
|
resolved = cls.__reversed__
|
||||||
|
overridden = resolved is not BidictBase.__reversed__
|
||||||
|
if overridden: # E.g. OrderedBidictBase, OrderedBidict
|
||||||
|
return
|
||||||
|
backing_reversible = all(issubclass(i, t.Reversible) for i in (cls._fwdm_cls, cls._invm_cls))
|
||||||
|
cls.__reversed__ = _fwdm_reversed if backing_reversible else None
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _ensure_inv_cls(cls) -> None:
|
||||||
|
"""Ensure :attr:`_inv_cls` is set, computing it dynamically if necessary.
|
||||||
|
|
||||||
|
All subclasses provided in :mod:`bidict` are their own inverse classes,
|
||||||
|
i.e., their backing forward and inverse mappings are both the same type,
|
||||||
|
but users may define subclasses where this is not the case.
|
||||||
|
This method ensures that the inverse class is computed correctly regardless.
|
||||||
|
|
||||||
|
See: :ref:`extending:Dynamic Inverse Class Generation`
|
||||||
|
(https://bidict.rtfd.io/extending.html#dynamic-inverse-class-generation)
|
||||||
|
"""
|
||||||
|
# This _ensure_inv_cls() method is (indirectly) corecursive with _make_inv_cls() below
|
||||||
|
# in the case that we need to dynamically generate the inverse class:
|
||||||
|
# 1. _ensure_inv_cls() calls cls._make_inv_cls()
|
||||||
|
# 2. cls._make_inv_cls() calls type(..., (cls, ...), ...) to dynamically generate inv_cls
|
||||||
|
# 3. Our __init_subclass__ hook (see above) is automatically called on inv_cls
|
||||||
|
# 4. inv_cls.__init_subclass__() calls inv_cls._ensure_inv_cls()
|
||||||
|
# 5. inv_cls._ensure_inv_cls() resolves to this implementation
|
||||||
|
# (inv_cls deliberately does not override this), so we're back where we started.
|
||||||
|
# But since the _make_inv_cls() call will have set inv_cls.__dict__._inv_cls,
|
||||||
|
# just check if it's already set before calling _make_inv_cls() to prevent infinite recursion.
|
||||||
|
if getattr(cls, '__dict__', {}).get('_inv_cls'): # Don't assume cls.__dict__ (e.g. mypyc native class)
|
||||||
|
return
|
||||||
|
cls._inv_cls = cls._make_inv_cls()
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _make_inv_cls(cls: type[BT]) -> type[BT]:
|
||||||
|
diff = cls._inv_cls_dict_diff()
|
||||||
|
cls_is_own_inv = all(getattr(cls, k, MISSING) == v for (k, v) in diff.items())
|
||||||
|
if cls_is_own_inv:
|
||||||
|
return cls
|
||||||
|
# Suppress auto-calculation of _inv_cls's _inv_cls since we know it already.
|
||||||
|
# Works with the guard in BidictBase._ensure_inv_cls() to prevent infinite recursion.
|
||||||
|
diff['_inv_cls'] = cls
|
||||||
|
inv_cls = type(f'{cls.__name__}Inv', (cls, GeneratedBidictInverse), diff)
|
||||||
|
inv_cls.__module__ = cls.__module__
|
||||||
|
return t.cast(t.Type[BT], inv_cls)
|
||||||
|
|
||||||
|
@classmethod
|
||||||
|
def _inv_cls_dict_diff(cls) -> dict[str, t.Any]:
|
||||||
|
return {
|
||||||
|
'_fwdm_cls': cls._invm_cls,
|
||||||
|
'_invm_cls': cls._fwdm_cls,
|
||||||
|
}
|
||||||
|
|
||||||
|
def __init__(self, arg: MapOrItems[KT, VT] = (), /, **kw: VT) -> None:
|
||||||
|
"""Make a new bidirectional mapping.
|
||||||
|
The signature behaves like that of :class:`dict`.
|
||||||
|
ktems passed via positional arg are processed first,
|
||||||
|
followed by any items passed via keyword argument.
|
||||||
|
Any duplication encountered along the way
|
||||||
|
is handled as per :attr:`on_dup`.
|
||||||
|
"""
|
||||||
|
self._fwdm = self._fwdm_cls()
|
||||||
|
self._invm = self._invm_cls()
|
||||||
|
self._update(arg, kw, rollback=False)
|
||||||
|
|
||||||
|
# If Python ever adds support for higher-kinded types, `inverse` could use them, e.g.
|
||||||
|
# def inverse(self: BT[KT, VT]) -> BT[VT, KT]:
|
||||||
|
# Ref: https://github.com/python/typing/issues/548#issuecomment-621571821
|
||||||
|
@property
|
||||||
|
def inverse(self) -> BidictBase[VT, KT]:
|
||||||
|
"""The inverse of this bidirectional mapping instance."""
|
||||||
|
# When `bi.inverse` is called for the first time, this method
|
||||||
|
# computes the inverse instance, stores it for subsequent use, and then
|
||||||
|
# returns it. It also stores a reference on `bi.inverse` back to `bi`,
|
||||||
|
# but uses a weakref to avoid creating a reference cycle. Strong references
|
||||||
|
# to inverse instances are stored in ._inv, and weak references are stored
|
||||||
|
# in ._invweak.
|
||||||
|
|
||||||
|
# First check if a strong reference is already stored.
|
||||||
|
inv: BidictBase[VT, KT] | None = getattr(self, '_inv', None)
|
||||||
|
if inv is not None:
|
||||||
|
return inv
|
||||||
|
# Next check if a weak reference is already stored.
|
||||||
|
invweak = getattr(self, '_invweak', None)
|
||||||
|
if invweak is not None:
|
||||||
|
inv = invweak() # Try to resolve a strong reference and return it.
|
||||||
|
if inv is not None:
|
||||||
|
return inv
|
||||||
|
# No luck. Compute the inverse reference and store it for subsequent use.
|
||||||
|
inv = self._make_inverse()
|
||||||
|
self._inv: BidictBase[VT, KT] | None = inv
|
||||||
|
self._invweak: weakref.ReferenceType[BidictBase[VT, KT]] | None = None
|
||||||
|
# Also store a weak reference back to `instance` on its inverse instance, so that
|
||||||
|
# the second `.inverse` access in `bi.inverse.inverse` hits the cached weakref.
|
||||||
|
inv._inv = None
|
||||||
|
inv._invweak = weakref.ref(self)
|
||||||
|
# In e.g. `bidict().inverse.inverse`, this design ensures that a strong reference
|
||||||
|
# back to the original instance is retained before its refcount drops to zero,
|
||||||
|
# avoiding an unintended potential deallocation.
|
||||||
|
return inv
|
||||||
|
|
||||||
|
def _make_inverse(self) -> BidictBase[VT, KT]:
|
||||||
|
inv: BidictBase[VT, KT] = self._inv_cls()
|
||||||
|
inv._fwdm = self._invm
|
||||||
|
inv._invm = self._fwdm
|
||||||
|
return inv
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inv(self) -> BidictBase[VT, KT]:
|
||||||
|
"""Alias for :attr:`inverse`."""
|
||||||
|
return self.inverse
|
||||||
|
|
||||||
|
def __repr__(self) -> str:
|
||||||
|
"""See :func:`repr`."""
|
||||||
|
clsname = self.__class__.__name__
|
||||||
|
items = dict(self.items()) if self else ''
|
||||||
|
return f'{clsname}({items})'
|
||||||
|
|
||||||
|
def values(self) -> BidictKeysView[VT]:
|
||||||
|
"""A set-like object providing a view on the contained values.
|
||||||
|
|
||||||
|
Since the values of a bidict are equivalent to the keys of its inverse,
|
||||||
|
this method returns a set-like object for this bidict's values
|
||||||
|
rather than just a collections.abc.ValuesView.
|
||||||
|
This object supports set operations like union and difference,
|
||||||
|
and constant- rather than linear-time containment checks,
|
||||||
|
and is no more expensive to provide than the less capable
|
||||||
|
collections.abc.ValuesView would be.
|
||||||
|
|
||||||
|
See :meth:`keys` for more information.
|
||||||
|
"""
|
||||||
|
return t.cast(BidictKeysView[VT], self.inverse.keys())
|
||||||
|
|
||||||
|
def keys(self) -> t.KeysView[KT]:
|
||||||
|
"""A set-like object providing a view on the contained keys.
|
||||||
|
|
||||||
|
When *b._fwdm* is a :class:`dict`, *b.keys()* returns a
|
||||||
|
*dict_keys* object that behaves exactly the same as
|
||||||
|
*collections.abc.KeysView(b)*, except for
|
||||||
|
|
||||||
|
- offering better performance
|
||||||
|
|
||||||
|
- being reversible on Python 3.8+
|
||||||
|
|
||||||
|
- having a .mapping attribute in Python 3.10+
|
||||||
|
that exposes a mappingproxy to *b._fwdm*.
|
||||||
|
"""
|
||||||
|
fwdm, fwdm_cls = self._fwdm, self._fwdm_cls
|
||||||
|
return fwdm.keys() if fwdm_cls is dict else BidictKeysView(self)
|
||||||
|
|
||||||
|
def items(self) -> t.ItemsView[KT, VT]:
|
||||||
|
"""A set-like object providing a view on the contained items.
|
||||||
|
|
||||||
|
When *b._fwdm* is a :class:`dict`, *b.items()* returns a
|
||||||
|
*dict_items* object that behaves exactly the same as
|
||||||
|
*collections.abc.ItemsView(b)*, except for:
|
||||||
|
|
||||||
|
- offering better performance
|
||||||
|
|
||||||
|
- being reversible on Python 3.8+
|
||||||
|
|
||||||
|
- having a .mapping attribute in Python 3.10+
|
||||||
|
that exposes a mappingproxy to *b._fwdm*.
|
||||||
|
"""
|
||||||
|
return self._fwdm.items() if self._fwdm_cls is dict else super().items()
|
||||||
|
|
||||||
|
# The inherited collections.abc.Mapping.__contains__() method is implemented by doing a `try`
|
||||||
|
# `except KeyError` around `self[key]`. The following implementation is much faster,
|
||||||
|
# especially in the missing case.
|
||||||
|
def __contains__(self, key: t.Any) -> bool:
|
||||||
|
"""True if the mapping contains the specified key, else False."""
|
||||||
|
return key in self._fwdm
|
||||||
|
|
||||||
|
# The inherited collections.abc.Mapping.__eq__() method is implemented in terms of an inefficient
|
||||||
|
# `dict(self.items()) == dict(other.items())` comparison, so override it with a
|
||||||
|
# more efficient implementation.
|
||||||
|
def __eq__(self, other: object) -> bool:
|
||||||
|
"""*x.__eq__(other) ⟺ x == other*
|
||||||
|
|
||||||
|
Equivalent to *dict(x.items()) == dict(other.items())*
|
||||||
|
but more efficient.
|
||||||
|
|
||||||
|
Note that :meth:`bidict's __eq__() <bidict.BidictBase.__eq__>` implementation
|
||||||
|
is inherited by subclasses,
|
||||||
|
in particular by the ordered bidict subclasses,
|
||||||
|
so even with ordered bidicts,
|
||||||
|
:ref:`== comparison is order-insensitive <eq-order-insensitive>`
|
||||||
|
(https://bidict.rtfd.io/other-bidict-types.html#eq-is-order-insensitive).
|
||||||
|
|
||||||
|
*See also* :meth:`equals_order_sensitive`
|
||||||
|
"""
|
||||||
|
if isinstance(other, t.Mapping):
|
||||||
|
return self._fwdm.items() == other.items()
|
||||||
|
# Ref: https://docs.python.org/3/library/constants.html#NotImplemented
|
||||||
|
return NotImplemented
|
||||||
|
|
||||||
|
def equals_order_sensitive(self, other: object) -> bool:
|
||||||
|
"""Order-sensitive equality check.
|
||||||
|
|
||||||
|
*See also* :ref:`eq-order-insensitive`
|
||||||
|
(https://bidict.rtfd.io/other-bidict-types.html#eq-is-order-insensitive)
|
||||||
|
"""
|
||||||
|
if not isinstance(other, t.Mapping) or len(self) != len(other):
|
||||||
|
return False
|
||||||
|
return all(starmap(eq, zip(self.items(), other.items())))
|
||||||
|
|
||||||
|
def _dedup(self, key: KT, val: VT, on_dup: OnDup) -> DedupResult[KT, VT]:
|
||||||
|
"""Check *key* and *val* for any duplication in self.
|
||||||
|
|
||||||
|
Handle any duplication as per the passed in *on_dup*.
|
||||||
|
|
||||||
|
If (key, val) is already present, return None
|
||||||
|
since writing (key, val) would be a no-op.
|
||||||
|
|
||||||
|
If duplication is found and the corresponding :class:`~bidict.OnDupAction` is
|
||||||
|
:attr:`~bidict.DROP_NEW`, return None.
|
||||||
|
|
||||||
|
If duplication is found and the corresponding :class:`~bidict.OnDupAction` is
|
||||||
|
:attr:`~bidict.RAISE`, raise the appropriate exception.
|
||||||
|
|
||||||
|
If duplication is found and the corresponding :class:`~bidict.OnDupAction` is
|
||||||
|
:attr:`~bidict.DROP_OLD`, or if no duplication is found,
|
||||||
|
return *(oldkey, oldval)*.
|
||||||
|
"""
|
||||||
|
fwdm, invm = self._fwdm, self._invm
|
||||||
|
oldval: OVT[VT] = fwdm.get(key, MISSING)
|
||||||
|
oldkey: OKT[KT] = invm.get(val, MISSING)
|
||||||
|
isdupkey, isdupval = oldval is not MISSING, oldkey is not MISSING
|
||||||
|
if isdupkey and isdupval:
|
||||||
|
if key == oldkey:
|
||||||
|
assert val == oldval
|
||||||
|
# (key, val) duplicates an existing item -> no-op.
|
||||||
|
return None
|
||||||
|
# key and val each duplicate a different existing item.
|
||||||
|
if on_dup.val is RAISE:
|
||||||
|
raise KeyAndValueDuplicationError(key, val)
|
||||||
|
if on_dup.val is DROP_NEW:
|
||||||
|
return None
|
||||||
|
assert on_dup.val is DROP_OLD
|
||||||
|
# Fall through to the return statement on the last line.
|
||||||
|
elif isdupkey:
|
||||||
|
if on_dup.key is RAISE:
|
||||||
|
raise KeyDuplicationError(key)
|
||||||
|
if on_dup.key is DROP_NEW:
|
||||||
|
return None
|
||||||
|
assert on_dup.key is DROP_OLD
|
||||||
|
# Fall through to the return statement on the last line.
|
||||||
|
elif isdupval:
|
||||||
|
if on_dup.val is RAISE:
|
||||||
|
raise ValueDuplicationError(val)
|
||||||
|
if on_dup.val is DROP_NEW:
|
||||||
|
return None
|
||||||
|
assert on_dup.val is DROP_OLD
|
||||||
|
# Fall through to the return statement on the last line.
|
||||||
|
# else neither isdupkey nor isdupval.
|
||||||
|
return oldkey, oldval
|
||||||
|
|
||||||
|
def _write(self, newkey: KT, newval: VT, oldkey: OKT[KT], oldval: OVT[VT], unwrites: Unwrites | None) -> None:
|
||||||
|
"""Insert (newkey, newval), extending *unwrites* with associated inverse operations if provided.
|
||||||
|
|
||||||
|
*oldkey* and *oldval* are as returned by :meth:`_dedup`.
|
||||||
|
|
||||||
|
If *unwrites* is not None, it is extended with the inverse operations necessary to undo the write.
|
||||||
|
This design allows :meth:`_update` to roll back a partially applied update that fails part-way through
|
||||||
|
when necessary.
|
||||||
|
|
||||||
|
This design also allows subclasses that require additional operations to easily extend this implementation.
|
||||||
|
For example, :class:`bidict.OrderedBidictBase` calls this inherited implementation, and then extends *unwrites*
|
||||||
|
with additional operations needed to keep its internal linked list nodes consistent with its items' order
|
||||||
|
as changes are made.
|
||||||
|
"""
|
||||||
|
fwdm, invm = self._fwdm, self._invm
|
||||||
|
fwdm_set, invm_set = fwdm.__setitem__, invm.__setitem__
|
||||||
|
fwdm_del, invm_del = fwdm.__delitem__, invm.__delitem__
|
||||||
|
# Always perform the following writes regardless of duplication.
|
||||||
|
fwdm_set(newkey, newval)
|
||||||
|
invm_set(newval, newkey)
|
||||||
|
if oldval is MISSING and oldkey is MISSING: # no key or value duplication
|
||||||
|
# {0: 1, 2: 3} | {4: 5} => {0: 1, 2: 3, 4: 5}
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.extend((
|
||||||
|
(fwdm_del, newkey),
|
||||||
|
(invm_del, newval),
|
||||||
|
))
|
||||||
|
elif oldval is not MISSING and oldkey is not MISSING: # key and value duplication across two different items
|
||||||
|
# {0: 1, 2: 3} | {0: 3} => {0: 3}
|
||||||
|
fwdm_del(oldkey)
|
||||||
|
invm_del(oldval)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.extend((
|
||||||
|
(fwdm_set, newkey, oldval),
|
||||||
|
(invm_set, oldval, newkey),
|
||||||
|
(fwdm_set, oldkey, newval),
|
||||||
|
(invm_set, newval, oldkey),
|
||||||
|
))
|
||||||
|
elif oldval is not MISSING: # just key duplication
|
||||||
|
# {0: 1, 2: 3} | {2: 4} => {0: 1, 2: 4}
|
||||||
|
invm_del(oldval)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.extend((
|
||||||
|
(fwdm_set, newkey, oldval),
|
||||||
|
(invm_set, oldval, newkey),
|
||||||
|
(invm_del, newval),
|
||||||
|
))
|
||||||
|
else:
|
||||||
|
assert oldkey is not MISSING # just value duplication
|
||||||
|
# {0: 1, 2: 3} | {4: 3} => {0: 1, 4: 3}
|
||||||
|
fwdm_del(oldkey)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.extend((
|
||||||
|
(fwdm_set, oldkey, newval),
|
||||||
|
(invm_set, newval, oldkey),
|
||||||
|
(fwdm_del, newkey),
|
||||||
|
))
|
||||||
|
|
||||||
|
def _update(
|
||||||
|
self,
|
||||||
|
arg: MapOrItems[KT, VT],
|
||||||
|
kw: t.Mapping[str, VT] = MappingProxyType({}),
|
||||||
|
*,
|
||||||
|
rollback: bool | None = None,
|
||||||
|
on_dup: OnDup | None = None,
|
||||||
|
) -> None:
|
||||||
|
"""Update with the items from *arg* and *kw*, maybe failing and rolling back as per *on_dup* and *rollback*."""
|
||||||
|
# Note: We must process input in a single pass, since arg may be a generator.
|
||||||
|
if not isinstance(arg, (t.Iterable, Maplike)):
|
||||||
|
raise TypeError(f"'{arg.__class__.__name__}' object is not iterable")
|
||||||
|
if not arg and not kw:
|
||||||
|
return
|
||||||
|
if on_dup is None:
|
||||||
|
on_dup = self.on_dup
|
||||||
|
if rollback is None:
|
||||||
|
rollback = RAISE in on_dup
|
||||||
|
|
||||||
|
# Fast path when we're empty and updating only from another bidict (i.e. no dup vals in new items).
|
||||||
|
if not self and not kw and isinstance(arg, BidictBase):
|
||||||
|
self._init_from(arg)
|
||||||
|
return
|
||||||
|
|
||||||
|
# Fast path when we're adding more items than we contain already and rollback is enabled:
|
||||||
|
# Update a copy of self with rollback disabled. Fail if that fails, otherwise become the copy.
|
||||||
|
if rollback and isinstance(arg, t.Sized) and len(arg) + len(kw) > len(self):
|
||||||
|
tmp = self.copy()
|
||||||
|
tmp._update(arg, kw, rollback=False, on_dup=on_dup)
|
||||||
|
self._init_from(tmp)
|
||||||
|
return
|
||||||
|
|
||||||
|
# In all other cases, benchmarking has indicated that the update is best implemented as follows:
|
||||||
|
# For each new item, perform a dup check (raising if necessary), and apply the associated writes we need to
|
||||||
|
# perform on our backing _fwdm and _invm mappings. If rollback is enabled, also compute the associated unwrites
|
||||||
|
# as we go. If the update results in a DuplicationError and rollback is enabled, apply the accumulated unwrites
|
||||||
|
# before raising, to ensure that we fail clean.
|
||||||
|
write = self._write
|
||||||
|
unwrites: Unwrites | None = [] if rollback else None
|
||||||
|
for key, val in iteritems(arg, **kw):
|
||||||
|
try:
|
||||||
|
dedup_result = self._dedup(key, val, on_dup)
|
||||||
|
except DuplicationError:
|
||||||
|
if unwrites is not None:
|
||||||
|
for fn, *args in reversed(unwrites):
|
||||||
|
fn(*args)
|
||||||
|
raise
|
||||||
|
if dedup_result is not None:
|
||||||
|
write(key, val, *dedup_result, unwrites=unwrites)
|
||||||
|
|
||||||
|
def __copy__(self: BT) -> BT:
|
||||||
|
"""Used for the copy protocol. See the :mod:`copy` module."""
|
||||||
|
return self.copy()
|
||||||
|
|
||||||
|
def copy(self: BT) -> BT:
|
||||||
|
"""Make a (shallow) copy of this bidict."""
|
||||||
|
# Could just `return self.__class__(self)` here, but the below is faster. The former
|
||||||
|
# would copy this bidict's items into a new instance one at a time (checking for duplication
|
||||||
|
# for each item), whereas the below copies from the backing mappings all at once, and foregoes
|
||||||
|
# item-by-item duplication checking since the backing mappings have been checked already.
|
||||||
|
return self._from_other(self.__class__, self)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _from_other(bt: type[BT], other: MapOrItems[KT, VT], inv: bool = False) -> BT:
|
||||||
|
"""Fast, private constructor based on :meth:`_init_from`.
|
||||||
|
|
||||||
|
If *inv* is true, return the inverse of the instance instead of the instance itself.
|
||||||
|
(Useful for pickling with dynamically-generated inverse classes -- see :meth:`__reduce__`.)
|
||||||
|
"""
|
||||||
|
inst = bt()
|
||||||
|
inst._init_from(other)
|
||||||
|
return t.cast(BT, inst.inverse) if inv else inst
|
||||||
|
|
||||||
|
def _init_from(self, other: MapOrItems[KT, VT]) -> None:
|
||||||
|
"""Fast init from *other*, bypassing item-by-item duplication checking."""
|
||||||
|
self._fwdm.clear()
|
||||||
|
self._invm.clear()
|
||||||
|
self._fwdm.update(other)
|
||||||
|
# If other is a bidict, use its existing backing inverse mapping, otherwise
|
||||||
|
# other could be a generator that's now exhausted, so invert self._fwdm on the fly.
|
||||||
|
inv = other.inverse if isinstance(other, BidictBase) else inverted(self._fwdm)
|
||||||
|
self._invm.update(inv)
|
||||||
|
|
||||||
|
# other's type is Mapping rather than Maplike since bidict() | SupportsKeysAndGetItem({})
|
||||||
|
# raises a TypeError, just like dict() | SupportsKeysAndGetItem({}) does.
|
||||||
|
def __or__(self: BT, other: t.Mapping[KT, VT]) -> BT:
|
||||||
|
"""Return self|other."""
|
||||||
|
if not isinstance(other, t.Mapping):
|
||||||
|
return NotImplemented
|
||||||
|
new = self.copy()
|
||||||
|
new._update(other, rollback=False)
|
||||||
|
return new
|
||||||
|
|
||||||
|
def __ror__(self: BT, other: t.Mapping[KT, VT]) -> BT:
|
||||||
|
"""Return other|self."""
|
||||||
|
if not isinstance(other, t.Mapping):
|
||||||
|
return NotImplemented
|
||||||
|
new = self.__class__(other)
|
||||||
|
new._update(self, rollback=False)
|
||||||
|
return new
|
||||||
|
|
||||||
|
def __len__(self) -> int:
|
||||||
|
"""The number of contained items."""
|
||||||
|
return len(self._fwdm)
|
||||||
|
|
||||||
|
def __iter__(self) -> t.Iterator[KT]:
|
||||||
|
"""Iterator over the contained keys."""
|
||||||
|
return iter(self._fwdm)
|
||||||
|
|
||||||
|
def __getitem__(self, key: KT) -> VT:
|
||||||
|
"""*x.__getitem__(key) ⟺ x[key]*"""
|
||||||
|
return self._fwdm[key]
|
||||||
|
|
||||||
|
def __reduce__(self) -> tuple[t.Any, ...]:
|
||||||
|
"""Return state information for pickling."""
|
||||||
|
cls = self.__class__
|
||||||
|
inst: t.Mapping[t.Any, t.Any] = self
|
||||||
|
# If this bidict's class is dynamically generated, pickle the inverse instead, whose (presumably not
|
||||||
|
# dynamically generated) class the caller is more likely to have a reference to somewhere in sys.modules
|
||||||
|
# that pickle can discover.
|
||||||
|
if should_invert := isinstance(self, GeneratedBidictInverse):
|
||||||
|
cls = self._inv_cls
|
||||||
|
inst = self.inverse
|
||||||
|
return self._from_other, (cls, dict(inst), should_invert)
|
||||||
|
|
||||||
|
|
||||||
|
# See BidictBase._set_reversed() above.
|
||||||
|
def _fwdm_reversed(self: BidictBase[KT, t.Any]) -> t.Iterator[KT]:
|
||||||
|
"""Iterator over the contained keys in reverse order."""
|
||||||
|
assert isinstance(self._fwdm, t.Reversible)
|
||||||
|
return reversed(self._fwdm)
|
||||||
|
|
||||||
|
|
||||||
|
BidictBase._init_class()
|
||||||
|
|
||||||
|
|
||||||
|
class GeneratedBidictInverse:
|
||||||
|
"""Base class for dynamically-generated inverse bidict classes."""
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _abc.py Current: _base.py Next: _frozen.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
@ -0,0 +1,194 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# (see comments in __init__.py)
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _frozen.py Current: _bidict.py Next: _orderedbase.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide :class:`MutableBidict` and :class:`bidict`."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
|
||||||
|
from ._abc import MutableBidirectionalMapping
|
||||||
|
from ._base import BidictBase
|
||||||
|
from ._dup import ON_DUP_DROP_OLD
|
||||||
|
from ._dup import ON_DUP_RAISE
|
||||||
|
from ._dup import OnDup
|
||||||
|
from ._typing import DT
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import MISSING
|
||||||
|
from ._typing import ODT
|
||||||
|
from ._typing import VT
|
||||||
|
from ._typing import MapOrItems
|
||||||
|
|
||||||
|
|
||||||
|
class MutableBidict(BidictBase[KT, VT], MutableBidirectionalMapping[KT, VT]):
|
||||||
|
"""Base class for mutable bidirectional mappings."""
|
||||||
|
|
||||||
|
if t.TYPE_CHECKING:
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inverse(self) -> MutableBidict[VT, KT]: ...
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inv(self) -> MutableBidict[VT, KT]: ...
|
||||||
|
|
||||||
|
def _pop(self, key: KT) -> VT:
|
||||||
|
val = self._fwdm.pop(key)
|
||||||
|
del self._invm[val]
|
||||||
|
return val
|
||||||
|
|
||||||
|
def __delitem__(self, key: KT) -> None:
|
||||||
|
"""*x.__delitem__(y) ⟺ del x[y]*"""
|
||||||
|
self._pop(key)
|
||||||
|
|
||||||
|
def __setitem__(self, key: KT, val: VT) -> None:
|
||||||
|
"""Set the value for *key* to *val*.
|
||||||
|
|
||||||
|
If *key* is already associated with *val*, this is a no-op.
|
||||||
|
|
||||||
|
If *key* is already associated with a different value,
|
||||||
|
the old value will be replaced with *val*,
|
||||||
|
as with dict's :meth:`__setitem__`.
|
||||||
|
|
||||||
|
If *val* is already associated with a different key,
|
||||||
|
an exception is raised
|
||||||
|
to protect against accidental removal of the key
|
||||||
|
that's currently associated with *val*.
|
||||||
|
|
||||||
|
Use :meth:`put` instead if you want to specify different behavior in
|
||||||
|
the case that the provided key or value duplicates an existing one.
|
||||||
|
Or use :meth:`forceput` to unconditionally associate *key* with *val*,
|
||||||
|
replacing any existing items as necessary to preserve uniqueness.
|
||||||
|
|
||||||
|
:raises bidict.ValueDuplicationError: if *val* duplicates that of an
|
||||||
|
existing item.
|
||||||
|
|
||||||
|
:raises bidict.KeyAndValueDuplicationError: if *key* duplicates the key of an
|
||||||
|
existing item and *val* duplicates the value of a different
|
||||||
|
existing item.
|
||||||
|
"""
|
||||||
|
self.put(key, val, on_dup=self.on_dup)
|
||||||
|
|
||||||
|
def put(self, key: KT, val: VT, on_dup: OnDup = ON_DUP_RAISE) -> None:
|
||||||
|
"""Associate *key* with *val*, honoring the :class:`OnDup` given in *on_dup*.
|
||||||
|
|
||||||
|
For example, if *on_dup* is :attr:`~bidict.ON_DUP_RAISE`,
|
||||||
|
then *key* will be associated with *val* if and only if
|
||||||
|
*key* is not already associated with an existing value and
|
||||||
|
*val* is not already associated with an existing key,
|
||||||
|
otherwise an exception will be raised.
|
||||||
|
|
||||||
|
If *key* is already associated with *val*, this is a no-op.
|
||||||
|
|
||||||
|
:raises bidict.KeyDuplicationError: if attempting to insert an item
|
||||||
|
whose key only duplicates an existing item's, and *on_dup.key* is
|
||||||
|
:attr:`~bidict.RAISE`.
|
||||||
|
|
||||||
|
:raises bidict.ValueDuplicationError: if attempting to insert an item
|
||||||
|
whose value only duplicates an existing item's, and *on_dup.val* is
|
||||||
|
:attr:`~bidict.RAISE`.
|
||||||
|
|
||||||
|
:raises bidict.KeyAndValueDuplicationError: if attempting to insert an
|
||||||
|
item whose key duplicates one existing item's, and whose value
|
||||||
|
duplicates another existing item's, and *on_dup.val* is
|
||||||
|
:attr:`~bidict.RAISE`.
|
||||||
|
"""
|
||||||
|
self._update(((key, val),), on_dup=on_dup)
|
||||||
|
|
||||||
|
def forceput(self, key: KT, val: VT) -> None:
|
||||||
|
"""Associate *key* with *val* unconditionally.
|
||||||
|
|
||||||
|
Replace any existing mappings containing key *key* or value *val*
|
||||||
|
as necessary to preserve uniqueness.
|
||||||
|
"""
|
||||||
|
self.put(key, val, on_dup=ON_DUP_DROP_OLD)
|
||||||
|
|
||||||
|
def clear(self) -> None:
|
||||||
|
"""Remove all items."""
|
||||||
|
self._fwdm.clear()
|
||||||
|
self._invm.clear()
|
||||||
|
|
||||||
|
@t.overload
|
||||||
|
def pop(self, key: KT, /) -> VT: ...
|
||||||
|
@t.overload
|
||||||
|
def pop(self, key: KT, default: DT = ..., /) -> VT | DT: ...
|
||||||
|
|
||||||
|
def pop(self, key: KT, default: ODT[DT] = MISSING, /) -> VT | DT:
|
||||||
|
"""*x.pop(k[, d]) → v*
|
||||||
|
|
||||||
|
Remove specified key and return the corresponding value.
|
||||||
|
|
||||||
|
:raises KeyError: if *key* is not found and no *default* is provided.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
return self._pop(key)
|
||||||
|
except KeyError:
|
||||||
|
if default is MISSING:
|
||||||
|
raise
|
||||||
|
return default
|
||||||
|
|
||||||
|
def popitem(self) -> tuple[KT, VT]:
|
||||||
|
"""*x.popitem() → (k, v)*
|
||||||
|
|
||||||
|
Remove and return some item as a (key, value) pair.
|
||||||
|
|
||||||
|
:raises KeyError: if *x* is empty.
|
||||||
|
"""
|
||||||
|
key, val = self._fwdm.popitem()
|
||||||
|
del self._invm[val]
|
||||||
|
return key, val
|
||||||
|
|
||||||
|
def update(self, arg: MapOrItems[KT, VT] = (), /, **kw: VT) -> None:
|
||||||
|
"""Like calling :meth:`putall` with *self.on_dup* passed for *on_dup*."""
|
||||||
|
self._update(arg, kw=kw)
|
||||||
|
|
||||||
|
def forceupdate(self, arg: MapOrItems[KT, VT] = (), /, **kw: VT) -> None:
|
||||||
|
"""Like a bulk :meth:`forceput`."""
|
||||||
|
self._update(arg, kw=kw, on_dup=ON_DUP_DROP_OLD)
|
||||||
|
|
||||||
|
def putall(self, items: MapOrItems[KT, VT], on_dup: OnDup = ON_DUP_RAISE) -> None:
|
||||||
|
"""Like a bulk :meth:`put`.
|
||||||
|
|
||||||
|
If one of the given items causes an exception to be raised,
|
||||||
|
none of the items is inserted.
|
||||||
|
"""
|
||||||
|
self._update(items, on_dup=on_dup)
|
||||||
|
|
||||||
|
# other's type is Mapping rather than Maplike since bidict() |= SupportsKeysAndGetItem({})
|
||||||
|
# raises a TypeError, just like dict() |= SupportsKeysAndGetItem({}) does.
|
||||||
|
def __ior__(self, other: t.Mapping[KT, VT]) -> MutableBidict[KT, VT]:
|
||||||
|
"""Return self|=other."""
|
||||||
|
self.update(other)
|
||||||
|
return self
|
||||||
|
|
||||||
|
|
||||||
|
class bidict(MutableBidict[KT, VT]):
|
||||||
|
"""The main bidirectional mapping type.
|
||||||
|
|
||||||
|
See :ref:`intro:Introduction` and :ref:`basic-usage:Basic Usage`
|
||||||
|
to get started (also available at https://bidict.rtfd.io).
|
||||||
|
"""
|
||||||
|
|
||||||
|
if t.TYPE_CHECKING:
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inverse(self) -> bidict[VT, KT]: ...
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inv(self) -> bidict[VT, KT]: ...
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _frozen.py Current: _bidict.py Next: _orderedbase.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide :class:`OnDup` and related functionality."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
from enum import Enum
|
||||||
|
|
||||||
|
|
||||||
|
class OnDupAction(Enum):
|
||||||
|
"""An action to take to prevent duplication from occurring."""
|
||||||
|
|
||||||
|
#: Raise a :class:`~bidict.DuplicationError`.
|
||||||
|
RAISE = 'RAISE'
|
||||||
|
#: Overwrite existing items with new items.
|
||||||
|
DROP_OLD = 'DROP_OLD'
|
||||||
|
#: Keep existing items and drop new items.
|
||||||
|
DROP_NEW = 'DROP_NEW'
|
||||||
|
|
||||||
|
def __repr__(self) -> str:
|
||||||
|
return f'{self.__class__.__name__}.{self.name}'
|
||||||
|
|
||||||
|
|
||||||
|
RAISE: t.Final[OnDupAction] = OnDupAction.RAISE
|
||||||
|
DROP_OLD: t.Final[OnDupAction] = OnDupAction.DROP_OLD
|
||||||
|
DROP_NEW: t.Final[OnDupAction] = OnDupAction.DROP_NEW
|
||||||
|
|
||||||
|
|
||||||
|
class OnDup(t.NamedTuple):
|
||||||
|
r"""A combination of :class:`~bidict.OnDupAction`\s specifying how to handle various types of duplication.
|
||||||
|
|
||||||
|
The :attr:`~OnDup.key` field specifies what action to take when a duplicate key is encountered.
|
||||||
|
|
||||||
|
The :attr:`~OnDup.val` field specifies what action to take when a duplicate value is encountered.
|
||||||
|
|
||||||
|
In the case of both key and value duplication across two different items,
|
||||||
|
only :attr:`~OnDup.val` is used.
|
||||||
|
|
||||||
|
*See also* :ref:`basic-usage:Values Must Be Unique`
|
||||||
|
(https://bidict.rtfd.io/basic-usage.html#values-must-be-unique)
|
||||||
|
"""
|
||||||
|
|
||||||
|
key: OnDupAction = DROP_OLD
|
||||||
|
val: OnDupAction = RAISE
|
||||||
|
|
||||||
|
|
||||||
|
#: Default :class:`OnDup` used for the
|
||||||
|
#: :meth:`~bidict.bidict.__init__`,
|
||||||
|
#: :meth:`~bidict.bidict.__setitem__`, and
|
||||||
|
#: :meth:`~bidict.bidict.update` methods.
|
||||||
|
ON_DUP_DEFAULT: t.Final[OnDup] = OnDup(key=DROP_OLD, val=RAISE)
|
||||||
|
#: An :class:`OnDup` whose members are all :obj:`RAISE`.
|
||||||
|
ON_DUP_RAISE: t.Final[OnDup] = OnDup(key=RAISE, val=RAISE)
|
||||||
|
#: An :class:`OnDup` whose members are all :obj:`DROP_OLD`.
|
||||||
|
ON_DUP_DROP_OLD: t.Final[OnDup] = OnDup(key=DROP_OLD, val=DROP_OLD)
|
||||||
|
|
@ -0,0 +1,36 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide all bidict exceptions."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
|
||||||
|
class BidictException(Exception):
|
||||||
|
"""Base class for bidict exceptions."""
|
||||||
|
|
||||||
|
|
||||||
|
class DuplicationError(BidictException):
|
||||||
|
"""Base class for exceptions raised when uniqueness is violated
|
||||||
|
as per the :attr:`~bidict.RAISE` :class:`~bidict.OnDupAction`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class KeyDuplicationError(DuplicationError):
|
||||||
|
"""Raised when a given key is not unique."""
|
||||||
|
|
||||||
|
|
||||||
|
class ValueDuplicationError(DuplicationError):
|
||||||
|
"""Raised when a given value is not unique."""
|
||||||
|
|
||||||
|
|
||||||
|
class KeyAndValueDuplicationError(KeyDuplicationError, ValueDuplicationError):
|
||||||
|
"""Raised when a given item's key and value are not unique.
|
||||||
|
|
||||||
|
That is, its key duplicates that of another item,
|
||||||
|
and its value duplicates that of a different other item.
|
||||||
|
"""
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# (see comments in __init__.py)
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _base.py Current: _frozen.py Next: _bidict.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
"""Provide :class:`frozenbidict`, an immutable, hashable bidirectional mapping type."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
|
||||||
|
from ._base import BidictBase
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import VT
|
||||||
|
|
||||||
|
|
||||||
|
class frozenbidict(BidictBase[KT, VT]):
|
||||||
|
"""Immutable, hashable bidict type."""
|
||||||
|
|
||||||
|
_hash: int
|
||||||
|
|
||||||
|
if t.TYPE_CHECKING:
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inverse(self) -> frozenbidict[VT, KT]: ...
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inv(self) -> frozenbidict[VT, KT]: ...
|
||||||
|
|
||||||
|
def __hash__(self) -> int:
|
||||||
|
"""The hash of this bidict as determined by its items."""
|
||||||
|
if getattr(self, '_hash', None) is None:
|
||||||
|
# The following is like hash(frozenset(self.items()))
|
||||||
|
# but more memory efficient. See also: https://bugs.python.org/issue46684
|
||||||
|
self._hash = t.ItemsView(self)._hash()
|
||||||
|
return self._hash
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _base.py Current: _frozen.py Next: _bidict.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
"""Functions for iterating over items in a mapping."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
from operator import itemgetter
|
||||||
|
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import VT
|
||||||
|
from ._typing import ItemsIter
|
||||||
|
from ._typing import Maplike
|
||||||
|
from ._typing import MapOrItems
|
||||||
|
|
||||||
|
|
||||||
|
def iteritems(arg: MapOrItems[KT, VT] = (), /, **kw: VT) -> ItemsIter[KT, VT]:
|
||||||
|
"""Yield the items from *arg* and *kw* in the order given."""
|
||||||
|
if isinstance(arg, t.Mapping):
|
||||||
|
yield from arg.items()
|
||||||
|
elif isinstance(arg, Maplike):
|
||||||
|
yield from ((k, arg[k]) for k in arg.keys())
|
||||||
|
else:
|
||||||
|
yield from arg
|
||||||
|
yield from t.cast(ItemsIter[KT, VT], kw.items())
|
||||||
|
|
||||||
|
|
||||||
|
swap: t.Final = itemgetter(1, 0)
|
||||||
|
|
||||||
|
|
||||||
|
def inverted(arg: MapOrItems[KT, VT]) -> ItemsIter[VT, KT]:
|
||||||
|
"""Yield the inverse items of the provided object.
|
||||||
|
|
||||||
|
If *arg* has a :func:`callable` ``__inverted__`` attribute,
|
||||||
|
return the result of calling it.
|
||||||
|
|
||||||
|
Otherwise, return an iterator over the items in `arg`,
|
||||||
|
inverting each item on the fly.
|
||||||
|
|
||||||
|
*See also* :attr:`bidict.BidirectionalMapping.__inverted__`
|
||||||
|
"""
|
||||||
|
invattr = getattr(arg, '__inverted__', None)
|
||||||
|
if callable(invattr):
|
||||||
|
inv: ItemsIter[VT, KT] = invattr()
|
||||||
|
return inv
|
||||||
|
return map(swap, iteritems(arg))
|
||||||
|
|
@ -0,0 +1,238 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# (see comments in __init__.py)
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _bidict.py Current: _orderedbase.py Next: _orderedbidict.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide :class:`OrderedBidictBase`."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
from weakref import ref as weakref
|
||||||
|
|
||||||
|
from ._base import BidictBase
|
||||||
|
from ._base import Unwrites
|
||||||
|
from ._bidict import bidict
|
||||||
|
from ._iter import iteritems
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import MISSING
|
||||||
|
from ._typing import OKT
|
||||||
|
from ._typing import OVT
|
||||||
|
from ._typing import VT
|
||||||
|
from ._typing import MapOrItems
|
||||||
|
|
||||||
|
|
||||||
|
AT = t.TypeVar('AT') # attr type
|
||||||
|
|
||||||
|
|
||||||
|
class WeakAttr(t.Generic[AT]):
|
||||||
|
"""Descriptor to automatically manage (de)referencing the given slot as a weakref.
|
||||||
|
|
||||||
|
See https://docs.python.org/3/howto/descriptor.html#managed-attributes
|
||||||
|
for an intro to using descriptors like this for managed attributes.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, *, slot: str) -> None:
|
||||||
|
self.slot = slot
|
||||||
|
|
||||||
|
def __set__(self, instance: t.Any, value: AT) -> None:
|
||||||
|
setattr(instance, self.slot, weakref(value))
|
||||||
|
|
||||||
|
def __get__(self, instance: t.Any, __owner: t.Any = None) -> AT:
|
||||||
|
return t.cast(AT, getattr(instance, self.slot)())
|
||||||
|
|
||||||
|
|
||||||
|
class Node:
|
||||||
|
"""A node in a circular doubly-linked list
|
||||||
|
used to encode the order of items in an ordered bidict.
|
||||||
|
|
||||||
|
A weak reference to the previous node is stored
|
||||||
|
to avoid creating strong reference cycles.
|
||||||
|
Referencing/dereferencing the weakref is handled automatically by :class:`WeakAttr`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
prv: WeakAttr[Node] = WeakAttr(slot='_prv_weak')
|
||||||
|
__slots__ = ('__weakref__', '_prv_weak', 'nxt')
|
||||||
|
|
||||||
|
nxt: Node | WeakAttr[Node] # Allow subclasses to use a WeakAttr for nxt too (see SentinelNode)
|
||||||
|
|
||||||
|
def __init__(self, prv: Node, nxt: Node) -> None:
|
||||||
|
self.prv = prv
|
||||||
|
self.nxt = nxt
|
||||||
|
|
||||||
|
def unlink(self) -> None:
|
||||||
|
"""Remove self from in between prv and nxt.
|
||||||
|
Self's references to prv and nxt are retained so it can be relinked (see below).
|
||||||
|
"""
|
||||||
|
self.prv.nxt = self.nxt
|
||||||
|
self.nxt.prv = self.prv
|
||||||
|
|
||||||
|
def relink(self) -> None:
|
||||||
|
"""Restore self between prv and nxt after unlinking (see above)."""
|
||||||
|
self.prv.nxt = self.nxt.prv = self
|
||||||
|
|
||||||
|
|
||||||
|
class SentinelNode(Node):
|
||||||
|
"""Special node in a circular doubly-linked list
|
||||||
|
that links the first node with the last node.
|
||||||
|
When its next and previous references point back to itself
|
||||||
|
it represents an empty list.
|
||||||
|
"""
|
||||||
|
|
||||||
|
nxt: WeakAttr[Node] = WeakAttr(slot='_nxt_weak')
|
||||||
|
__slots__ = ('_nxt_weak',)
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
super().__init__(self, self)
|
||||||
|
|
||||||
|
def iternodes(self, *, reverse: bool = False) -> t.Iterator[Node]:
|
||||||
|
"""Iterator yielding nodes in the requested order."""
|
||||||
|
attr = 'prv' if reverse else 'nxt'
|
||||||
|
node = getattr(self, attr)
|
||||||
|
while node is not self:
|
||||||
|
yield node
|
||||||
|
node = getattr(node, attr)
|
||||||
|
|
||||||
|
def new_last_node(self) -> Node:
|
||||||
|
"""Create and return a new terminal node."""
|
||||||
|
old_last = self.prv
|
||||||
|
new_last = Node(old_last, self)
|
||||||
|
old_last.nxt = self.prv = new_last
|
||||||
|
return new_last
|
||||||
|
|
||||||
|
|
||||||
|
class OrderedBidictBase(BidictBase[KT, VT]):
|
||||||
|
"""Base class implementing an ordered :class:`BidirectionalMapping`."""
|
||||||
|
|
||||||
|
_node_by_korv: bidict[t.Any, Node]
|
||||||
|
_bykey: bool
|
||||||
|
|
||||||
|
def __init__(self, arg: MapOrItems[KT, VT] = (), /, **kw: VT) -> None:
|
||||||
|
"""Make a new ordered bidirectional mapping.
|
||||||
|
The signature behaves like that of :class:`dict`.
|
||||||
|
Items passed in are added in the order they are passed,
|
||||||
|
respecting the :attr:`~bidict.BidictBase.on_dup`
|
||||||
|
class attribute in the process.
|
||||||
|
|
||||||
|
The order in which items are inserted is remembered,
|
||||||
|
similar to :class:`collections.OrderedDict`.
|
||||||
|
"""
|
||||||
|
self._sntl = SentinelNode()
|
||||||
|
self._node_by_korv = bidict()
|
||||||
|
self._bykey = True
|
||||||
|
super().__init__(arg, **kw)
|
||||||
|
|
||||||
|
if t.TYPE_CHECKING:
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inverse(self) -> OrderedBidictBase[VT, KT]: ...
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inv(self) -> OrderedBidictBase[VT, KT]: ...
|
||||||
|
|
||||||
|
def _make_inverse(self) -> OrderedBidictBase[VT, KT]:
|
||||||
|
inv = t.cast(OrderedBidictBase[VT, KT], super()._make_inverse())
|
||||||
|
inv._sntl = self._sntl
|
||||||
|
inv._node_by_korv = self._node_by_korv
|
||||||
|
inv._bykey = not self._bykey
|
||||||
|
return inv
|
||||||
|
|
||||||
|
def _assoc_node(self, node: Node, key: KT, val: VT) -> None:
|
||||||
|
korv = key if self._bykey else val
|
||||||
|
self._node_by_korv.forceput(korv, node)
|
||||||
|
|
||||||
|
def _dissoc_node(self, node: Node) -> None:
|
||||||
|
del self._node_by_korv.inverse[node]
|
||||||
|
node.unlink()
|
||||||
|
|
||||||
|
def _init_from(self, other: MapOrItems[KT, VT]) -> None:
|
||||||
|
"""See :meth:`BidictBase._init_from`."""
|
||||||
|
super()._init_from(other)
|
||||||
|
bykey = self._bykey
|
||||||
|
korv_by_node = self._node_by_korv.inverse
|
||||||
|
korv_by_node.clear()
|
||||||
|
korv_by_node_set = korv_by_node.__setitem__
|
||||||
|
self._sntl.nxt = self._sntl.prv = self._sntl
|
||||||
|
new_node = self._sntl.new_last_node
|
||||||
|
for k, v in iteritems(other):
|
||||||
|
korv_by_node_set(new_node(), k if bykey else v)
|
||||||
|
|
||||||
|
def _write(self, newkey: KT, newval: VT, oldkey: OKT[KT], oldval: OVT[VT], unwrites: Unwrites | None) -> None:
|
||||||
|
"""See :meth:`bidict.BidictBase._spec_write`."""
|
||||||
|
super()._write(newkey, newval, oldkey, oldval, unwrites)
|
||||||
|
assoc, dissoc = self._assoc_node, self._dissoc_node
|
||||||
|
node_by_korv, bykey = self._node_by_korv, self._bykey
|
||||||
|
if oldval is MISSING and oldkey is MISSING: # no key or value duplication
|
||||||
|
# {0: 1, 2: 3} | {4: 5} => {0: 1, 2: 3, 4: 5}
|
||||||
|
newnode = self._sntl.new_last_node()
|
||||||
|
assoc(newnode, newkey, newval)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.append((dissoc, newnode))
|
||||||
|
elif oldval is not MISSING and oldkey is not MISSING: # key and value duplication across two different items
|
||||||
|
# {0: 1, 2: 3} | {0: 3} => {0: 3}
|
||||||
|
# n1, n2 => n1 (collapse n1 and n2 into n1)
|
||||||
|
# oldkey: 2, oldval: 1, oldnode: n2, newkey: 0, newval: 3, newnode: n1
|
||||||
|
if bykey:
|
||||||
|
oldnode = node_by_korv[oldkey]
|
||||||
|
newnode = node_by_korv[newkey]
|
||||||
|
else:
|
||||||
|
oldnode = node_by_korv[newval]
|
||||||
|
newnode = node_by_korv[oldval]
|
||||||
|
dissoc(oldnode)
|
||||||
|
assoc(newnode, newkey, newval)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.extend((
|
||||||
|
(assoc, newnode, newkey, oldval),
|
||||||
|
(assoc, oldnode, oldkey, newval),
|
||||||
|
(oldnode.relink,),
|
||||||
|
))
|
||||||
|
elif oldval is not MISSING: # just key duplication
|
||||||
|
# {0: 1, 2: 3} | {2: 4} => {0: 1, 2: 4}
|
||||||
|
# oldkey: MISSING, oldval: 3, newkey: 2, newval: 4
|
||||||
|
node = node_by_korv[newkey if bykey else oldval]
|
||||||
|
assoc(node, newkey, newval)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.append((assoc, node, newkey, oldval))
|
||||||
|
else:
|
||||||
|
assert oldkey is not MISSING # just value duplication
|
||||||
|
# {0: 1, 2: 3} | {4: 3} => {0: 1, 4: 3}
|
||||||
|
# oldkey: 2, oldval: MISSING, newkey: 4, newval: 3
|
||||||
|
node = node_by_korv[oldkey if bykey else newval]
|
||||||
|
assoc(node, newkey, newval)
|
||||||
|
if unwrites is not None:
|
||||||
|
unwrites.append((assoc, node, oldkey, newval))
|
||||||
|
|
||||||
|
def __iter__(self) -> t.Iterator[KT]:
|
||||||
|
"""Iterator over the contained keys in insertion order."""
|
||||||
|
return self._iter(reverse=False)
|
||||||
|
|
||||||
|
def __reversed__(self) -> t.Iterator[KT]:
|
||||||
|
"""Iterator over the contained keys in reverse insertion order."""
|
||||||
|
return self._iter(reverse=True)
|
||||||
|
|
||||||
|
def _iter(self, *, reverse: bool = False) -> t.Iterator[KT]:
|
||||||
|
nodes = self._sntl.iternodes(reverse=reverse)
|
||||||
|
korv_by_node = self._node_by_korv.inverse
|
||||||
|
if self._bykey:
|
||||||
|
for node in nodes:
|
||||||
|
yield korv_by_node[node]
|
||||||
|
else:
|
||||||
|
key_by_val = self._invm
|
||||||
|
for node in nodes:
|
||||||
|
val = korv_by_node[node]
|
||||||
|
yield key_by_val[val]
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _bidict.py Current: _orderedbase.py Next: _orderedbidict.py →
|
||||||
|
# ============================================================================
|
||||||
|
|
@ -0,0 +1,172 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# (see comments in __init__.py)
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _orderedbase.py Current: _orderedbidict.py <FIN>
|
||||||
|
# ============================================================================
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide :class:`OrderedBidict`."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
from collections.abc import Set
|
||||||
|
|
||||||
|
from ._base import BidictKeysView
|
||||||
|
from ._bidict import MutableBidict
|
||||||
|
from ._orderedbase import OrderedBidictBase
|
||||||
|
from ._typing import KT
|
||||||
|
from ._typing import VT
|
||||||
|
|
||||||
|
|
||||||
|
class OrderedBidict(OrderedBidictBase[KT, VT], MutableBidict[KT, VT]):
|
||||||
|
"""Mutable bidict type that maintains items in insertion order."""
|
||||||
|
|
||||||
|
if t.TYPE_CHECKING:
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inverse(self) -> OrderedBidict[VT, KT]: ...
|
||||||
|
|
||||||
|
@property
|
||||||
|
def inv(self) -> OrderedBidict[VT, KT]: ...
|
||||||
|
|
||||||
|
def clear(self) -> None:
|
||||||
|
"""Remove all items."""
|
||||||
|
super().clear()
|
||||||
|
self._node_by_korv.clear()
|
||||||
|
self._sntl.nxt = self._sntl.prv = self._sntl
|
||||||
|
|
||||||
|
def _pop(self, key: KT) -> VT:
|
||||||
|
val = super()._pop(key)
|
||||||
|
node = self._node_by_korv[key if self._bykey else val]
|
||||||
|
self._dissoc_node(node)
|
||||||
|
return val
|
||||||
|
|
||||||
|
def popitem(self, last: bool = True) -> tuple[KT, VT]:
|
||||||
|
"""*b.popitem() → (k, v)*
|
||||||
|
|
||||||
|
If *last* is true,
|
||||||
|
remove and return the most recently added item as a (key, value) pair.
|
||||||
|
Otherwise, remove and return the least recently added item.
|
||||||
|
|
||||||
|
:raises KeyError: if *b* is empty.
|
||||||
|
"""
|
||||||
|
if not self:
|
||||||
|
raise KeyError('OrderedBidict is empty')
|
||||||
|
node = getattr(self._sntl, 'prv' if last else 'nxt')
|
||||||
|
korv = self._node_by_korv.inverse[node]
|
||||||
|
if self._bykey:
|
||||||
|
return korv, self._pop(korv)
|
||||||
|
return self.inverse._pop(korv), korv
|
||||||
|
|
||||||
|
def move_to_end(self, key: KT, last: bool = True) -> None:
|
||||||
|
"""Move the item with the given key to the end if *last* is true, else to the beginning.
|
||||||
|
|
||||||
|
:raises KeyError: if *key* is missing
|
||||||
|
"""
|
||||||
|
korv = key if self._bykey else self._fwdm[key]
|
||||||
|
node = self._node_by_korv[korv]
|
||||||
|
node.prv.nxt = node.nxt
|
||||||
|
node.nxt.prv = node.prv
|
||||||
|
sntl = self._sntl
|
||||||
|
if last:
|
||||||
|
lastnode = sntl.prv
|
||||||
|
node.prv = lastnode
|
||||||
|
node.nxt = sntl
|
||||||
|
sntl.prv = lastnode.nxt = node
|
||||||
|
else:
|
||||||
|
firstnode = sntl.nxt
|
||||||
|
node.prv = sntl
|
||||||
|
node.nxt = firstnode
|
||||||
|
sntl.nxt = firstnode.prv = node
|
||||||
|
|
||||||
|
# Override the keys() and items() implementations inherited from BidictBase,
|
||||||
|
# which may delegate to the backing _fwdm dict, since this is a mutable ordered bidict,
|
||||||
|
# and therefore the ordering of items can get out of sync with the backing mappings
|
||||||
|
# after mutation. (Need not override values() because it delegates to .inverse.keys().)
|
||||||
|
def keys(self) -> t.KeysView[KT]:
|
||||||
|
"""A set-like object providing a view on the contained keys."""
|
||||||
|
return _OrderedBidictKeysView(self)
|
||||||
|
|
||||||
|
def items(self) -> t.ItemsView[KT, VT]:
|
||||||
|
"""A set-like object providing a view on the contained items."""
|
||||||
|
return _OrderedBidictItemsView(self)
|
||||||
|
|
||||||
|
|
||||||
|
# The following MappingView implementations use the __iter__ implementations
|
||||||
|
# inherited from their superclass counterparts in collections.abc, so they
|
||||||
|
# continue to yield items in the correct order even after an OrderedBidict
|
||||||
|
# is mutated. They also provide a __reversed__ implementation, which is not
|
||||||
|
# provided by the collections.abc superclasses.
|
||||||
|
class _OrderedBidictKeysView(BidictKeysView[KT]):
|
||||||
|
_mapping: OrderedBidict[KT, t.Any]
|
||||||
|
|
||||||
|
def __reversed__(self) -> t.Iterator[KT]:
|
||||||
|
return reversed(self._mapping)
|
||||||
|
|
||||||
|
|
||||||
|
class _OrderedBidictItemsView(t.ItemsView[KT, VT]):
|
||||||
|
_mapping: OrderedBidict[KT, VT]
|
||||||
|
|
||||||
|
def __reversed__(self) -> t.Iterator[tuple[KT, VT]]:
|
||||||
|
ob = self._mapping
|
||||||
|
for key in reversed(ob):
|
||||||
|
yield key, ob[key]
|
||||||
|
|
||||||
|
|
||||||
|
# For better performance, make _OrderedBidictKeysView and _OrderedBidictItemsView delegate
|
||||||
|
# to backing dicts for the methods they inherit from collections.abc.Set. (Cannot delegate
|
||||||
|
# for __iter__ and __reversed__ since they are order-sensitive.) See also: https://bugs.python.org/issue46713
|
||||||
|
_OView = t.Union[t.Type[_OrderedBidictKeysView[KT]], t.Type[_OrderedBidictItemsView[KT, t.Any]]]
|
||||||
|
_setmethodnames: t.Iterable[str] = (
|
||||||
|
'__lt__ __le__ __gt__ __ge__ __eq__ __ne__ __sub__ __rsub__ '
|
||||||
|
'__or__ __ror__ __xor__ __rxor__ __and__ __rand__ isdisjoint'
|
||||||
|
).split()
|
||||||
|
|
||||||
|
|
||||||
|
def _override_set_methods_to_use_backing_dict(cls: _OView[KT], viewname: str) -> None:
|
||||||
|
def make_proxy_method(methodname: str) -> t.Any:
|
||||||
|
def method(self: _OrderedBidictKeysView[KT] | _OrderedBidictItemsView[KT, t.Any], *args: t.Any) -> t.Any:
|
||||||
|
fwdm = self._mapping._fwdm
|
||||||
|
if not isinstance(fwdm, dict): # dict view speedup not available, fall back to Set's implementation.
|
||||||
|
return getattr(Set, methodname)(self, *args)
|
||||||
|
fwdm_dict_view = getattr(fwdm, viewname)()
|
||||||
|
fwdm_dict_view_method = getattr(fwdm_dict_view, methodname)
|
||||||
|
if (
|
||||||
|
len(args) != 1
|
||||||
|
or not isinstance((arg := args[0]), self.__class__)
|
||||||
|
or not isinstance(arg._mapping._fwdm, dict)
|
||||||
|
):
|
||||||
|
return fwdm_dict_view_method(*args)
|
||||||
|
# self and arg are both _OrderedBidictKeysViews or _OrderedBidictItemsViews whose bidicts are backed by
|
||||||
|
# a dict. Use arg's backing dict's corresponding view instead of arg. Otherwise, e.g. `ob1.keys()
|
||||||
|
# < ob2.keys()` would give "TypeError: '<' not supported between instances of '_OrderedBidictKeysView' and
|
||||||
|
# '_OrderedBidictKeysView'", because both `dict_keys(ob1).__lt__(ob2.keys()) is NotImplemented` and
|
||||||
|
# `dict_keys(ob2).__gt__(ob1.keys()) is NotImplemented`.
|
||||||
|
arg_dict = arg._mapping._fwdm
|
||||||
|
arg_dict_view = getattr(arg_dict, viewname)()
|
||||||
|
return fwdm_dict_view_method(arg_dict_view)
|
||||||
|
|
||||||
|
method.__name__ = methodname
|
||||||
|
method.__qualname__ = f'{cls.__qualname__}.{methodname}'
|
||||||
|
return method
|
||||||
|
|
||||||
|
for name in _setmethodnames:
|
||||||
|
setattr(cls, name, make_proxy_method(name))
|
||||||
|
|
||||||
|
|
||||||
|
_override_set_methods_to_use_backing_dict(_OrderedBidictKeysView, 'keys')
|
||||||
|
_override_set_methods_to_use_backing_dict(_OrderedBidictItemsView, 'items')
|
||||||
|
|
||||||
|
|
||||||
|
# * Code review nav *
|
||||||
|
# ============================================================================
|
||||||
|
# ← Prev: _orderedbase.py Current: _orderedbidict.py <FIN>
|
||||||
|
# ============================================================================
|
||||||
|
|
@ -0,0 +1,49 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
|
||||||
|
"""Provide typing-related objects."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import typing as t
|
||||||
|
from enum import Enum
|
||||||
|
|
||||||
|
|
||||||
|
KT = t.TypeVar('KT')
|
||||||
|
VT = t.TypeVar('VT')
|
||||||
|
VT_co = t.TypeVar('VT_co', covariant=True)
|
||||||
|
|
||||||
|
|
||||||
|
Items = t.Iterable[t.Tuple[KT, VT]]
|
||||||
|
|
||||||
|
|
||||||
|
@t.runtime_checkable
|
||||||
|
class Maplike(t.Protocol[KT, VT_co]):
|
||||||
|
"""Like typeshed's SupportsKeysAndGetItem, but usable at runtime."""
|
||||||
|
|
||||||
|
def keys(self) -> t.Iterable[KT]: ...
|
||||||
|
|
||||||
|
def __getitem__(self, __key: KT) -> VT_co: ...
|
||||||
|
|
||||||
|
|
||||||
|
MapOrItems = t.Union[Maplike[KT, VT], Items[KT, VT]]
|
||||||
|
MappOrItems = t.Union[t.Mapping[KT, VT], Items[KT, VT]]
|
||||||
|
ItemsIter = t.Iterator[t.Tuple[KT, VT]]
|
||||||
|
|
||||||
|
|
||||||
|
class MissingT(Enum):
|
||||||
|
"""Sentinel used to represent none/missing when None itself can't be used."""
|
||||||
|
|
||||||
|
MISSING = 'MISSING'
|
||||||
|
|
||||||
|
|
||||||
|
MISSING: t.Final[t.Literal[MissingT.MISSING]] = MissingT.MISSING
|
||||||
|
OKT = t.Union[KT, MissingT] #: optional key type
|
||||||
|
OVT = t.Union[VT, MissingT] #: optional value type
|
||||||
|
|
||||||
|
DT = t.TypeVar('DT') #: for default arguments
|
||||||
|
ODT = t.Union[DT, MissingT] #: optional default arg type
|
||||||
|
|
@ -0,0 +1,14 @@
|
||||||
|
# Copyright 2009-2024 Joshua Bronson. All rights reserved.
|
||||||
|
#
|
||||||
|
# This Source Code Form is subject to the terms of the Mozilla Public
|
||||||
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||||
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||||
|
|
||||||
|
"""Define bidict package metadata."""
|
||||||
|
|
||||||
|
__version__ = '0.23.1'
|
||||||
|
__author__ = {'name': 'Joshua Bronson', 'email': 'jabronson@gmail.com'}
|
||||||
|
__copyright__ = '© 2009-2024 Joshua Bronson'
|
||||||
|
__description__ = 'The bidirectional mapping library for Python.'
|
||||||
|
__license__ = 'MPL 2.0'
|
||||||
|
__url__ = 'https://bidict.readthedocs.io'
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
PEP-561 marker.
|
||||||
|
|
@ -0,0 +1,70 @@
|
||||||
|
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license
|
||||||
|
|
||||||
|
# Copyright (C) 2003-2007, 2009, 2011 Nominum, Inc.
|
||||||
|
#
|
||||||
|
# Permission to use, copy, modify, and distribute this software and its
|
||||||
|
# documentation for any purpose with or without fee is hereby granted,
|
||||||
|
# provided that the above copyright notice and this permission notice
|
||||||
|
# appear in all copies.
|
||||||
|
#
|
||||||
|
# THE SOFTWARE IS PROVIDED "AS IS" AND NOMINUM DISCLAIMS ALL WARRANTIES
|
||||||
|
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL NOMINUM BE LIABLE FOR
|
||||||
|
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
|
||||||
|
# OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
||||||
|
"""dnspython DNS toolkit"""
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"asyncbackend",
|
||||||
|
"asyncquery",
|
||||||
|
"asyncresolver",
|
||||||
|
"dnssec",
|
||||||
|
"dnssecalgs",
|
||||||
|
"dnssectypes",
|
||||||
|
"e164",
|
||||||
|
"edns",
|
||||||
|
"entropy",
|
||||||
|
"exception",
|
||||||
|
"flags",
|
||||||
|
"immutable",
|
||||||
|
"inet",
|
||||||
|
"ipv4",
|
||||||
|
"ipv6",
|
||||||
|
"message",
|
||||||
|
"name",
|
||||||
|
"namedict",
|
||||||
|
"node",
|
||||||
|
"opcode",
|
||||||
|
"query",
|
||||||
|
"quic",
|
||||||
|
"rcode",
|
||||||
|
"rdata",
|
||||||
|
"rdataclass",
|
||||||
|
"rdataset",
|
||||||
|
"rdatatype",
|
||||||
|
"renderer",
|
||||||
|
"resolver",
|
||||||
|
"reversename",
|
||||||
|
"rrset",
|
||||||
|
"serial",
|
||||||
|
"set",
|
||||||
|
"tokenizer",
|
||||||
|
"transaction",
|
||||||
|
"tsig",
|
||||||
|
"tsigkeyring",
|
||||||
|
"ttl",
|
||||||
|
"rdtypes",
|
||||||
|
"update",
|
||||||
|
"version",
|
||||||
|
"versioned",
|
||||||
|
"wire",
|
||||||
|
"xfr",
|
||||||
|
"zone",
|
||||||
|
"zonetypes",
|
||||||
|
"zonefile",
|
||||||
|
]
|
||||||
|
|
||||||
|
from dns.version import version as __version__ # noqa
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,99 @@
|
||||||
|
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license
|
||||||
|
|
||||||
|
# This is a nullcontext for both sync and async. 3.7 has a nullcontext,
|
||||||
|
# but it is only for sync use.
|
||||||
|
|
||||||
|
|
||||||
|
class NullContext:
|
||||||
|
def __init__(self, enter_result=None):
|
||||||
|
self.enter_result = enter_result
|
||||||
|
|
||||||
|
def __enter__(self):
|
||||||
|
return self.enter_result
|
||||||
|
|
||||||
|
def __exit__(self, exc_type, exc_value, traceback):
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def __aenter__(self):
|
||||||
|
return self.enter_result
|
||||||
|
|
||||||
|
async def __aexit__(self, exc_type, exc_value, traceback):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
# These are declared here so backends can import them without creating
|
||||||
|
# circular dependencies with dns.asyncbackend.
|
||||||
|
|
||||||
|
|
||||||
|
class Socket: # pragma: no cover
|
||||||
|
async def close(self):
|
||||||
|
pass
|
||||||
|
|
||||||
|
async def getpeername(self):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def getsockname(self):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def getpeercert(self, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def __aenter__(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
async def __aexit__(self, exc_type, exc_value, traceback):
|
||||||
|
await self.close()
|
||||||
|
|
||||||
|
|
||||||
|
class DatagramSocket(Socket): # pragma: no cover
|
||||||
|
def __init__(self, family: int):
|
||||||
|
self.family = family
|
||||||
|
|
||||||
|
async def sendto(self, what, destination, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def recvfrom(self, size, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
|
||||||
|
class StreamSocket(Socket): # pragma: no cover
|
||||||
|
async def sendall(self, what, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def recv(self, size, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
|
||||||
|
class NullTransport:
|
||||||
|
async def connect_tcp(self, host, port, timeout, local_address):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
|
||||||
|
class Backend: # pragma: no cover
|
||||||
|
def name(self):
|
||||||
|
return "unknown"
|
||||||
|
|
||||||
|
async def make_socket(
|
||||||
|
self,
|
||||||
|
af,
|
||||||
|
socktype,
|
||||||
|
proto=0,
|
||||||
|
source=None,
|
||||||
|
destination=None,
|
||||||
|
timeout=None,
|
||||||
|
ssl_context=None,
|
||||||
|
server_hostname=None,
|
||||||
|
):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
def datagram_connection_required(self):
|
||||||
|
return False
|
||||||
|
|
||||||
|
async def sleep(self, interval):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
def get_transport_class(self):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def wait_for(self, awaitable, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
@ -0,0 +1,275 @@
|
||||||
|
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license
|
||||||
|
|
||||||
|
"""asyncio library query support"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import socket
|
||||||
|
import sys
|
||||||
|
|
||||||
|
import dns._asyncbackend
|
||||||
|
import dns._features
|
||||||
|
import dns.exception
|
||||||
|
import dns.inet
|
||||||
|
|
||||||
|
_is_win32 = sys.platform == "win32"
|
||||||
|
|
||||||
|
|
||||||
|
def _get_running_loop():
|
||||||
|
try:
|
||||||
|
return asyncio.get_running_loop()
|
||||||
|
except AttributeError: # pragma: no cover
|
||||||
|
return asyncio.get_event_loop()
|
||||||
|
|
||||||
|
|
||||||
|
class _DatagramProtocol:
|
||||||
|
def __init__(self):
|
||||||
|
self.transport = None
|
||||||
|
self.recvfrom = None
|
||||||
|
|
||||||
|
def connection_made(self, transport):
|
||||||
|
self.transport = transport
|
||||||
|
|
||||||
|
def datagram_received(self, data, addr):
|
||||||
|
if self.recvfrom and not self.recvfrom.done():
|
||||||
|
self.recvfrom.set_result((data, addr))
|
||||||
|
|
||||||
|
def error_received(self, exc): # pragma: no cover
|
||||||
|
if self.recvfrom and not self.recvfrom.done():
|
||||||
|
self.recvfrom.set_exception(exc)
|
||||||
|
|
||||||
|
def connection_lost(self, exc):
|
||||||
|
if self.recvfrom and not self.recvfrom.done():
|
||||||
|
if exc is None:
|
||||||
|
# EOF we triggered. Is there a better way to do this?
|
||||||
|
try:
|
||||||
|
raise EOFError
|
||||||
|
except EOFError as e:
|
||||||
|
self.recvfrom.set_exception(e)
|
||||||
|
else:
|
||||||
|
self.recvfrom.set_exception(exc)
|
||||||
|
|
||||||
|
def close(self):
|
||||||
|
self.transport.close()
|
||||||
|
|
||||||
|
|
||||||
|
async def _maybe_wait_for(awaitable, timeout):
|
||||||
|
if timeout is not None:
|
||||||
|
try:
|
||||||
|
return await asyncio.wait_for(awaitable, timeout)
|
||||||
|
except asyncio.TimeoutError:
|
||||||
|
raise dns.exception.Timeout(timeout=timeout)
|
||||||
|
else:
|
||||||
|
return await awaitable
|
||||||
|
|
||||||
|
|
||||||
|
class DatagramSocket(dns._asyncbackend.DatagramSocket):
|
||||||
|
def __init__(self, family, transport, protocol):
|
||||||
|
super().__init__(family)
|
||||||
|
self.transport = transport
|
||||||
|
self.protocol = protocol
|
||||||
|
|
||||||
|
async def sendto(self, what, destination, timeout): # pragma: no cover
|
||||||
|
# no timeout for asyncio sendto
|
||||||
|
self.transport.sendto(what, destination)
|
||||||
|
return len(what)
|
||||||
|
|
||||||
|
async def recvfrom(self, size, timeout):
|
||||||
|
# ignore size as there's no way I know to tell protocol about it
|
||||||
|
done = _get_running_loop().create_future()
|
||||||
|
try:
|
||||||
|
assert self.protocol.recvfrom is None
|
||||||
|
self.protocol.recvfrom = done
|
||||||
|
await _maybe_wait_for(done, timeout)
|
||||||
|
return done.result()
|
||||||
|
finally:
|
||||||
|
self.protocol.recvfrom = None
|
||||||
|
|
||||||
|
async def close(self):
|
||||||
|
self.protocol.close()
|
||||||
|
|
||||||
|
async def getpeername(self):
|
||||||
|
return self.transport.get_extra_info("peername")
|
||||||
|
|
||||||
|
async def getsockname(self):
|
||||||
|
return self.transport.get_extra_info("sockname")
|
||||||
|
|
||||||
|
async def getpeercert(self, timeout):
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
|
||||||
|
class StreamSocket(dns._asyncbackend.StreamSocket):
|
||||||
|
def __init__(self, af, reader, writer):
|
||||||
|
self.family = af
|
||||||
|
self.reader = reader
|
||||||
|
self.writer = writer
|
||||||
|
|
||||||
|
async def sendall(self, what, timeout):
|
||||||
|
self.writer.write(what)
|
||||||
|
return await _maybe_wait_for(self.writer.drain(), timeout)
|
||||||
|
|
||||||
|
async def recv(self, size, timeout):
|
||||||
|
return await _maybe_wait_for(self.reader.read(size), timeout)
|
||||||
|
|
||||||
|
async def close(self):
|
||||||
|
self.writer.close()
|
||||||
|
|
||||||
|
async def getpeername(self):
|
||||||
|
return self.writer.get_extra_info("peername")
|
||||||
|
|
||||||
|
async def getsockname(self):
|
||||||
|
return self.writer.get_extra_info("sockname")
|
||||||
|
|
||||||
|
async def getpeercert(self, timeout):
|
||||||
|
return self.writer.get_extra_info("peercert")
|
||||||
|
|
||||||
|
|
||||||
|
if dns._features.have("doh"):
|
||||||
|
import anyio
|
||||||
|
import httpcore
|
||||||
|
import httpcore._backends.anyio
|
||||||
|
import httpx
|
||||||
|
|
||||||
|
_CoreAsyncNetworkBackend = httpcore.AsyncNetworkBackend
|
||||||
|
_CoreAnyIOStream = httpcore._backends.anyio.AnyIOStream
|
||||||
|
|
||||||
|
from dns.query import _compute_times, _expiration_for_this_attempt, _remaining
|
||||||
|
|
||||||
|
class _NetworkBackend(_CoreAsyncNetworkBackend):
|
||||||
|
def __init__(self, resolver, local_port, bootstrap_address, family):
|
||||||
|
super().__init__()
|
||||||
|
self._local_port = local_port
|
||||||
|
self._resolver = resolver
|
||||||
|
self._bootstrap_address = bootstrap_address
|
||||||
|
self._family = family
|
||||||
|
if local_port != 0:
|
||||||
|
raise NotImplementedError(
|
||||||
|
"the asyncio transport for HTTPX cannot set the local port"
|
||||||
|
)
|
||||||
|
|
||||||
|
async def connect_tcp(
|
||||||
|
self, host, port, timeout, local_address, socket_options=None
|
||||||
|
): # pylint: disable=signature-differs
|
||||||
|
addresses = []
|
||||||
|
_, expiration = _compute_times(timeout)
|
||||||
|
if dns.inet.is_address(host):
|
||||||
|
addresses.append(host)
|
||||||
|
elif self._bootstrap_address is not None:
|
||||||
|
addresses.append(self._bootstrap_address)
|
||||||
|
else:
|
||||||
|
timeout = _remaining(expiration)
|
||||||
|
family = self._family
|
||||||
|
if local_address:
|
||||||
|
family = dns.inet.af_for_address(local_address)
|
||||||
|
answers = await self._resolver.resolve_name(
|
||||||
|
host, family=family, lifetime=timeout
|
||||||
|
)
|
||||||
|
addresses = answers.addresses()
|
||||||
|
for address in addresses:
|
||||||
|
try:
|
||||||
|
attempt_expiration = _expiration_for_this_attempt(2.0, expiration)
|
||||||
|
timeout = _remaining(attempt_expiration)
|
||||||
|
with anyio.fail_after(timeout):
|
||||||
|
stream = await anyio.connect_tcp(
|
||||||
|
remote_host=address,
|
||||||
|
remote_port=port,
|
||||||
|
local_host=local_address,
|
||||||
|
)
|
||||||
|
return _CoreAnyIOStream(stream)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
raise httpcore.ConnectError
|
||||||
|
|
||||||
|
async def connect_unix_socket(
|
||||||
|
self, path, timeout, socket_options=None
|
||||||
|
): # pylint: disable=signature-differs
|
||||||
|
raise NotImplementedError
|
||||||
|
|
||||||
|
async def sleep(self, seconds): # pylint: disable=signature-differs
|
||||||
|
await anyio.sleep(seconds)
|
||||||
|
|
||||||
|
class _HTTPTransport(httpx.AsyncHTTPTransport):
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*args,
|
||||||
|
local_port=0,
|
||||||
|
bootstrap_address=None,
|
||||||
|
resolver=None,
|
||||||
|
family=socket.AF_UNSPEC,
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
if resolver is None:
|
||||||
|
# pylint: disable=import-outside-toplevel,redefined-outer-name
|
||||||
|
import dns.asyncresolver
|
||||||
|
|
||||||
|
resolver = dns.asyncresolver.Resolver()
|
||||||
|
super().__init__(*args, **kwargs)
|
||||||
|
self._pool._network_backend = _NetworkBackend(
|
||||||
|
resolver, local_port, bootstrap_address, family
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
_HTTPTransport = dns._asyncbackend.NullTransport # type: ignore
|
||||||
|
|
||||||
|
|
||||||
|
class Backend(dns._asyncbackend.Backend):
|
||||||
|
def name(self):
|
||||||
|
return "asyncio"
|
||||||
|
|
||||||
|
async def make_socket(
|
||||||
|
self,
|
||||||
|
af,
|
||||||
|
socktype,
|
||||||
|
proto=0,
|
||||||
|
source=None,
|
||||||
|
destination=None,
|
||||||
|
timeout=None,
|
||||||
|
ssl_context=None,
|
||||||
|
server_hostname=None,
|
||||||
|
):
|
||||||
|
loop = _get_running_loop()
|
||||||
|
if socktype == socket.SOCK_DGRAM:
|
||||||
|
if _is_win32 and source is None:
|
||||||
|
# Win32 wants explicit binding before recvfrom(). This is the
|
||||||
|
# proper fix for [#637].
|
||||||
|
source = (dns.inet.any_for_af(af), 0)
|
||||||
|
transport, protocol = await loop.create_datagram_endpoint(
|
||||||
|
_DatagramProtocol,
|
||||||
|
source,
|
||||||
|
family=af,
|
||||||
|
proto=proto,
|
||||||
|
remote_addr=destination,
|
||||||
|
)
|
||||||
|
return DatagramSocket(af, transport, protocol)
|
||||||
|
elif socktype == socket.SOCK_STREAM:
|
||||||
|
if destination is None:
|
||||||
|
# This shouldn't happen, but we check to make code analysis software
|
||||||
|
# happier.
|
||||||
|
raise ValueError("destination required for stream sockets")
|
||||||
|
(r, w) = await _maybe_wait_for(
|
||||||
|
asyncio.open_connection(
|
||||||
|
destination[0],
|
||||||
|
destination[1],
|
||||||
|
ssl=ssl_context,
|
||||||
|
family=af,
|
||||||
|
proto=proto,
|
||||||
|
local_addr=source,
|
||||||
|
server_hostname=server_hostname,
|
||||||
|
),
|
||||||
|
timeout,
|
||||||
|
)
|
||||||
|
return StreamSocket(af, r, w)
|
||||||
|
raise NotImplementedError(
|
||||||
|
"unsupported socket " + f"type {socktype}"
|
||||||
|
) # pragma: no cover
|
||||||
|
|
||||||
|
async def sleep(self, interval):
|
||||||
|
await asyncio.sleep(interval)
|
||||||
|
|
||||||
|
def datagram_connection_required(self):
|
||||||
|
return False
|
||||||
|
|
||||||
|
def get_transport_class(self):
|
||||||
|
return _HTTPTransport
|
||||||
|
|
||||||
|
async def wait_for(self, awaitable, timeout):
|
||||||
|
return await _maybe_wait_for(awaitable, timeout)
|
||||||
|
|
@ -0,0 +1,154 @@
|
||||||
|
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license
|
||||||
|
#
|
||||||
|
# Support for Discovery of Designated Resolvers
|
||||||
|
|
||||||
|
import socket
|
||||||
|
import time
|
||||||
|
from urllib.parse import urlparse
|
||||||
|
|
||||||
|
import dns.asyncbackend
|
||||||
|
import dns.inet
|
||||||
|
import dns.name
|
||||||
|
import dns.nameserver
|
||||||
|
import dns.query
|
||||||
|
import dns.rdtypes.svcbbase
|
||||||
|
|
||||||
|
# The special name of the local resolver when using DDR
|
||||||
|
_local_resolver_name = dns.name.from_text("_dns.resolver.arpa")
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# Processing is split up into I/O independent and I/O dependent parts to
|
||||||
|
# make supporting sync and async versions easy.
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
class _SVCBInfo:
|
||||||
|
def __init__(self, bootstrap_address, port, hostname, nameservers):
|
||||||
|
self.bootstrap_address = bootstrap_address
|
||||||
|
self.port = port
|
||||||
|
self.hostname = hostname
|
||||||
|
self.nameservers = nameservers
|
||||||
|
|
||||||
|
def ddr_check_certificate(self, cert):
|
||||||
|
"""Verify that the _SVCBInfo's address is in the cert's subjectAltName (SAN)"""
|
||||||
|
for name, value in cert["subjectAltName"]:
|
||||||
|
if name == "IP Address" and value == self.bootstrap_address:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def make_tls_context(self):
|
||||||
|
ssl = dns.query.ssl
|
||||||
|
ctx = ssl.create_default_context()
|
||||||
|
ctx.minimum_version = ssl.TLSVersion.TLSv1_2
|
||||||
|
return ctx
|
||||||
|
|
||||||
|
def ddr_tls_check_sync(self, lifetime):
|
||||||
|
ctx = self.make_tls_context()
|
||||||
|
expiration = time.time() + lifetime
|
||||||
|
with socket.create_connection(
|
||||||
|
(self.bootstrap_address, self.port), lifetime
|
||||||
|
) as s:
|
||||||
|
with ctx.wrap_socket(s, server_hostname=self.hostname) as ts:
|
||||||
|
ts.settimeout(dns.query._remaining(expiration))
|
||||||
|
ts.do_handshake()
|
||||||
|
cert = ts.getpeercert()
|
||||||
|
return self.ddr_check_certificate(cert)
|
||||||
|
|
||||||
|
async def ddr_tls_check_async(self, lifetime, backend=None):
|
||||||
|
if backend is None:
|
||||||
|
backend = dns.asyncbackend.get_default_backend()
|
||||||
|
ctx = self.make_tls_context()
|
||||||
|
expiration = time.time() + lifetime
|
||||||
|
async with await backend.make_socket(
|
||||||
|
dns.inet.af_for_address(self.bootstrap_address),
|
||||||
|
socket.SOCK_STREAM,
|
||||||
|
0,
|
||||||
|
None,
|
||||||
|
(self.bootstrap_address, self.port),
|
||||||
|
lifetime,
|
||||||
|
ctx,
|
||||||
|
self.hostname,
|
||||||
|
) as ts:
|
||||||
|
cert = await ts.getpeercert(dns.query._remaining(expiration))
|
||||||
|
return self.ddr_check_certificate(cert)
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_nameservers_from_svcb(answer):
|
||||||
|
bootstrap_address = answer.nameserver
|
||||||
|
if not dns.inet.is_address(bootstrap_address):
|
||||||
|
return []
|
||||||
|
infos = []
|
||||||
|
for rr in answer.rrset.processing_order():
|
||||||
|
nameservers = []
|
||||||
|
param = rr.params.get(dns.rdtypes.svcbbase.ParamKey.ALPN)
|
||||||
|
if param is None:
|
||||||
|
continue
|
||||||
|
alpns = set(param.ids)
|
||||||
|
host = rr.target.to_text(omit_final_dot=True)
|
||||||
|
port = None
|
||||||
|
param = rr.params.get(dns.rdtypes.svcbbase.ParamKey.PORT)
|
||||||
|
if param is not None:
|
||||||
|
port = param.port
|
||||||
|
# For now we ignore address hints and address resolution and always use the
|
||||||
|
# bootstrap address
|
||||||
|
if b"h2" in alpns:
|
||||||
|
param = rr.params.get(dns.rdtypes.svcbbase.ParamKey.DOHPATH)
|
||||||
|
if param is None or not param.value.endswith(b"{?dns}"):
|
||||||
|
continue
|
||||||
|
path = param.value[:-6].decode()
|
||||||
|
if not path.startswith("/"):
|
||||||
|
path = "/" + path
|
||||||
|
if port is None:
|
||||||
|
port = 443
|
||||||
|
url = f"https://{host}:{port}{path}"
|
||||||
|
# check the URL
|
||||||
|
try:
|
||||||
|
urlparse(url)
|
||||||
|
nameservers.append(dns.nameserver.DoHNameserver(url, bootstrap_address))
|
||||||
|
except Exception:
|
||||||
|
# continue processing other ALPN types
|
||||||
|
pass
|
||||||
|
if b"dot" in alpns:
|
||||||
|
if port is None:
|
||||||
|
port = 853
|
||||||
|
nameservers.append(
|
||||||
|
dns.nameserver.DoTNameserver(bootstrap_address, port, host)
|
||||||
|
)
|
||||||
|
if b"doq" in alpns:
|
||||||
|
if port is None:
|
||||||
|
port = 853
|
||||||
|
nameservers.append(
|
||||||
|
dns.nameserver.DoQNameserver(bootstrap_address, port, True, host)
|
||||||
|
)
|
||||||
|
if len(nameservers) > 0:
|
||||||
|
infos.append(_SVCBInfo(bootstrap_address, port, host, nameservers))
|
||||||
|
return infos
|
||||||
|
|
||||||
|
|
||||||
|
def _get_nameservers_sync(answer, lifetime):
|
||||||
|
"""Return a list of TLS-validated resolver nameservers extracted from an SVCB
|
||||||
|
answer."""
|
||||||
|
nameservers = []
|
||||||
|
infos = _extract_nameservers_from_svcb(answer)
|
||||||
|
for info in infos:
|
||||||
|
try:
|
||||||
|
if info.ddr_tls_check_sync(lifetime):
|
||||||
|
nameservers.extend(info.nameservers)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return nameservers
|
||||||
|
|
||||||
|
|
||||||
|
async def _get_nameservers_async(answer, lifetime):
|
||||||
|
"""Return a list of TLS-validated resolver nameservers extracted from an SVCB
|
||||||
|
answer."""
|
||||||
|
nameservers = []
|
||||||
|
infos = _extract_nameservers_from_svcb(answer)
|
||||||
|
for info in infos:
|
||||||
|
try:
|
||||||
|
if await info.ddr_tls_check_async(lifetime):
|
||||||
|
nameservers.extend(info.nameservers)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return nameservers
|
||||||
|
|
@ -0,0 +1,92 @@
|
||||||
|
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license
|
||||||
|
|
||||||
|
import importlib.metadata
|
||||||
|
import itertools
|
||||||
|
import string
|
||||||
|
from typing import Dict, List, Tuple
|
||||||
|
|
||||||
|
|
||||||
|
def _tuple_from_text(version: str) -> Tuple:
|
||||||
|
text_parts = version.split(".")
|
||||||
|
int_parts = []
|
||||||
|
for text_part in text_parts:
|
||||||
|
digit_prefix = "".join(
|
||||||
|
itertools.takewhile(lambda x: x in string.digits, text_part)
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
int_parts.append(int(digit_prefix))
|
||||||
|
except Exception:
|
||||||
|
break
|
||||||
|
return tuple(int_parts)
|
||||||
|
|
||||||
|
|
||||||
|
def _version_check(
|
||||||
|
requirement: str,
|
||||||
|
) -> bool:
|
||||||
|
"""Is the requirement fulfilled?
|
||||||
|
|
||||||
|
The requirement must be of the form
|
||||||
|
|
||||||
|
package>=version
|
||||||
|
"""
|
||||||
|
package, minimum = requirement.split(">=")
|
||||||
|
try:
|
||||||
|
version = importlib.metadata.version(package)
|
||||||
|
except Exception:
|
||||||
|
return False
|
||||||
|
t_version = _tuple_from_text(version)
|
||||||
|
t_minimum = _tuple_from_text(minimum)
|
||||||
|
if t_version < t_minimum:
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
_cache: Dict[str, bool] = {}
|
||||||
|
|
||||||
|
|
||||||
|
def have(feature: str) -> bool:
|
||||||
|
"""Is *feature* available?
|
||||||
|
|
||||||
|
This tests if all optional packages needed for the
|
||||||
|
feature are available and recent enough.
|
||||||
|
|
||||||
|
Returns ``True`` if the feature is available,
|
||||||
|
and ``False`` if it is not or if metadata is
|
||||||
|
missing.
|
||||||
|
"""
|
||||||
|
value = _cache.get(feature)
|
||||||
|
if value is not None:
|
||||||
|
return value
|
||||||
|
requirements = _requirements.get(feature)
|
||||||
|
if requirements is None:
|
||||||
|
# we make a cache entry here for consistency not performance
|
||||||
|
_cache[feature] = False
|
||||||
|
return False
|
||||||
|
ok = True
|
||||||
|
for requirement in requirements:
|
||||||
|
if not _version_check(requirement):
|
||||||
|
ok = False
|
||||||
|
break
|
||||||
|
_cache[feature] = ok
|
||||||
|
return ok
|
||||||
|
|
||||||
|
|
||||||
|
def force(feature: str, enabled: bool) -> None:
|
||||||
|
"""Force the status of *feature* to be *enabled*.
|
||||||
|
|
||||||
|
This method is provided as a workaround for any cases
|
||||||
|
where importlib.metadata is ineffective, or for testing.
|
||||||
|
"""
|
||||||
|
_cache[feature] = enabled
|
||||||
|
|
||||||
|
|
||||||
|
_requirements: Dict[str, List[str]] = {
|
||||||
|
### BEGIN generated requirements
|
||||||
|
"dnssec": ["cryptography>=41"],
|
||||||
|
"doh": ["httpcore>=1.0.0", "httpx>=0.26.0", "h2>=4.1.0"],
|
||||||
|
"doq": ["aioquic>=0.9.25"],
|
||||||
|
"idna": ["idna>=3.6"],
|
||||||
|
"trio": ["trio>=0.23"],
|
||||||
|
"wmi": ["wmi>=1.5.1"],
|
||||||
|
### END generated requirements
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
# Copyright (C) Dnspython Contributors, see LICENSE for text of ISC license
|
||||||
|
|
||||||
|
# This implementation of the immutable decorator requires python >=
|
||||||
|
# 3.7, and is significantly more storage efficient when making classes
|
||||||
|
# with slots immutable. It's also faster.
|
||||||
|
|
||||||
|
import contextvars
|
||||||
|
import inspect
|
||||||
|
|
||||||
|
_in__init__ = contextvars.ContextVar("_immutable_in__init__", default=False)
|
||||||
|
|
||||||
|
|
||||||
|
class _Immutable:
|
||||||
|
"""Immutable mixin class"""
|
||||||
|
|
||||||
|
# We set slots to the empty list to say "we don't have any attributes".
|
||||||
|
# We do this so that if we're mixed in with a class with __slots__, we
|
||||||
|
# don't cause a __dict__ to be added which would waste space.
|
||||||
|
|
||||||
|
__slots__ = ()
|
||||||
|
|
||||||
|
def __setattr__(self, name, value):
|
||||||
|
if _in__init__.get() is not self:
|
||||||
|
raise TypeError("object doesn't support attribute assignment")
|
||||||
|
else:
|
||||||
|
super().__setattr__(name, value)
|
||||||
|
|
||||||
|
def __delattr__(self, name):
|
||||||
|
if _in__init__.get() is not self:
|
||||||
|
raise TypeError("object doesn't support attribute assignment")
|
||||||
|
else:
|
||||||
|
super().__delattr__(name)
|
||||||
|
|
||||||
|
|
||||||
|
def _immutable_init(f):
|
||||||
|
def nf(*args, **kwargs):
|
||||||
|
previous = _in__init__.set(args[0])
|
||||||
|
try:
|
||||||
|
# call the actual __init__
|
||||||
|
f(*args, **kwargs)
|
||||||
|
finally:
|
||||||
|
_in__init__.reset(previous)
|
||||||
|
|
||||||
|
nf.__signature__ = inspect.signature(f)
|
||||||
|
return nf
|
||||||
|
|
||||||
|
|
||||||
|
def immutable(cls):
|
||||||
|
if _Immutable in cls.__mro__:
|
||||||
|
# Some ancestor already has the mixin, so just make sure we keep
|
||||||
|
# following the __init__ protocol.
|
||||||
|
cls.__init__ = _immutable_init(cls.__init__)
|
||||||
|
if hasattr(cls, "__setstate__"):
|
||||||
|
cls.__setstate__ = _immutable_init(cls.__setstate__)
|
||||||
|
ncls = cls
|
||||||
|
else:
|
||||||
|
# Mixin the Immutable class and follow the __init__ protocol.
|
||||||
|
class ncls(_Immutable, cls):
|
||||||
|
# We have to do the __slots__ declaration here too!
|
||||||
|
__slots__ = ()
|
||||||
|
|
||||||
|
@_immutable_init
|
||||||
|
def __init__(self, *args, **kwargs):
|
||||||
|
super().__init__(*args, **kwargs)
|
||||||
|
|
||||||
|
if hasattr(cls, "__setstate__"):
|
||||||
|
|
||||||
|
@_immutable_init
|
||||||
|
def __setstate__(self, *args, **kwargs):
|
||||||
|
super().__setstate__(*args, **kwargs)
|
||||||
|
|
||||||
|
# make ncls have the same name and module as cls
|
||||||
|
ncls.__name__ = cls.__name__
|
||||||
|
ncls.__qualname__ = cls.__qualname__
|
||||||
|
ncls.__module__ = cls.__module__
|
||||||
|
return ncls
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue