Alex Waygood
67e52e54bb
[3.10] gh-100673: Removed erroneous note in the get_type_hints docs ( #100701 ) (GH-100826)
...
Removed erroneous note in the get_type_hints docs
typing.get_type_hints still includes base class type hints.
(cherry picked from commit deaf090699
2023-01-07 12:55:41 -08:00
Jelle Zijlstra
1ffc67265f
[3.10] gh-99535: Add test for inheritance of annotations and update documentation (GH-99990) ( #100509 )
...
(cherry picked from commit f5b7b19bf1
2022-12-26 20:44:53 -08:00
Jelle Zijlstra
e07086db03
[3.10] gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958) ( #98986 )
...
[3.10] gh-92871: Postpone the removal of typing.{io,re} to 3.13 (GH-98958).
(cherry picked from commit 65d1407737
2022-11-02 09:12:37 +00:00
Miss Islington (bot)
3e335f2c0d
gh-98623: Fix base classes in typing.rst (GH-98626)
...
(cherry picked from commit 5076108872
2022-10-25 07:15:07 -07:00
Miss Islington (bot)
d79a42aac8
gh-98507: [typing docs] Rephrase "now supports []" to "now supports subscripting" (GH-98508)
...
(cherry picked from commit e3b9dd8e87
2022-10-24 11:17:33 -07:00
Miss Islington (bot)
e69509f468
gh-98500: Fix typing docs for *View classes (GH-98511)
...
(cherry picked from commit 1a217f9ffc
2022-10-24 10:54:35 -07:00
Miss Islington (bot)
f3c23fc48c
gh-98561: Fix a typo in typing (GH-98562)
...
(cherry picked from commit b6d5d5b60a
2022-10-23 07:11:29 -07:00
Jelle Zijlstra
8a1f1cbe1a
[3.10] docs(typing): harmonize "See PEP x for more details" (GH-97927). ( #98293 )
...
(cherry picked from commit 02389658a4
2022-10-15 21:08:46 -07:00
Miss Islington (bot)
48447d44ed
gh-96130: Rephrase use of "typecheck" verb for clarity (GH-98144)
...
I'm sympathetic to the issue report, especially in case this helps
clarify to new users that Python itself does not do type checking at runtime
(cherry picked from commit ed6344eed0
2022-10-11 19:48:39 -07:00
Shantanu
7b6021b060
[3.10] gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921) (GH-96937)
...
See the discussion at https://github.com/python/cpython/issues/91533 .
(cherry picked from commit 5b3a2569f4
2022-09-20 18:15:48 +08:00
Miss Islington (bot)
a372a7d653
gh-94439: typing docs: Add minimum version to __required_keys__ and __optional_keys__ (GH-95373)
...
(cherry picked from commit f235178bec
2022-08-12 21:31:51 -07:00
Guy Yagev
860aefaeca
gh-92743: Remove copyright sign next to "Raymond Hettinger" ( #94665 )
...
Closes GH-92743
2022-07-07 14:31:39 -07:00
Miss Islington (bot)
80ce70110b
gh-92417: typing docs: from __future__ import annotations can be used in all supported Python versions (GH-92418)
...
(cherry picked from commit e5b4bd4d60
2022-05-08 08:04:18 -07:00
Jelle Zijlstra
31d9a88ca8
[3.10] Improve the typing docs (GH-92264) ( #92270 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 27e3665715
2022-05-03 16:41:39 -06:00
Miss Islington (bot)
e7de543219
typing docs: Add example for async functions (GH-20386)
...
Fixes python/typingGH-424
(cherry picked from commit 9588f880a2
2022-04-30 21:55:58 -07:00
Ken Jin
80af26d25a
[3.10] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32374)
...
* Use double backticks to appease rstlint
* Update susp-ignored.csv
2022-04-07 02:00:26 +08:00
Alex Waygood
d5ed8a8258
[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 81b425d4dc
2022-03-22 19:52:40 -07:00
Charlie Zhao
28f20a6613
[3.10] bpo-46677: Add examples of inheritance and attributes to TypedDict docs (GH-31349) (GH-31815)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 8a207e0321
2022-03-11 17:03:52 -08:00
Miss Islington (bot)
e053f0e9f4
bpo-46494: Mention the typing_extensions pkg in typing docs (GH-31260)
...
(cherry picked from commit 8debeed307
2022-03-07 20:25:30 -08:00
Miss Islington (bot)
da8c0759d2
Remove unused Any from Concatenate example in typing docs (GH-30516)
...
(cherry picked from commit 73decdf021
2022-01-11 06:21:40 -08:00
Miss Islington (bot)
ed1671ced7
[3.10] bpo-46120: State that | is preferred over Union (GH-30222) (GH-30250)
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
(cherry picked from commit 1b30660c3b
2021-12-29 03:45:14 -08:00
Miss Islington (bot)
0c0bd78ccf
[3.10] bpo-46104: Fix example broken by GH-30148 (GH-30203) (GH-30209)
...
See discussion in GH-30179.
(cherry picked from commit 7c5c3f7254
2021-12-19 22:01:51 -08:00
Miss Islington (bot)
a66be9185c
[3.10] bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH-30148) (GH-30179)
...
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
(cherry picked from commit 6ada013df1
2021-12-18 04:14:25 -08:00
Miss Islington (bot)
fde9f61e70
[3.10] [doc] bpo-45680: Disambiguate `__getitem__ and __class_getitem__` in the data model (GH-29389) (GH-29620)
...
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 31b3a70edb
2021-11-18 18:34:08 +01:00
Miss Islington (bot)
75ed2ce9e8
Remove reference to `Tuple at top of typing` docs (GH-29401)
...
``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 87032cfa3d
2021-11-04 05:11:14 -07:00
Miss Islington (bot)
c10896696f
bpo-45680: `typing docs: improve links to docs on GenericAlias/__class_getitem__` (GH-29387)
...
(cherry picked from commit e03e50377d
2021-11-03 21:27:47 -07:00
Miss Islington (bot)
6742b0dfb6
bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)
...
(cherry picked from commit d9575218d7
2021-10-29 07:16:19 -07:00
Alex Waygood
2c8a0027e5
[3.10] bo-45655: Add "relevant PEPs" section to typing documentation (GH-29302)
...
The list of PEPs at the top of the documentation for the ``typing`` module has
become too long to be readable. This PR proposes presenting this
information in a more structured and readable way by adding a new "relevant
PEPs" section to the ``typing`` docs.
(cherry picked from commit 03db1bbfd2
2021-10-29 18:03:48 +08:00
Miss Islington (bot)
0d0312e1ac
Add PEPs 593 & 647 to list of PEPs at top of typing docs (GH-29097)
...
(cherry picked from commit d9e1dae35a
2021-10-20 08:36:34 -07:00
Miss Islington (bot)
1d0c559614
bpo-44925: [docs] Fix confusing deprecation notice for typing.IO (GH-28004)
...
(cherry picked from commit edae42f99f
2021-08-31 03:07:49 -07:00
Miss Islington (bot)
57b321c377
Move susp-ignored locations
2021-08-22 13:04:43 -07:00
Miss Islington (bot)
9ffe582a01
bpo-44926: get_type_hints: Add note about type aliases with forward refs (GH-27859) (GH-27860)
...
(cherry picked from commit 16b9be4861
2021-08-22 20:29:59 +02:00
Miss Islington (bot)
6ca35f2891
Doc: Change errant 3.10.0 to 3.10, to match other mentions (GH-27459) (GH-27479)
...
(cherry picked from commit f4367ba3c5
2021-07-30 16:16:46 +02:00
Miss Islington (bot)
d15949a845
bpo-44353: Document that typing.NewType is now a class (GH-27319) (GH-27321)
...
(cherry picked from commit 7aac3f6236
2021-07-24 11:31:33 +02:00
Miss Islington (bot)
846cc4d280
bpo-43453: Update and re-add example to typing runtime_checkable (GH-27013)
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 17f94e2888
2021-07-05 13:46:02 -07:00
Miss Islington (bot)
fc310cb862
bpo-38291: Remove mention of typing.io and typing.re again (GH-26113)
...
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 8a76683cfb
2021-06-14 08:06:33 -07:00
Miss Islington (bot)
2046fb35e4
bpo-44001: improve Literal documentation (GH-25877) ( #25882 )
...
(cherry picked from commit 87109f4d85
2021-05-04 11:17:35 +02:00
Ken Jin
99fdd78200
bpo-43766: Fix TypeGuard docs ( #25660 )
2021-04-27 08:55:08 -07:00
Ken Jin
05ab4b60ab
bpo-43766: Implement PEP 647 (User-Defined Type Guards) in typing.py ( #25282 )
2021-04-27 07:31:04 -07:00
Jelle Zijlstra
522433601a
bpo-43783: Add ParamSpecArgs/Kwargs (GH-25298)
2021-04-10 19:57:05 -07:00
DevilXD
ac05f82ad4
bpo-41974: Remove part of the note regarding complex.__float__ (GH-25197)
...
(The deleted example no longer works and is thus irrelevant.)
2021-04-10 15:36:40 -07:00
Ken Jin
2b5913b4ee
bpo-41370: Add note about ForwardRefs and PEP585 generic types in docs ( #25183 )
2021-04-04 08:14:44 -07:00
Paul Bryan
1e3c68246e
bpo-43345: Enhance TypedDict documentation. ( #24668 )
2021-02-27 23:02:14 -08:00
Ken Jin
da21f7b6e1
bpo-41824: Add versionadded for typing.ForwardRef docs ( #24224 )
2021-02-08 17:58:50 -08:00
Ken Jin
ace008c531
Fix various ParamSpec errors in typing (GH-24176)
...
1. ParamSpec -> TypeVar for ``typing.Concatenate``
2. ParamSpec's call signature should align with its documentation.
Noticed in GH-24169
2021-01-10 16:11:41 -08:00
Johan Dahlin
68e1f259be
Fix a typo in docs for typing.Concatenate ( #24169 )
...
Return param spec should be R, not T
2021-01-08 10:08:21 -08:00
Ken Jin
11276cd9c4
bpo-41559: Documentation for PEP 612 (GH-24000)
2021-01-01 16:45:50 -08:00
John Belmonte
5ef53a88f3
Doc: fix typo in typing.Type docs (GH-23460)
2020-11-22 23:54:19 +09:00
kj
e1dc0db8c7
bpo-42345: Add whatsnew and versionchanged for typing.Literal in 3.9 (GH-23386)
...
* Whatsnew entry in 3.9 same as the one in 3.10.
* versionchanged for typing.Literal docs
Needs backport to 3.9.
2020-11-19 09:37:26 -08:00
Yurii Karabas
1b54077ff6
bpo-42345: Fix hash implementation of typing.Literal (GH-23383)
...
Fix hash implementation of `typing.Literal`.
Update docs regarding `typing.Litaral` caching.
Base implementation was done in PR #23294 .
2020-11-19 08:17:38 -08:00
