From 569293414432c2a7a4f7ad8efff223fb818da7ee Mon Sep 17 00:00:00 2001 From: fei <204683769+feiiiiii5@users.noreply.github.com> Date: Fri, 25 Sep 2026 19:21:05 +0800 Subject: [PATCH] Document attrs filter examples --- docs/api.rst | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index 42b87f7a7..f343fe098 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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).