2a1e9b01d1
gh-96917: link to typing.readthedocs.io from typing.rst (GH-96921)
...
See the discussion at https://github.com/python/cpython/issues/91533
(cherry picked from commit 5b3a2569f4
2022-10-22 20:06:06 +01:00
28f97dc9d2
docs(typing): add "see PEP 675" to LiteralString (GH-97926)
...
(cherry picked from commit 2016bc54a2
2022-10-22 20:05:11 +01:00
7b1be2ac81
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-22 20:04:44 +01:00
1a84816c30
docs(typing): harmonize "See PEP x for more details" (GH-97927)
...
(cherry picked from commit 02389658a4
2022-10-22 20:04:36 +01:00
d00a9e0176
gh-95337: update TypeVarTuple example (GH-95338)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 07f12b5c15
2022-08-30 08:06:19 -07:00
1fccb1d493
[3.11] gh-94439: typing docs: Add minimum version to `__required_keys__` and `__optional_keys__` (GH-95373) ( #95944 )
...
Co-authored-by: Howie Zhao <howiezhaohr@hotmail.com>
2022-08-13 19:42:27 +01:00
7c185017a9
docs: typing.Self, fix typo (GH-94771)
...
* fix typo - double spelled word 'use'
* change methods names to the infinitive form
(cherry picked from commit 90a6e56e56
2022-07-12 11:17:06 -07:00
77bf973930
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5
2022-07-05 14:30:19 +02:00
64365d0df9
gh-91860: Add docs for typing.dataclass_transform field specifier params (GH-94354) (GH-94372)
...
(cherry picked from commit 81ac9ac492
2022-06-28 12:10:42 +02:00
3f7abff97b
gh-91243: Document Required and NotRequired (GH-93173)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 711eda7dec
2022-05-27 15:25:50 -07:00
6a3a6ba7a2
gh-91860: documentation for typing.dataclass_transform (GH-92768)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit f20a6a54fb
2022-05-20 08:01:44 -07:00
6d8fd3f608
`typing.Text`: tweak deprecation notice (GH-92405)
...
https://github.com/python/cpython/pull/92351/filesGH-r866869469
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit bdc99a830f
2022-05-08 08:36:54 -07:00
a85bdd7e02
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:31 -07:00
6f18b86fda
gh-92332: Docs-only deprecation of `typing.Text` (GH-92351)
...
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-06 18:15:18 +08:00
27e3665715
Improve the typing docs ( #92264 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-03 15:49:21 -06:00
f6f36cc269
bpo-44863: Allow generic typing.TypedDict ( #27663 )
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Yurii Karabas <1998uriyyo@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-05-03 07:21:42 -06:00
b04e02c57f
bpo-43923: Add support for generic typing.NamedTuple ( #92027 )
2022-05-02 16:41:23 -06:00
9588f880a2
typing docs: Add example for async functions ( #20386 )
...
Fixes python/typing#424
2022-04-30 22:40:27 -06:00
2f7952c35b
Rephrase typing.assert_never docs ( #92061 )
...
This change is similar to that in #32069
2022-04-29 21:13:21 -06:00
7861a9e327
Fix indentation for typing.Unpack docs ( #92058 )
...
https://docs.python.org/3.11/library/typing.html#typing.Unpack
2022-04-29 16:58:40 -06:00
81120b6754
bpo-44791: Accept ellipsis as the last argument of typing.Concatenate ( #30969 )
2022-04-29 15:01:40 -06:00
64113a4ba8
gh-91873: Summarise deprecations in typing at the top level (GH-91864)
2022-04-29 12:22:25 +08:00
93d280141c
gh-90633: Improve error and docs for typing.assert_never ( #91720 )
...
Closes #90633
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-04-25 06:40:18 -07:00
9fe82d0b70
gh-91764: Mark version typing.Unpack and LiteralString were added in ( #91817 )
...
Closes GH-91764
2022-04-22 07:28:39 -07:00
055760ed9e
gh-89263: Add typing.get_overloads (GH-31716)
...
Based on suggestions by Guido van Rossum, Spencer Brown, and Alex Waygood.
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Ken Jin <kenjin4096@gmail.com>
2022-04-16 09:01:43 -07:00
cfb849a326
bpo-47088: Add typing.LiteralString (PEP 675) (GH-32064)
...
Co-authored-by: Nick Pope <nick@nickpope.me.uk>
2022-04-05 07:21:03 -07:00
5a4973e29f
bpo-46998: Allow subclassing Any at runtime (GH-31841)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-04 19:35:29 -07:00
38ae5b8c0c
bpo-47097: Add documentation for TypeVarTuple ( #32103 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-04-04 16:37:01 -07:00
3354245daf
bpo-46480: rephrase typing.assert_type docs (GH-32069)
...
The goal here is to reduce potential confusion between
`assert_type(val, type)` and `assert isinstance(val, typ)`.
The former is meant to ask a type checker to confirm a fact, the latter
is meant to tell a type checker a fact. The behaviour of the latter more
closely resembles what I'd expect from the prior phrasing of
"assert [something] to the type checker".
2022-03-23 19:15:06 -07:00
96568e995d
bpo-46480: add typing.assert_type (GH-30843)
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: David Foster <david@dafoster.net>
2022-03-16 20:02:26 -07:00
81b425d4dc
bpo-46769: Improve documentation for `typing.TypeVar` (GH-31712)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-03-16 08:51:26 -07:00
8a207e0321
bpo-46677: Add examples of inheritance and attributes to `TypedDict` docs (GH-31349)
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-03-10 08:40:54 -08:00
8debeed307
bpo-46494: Mention the typing_extensions pkg in typing docs (GH-31260)
2022-03-07 20:04:04 -08:00
20a1c8ee4b
bpo-46195: Do not add `Optional` in `get_type_hints` (GH-30304)
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-03-01 21:29:46 -08:00
395029b0bd
bpo-46571: improve `typing.no_type_check` to skip foreign objects (GH-31042)
...
There are several changes:
1. We now don't explicitly check for any base / sub types, because new name check covers it
2. I've also checked that `no_type_check` do not modify foreign functions. It was the same as with `type`s
3. I've also covered `except TypeError` in `no_type_check` with a simple test case, it was not covered at all
4. I also felt like adding `lambda` test is a good idea: because `lambda` is a bit of both in class bodies: a function and an assignment
<!-- issue-number: [bpo-46571](https://bugs.python.org/issue46571 ) -->
https://bugs.python.org/issue46571
<!-- /issue-number -->
2022-02-18 17:53:29 -08:00
de6043e596
bpo-46066: Deprecate kwargs syntax for TypedDict definitions (GH-31126)
...
Closes python/typing#981
https://bugs.python.org/issue46066
2022-02-16 19:26:07 -08:00
243436f377
bpo-46475: Add typing.Never and typing.assert_never (GH-30842)
2022-02-08 10:50:26 -08:00
7ba1cc8049
bpo-46534: Implement PEP 673 Self in typing.py (GH-30924)
...
Co-authored-by: Pradeep Kumar Srinivasan <gohanpra@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-02-07 12:47:48 -08:00
abcc3d75f6
bpo-46414: Add typing.reveal_type ( #30646 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-02-01 18:48:55 -08:00
d75a51bea3
fix typo in typing.rst ( #30841 )
2022-01-23 15:36:08 -08:00
0bbf30e2b9
bpo-46342: make @typing.final introspectable (GH-30530)
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2022-01-12 11:38:25 -08:00
73decdf021
Remove unused `Any` from `Concatenate` example in typing docs (GH-30516)
2022-01-11 21:59:26 +08:00
1b30660c3b
bpo-46120: State that `|` is preferred over `Union` (GH-30222)
...
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
2021-12-24 13:36:09 -08:00
7c5c3f7254
bpo-46104: Fix example broken by GH-30148 (GH-30203)
...
See discussion in GH-30179.
2021-12-20 12:48:35 +08:00
6ada013df1
bpo-46104: Reduce use of pre-PEP 526 syntax in typing docs (GH-30148)
...
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
2021-12-18 18:23:51 +08:00
31b3a70edb
[doc] bpo-45680: Disambiguate ``__getitem__`` and ``__class_getitem__`` in the data model (GH-29389)
...
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.
2021-11-18 16:54:25 +01:00
87032cfa3d
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.
2021-11-04 19:48:40 +08:00
e03e50377d
bpo-45680: ``typing`` docs: improve links to docs on ``GenericAlias``/``__class_getitem__`` (GH-29387)
2021-11-04 12:06:34 +08:00
d9575218d7
bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)
2021-10-29 21:56:21 +08:00
03db1bbfd2
bpo-45655: Add "relevant PEPs" section to ``typing`` documentation (GH-29280)
...
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.
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-28 21:55:50 +02:00
Miss Islington (bot)