659c2607f5
gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)
...
update dataclasses docs for when annotations are inspected
2023-01-06 09:26:44 -05:00
51ee0a29e9
dataclasses.rst: Prevent horizontal scrolling (gh-100025)
2022-12-05 13:56:13 -05:00
880bafc574
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
2022-10-31 11:02:02 -04:00
d10c2b9742
dataclasses docs: consistent indentation (4 spaces) in examples ( #98855 )
2022-10-29 18:06:52 +01:00
268129a74f
docs: Change links to label refs ( #98454 )
...
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-10-25 20:26:28 -07:00
5f319308a8
gh-91330: Tests and docs for dataclass descriptor-typed fields (GH-94424)
...
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-07-05 20:09:41 +02:00
5f9c0f5ddf
Add weakref_slot to dataclass decorator, to allow instances with slots to be weakref-able. ( #92160 )
2022-05-02 10:36:39 -06:00
82e9b0bb0a
bpo-46382 dataclass(slots=True) now takes inherited slots into account (GH-31980)
...
Do not include any members in __slots__ that are already in a base class's __slots__.
2022-03-19 17:01:17 -04:00
5a3f97291e
bpo-43532: add version added to KW_ONLY (GH-31235)
...
Minor missing version note mentioned at the end of (and affected me independently before reading that note).
Automerge-Triggered-By: GH:ericvsmith
2022-02-09 12:56:10 -08:00
ef5376e69e
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
2022-01-08 12:56:35 +02:00
d0669c5e69
Remove erroneous padding in dataclasses (GH-30076)
...
Automerge-Triggered-By: GH:ericvsmith
2021-12-12 10:05:48 -08:00
e029c53e1a
bpo-44674: Use unhashability as a proxy for mutability for default dataclass __init__ arguments. (GH-29867)
...
`@dataclass` in 3.10 prohibits using list, dict, or set as default values. It does this to avoid the mutable default problem. This test is both too strict, and not strict enough. Too strict, because some immutable subclasses should be safe, and not strict enough, because other mutable types should be prohibited. With this change applied, `@dataclass` now uses unhashability as a proxy for mutability: if objects aren't hashable, they're assumed to be mutable.
2021-12-11 16:12:17 -05:00
c1f93f0d37
bpo-43905: Expand dataclasses.astuple() and asdict() docs (GH-26154)
...
Expanded ``astuple()`` docs, warning about deepcopy being applied
and providing a workaround.
Automerge-Triggered-By: GH:ericvsmith
2021-11-29 10:10:32 -08:00
767a17f35a
[doc] Reword sentinel object summary in dataclasses (GH-27792)
...
This sentinel value (`MISSING`) is also used as default value for the `kw_only` parameter introduced in Python 3.10. It's cleaner to simply omit the usage here.
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-09-02 18:03:22 +02:00
d26dbba929
Fix reST markup in dataclasses.rst (GH-27843)
...
The signature of field() had an extraneous colon at the end, causing it
to appear all bold and without the module name.
2021-08-19 16:47:16 -04:00
aa0e4a64b0
Fix typo in dataclasses documentation ( #27360 )
...
"affect" -> "effect"
2021-07-26 08:39:45 -04:00
2a031723ee
bpo-43558: Add note about base class initialization to dataclasses doc (GH-25967)
2021-05-10 09:30:22 -04:00
801497a115
Fix a word in dataclasses docs. (GH-26003)
2021-05-08 22:20:04 -04:00
ee8e7c2fa9
Fix minor grammar problems in dataclasses documentation (GH-25948)
...
Some missing words; some odd word choices.
2021-05-06 17:52:46 -04:00
72720a2639
dataclasses docs: add a missing word. (GH-25839)
2021-05-03 02:33:34 -04:00
a21b3d2fa2
More clarification of kw_only args. (GH-25838)
...
Also, clarify that the dataclass decorator is what raises an error for some mutable defaults.
2021-05-03 01:55:13 -04:00
4ae828f3c0
Fix invalid markup ( #25833 )
2021-05-02 21:07:29 -07:00
821f0c8c39
More work on documenting dataclass keyword-only fields. (GH-25828)
2021-05-02 21:20:50 -04:00
a5eabc9a39
bpo-43997: Add versionadded directives for to match_args, kw_only, and slots in dataclasses.dataclasses documentation (GH-25803)
2021-05-02 08:43:50 -07:00
318ca1764c
Minor tweaks to dataclasses keyword-only fields documentation. (GH-25801)
2021-05-01 21:46:05 -04:00
2f59a767bc
Improve the dataclasses kw_only documentation. (GH-25799)
2021-05-01 19:51:12 -04:00
c24199184b
bpo-42269: Add slots parameter to dataclass decorator (GH-24171)
...
Add slots parameter to dataclass decorator and make_dataclass function.
2021-04-30 22:14:30 -04:00
e726a902b7
bpo-43971: Add spaces around annotated arg default '=' (GH-25702)
...
Result: "quantity_on_hand: int = 0".
2021-04-30 19:06:55 -04:00
8a307e488d
bpo-43938: improve dataclasses.FrozenInstanceError documentation (GH-25603)
2021-04-26 14:53:28 -04:00
c0280532dc
Add keyword-only fields to dataclasses. (GH=25608)
2021-04-25 20:42:39 -04:00
750f484752
bpo-43764: Add match_args=False parameter to dataclass decorator and to make_dataclasses function. (GH-25337)
...
Add match_args=False parameter to dataclass decorator and to make_dataclass function.
2021-04-10 21:28:42 -04:00
0554044ddc
bpo-43415: Fix typo on dataclasses.rst ( #24789 )
2021-03-08 17:50:39 -05:00
7f54e563dc
[doc] Use list[int] instead of List[int] (etc.) in a few more places (GH-22524)
...
This changes a few occurrences left behind by #22340 .
Automerge-Triggered-By: @gvanrossum
2020-10-03 15:10:59 -07:00
61bb24a270
bpo-41199: Docstring convention not followed for dataclasses documentation page (GH-21413)
...
Automerge-Triggered-By: @ericvsmith
2020-07-09 05:13:47 -07:00
2effef7453
Make the first dataclass example more useful (GH-19994)
2020-05-08 04:39:57 -07:00
e28aff54d9
bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) (GH-17677)
2019-12-25 17:45:30 -05:00
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
...
* "Return true/false" is replaced with "Return ``True``/``False``"
if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
2019-11-12 16:57:03 +02:00
2d88e63bfc
bpo-37163: Make the obj argument of dataclasses.replace() a positional-only. (GH-14390)
2019-06-26 19:07:44 +03:00
b7105c9c96
bpo-35566: Add links to annotation glossary term (GH-11291)
2018-12-23 21:09:09 -08:00
508d820512
Fix astuple in dataclasses documentation (GH-9631)
2018-09-29 06:50:31 -04:00
075b3c3259
Fix typo in the dataclasses's doc (GH-8896)
2018-08-24 05:19:24 -04:00
da5e9476bb
Dataclasses: Fix example on 30.6.8, add method should receive a list rather than an integer. (GH-8038)
...
Change example function to append rather than add lists.
2018-07-10 22:39:57 -04:00
713a936736
bpo-32216: Update dataclasses documentation ( #6913 )
2018-05-16 15:50:07 -04:00
7a1c027501
Minor tweaks to dataclasses docs. (GH-6903)
2018-05-16 09:29:05 -04:00
98d50cb8f5
bpo-32216: Add documentation for dataclasses (GH-6886)
...
This is an initial version that likely requires much polishing. I'm adding it lay out the structure and so we have something to start working from.
2018-05-16 04:20:43 -04:00
Akshit Tyagi
Ram Rachum
Shantanu
FC Stegerman
Stanley
Erik De Bonte
Eric V. Smith
Arie Bovenberg
Henry Schreiner
Zsolt Dollenstein
Andre Delfino
andrei kulakov
Ville Korhonen
Jean-Abou-Samra
thomkeh
dhoekstra2000
Scott Noyes
Raymond Hettinger
Shreyan Avigyan
Yurii Karabas
Mohamed Moselhy
Llandy Riveron Del Risco
Guilherme Martins Crocetti
marload
Ned Batchelder
Fabio Sangiovanni
Serhiy Storchaka
Cheryl Sabella
방성범 (Bang Seongbeom)
Daniel Dương
Tom Faulkner
Barry Warsaw