summaryrefslogtreecommitdiffstats
path: root/Doc/library/typing.rst
Commit message (Collapse)AuthorAgeFilesLines
* gh-92417: `typing` docs: `from __future__ import annotations` can be used in ↵Miss Islington (bot)2022-05-081-1/+1
| | | | | | | all supported Python versions (GH-92418) (cherry picked from commit e5b4bd4d60aaf0292c5b9d628512145b8987b3c6) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.9] Improve the typing docs (GH-92264) (#92271)Jelle Zijlstra2022-05-031-12/+12
| | | | | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>. (cherry picked from commit 27e366571590e9e98f61dccf69dbeaa88ee66737) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* typing docs: Add example for async functions (GH-20386)Miss Islington (bot)2022-05-011-0/+4
| | | | | | Fixes python/typingGH-424 (cherry picked from commit 9588f880a286a8cc5597188f6ab44108c8f18761) Co-authored-by: Sam Bull <aa6bs0@sambull.org>
* [3.9] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32375)Ken Jin2022-04-061-1/+1
| | | | | * Use double backticks to appease rstlint * Update susp-ignored.csv
* [3.9] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) ↵Jelle Zijlstra2022-03-231-21/+88
| | | | | | | | | | | | | | | | | | | (GH-31941) (GH-32067) * [3.9] [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) (GH-31941) * [3.10] bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 81b425d4dc43b60dd11a3e9abc5c84a4b8b384db) * Remove references to `reveal_type`, add new section on `self` types. (cherry picked from commit d5ed8a8258eaf7a241978b1b0aeb971108d0f7e0) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> * remove unused susp allowlist Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.9] bpo-46677: Add examples of inheritance and attributes to `TypedDict` ↵Charlie Zhao2022-03-121-12/+106
| | | | | | | | docs. (GH-31349) (GH-31808) * bpo-46677: Add examples of inheritance and attributes to `TypedDict` docs (GH-31349) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> (cherry picked from commit 8a207e0321db75f3342692905e342f1d5e1add54)
* bpo-46494: Mention the typing_extensions pkg in typing docs (GH-31260)Miss Islington (bot)2022-03-081-0/+4
| | | | | (cherry picked from commit 8debeed3075bf4d7e568e65da16bec63cf276f4f) Co-authored-by: Meer Suri <46469858+meersuri@users.noreply.github.com>
* [3.9] bpo-46104: Fix example broken by GH-30148 (GH-30203) (GH-30210)Miss Islington (bot)2021-12-201-1/+1
| | | | | | | | | See discussion in GH-30179. (cherry picked from commit 7c5c3f7254d78babcaf7a2ec187fd6ec53b8403c) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Automerge-Triggered-By: GH:Fidget-Spinner
* [3.9] bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH-30148) ↵Miss Islington (bot)2021-12-181-9/+8
| | | | | | | | | (GH-30180) Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com> (cherry picked from commit 6ada013df170b0afb6b61a0d942388c6fd81cbc9) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.9] [doc] bpo-45680: Disambiguate ``__getitem__`` and ↵Miss Islington (bot)2021-11-181-0/+1
| | | | | | | | | | | | | | | | | ``__class_getitem__`` in the data model (GH-29389) (GH-29619) The documentation explaining Python's data model does not adequately explain the differences between ``__getitem__`` and ``__class_getitem__``, nor does it explain when each is called. There is an attempt at explaining ``__class_getitem__`` in the documentation for ``GenericAlias`` objects, but this does not give sufficient clarity into how the method works. Moreover, it is the wrong place for that information to be found; the explanation of ``__class_getitem__`` should be in the documentation explaining the data model. This PR has been split off from GH-29335. (cherry picked from commit 31b3a70edb1216bdc8fab3b2eafd8ddb00487f41) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* Remove reference to ``Tuple`` at top of ``typing`` docs (GH-29401)Miss Islington (bot)2021-11-041-4/+3
| | | | | | ``typing.Tuple`` has been deprecated since Python 3.9, so it makes no sense to mention it so prominently in the documentation for the ``typing`` module. (cherry picked from commit 87032cfa3dc975d7442fd57dea2c6a56d31c911a) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* bpo-45680: ``typing`` docs: improve links to docs on ↵Miss Islington (bot)2021-11-041-4/+4
| | | | | | | ``GenericAlias``/``__class_getitem__`` (GH-29387) (cherry picked from commit e03e50377d6f8f212af60fed4ae405ebeb73237d) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.9] bpo-45655: Add "relevant PEPs" section to typing documentation (GH-29297)Alex Waygood2021-10-281-6/+32
| | | | Backport of https://github.com/python/cpython/pull/29280 to the 3.9 branch.
* bpo-38291: Remove mention of typing.io and typing.re again (GH-26113)Miss Islington (bot)2021-06-141-2/+10
| | | | | | | They were originally removed in GH-10173 per bpo-35089, but then readded in GH-21574. Cf. bpo-38291 for decision to remove. (cherry picked from commit 8a76683cfb842e12b57f6d276839f6c68fd94e1a) Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
* [3.9] bpo-44001: improve Literal documentation (GH-25877). (#25897)Jelle Zijlstra2021-05-041-2/+2
| | | | | (cherry picked from commit 87109f4d85c93a870ee8aa0d2b394547d4636b17) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.9] bpo-41370: Add note about ForwardRefs and PEP585 generic types in docs ↵Miss Islington (bot)2021-04-041-2/+7
| | | | | | | | | | (GH-25183) (GH-25184) (cherry picked from commit 2b5913b4ee5852a28ca1509478f5582beb3aff7b) Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> Automerge-Triggered-By: GH:gvanrossum
* bpo-41824: Add versionadded for typing.ForwardRef docs (#24224) (#24493)Ken Jin2021-02-091-0/+2
|
* Doc: fix typo in typing.Type docs (GH-23460)Miss Islington (bot)2020-11-221-1/+1
| | | | | (cherry picked from commit 5ef53a88f3130cfcf9a9be3abd2ff2f997902647) Co-authored-by: John Belmonte <john@neggie.net>
* bpo-42345: Add whatsnew and versionchanged for typing.Literal in 3.9 (GH-23386)Miss Islington (bot)2020-11-191-0/+6
| | | | | | | | | * Whatsnew entry in 3.9 same as the one in 3.10. * versionchanged for typing.Literal docs Needs backport to 3.9. (cherry picked from commit e1dc0db8c7cb8c4d7343e051ba85146b375bb8e0) Co-authored-by: kj <28750310+Fidget-Spinner@users.noreply.github.com>
* bpo-42345: Fix hash implementation of typing.Literal (GH-23383)Miss Islington (bot)2020-11-191-3/+3
| | | | | | | | | | Fix hash implementation of `typing.Literal`. Update docs regarding `typing.Litaral` caching. Base implementation was done in PR GH-23294. (cherry picked from commit 1b54077ff6f5c1379e097e9f8e8648da9826d6ec) Co-authored-by: Yurii Karabas <1998uriyyo@gmail.com>
* bpo-42317: Improve docs of typing.get_args concerning Union (GH-23254)Miss Islington (bot)2020-11-161-0/+3
| | | | | (cherry picked from commit c3b9592244a9112d8af9610ff1c4e1e4cd4bfaca) Co-authored-by: Dominik1123 <15989985+Dominik1123@users.noreply.github.com>
* bpo-42198: Link to GenericAlias in typing and expressions (GH-23030)Miss Skeleton (bot)2020-10-301-37/+74
| | | | | | Follow up to 7cdf30fff39ea97f403b5472096349998d190e30 and 4173320920706b49a004bdddd8d7108e8984e3fc. This addresses the point "1. Update links in typing, subscription and union to point to GenericAlias." in the bpo for this PR. (cherry picked from commit 9129af6050b747f288baa9d4e7d43031647ed222) Co-authored-by: kj <28750310+Fidget-Spinner@users.noreply.github.com>
* [doc] Add link to Generic in typing (GH-22125)Miss Skeleton (bot)2020-10-191-1/+1
| | | | | | (cherry picked from commit 5bfd60fc2bf26bd6fa23a3a50c7990b7f68b3ea3) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* Fix typo in "Context manager types" section in typing.rst (GH-22676)Miss Skeleton (bot)2020-10-121-2/+2
| | | | | | | | Fix typo in the "Context manager types" section in `typing.rst`. Automerge-Triggered-By: @gvanrossum (cherry picked from commit ba06a70c822ede62688136add488eb78957689fe) Co-authored-by: Saiyang Gou <gousaiyang@163.com>
* Fix typo in typing.rst (GH-22625)Miss Skeleton (bot)2020-10-111-1/+1
| | | | | (cherry picked from commit 0ff8a3b374286d2218fc18f47556a5ace202dad3) Co-authored-by: abdo <abd.nh25@gmail.com>
* [doc] Use list[int] instead of List[int] (etc.) in a few more places (GH-22524)Miss Skeleton (bot)2020-10-031-6/+6
| | | | | | | | This changes a few occurrences left behind by GH-22340. Automerge-Triggered-By: @gvanrossum (cherry picked from commit 7f54e563dc150cd670ca8df678437455c3a7f2cd) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [doc] Fix link to abc.collections.Iterable (GH-22520)Miss Skeleton (bot)2020-10-031-2/+2
| | | | | | | | Missed this occurrence before, sorry. Also changed "the PEP" to "PEP". Automerge-Triggered-By: @gvanrossum (cherry picked from commit 3fe614893742faee3c64e6d974e11329a496424f) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [doc] Fix link to abc.collections.Iterable (GH-22502)Miss Skeleton (bot)2020-10-021-1/+1
| | | | | | Automerge-Triggered-By: @gvanrossum (cherry picked from commit d4b9edd5052a2d9ae3d2be69975cc933afb37737) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [doc] Leverage the fact that the actual types can now be indexed for typing ↵Miss Islington (bot)2020-09-271-23/+26
| | | | | | | | | | | | | | (GH-22340) This shows users that they can use the actual types. Using deprecated types is confusing. This also prefers colections.abc.Sized instead of the alias typing.Sized. I guess the aliases were created to make it convenient to import all collections related types from the same place. This should be backported to 3.9. Automerge-Triggered-By: @gvanrossum (cherry picked from commit d9ab95ff1fe81efdf70e545d536d9f6927d1ba81) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [3.9] [doc] Fix padding in some typing definitions (GH-22114) (GH-22115)Miss Islington (bot)2020-09-061-12/+12
| | | | | | | Automerge-Triggered-By: @gvanrossum (cherry picked from commit 2623868ede4ef3c848fc83a9b1e19e0d031dee1d) Co-authored-by: Andre Delfino <adelfino@gmail.com>
* [3.9] bpo-41624: fix documentation of typing.Coroutine (GH-21952) (#21982)Karthikeyan Singaravelan2020-08-281-1/+1
| | | | | | | (cherry picked from commit 8c58d2a) Co-authored-by: MingZhe Hu <humingzhework@163.com> Co-authored-by: MingZhe Hu <humingzhework@163.com>
* Fix typo in typing doc (GH-21879)Miss Islington (bot)2020-08-141-1/+1
| | | | | | Automerge-Triggered-By: @gvanrossum (cherry picked from commit fa5d7251987c70a9c5d58b59a0b36ac9287eaafa) Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
* [3.9] bpo-40979: refactored typing.rst; (mostly) same content, new ↵Guido van Rossum2020-08-121-614/+823
| | | | | | | | | sub-sections and ordering (GH-21574) (#21843) Also added PEP 585 deprecation notes. (cherry picked from commit ab72fdeb82) Co-authored-by: Luciano Ramalho <luciano@ramalho.org>
* bpo-33864: Clarify the docs for typing.ByteString (GH-21311)Miss Islington (bot)2020-07-041-1/+1
| | | | | (cherry picked from commit b40e434386cd94a367d4a256e3364771140160e7) Co-authored-by: Zackery Spytz <zspytz@gmail.com>
* bpo-40745: Fix typos in NewType docs (GH-20379)Miss Islington (bot)2020-05-261-2/+2
| | | | | (cherry picked from commit 2b0e654f91f28379c6c7ef5fd80e8754afb70935) Co-authored-by: ziheng <zihenglv@gmail.com>
* bpo-40182: Remove the _field_types attribute of the NamedTuple class (GH-19368)Serhiy Storchaka2020-04-041-4/+5
|
* Add a missing space after a period in 'typing.TypedDict' documentation ↵Miss Islington (bot)2020-03-051-1/+1
| | | | (GH-18784)
* bpo-39572: Document ’total’ flag of TypedDict (GH-18554)ananthan-1232020-02-191-2/+14
|
* bpo-39491: Merge PEP 593 (typing.Annotated) support (#18260)Jakub Stasiak2020-02-051-1/+101
| | | | | | | | | | | | | | | | | | | | | | | | | * bpo-39491: Merge PEP 593 (typing.Annotated) support PEP 593 has been accepted some time ago. I got a green light for merging this from Till, so I went ahead and combined the code contributed to typing_extensions[1] and the documentation from the PEP 593 text[2]. My changes were limited to: * removing code designed for typing_extensions to run on older Python versions * removing some irrelevant parts of the PEP text when copying it over as documentation and otherwise changing few small bits to better serve the purpose * changing the get_type_hints signature to match reality (parameter names) I wasn't entirely sure how to go about crediting the authors but I used my best judgment, let me know if something needs changing in this regard. [1] https://github.com/python/typing/blob/8280de241fd8c8afe727c7860254b753e383b360/typing_extensions/src_py3/typing_extensions.py [2] https://github.com/python/peps/blob/17710b879882454d55f82c2d44596e8e9f8e4bff/pep-0593.rst
* bpo-38467: Fix argument name of typing functions (GH-16753)Sebastian Rittau2019-10-131-2/+2
|
* bpo-28556: Remove another mention of metaclass of Generic in typing docs ↵Ivan Levkivskyi2019-10-131-2/+2
| | | | | | | | (GH-16743) Metaclass was removed in Python 3.7 (there is already a `versionchanged` item about this). https://bugs.python.org/issue28556
* bpo-32996: Documentation fix-up. (GH-16646)M. Eric Irrgang2019-10-101-3/+4
| | | | | | | PR #4906 changed the typing.Generic class hierarchy, leaving an outdated comment in the library reference. User-defined Generic ABCs now must get a abc.ABCMeta metaclass from something other than typing.Generic inheritance.
* bpo-28556: Update the opening note in typing docs (GH-16204)Ivan Levkivskyi2019-09-161-4/+3
| | | | This PR replaces the old note mentioning that `typing` is a provisional module with a new one mentioning types are not enforced at runtime. I am not sure if there was any official announcement about making `typing` non-provisional, but _de-facto_ no new features were added during Python 3.7, and no backwards incompatible changes were made except for few small things that were considered bugs.
* bpo-37814: Document the empty tuple type annotation syntax (GH-15208)Josh Holland2019-08-131-1/+2
| | | | | | | | https://bugs.python.org/issue37814: > The empty tuple syntax in type annotations, `Tuple[()]`, is not obvious from the examples given in the documentation (I naively expected `Tuple[]` to work); it has been documented in PEP 484 and in mypy, but not in the documentation for the typing module. https://bugs.python.org/issue37814
* Document typing.ForwardRef (GH-14216)Ivan Levkivskyi2019-06-191-0/+7
|
* Improve version added references in `typing` module docs (GH-13457)Anthony Sottile2019-06-021-4/+18
|
* bpo-29262: Add get_origin() and get_args() introspection helpers to typing ↵Ivan Levkivskyi2019-05-301-0/+19
| | | | | | | | | | (GH-13685) This is an old feature request that appears from time to time. After a year of experimenting with various introspection capabilities in `typing_inspect` on PyPI, I propose to add these two most commonly used functions: `get_origin()` and `get_args()`. These are essentially thin public wrappers around private APIs: `__origin__` and `__args__`. As discussed in the issue and on the typing tracker, exposing some public helpers instead of `__origin__` and `__args__` directly will give us more flexibility if we will decide to update the internal representation, while still maintaining backwards compatibility. The implementation is very simple an is essentially a copy from `typing_inspect` with one exception: `ClassVar` was special-cased in `typing_inspect`, but I think this special-casing doesn't really help and only makes things more complicated.
* bpo-37058: PEP 544: Add Protocol to typing module (GH-13585)Ivan Levkivskyi2019-05-281-1/+97
| | | | | I tried to get rid of the `_ProtocolMeta`, but unfortunately it didn'y work. My idea to return a generic alias from `@runtime_checkable` made runtime protocols unpickleable. I am not sure what is worse (a custom metaclass or having some classes unpickleable), so I decided to stick with the status quo (since there were no complains so far). So essentially this is a copy of the implementation in `typing_extensions` with two modifications: * Rename `@runtime` to `@runtime_checkable` (plus corresponding updates). * Allow protocols that extend `collections.abc.Iterable` etc.
* bpo-37049: PEP 589: Add TypedDict to typing module (GH-13573)Ivan Levkivskyi2019-05-261-0/+33
| | | | The implementation is straightforward and essentially is just copied from `typing_extensions`.
* bpo-37046: PEP 586: Add Literal to typing module (#13572)Ivan Levkivskyi2019-05-261-0/+22
| | | | The implementation is straightforward and essentially is just copied from `typing_extensions`.
generated by cgit v0.12 at 2025-09-15 17:30:47 (GMT)