===========================
SQLAlchemy 2 Stubs (Legacy)
===========================
These are interim PEP-484 typing stubs for the
`SQLAlchemy <https://www.sqlalchemy.org>`_ **1.4 release series only**. They
are released concurrently along with a
`Mypy extension <https://docs.sqlalchemy.org/en/14/orm/extensions/mypy.html>`_
which is designed to work with these stubs, which assists primarily in the area
of ORM mappings.
The stubs replace the use of the "sqlalchemy-stubs" package published by
Dropbox. Differences include that these stubs are generated against 1.4's API
as well as some adjustments to the use of generics. The sqlalchemy2-stubs stubs
package **will not work with SQLAlchemy 2.0, and will need to be explicitly /
manually uninstalled when upgrading to SQLAlchemy 2.0**.
This project should be considered **alpha level** and is not as mature
as the Dropbox stubs for the initial release.
See the Mypy plugin documentation at https://docs.sqlalchemy.org/en/14/orm/extensions/mypy.html
for an overview of how to use PEP-484 annotations with ORM mapped classes.
For SQLAlchemy 2.0, when released, **the sqlalchemy2-stubs project is not
compatible**. SQLAlchemy 2.0 will be / is fully pep-484 typed inline and
will not be compatible with any stubs. There unfortunately appears to be no
standard approach in Python for the problem of a library that upgrades to
include typing annotations inline, as typing tools will still consider
any installed stubs to take precedence. Therefore **sqlalchemy2-stubs
will need to be manually uninstalled when upgrading to SQLAlchemy 2.0**.
Code of Conduct
---------------
Above all, SQLAlchemy places great emphasis on polite, thoughtful, and
constructive communication between users and developers.
Please see our current Code of Conduct at
`Code of Conduct <http://www.sqlalchemy.org/codeofconduct.html>`_.
License
-------
SQLAlchemy is distributed under the `MIT license
<http://www.opensource.org/licenses/mit-license.php>`_.
Raw data
{
"_id": null,
"home_page": "http://www.sqlalchemy.org",
"name": "sqlalchemy2-stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Mike Bayer",
"author_email": "mike_mp@zzzcomputing.com",
"download_url": "https://files.pythonhosted.org/packages/94/df/be9e0062f649fd2e9b9b73a98c250f520fa10beaebddb8948dffad23c3b6/sqlalchemy2-stubs-0.0.2a38.tar.gz",
"platform": null,
"description": "===========================\nSQLAlchemy 2 Stubs (Legacy)\n===========================\n\nThese are interim PEP-484 typing stubs for the\n`SQLAlchemy <https://www.sqlalchemy.org>`_ **1.4 release series only**. They\nare released concurrently along with a\n`Mypy extension <https://docs.sqlalchemy.org/en/14/orm/extensions/mypy.html>`_\nwhich is designed to work with these stubs, which assists primarily in the area\nof ORM mappings.\n\nThe stubs replace the use of the \"sqlalchemy-stubs\" package published by\nDropbox. Differences include that these stubs are generated against 1.4's API\nas well as some adjustments to the use of generics. The sqlalchemy2-stubs stubs\npackage **will not work with SQLAlchemy 2.0, and will need to be explicitly /\nmanually uninstalled when upgrading to SQLAlchemy 2.0**.\n\nThis project should be considered **alpha level** and is not as mature\nas the Dropbox stubs for the initial release.\n\nSee the Mypy plugin documentation at https://docs.sqlalchemy.org/en/14/orm/extensions/mypy.html\nfor an overview of how to use PEP-484 annotations with ORM mapped classes.\n\nFor SQLAlchemy 2.0, when released, **the sqlalchemy2-stubs project is not\ncompatible**. SQLAlchemy 2.0 will be / is fully pep-484 typed inline and\nwill not be compatible with any stubs. There unfortunately appears to be no\nstandard approach in Python for the problem of a library that upgrades to\ninclude typing annotations inline, as typing tools will still consider\nany installed stubs to take precedence. Therefore **sqlalchemy2-stubs\nwill need to be manually uninstalled when upgrading to SQLAlchemy 2.0**.\n\n\nCode of Conduct\n---------------\n\nAbove all, SQLAlchemy places great emphasis on polite, thoughtful, and\nconstructive communication between users and developers.\nPlease see our current Code of Conduct at\n`Code of Conduct <http://www.sqlalchemy.org/codeofconduct.html>`_.\n\nLicense\n-------\n\nSQLAlchemy is distributed under the `MIT license\n<http://www.opensource.org/licenses/mit-license.php>`_.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Typing Stubs for SQLAlchemy 1.4",
"version": "0.0.2a38",
"project_urls": {
"Homepage": "http://www.sqlalchemy.org",
"Issue Tracker": "https://github.com/sqlalchemy/sqlalchemy2-stubs/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eeea6eff437d0a26c894da2982429ed2c148ecaf0526349ddc8cda1e7151c171",
"md5": "ba3f6c7d3330966b83a45619fba26024",
"sha256": "b62aa46943807287550e2033dafe07564b33b6a815fbaa3c144e396f9cc53bcb"
},
"downloads": -1,
"filename": "sqlalchemy2_stubs-0.0.2a38-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba3f6c7d3330966b83a45619fba26024",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 191786,
"upload_time": "2023-12-30T12:15:27",
"upload_time_iso_8601": "2023-12-30T12:15:27.882535Z",
"url": "https://files.pythonhosted.org/packages/ee/ea/6eff437d0a26c894da2982429ed2c148ecaf0526349ddc8cda1e7151c171/sqlalchemy2_stubs-0.0.2a38-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94dfbe9e0062f649fd2e9b9b73a98c250f520fa10beaebddb8948dffad23c3b6",
"md5": "b12072587c4b068418497cc6154716f9",
"sha256": "861d722abeb12f13eacd775a9f09379b11a5a9076f469ccd4099961b95800f9e"
},
"downloads": -1,
"filename": "sqlalchemy2-stubs-0.0.2a38.tar.gz",
"has_sig": false,
"md5_digest": "b12072587c4b068418497cc6154716f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 123950,
"upload_time": "2023-12-30T12:15:29",
"upload_time_iso_8601": "2023-12-30T12:15:29.270824Z",
"url": "https://files.pythonhosted.org/packages/94/df/be9e0062f649fd2e9b9b73a98c250f520fa10beaebddb8948dffad23c3b6/sqlalchemy2-stubs-0.0.2a38.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-30 12:15:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sqlalchemy",
"github_project": "sqlalchemy2-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sqlalchemy2-stubs"
}
JSON
