Skip to content

Document attrs.filters include and exclude helpers #1628

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
feiiiiii5 wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −1
Open

Document attrs.filters include and exclude helpers #1628

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
22 changes: 21 additions & 1 deletion docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,29 @@ Helpers

.. autofunction:: include

For example:

.. doctest::

>>> @define
... class C:
... x: int
... y: int
>>> attrs.asdict(C(1, 2), filter=attrs.filters.include("x"))
{'x': 1}

.. autofunction:: exclude

See :func:`attrs.asdict` for examples.
For example:

.. doctest::

>>> @define
... class C:
... x: int
... y: int
>>> attrs.astuple(C(1, 2), filter=attrs.filters.exclude("x"))
(2,)

All objects from ``attrs.filters`` are also available from ``attr.filters`` (it's the same module in a different namespace).

Expand Down
Loading