Jelle Zijlstra
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
Alex Waygood
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
Charlie Zhao
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
Meer Suri
8debeed307
bpo-46494: Mention the typing_extensions pkg in typing docs (GH-31260)
2022-03-07 20:04:04 -08:00
Nikita Sobolev
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
Nikita Sobolev
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
97littleleaf11
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
Jelle Zijlstra
243436f377
bpo-46475: Add typing.Never and typing.assert_never (GH-30842)
2022-02-08 10:50:26 -08:00
James Hilton-Balfe
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
Jelle Zijlstra
abcc3d75f6
bpo-46414: Add typing.reveal_type ( #30646 )
...
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-02-01 18:48:55 -08:00
Jelle Zijlstra
d75a51bea3
fix typo in typing.rst ( #30841 )
2022-01-23 15:36:08 -08:00
Jelle Zijlstra
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
Michael Oliver
73decdf021
Remove unused `Any` from `Concatenate` example in typing docs (GH-30516)
2022-01-11 21:59:26 +08:00
Nikita Sobolev
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
Alex Waygood
7c5c3f7254
bpo-46104: Fix example broken by GH-30148 (GH-30203)
...
See discussion in GH-30179.
2021-12-20 12:48:35 +08:00
Alex Waygood
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
Alex Waygood
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
Alex Waygood
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
Alex Waygood
e03e50377d
bpo-45680: ``typing`` docs: improve links to docs on ``GenericAlias``/``__class_getitem__`` (GH-29387)
2021-11-04 12:06:34 +08:00
Alex Waygood
d9575218d7
bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)
2021-10-29 21:56:21 +08:00
Alex Waygood
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
Alex Waygood
d9e1dae35a
Add PEPs 593 & 647 to list of PEPs at top of typing docs (GH-29097)
2021-10-20 23:15:59 +08:00
Micael Jarniac
a98b273ce4
Replace usage of List[...] with list[...] in typing docs (GH-28821)
...
The ``List[...]`` form is deprecated since 3.9.
2021-10-09 11:33:37 +08:00
DonnaDia
edae42f99f
bpo-44925: [docs] Fix confusing deprecation notice for typing.IO (GH-28004)
2021-08-31 17:44:27 +08:00
Sebastian Rittau
dabb6e8ddd
bpo-44957: Promote PEP 604 syntax in typing docs (GH-27833)
...
* Use "X | Y" instead of "Union" where it makes sense.
* Mention that "X | Y" is equivalent to "Union[X, Y]" in Union section.
* Remove "Optional[X]" as shorthand for "Union[X, None]" as the new
shorthand is now "X | None".
* Mention that "Optional[X]" can be written as "X | None" in section
about "Optional".
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-08-22 20:45:01 +02:00
Maximilian Hils
16b9be4861
bpo-44926: `get_type_hints`: Add note about type aliases with forward refs ( #27859 )
2021-08-20 07:36:51 -07:00
Ori Avtalion
f4367ba3c5
Doc: Change errant 3.10.0 to 3.10, to match other mentions (GH-27459)
2021-07-30 15:55:09 +02:00
Ken Jin
7aac3f6236
bpo-44353: Document that typing.NewType is now a class ( #27319 )
2021-07-24 10:53:49 +02:00
andrei kulakov
17f94e2888
bpo-43453: Update and re-add example to typing runtime_checkable ( #27013 )
...
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-07-05 09:23:42 -07:00
Sebastian Rittau
8a76683cfb
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.
2021-06-14 07:45:19 -07:00
Jelle Zijlstra
87109f4d85
bpo-44001: improve Literal documentation (GH-25877)
2021-05-04 10:54:12 +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
Dominik1123
c3b9592244
bpo-42317: Improve docs of typing.get_args concerning Union (GH-23254)
2020-11-15 17:30:55 -08:00
kj
9129af6050
bpo-42198: Link to GenericAlias in typing and expressions (GH-23030)
...
Follow up to 7cdf30fff3
and 4173320920
. This addresses the point "1. Update links in typing, subscription and union to point to GenericAlias." in the bpo for this PR.
2020-10-29 21:01:17 -07:00
Andre Delfino
975d10a4f8
[doc] Add mentions of PEP 613 (TypeAlias) to docs (GH-22733)
2020-10-16 19:34:01 -07:00
Saiyang Gou
ba06a70c82
Fix typo in "Context manager types" section in typing.rst (GH-22676)
...
Fix typo in the "Context manager types" section in `typing.rst`.
Automerge-Triggered-By: @gvanrossum
2020-10-12 16:34:33 -07:00
abdo
0ff8a3b374
Fix typo in typing.rst (GH-22625)
2020-10-11 11:40:21 +05:30
Mikhail Golubev
4f3c25043d
bpo-41923: PEP 613: Add TypeAlias to typing module ( #22532 )
...
This special marker annotation is intended to help in distinguishing
proper PEP 484-compliant type aliases from regular top-level variable
assignments.
2020-10-07 14:44:31 -07:00