bf4ff3ad2e
gh-119260: Clarify is_dataclass Behavior for Subclasses in Documentation and Tests ( #119480 )
...
Co-authored-by: Carl Meyer <carl@oddbird.net>
2024-05-29 17:26:22 +00:00
e3ed574f6a
gh-90562: Mention slots pitfall in dataclass docs ( #107391 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-05-21 19:37:32 +00:00
423bbcbbc4
gh-108267 Fix another dataclasses docs typo ( #119277 )
2024-05-20 22:34:57 +00:00
17cba55786
gh-108267: Fix object.__setattr__ regression in dataclasses docs ( #119082 )
2024-05-16 09:39:37 -04:00
05c2fe1acd
Format None, True, False and NotImplemented as literals (GH-118758)
2024-05-08 22:35:16 +03:00
e01831760e
Doc: mark up classes, attributes, parameters, and methods in dataclasses.rst ( #117820 )
2024-04-14 16:29:01 +00:00
c99d374fc7
dataclasses docs: add some link anchors ( #117601 )
2024-04-14 01:03:16 -07:00
f303651b45
Simpler example of shallow dict export of a dataclass ( #117812 )
2024-04-13 17:14:43 -07:00
e7cce2a9c6
Tweak wording for dataclasses.replace (gh-117758)
2024-04-13 20:03:09 -04:00
0907871d43
docs: fix over-linking in dataclasses.rst ( #117005 )
2024-03-21 12:47:09 -07:00
db8f423f58
gh-116535: Fix distracting "TypeError" in example code (gh-116538)
2024-03-09 16:52:57 -05:00
d00fbed68f
Fix indentation in `__post_init__` documentation. (gh-114666)
2024-01-28 15:10:32 -05:00
30b7b4f73c
Docs: 'still' is a better word than 'nonetheless' ( #114598 )
2024-01-26 13:42:49 +00:00
05008c27b7
gh-88531 Fix dataclass __post_init__/__init__ interplay documentation (gh-107404)
...
* Simplify __post_init__ example usage. It applies to all base classes, not just dataclasses.
2024-01-16 20:17:34 -05:00
718391f475
gh-110631: Fix reST indentation ( #110724 )
...
* Fix wrong indentation in the other dirs.
* Fix more wrong indentation.
2023-10-11 22:43:03 +02:00
6f3c138dfa
gh-108751: Add copy.replace() function (GH-108752)
...
It creates a modified copy of an object by calling the object's
__replace__() method.
It is a generalization of dataclasses.replace(), named tuple's _replace()
method and replace() methods in various classes, and supports all these
stdlib classes.
2023-09-06 23:55:42 +03:00
79fdacc005
gh-108267: Dataclasses docs: Fix object.__setattr__ typo ( #108355 )
...
Fixed a sentence in dataclasses.rst
Changed "__setattr__" to "object.__setattr__" in a section that was specifically supposed to refer to the __setattr__ method of the object class. Also suppressed the link to the data model docs for __setattr__, since we're talking about a specific __setattr__ implementation, not __setattr__ methods in general.
2023-08-23 08:11:15 +01:00
512f299e55
gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109)
2023-06-26 14:00:21 -04:00
83aa496f81
gh-101100: Add reference doc for __post_init__ ( #103818 )
...
Signed-off-by: Olga Matoula <olgamatoula@gmail.com>
2023-04-28 13:10:26 -06:00
0f23eda4b9
gh-103810: Fix broken references in dataclasses ( #103811 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-25 01:26:18 +02:00
7ef614c1ad
gh-91687: modernize dataclass example typing ( #103773 )
...
modernize dataclass example typing `list` rather than `List` and comment as to that line being the alluded too error.
2023-04-24 10:16:23 -07:00
b48be8fa18
gh-102103: add `module` argument to `dataclasses.make_dataclass` ( #102104 )
2023-03-10 17:26:46 -07:00
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
Aditya Borikar
Josh Cannon
Alex Waygood
Shantanu
Serhiy Storchaka
Erlend E. Aasland
Jelle Zijlstra
Gouvernathor
Ned Batchelder
Declan
Bhushan Mohanraj
Steffen Zeile
Ezio Melotti
FrozenBob
Roderich Schupp
Olga Matoula
Allan Lago
Nikita Sobolev
Akshit Tyagi
Ram Rachum
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