234ef7ed9d
* Return types for psycopg2 dict connections DB connection and cursor methods that deal with `dict`-style results now indicate the expected return types as implemented. * Return types for psycopg2 namedtuple connections DB connection and cursor methods that deal with `namedtuple` results now indicate the expected return types as implemented. * Use ABC iterator As required by flake8, the `Iterator` referenced in psycopg2's `extras` module has been switched to the `collections.abc.Iterator[T]` variant. * Fix base psycopg2 cursor iter return type The previous return type of `Self` is wrong; `cursor`'s `__iter__` method returns an `Iterator`. * Correct return type for cursor iter and next methods The previous attempt to fix the return type of `cursor`'s (and subclasses) `__iter__` method was misguided; they should indeed return `Self`. It's the `__next__` methods that had to be updated to return the correct record/row instance type. * Comprehensive overloads for psycopg2 extra connections Provides full method signatures for the `cursor` methods of the `DictConnection`, `RealDictConnection` and `NamedTupleConnection` types. Notably this includes a default value for `cursor_factory` in each case, while preserving the option to override the parameter manually. * Have mypy ignore incompatible psycopg2 return types The return types of the `fetch*` and `__next__` methods of `DictCursor`, `RealDictCursor` and `NamedTupleCursor` are incompatible with the base `cursor` class's corresponding methods' return types. However, this does accurately reflect reality, so ignore the mypy errors in those cases. * Use ABC callable for psycopg2 extras module As required by flake8, the `Callable` referenced in psycopg2's `extras` module has been switched to the `Callable` variant. * Remove superfluous psycopg2 member overrides Several members in the `DictCursorBase` type definition were entirely unnecessary, so they have been removed. In addition, adds a type to the `size` param of the `cursor`'s `fetchmany` method.
typeshed
About
Typeshed contains external type annotations for the Python standard library and Python builtins, as well as third party packages as contributed by people external to those projects.
This data can e.g. be used for static analysis, type checking or type inference.
For information on how to use typeshed, read below. Information for
contributors can be found in CONTRIBUTING.md. Please read
it before submitting pull requests; do not report issues with annotations to
the project the stubs are for, but instead report them here to typeshed.
Typeshed supports Python versions 3.7 and up.
Using
If you're just using mypy (or pytype or PyCharm), as opposed to
developing it, you don't need to interact with the typeshed repo at
all: a copy of standard library part of typeshed is bundled with mypy.
And type stubs for third party packages and modules you are using can
be installed from PyPI. For example, if you are using six and requests,
you can install the type stubs using
$ pip install types-six types-requests
These PyPI packages follow PEP 561 and are automatically released (multiple times a day, when needed) by typeshed internal machinery.
Type checkers should be able to use these stub packages when installed. For more details, see the documentation for your type checker.
The _typeshed package
typeshed includes a package _typeshed as part of the standard library.
This package and its submodules contains utility types, but is not
available at runtime. For more information about how to use this package,
see the stdlib/_typeshed directory.
Discussion
If you've run into behavior in the type checker that suggests the type stubs for a given library are incorrect or incomplete, we want to hear from you!
Our main forum for discussion is the project's GitHub issue tracker. This is the right place to start a discussion of any of the above or most any other topic concerning the project.
If you have general questions about typing with Python, or you need a review of your type annotations or stubs outside of typeshed, head over to our discussion forum. For less formal discussion, try the typing chat room on gitter.im. Some typeshed maintainers are almost always present; feel free to find us there and we're happy to chat. Substantive technical discussion will be directed to the issue tracker.