cfec22ce19
[3.13] Improve documentation for typing.get_type_hints (GH-119928) ( #119943 )
...
- Explicit list of what it does that is different from
"just return __annotations__"
- Remove reference to PEP 563; adding the future import doesn't
do anything to type aliases, and in general it will never make
get_type_hints() less likely to fail.
- Remove example, as the Annotated docs already have a similar
example, and it's unbalanced to have one example about this
one edge case but not about other behaviors of the function.
(cherry picked from commit aa9fe98e06
2024-06-02 15:29:25 +00:00
8f3fc01c4c
[3.13] [docs] TypeVarTuple default is keyword-only (GH-119215) ( #119224 )
...
(cherry picked from commit e406b399f9
2024-05-20 15:57:19 +00:00
cbf064b096
[3.13] typing docs: Fix formatting issue (GH-119210) ( #119212 )
...
typing docs: Fix formatting issue (GH-119210)
(cherry picked from commit 72d07dd30b
2024-05-20 15:08:49 +00:00
8f31af68d0
[3.13] Format None, True, False and NotImplemented as literals (GH-118758) (GH-118792)
...
(cherry picked from commit 05c2fe1acd
2024-05-08 19:55:12 +00:00
71080b8a0f
gh-118660: Add second type parameter to (Async)ContextManager ( #118681 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-05-07 14:16:05 +00:00
8419f01673
gh-118647: Add defaults to typing.Generator and typing.AsyncGenerator ( #118648 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-05-06 22:35:06 +00:00
ca269e58c2
gh-116126: Implement PEP 696 ( #116129 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-05-03 06:17:32 -07:00
852263e108
gh-117492: Clarify documentation of `typing.Never` ( #117678 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2024-05-03 06:02:11 -07:00
78ba4cb758
gh-118030: Group definitions for `ParamSpecArgs` and `ParamSpecKwargs` in `typing.rst` ( #118154 )
2024-04-22 14:57:46 +00:00
1e3e7ce11e
gh-114053: Fix bad interaction of PEP-695, PEP-563 and ``get_type_hints`` ( #118009 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-04-19 13:03:44 +00:00
3375282bb8
Docs: add link roles with Sphinx extlinks ( #117850 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-04-15 21:22:00 +03:00
f2132fcd2a
gh-117516: Implement typing.TypeIs ( #117517 )
...
See PEP 742.
Co-authored-by: Carl Meyer <carl@oddbird.net>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-04-09 10:50:37 +00:00
262445358e
Link to the Python type system specification ( #117400 )
2024-03-31 12:02:48 -07:00
290330714b
gh-89547: typing.rst: Add note about change in behavior with ClassVar/Final ( #116686 )
2024-03-12 15:17:53 -07:00
df4784b3b7
gh-116127: PEP-705: Add `ReadOnly` support for `TypedDict` ( #116350 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-03-12 07:49:39 -07:00
0064dfa091
gh-115777: Fix double versionadded directives (GH-116269)
2024-03-05 17:41:53 +02:00
11ee912327
gh-113255: Clarify docs for `typing.reveal_type` ( #113286 )
...
Co-authored-by: AlexWaygood <alex.waygood@gmail.com>
2023-12-20 17:21:23 +00:00
8ab7ad6308
Glossary: Add "static type checker" ( #111837 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-11-08 14:38:36 +00:00
c3e19c3a62
gh-111729: update generic syntax for `typing.Concatenate` sample code in `Doc/library/typing.rst` ( #111734 )
...
use new generic syntax
2023-11-06 16:53:17 -08:00
ccc8caa858
gh-111681: minor fixes to typing doctests; remove unused imports in `test_typing` ( #111682 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-11-03 12:23:33 +00:00
1198076447
gh-111151: Convert monospaced directives to :ref: ( #111152 )
2023-10-24 08:22:08 -07:00
f49958c886
Enhance TypedDict docs around required/optional keys ( #109547 )
...
As discussed in comments to #109544 , the semantics of this attribute
are somewhat confusing. Add a note explaining its limitations and
steering users towards __required_keys__ and __optional_keys__ instead.
2023-09-27 10:35:46 -07:00
ef6d475db3
Fix typos in docs and comments ( #109619 )
2023-09-20 16:58:23 +00:00
72b615ab01
Fix typo in typing docs: Remove redundant backtick ( #108559 )
2023-08-28 11:19:29 +00:00
c8872f4285
Clarify `Self` interaction with subclasses ( #107511 )
2023-08-01 13:20:25 -07:00
a22ff8e11c
gh-105578: Document that `AnyStr` is deprecated in py313 ( #107116 )
...
It will not be removed until Python 3.18.
2023-07-31 15:43:53 +00:00
f877b32b87
gh-105578: Add more usage examples to `typing.AnyStr` docs ( #107045 )
...
``typing.AnyStr`` has different semantics to ``str | bytes``, which often leads to user confusion
2023-07-31 16:23:08 +01:00
89fd4f4a3f
gh-107422: Remove outdated `TypedDict` example from typing docs ( #107436 )
2023-07-29 17:04:46 +00:00
89ec0e9529
gh-106745: typing docs: Clarify that removal of PEP-585 aliases is not currently planned ( #106748 )
2023-07-14 19:49:02 +01:00
32718f908c
gh-106309: Deprecate typing.no_type_check_decorator ( #106312 )
2023-07-13 14:30:35 +01:00
ca8b55c7f5
gh-106461: typing: Consolidate docs on `Callable` ( #106462 )
2023-07-09 21:46:15 +01:00
3eeb8c8906
Improve typing docs on the type of class objects ( #106081 )
2023-06-26 00:13:48 -07:00
8ef0ee4ebc
Typing docs: fix typo in annotating tuples comment ( #106048 )
2023-06-23 21:34:05 +01:00
968435ddb1
Typing docs: improve the guidance on annotating tuples ( #106021 )
2023-06-23 15:33:20 +01:00
4426279a43
typing docs: Improve the intro to each section ( #105901 )
2023-06-19 00:54:29 +01:00
da911a6b22
More reorganisation of the typing docs ( #105787 )
2023-06-15 06:52:18 +01:00
006a453205
Improve docs for `typing.dataclass_transform` ( #105792 )
2023-06-15 06:51:42 +01:00
7b1f0f204a
gh-105570: Deprecate unusual ways of creating empty TypedDicts ( #105780 )
...
Deprecate two methods of creating typing.TypedDict classes with 0 fields using the functional syntax: `TD = TypedDict("TD")` and `TD = TypedDict("TD", None)`. Both will be disallowed in Python 3.15. To create a TypedDict class with 0 fields, either use `class TD(TypedDict): pass` or `TD = TypedDict("TD", {})`.
2023-06-14 14:58:41 +00:00
4a113e24a3
Typing docs: move the deprecated stuff below the non-deprecated stuff ( #105781 )
2023-06-14 15:19:27 +01:00
ad56340b66
gh-105566: Deprecate unusual ways of creating `typing.NamedTuple` classes ( #105609 )
...
Deprecate creating a typing.NamedTuple class using keyword arguments to denote the fields (`NT = NamedTuple("NT", x=int, y=str)`). This will be disallowed in Python 3.15. Use the class-based syntax or the functional syntax instead.
Two methods of creating `NamedTuple` classes with 0 fields using the functional syntax are also deprecated, and will be disallowed in Python 3.15: `NT = NamedTuple("NT")` and `NT = NamedTuple("NT", None)`. To create a `NamedTuple` class with 0 fields, either use `class NT(NamedTuple): pass` or `NT = NamedTuple("NT", [])`.
2023-06-14 13:38:49 +01:00
fc8037d84c
gh-104873: Add typing.get_protocol_members and typing.is_protocol ( #104878 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-14 05:35:06 -07:00
8e755923c9
Miscellaneous improvements to the typing docs ( #105529 )
...
Mostly, these are changes so that we use shorter sentences and shorter paragraphs. In particular, I've tried to make the first sentence introducing each object in the typing API short and declarative.
2023-06-09 15:08:57 +00:00
d213c2990f
Further improve docs for `typing.Annotated` ( #105498 )
2023-06-08 14:36:30 +00:00
d63a7c3694
typing: Improve documentation of generic classes and aliases ( #105369 )
2023-06-07 14:02:40 +00:00
e26d296984
gh-97797: Improve documentation for typing.Annotated ( #105365 )
2023-06-07 06:35:34 -07:00
c5ec51ec8f
Improve docs for `typing.TypeAlias` ( #105372 )
2023-06-07 06:31:02 -07:00
81c81328a4
Improve code examples in `typing.rst` ( #105346 )
2023-06-07 07:47:11 +01:00
d7645124f5
typing docs: Make the PEPs list an expandable section, hidden by default ( #105353 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-07 07:37:02 +01:00
5f65ff0370
`typing.NewType` docs: the future performance improvements are now in the past ( #105354 )
2023-06-06 17:18:09 -07:00
060277d96b
gh-103921: Document PEP 695 ( #104642 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-26 10:48:17 -07:00
Miss Islington (bot)
Jelle Zijlstra
Nice Zombies
Alex Waygood
Hugo van Kemenade
Shantanu
Nikita Sobolev
Serhiy Storchaka
Kir
方糖
InSync
Heinz-Alexander Fuetterer
nikkie
Alexandru Mărășteanu
Michael The
Rakesh Sabale
Eamon Tracey