Skip to main content

Typing Stubs for SQLAlchemy 1.4

Project description

These are interim PEP-484 typing stubs for the SQLAlchemy 1.4 release series only. They are released concurrently along with a Mypy extension 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.

License

SQLAlchemy is distributed under the MIT license.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sqlalchemy2-stubs-0.0.2a20.tar.gz (122.6 kB view details)

Uploaded Source

Built Distribution

sqlalchemy2_stubs-0.0.2a20-py3-none-any.whl (190.4 kB view details)

Uploaded Python 3

File details

Details for the file sqlalchemy2-stubs-0.0.2a20.tar.gz.

File metadata

  • Download URL: sqlalchemy2-stubs-0.0.2a20.tar.gz
  • Upload date:
  • Size: 122.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for sqlalchemy2-stubs-0.0.2a20.tar.gz
Algorithm Hash digest
SHA256 3e96a5bb7d46a368c780ba57dcf2afbe2d3efdd75f7724ae7a859df0b0625f38
MD5 e7888585b14dcc8bcd548eb188f90f05
BLAKE2b-256 18aa0392a5c6b0863a74ca625a37d28672491233080028e40ff410755eb9aaf9

See more details on using hashes here.

File details

Details for the file sqlalchemy2_stubs-0.0.2a20-py3-none-any.whl.

File metadata

  • Download URL: sqlalchemy2_stubs-0.0.2a20-py3-none-any.whl
  • Upload date:
  • Size: 190.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for sqlalchemy2_stubs-0.0.2a20-py3-none-any.whl
Algorithm Hash digest
SHA256 da31d0e30a2af2e5ad83dbce5738543a9f488089774f506de5ec7d28d425a202
MD5 6b1acf50fe00998e531cbe551f63f6be
BLAKE2b-256 0d2577b5c9ab006a7995fd054e4e50f2daccca6d76dea1b50ff19669a02bb284

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page