Skip to content

DOC clarify attrs.define generated class example #1622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zihjiang wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

DOC clarify attrs.define generated class example #1622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/why.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ is roughly

```{doctest}
>>> class ArtisanalClass:
... __slots__ = ("a", "b")
... def __init__(self, a, b):
... self.a = a
... self.b = b
Expand All @@ -255,12 +256,11 @@ is roughly
... else:
... return not result
...
... def __hash__(self):
... return hash((self.__class__, self.a, self.b))
>>> ArtisanalClass(a=1, b=2)
ArtisanalClass(a=1, b=2)
```

This example reflects the defaults of @attrs.define: classes are slotted, comparable, and unhashable.
That's quite a mouthful and it doesn't even use any of *attrs*'s more advanced features like validators or default values.
If you pass `order=True`, there's even four more methods: `__lt__`, `__le__`, `__gt__`, and `__ge__`.
And who will guarantee you, that you don't accidentally flip the `<` in your tenth implementation of `__gt__`?
Expand Down