Shantanu
82ba6ce303
Improve assert_type phrasing ( #104081 )
...
I'd like to make the fact that this does nothing at runtime
really obvious, since I suspect this is unintuitive for users who are
unfamiliar with static type checking.
I thought of this because of
https://discuss.python.org/t/add-arg-check-type-to-types/26384
wherein I'm skeptical that the user really did want `assert_type`.
2023-05-01 23:05:25 -07:00
Franek Magiera
dc3f97549a
gh-103629: Update typing.Unpack docs in compliance with PEP 692 ( #103894 )
2023-04-26 16:39:39 -06:00
James Hilton-Balfe
ecad802e3f
Fix old behaviour in typing documentation ( #103400 )
2023-04-09 22:55:32 +01:00
Alex Waygood
644136563d
gh-74690: Document changes made to runtime-checkable protocols in 3.12 ( #103348 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-04-07 22:06:37 +01:00
Alex Waygood
6d59c9e32e
gh-102433: Use inspect.getattr_static in typing._ProtocolMeta.__instancecheck__ ( #103034 )
2023-04-02 14:22:19 +01:00
Shantanu
fda95aa194
gh-103099: Link mypy docs from typing.rst ( #103100 )
2023-03-30 01:32:09 -07:00
Alex Waygood
58d2b30c01
gh-102936: typing: document performance pitfalls of protocols decorated with @runtime_checkable ( #102937 )
2023-03-23 18:18:53 +00:00
Michael K
73250000ac
Fix typos in documentation and comments (GH-102374)
...
Found some duplicate `to`s in the documentation and some code comments and fixed them.
[Misc/NEWS.d/3.12.0a1.rst](ed55c69ebd/Misc/NEWS.d/3.12.0a1.rst
2023-03-02 07:26:49 -08:00
Steven Troxler
0f89acf6cc
gh-101561: Add typing.override decorator ( #101564 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-27 13:16:11 -08:00
Nikita Sobolev
a498de4c0e
gh-101100: Fix sphinx warnings in typing module docs ( #102260 )
2023-02-25 21:48:00 +00:00
Furkan Onder
3690688149
GH-101898: Fix missing term references for hashable definition ( #101899 )
...
Fix missing term references for hashable definition
2023-02-14 14:20:11 +04:00
FrozenBob
deaf090699
gh-100673: Removed erroneous note in the get_type_hints docs ( #100701 )
...
Removed erroneous note in the get_type_hints docs
typing.get_type_hints still includes base class type hints.
2023-01-07 17:31:47 +00:00
MonadChains
f5b7b19bf1
gh-99535: Add test for inheritance of annotations and update documentation ( #99990 )
2022-12-24 12:07:14 -08:00
Erik De Bonte
5c19050546
gh-99957: Add frozen_default parameter on dataclass_transform ( #99958 )
2022-12-05 19:35:43 -08:00
GabrielAnguita
1bf983ce7e
gh-99662: fix typo in typing.TypeVarTuple docs ( #99672 )
2022-11-21 20:02:55 -08:00
Sebastian Rittau
65d1407737
gh-92871: Postpone the removal of typing.{io,re} to 3.13 ( #98958 )
2022-11-01 20:51:45 -07:00
Eclips4
be0cf82ae4
gh-98602: [typing docs] Use quotes for forward reference in TypeVarTuple example ( #98605 )
2022-10-25 16:32:52 +01:00
Nikita Sobolev
5076108872
gh-98623: Fix base classes in typing.rst ( #98626 )
2022-10-25 07:06:13 -07:00
Nikita Sobolev
e3b9dd8e87
gh-98507: [typing docs] Rephrase "now supports []" to "now supports subscripting" ( #98508 )
2022-10-24 19:10:25 +01:00
Nikita Sobolev
1a217f9ffc
gh-98500: Fix typing docs for *View classes ( #98511 )
2022-10-24 10:47:32 -07:00
Omkaar
b6d5d5b60a
gh-98561: Fix a typo in typing (GH-98562)
2022-10-23 22:05:08 +08:00
Simon Legner
02389658a4
docs(typing): harmonize "See PEP x for more details" ( #97927 )
2022-10-15 12:17:51 -07:00
Shantanu
ed6344eed0
gh-96130: Rephrase use of "typecheck" verb for clarity ( #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
2022-10-11 19:37:58 -07:00
Simon Legner
2016bc54a2
docs(typing): add "see PEP 675" to LiteralString ( #97926 )
2022-10-05 13:08:07 -07:00
Shantanu
5b3a2569f4
gh-96917: link to typing.readthedocs.io from typing.rst ( #96921 )
...
See the discussion at https://github.com/python/cpython/issues/91533
2022-09-19 12:09:41 -07:00
Adrian Garcia Badaracco
07f12b5c15
gh-95337: update TypeVarTuple example ( #95338 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-08-30 07:57:03 -07:00
Howie Zhao
f235178bec
gh-94439: typing docs: Add minimum version to __required_keys__ and __optional_keys__ ( #95373 )
2022-08-12 21:23:33 -07:00
Max Zhenzhera
90a6e56e56
docs: typing.Self, fix typo (GH-94771)
...
* fix typo - double spelled word 'use'
* change methods names to the infinitive form
2022-07-12 18:45:52 +01:00
MonadChains
e8e4b550f5
gh-94309: Deprecate typing.Hashable/Sized (GH-94626)
...
Deprecate typing.Hashable/Sized. Use the collections.abc counterparts directly instead.
To be consistent with PEP 585, deprecated aliases will not raise any DeprecationWarning.
2022-07-10 19:04:01 +01:00
Ned Batchelder
3440d197a5
Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551)
...
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
2022-07-05 11:16:10 +02:00
Erik De Bonte
81ac9ac492
Add docs for decorated object and field specifier params (GH-94354)
2022-06-28 11:58:35 +02:00
David Foster
711eda7dec
gh-91243: Document Required and NotRequired ( #93173 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-27 15:11:45 -07:00
Shantanu
f20a6a54fb
gh-91860: documentation for typing.dataclass_transform ( #92768 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-20 07:32:29 -07:00
Alex Waygood
bdc99a830f
typing.Text: tweak deprecation notice (#92405 )
...
https://github.com/python/cpython/pull/92351/files#r866869469
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-08 08:22:32 -07:00
Alex Waygood
e5b4bd4d60
gh-92417: typing docs: from __future__ import annotations can be used in all supported Python versions (GH-92418)
2022-05-08 16:15:38 +03:00
Alex Waygood
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
Jelle Zijlstra
27e3665715
Improve the typing docs ( #92264 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-03 15:49:21 -06:00
Samodya Abey
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
Serhiy Storchaka
b04e02c57f
bpo-43923: Add support for generic typing.NamedTuple ( #92027 )
2022-05-02 16:41:23 -06:00
Sam Bull
9588f880a2
typing docs: Add example for async functions ( #20386 )
...
Fixes python/typing#424
2022-04-30 22:40:27 -06:00
Shantanu
2f7952c35b
Rephrase typing.assert_never docs ( #92061 )
...
This change is similar to that in #32069
2022-04-29 21:13:21 -06:00
Jelle Zijlstra
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
Serhiy Storchaka
81120b6754
bpo-44791: Accept ellipsis as the last argument of typing.Concatenate ( #30969 )
2022-04-29 15:01:40 -06:00
Ken Jin
64113a4ba8
gh-91873: Summarise deprecations in typing at the top level (GH-91864)
2022-04-29 12:22:25 +08:00
Jelle Zijlstra
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
Dominic Davis-Foster
9fe82d0b70
gh-91764: Mark version typing.Unpack and LiteralString were added in ( #91817 )
...
Closes GH-91764
2022-04-22 07:28:39 -07:00
Jelle Zijlstra
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
Jelle Zijlstra
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
Shantanu
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
Matthew Rahtz
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
