pax_global_header 0000666 0000000 0000000 00000000064 15157001312 0014505 g ustar 00root root 0000000 0000000 52 comment=7bfc49e9b22d5ba25b6e429524c3d49fee27cb36 python-attrs-attrs-61c0e09/ 0000775 0000000 0000000 00000000000 15157001312 0015645 5 ustar 00root root 0000000 0000000 python-attrs-attrs-61c0e09/.git_archival.txt 0000664 0000000 0000000 00000000152 15157001312 0021116 0 ustar 00root root 0000000 0000000 node: 7bfc49e9b22d5ba25b6e429524c3d49fee27cb36 node-date: 2026-03-19T10:06:02-04:00 describe-name: 26.1.0 python-attrs-attrs-61c0e09/.gitattributes 0000664 0000000 0000000 00000000203 15157001312 0020533 0 ustar 00root root 0000000 0000000 # Force LF line endings for text files * text=auto eol=lf # Needed for setuptools-scm-git-archive .git_archival.txt export-subst python-attrs-attrs-61c0e09/.github/ 0000775 0000000 0000000 00000000000 15157001312 0017205 5 ustar 00root root 0000000 0000000 python-attrs-attrs-61c0e09/.github/AI_POLICY.md 0000664 0000000 0000000 00000010116 15157001312 0021076 0 ustar 00root root 0000000 0000000 # Generative AI / LLM Policy We appreciate that we can't realistically police how you author your pull requests, which includes whether you employ large-language model (LLM)-based development tools. So, we don't. However, due to both legal and human reasons, we have to establish boundaries. > [!CAUTION] > **TL;DR:** > - We take the responsibility for this project very seriously and we expect you to take your responsibility for your contributions seriously, too. > This used to be a given, but it changed now that a pull request is just one prompt away. > > - Every contribution has to be backed by a human who unequivocally owns the copyright for all changes. > No LLM bots in `Co-authored-by:`s. > > - DoS-by-slop leads to a permanent ban. > > - Absolutely **no** unsupervised agentic tools like OpenClaw. > > --- > > By submitting a pull request, you certify that: > > - You are the author of the contribution or have the legal right to submit it. > - You either hold the copyright to the changes or have explicit legal authorization to contribute them under this project's license. > - You understand the code. > - You accept full responsibility for it. ## Legal There is ongoing legal uncertainty regarding the copyright status of LLM-generated works and their provenance. Since we do not have a formal [Contributor License Agreement](https://en.wikipedia.org/wiki/Contributor_license_agreement) (CLA), you retain your copyright to your changes to this project. Therefore, allowing contributions by LLMs has unpredictable consequences for the copyright status of this project – even when leaving aside possible copyright violations due to plagiarism. ## Human As the makers of software that is used by millions of people worldwide and with a reputation for high-quality maintenance, we take our responsibility to our users very seriously. No matter what LLM vendors or boosters on LinkedIn tell you, we have to manually review every change before merging, because it's **our responsibility** to keep the project stable. Please understand that by opening low-quality pull requests you're not helping anyone. Worse, you're [poisoning the open source ecosystem](https://lwn.net/Articles/1058266/) that was precarious even before the arrival of LLM tools. Having to wade through plausible-looking-but-low-quality pull requests and trying to determine which ones are legit is extremely demoralizing and has already burned out many good maintainers. Put bluntly, we have no time or interest to become part of your vibe coding loop where you drop LLM slop at our door, we spend time and energy to review it, and you just feed it back into the LLM for another iteration. This dynamic is especially pernicious because it poisons the well for mentoring new contributors which we are committed to. ## Summary In practice, this means: - Pull requests that have an LLM product listed as co-author can't be merged and will be closed without further discussion. We cannot risk the copyright status of this project. If you used LLM tools during development, you may still submit – but you must remove any LLM co-author tags and take full ownership of every line. - By submitting a pull request, **you** take full **technical and legal** responsibility for the contents of the pull request and promise that **you** hold the copyright for the changes submitted. "An LLM wrote it" is **not** an acceptable response to questions or critique. **If you cannot explain and defend the changes you submit, do not submit them** and open a high-quality bug report/feature request instead. - Accounts that exercise bot-like behavior – like automated mass pull requests – will be permanently banned, whether they belong to a human or not. - Do **not** post LLM-generated review comments -- we can prompt LLMs ourselves should we desire their wisdom. Do **not** post summaries unless you've fact-checked them and take responsibility for 100% of their content. Remember that *all* LLM output *looks* **plausible**. When using these tools, it's **your** responsibility to ensure that it's also **correct** and has a reasonable signal-to-noise ratio. python-attrs-attrs-61c0e09/.github/CODE_OF_CONDUCT.md 0000664 0000000 0000000 00000001626 15157001312 0022011 0 ustar 00root root 0000000 0000000 # Code of Conduct While not being a [Python Software Foundation](https://www.python.org/psf-landing/) project, everyone interacting in this project is expected to follow the [PSF Code of Conduct](https://policies.python.org/python.org/code-of-conduct/). In general, this means that everyone is expected to be **open**, **considerate**, and **respectful** of others no matter what their position is within the project. ## Enforcement We take Code of Conduct violations seriously, and will act to ensure our spaces are welcoming, inclusive, and professional environments to communicate in. If you need to raise a Code of Conduct report, you may do so privately by email to [Hynek Schlawack](mailto:hs@ox.cx). Reports will be treated confidentially. Alternately you can make a [report to the Python Software Foundation](https://policies.python.org/python.org/code-of-conduct/Procedures-for-Reporting-Incidents/). python-attrs-attrs-61c0e09/.github/CONTRIBUTING.md 0000664 0000000 0000000 00000027623 15157001312 0021450 0 ustar 00root root 0000000 0000000 # How To Contribute > [!IMPORTANT] > - This document is mainly to help you to get started by codifying tribal knowledge and expectations and make it more accessible to everyone. > But don't be afraid to open half-finished PRs and ask questions if something is unclear! > > - If you use LLM / "AI" tools for your contributions, please read and follow our [_Generative AI / LLM Policy_][llm]. ## Support In case you'd like to help out but don't want to deal with GitHub, there's a great opportunity: help your fellow developers on [Stack Overflow](https://stackoverflow.com/questions/tagged/python-attrs)! The official tag is `python-attrs` and helping out in support frees us up to improve *attrs* instead! ## Workflow First off, thank you for considering to contribute! It's people like *you* who make this project such a great tool for everyone. - **Only contribute code that you fully understand.** See also our [AI policy][llm]. - Very relatedly, our pull request check list is our mandatory [Van Halen test](https://en.wikipedia.org/wiki/Van_Halen_test). Sadly, the current state of the world has forced us into being stricter about policies -- sorry fellow humans! - No contribution is too small! Please submit as many fixes for typos and grammar bloopers as you can! They're your license to delete the checklist! - Before starting big contributions, **talk to us first**. Don't waste energy / tokens on something that we do not want. Rejecting a huge PR is unpleasant for everybody. - Try to limit each pull request to *one* change only. - Since we squash on merge, it's up to you how you handle updates to the `main` branch. Whether you prefer to rebase on `main` or merge `main` into your branch, do whatever is more comfortable for you. Just remember to [not use your own `main` branch for the pull request](https://hynek.me/articles/pull-requests-branch/). - *Always* add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won't be merged. - Consider adding a news fragment to [`changelog.d`](../changelog.d/) to reflect the changes as observed by people *using* this library. - Make sure your changes pass our [CI](https://github.com/python-attrs/attrs/actions). You won't get any feedback until it's green unless you ask for it. For the CI to pass, the coverage must be 100%. If you have problems to test something, open anyway and ask for advice. In some situations, we may agree to add an `# pragma: no cover`. - Once you've addressed review feedback, make sure to bump the pull request with a short note, so we know you're done. - Don't break [backwards-compatibility](SECURITY.md). ## Local Development Environment First, **fork** the repository on GitHub. Make sure to **uncheck** the `Copy the main branch only` radio button on the `Create a new fork` page. If you don't, our test suite will fail because we use Git tags for packaging. Finally, **clone** your fork using one of the alternatives that you can copy-paste by pressing the big green button labeled `<> Code`. You can (and should) run our test suite using [*tox*](https://tox.wiki/) with the [*tox-uv*](https://github.com/tox-dev/tox-uv) plugin. The easiest way is to [install *uv*] which is needed in any case and then run `uv tool install --with tox-uv tox` to have it globally available or `uvx --with tox-uv tox` to use a temporary environment. --- However, you'll probably want a more traditional environment as well. We recommend using the Python version from the `.python-version-default` file in the project's root directory. We use a fully-locked development environment using [*uv*](https://docs.astral.sh/uv/) so the easiest way to get started is to [install *uv*] and you can run `uv run pytest` to run the tests immediately. I you'd like a traditional virtual environment, you can run `uv sync --python=$(cat .python-version-default)` and it will create a virtual environment named `.venv` with the correct Python version and install all the dependencies in the root directory. If you're using [*direnv*](https://direnv.net), you can automate the creation and activation of the project's virtual environment with the correct Python version by adding the following `.envrc` to the project root: ```bash uv sync --python=$(cat .python-version-default) . .venv/bin/activate ``` --- If you don't want to use *uv*, you can use Pip 25.1 (that added support for dependency groups) or newer and install the dependencies manually: ```console $ pip install -e . --group dev ``` --- If the test suite fails with errors in `test_packaging.py`, you're lacking Git tags. You can retroactively fetch them using: ```console $ git remote add upstream git@github.com:python-attrs/attrs.git $ git fetch upstream --tags ``` --- > [!WARNING] > - **Before** you start working on a new pull request, use the "*Sync fork*" button in GitHub's web UI to ensure your fork is up to date. > > - **Always create a new branch off `main` for each new pull request.** > Yes, you can work on `main` in your fork and submit pull requests. > But this will *inevitably* lead to you not being able to synchronize your fork with upstream and having to start over. --- When working on the documentation, use: ```console $ tox run -e docs-watch ``` This will build the documentation, watch for changes, and rebuild it whenever you save a file. To just build the documentation and exit immediately use: ```console $ tox run -e docs-build ``` You will find the built documentation in `docs/_build/html`. To run doctests: ```console $ tox run -e docs-doctests ``` ## Code - We follow [PEP 8](https://peps.python.org/pep-0008/) as enforced by [Ruff](https://ruff.rs/) with a line length of 79 characters. - As long as you run our full *tox* suite before committing, or install our [*pre-commit*](https://pre-commit.com/) hooks, you won't have to spend any time on formatting your code at all. If you don't, CI will catch it for you -- but that seems like a waste of your time! - If you've changed or added public APIs, please update our type stubs (files ending in `.pyi`). ## Tests - Write your asserts as `expected == actual` to line them up nicely, and leave an empty line before them: ```python x = f() assert 42 == x.some_attribute assert "foo" == x._a_private_attribute ``` - You can run the test suite with all dependencies against all supported Python versions -- just as it will in our CI -- by running `tox`. - Write [good test docstrings](https://jml.io/test-docstrings/). - To ensure new features work well with the rest of the system, they should be also added to our [Hypothesis](https://hypothesis.readthedocs.io/) testing strategy, which can be found in `tests/strategies.py`. ## Documentation - Use [semantic newlines] in [reStructuredText](https://www.sphinx-doc.org/en/stable/usage/restructuredtext/basics.html) (`*.rst`) and [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) (`*.md`) files: ```markdown This is a sentence. This is another sentence. This is a new paragraph. ``` - If you start a new section, add two blank lines before and one blank line after the header except if two headers follow immediately after each other: ```markdown # Main Header Last line of previous section. ## Header of New Top Section ### Header of New Section First line of new section. ``` - If you add a new feature, demonstrate its awesomeness on the [examples page](https://github.com/python-attrs/attrs/blob/main/docs/examples.md)! - For docstrings, we follow [PEP 257](https://peps.python.org/pep-0257/), use the `"""`-on-separate-lines style, and [Napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html)-style API documentation: ```python def func(x: str, y: int) -> str: """ Do something. Args: x: A very important argument. y: Another very important argument, but its description is so long that it doesn't fit on one line. So, we start the whole block on a fresh new line to keep the block together. Returns: str: The result of doing something. Raises: ValueError: When an invalid value is passed. """ ``` Please note that the API docstrings are still reStructuredText. - If you add or change public APIs, tag the docstring using `.. versionadded:: 24.1.0 WHAT` or `.. versionchanged:: 24.1.0 WHAT`. We follow CalVer, so the next version will be the current with with the middle number incremented (for example, `24.1.0` -> `24.2.0`). ### Changelog If your change is interesting to end-users, there needs to be a changelog entry so they can learn about it! To avoid merge conflicts, we use the [Towncrier](https://pypi.org/project/towncrier) package to manage our changelog. *towncrier* uses independent Markdown files for each pull request -- so called *news fragments* -- instead of one monolithic changelog file. On release, those news fragments are compiled into our [`CHANGELOG.md`](../CHANGELOG.md). You don't need to install Towncrier yourself, you just have to abide by a few simple rules: - For each pull request, add a new file into `changelog.d` with a filename adhering to the `pr#.(change|deprecation|breaking).md` schema: For example, `changelog.d/42.change.md` for a non-breaking change that is proposed in pull request #42. - As with other docs, please use [semantic newlines] within news fragments. - Refer to all symbols by their fully-qualified names. For example, `attrs.Foo` -- not just `Foo`. - Wrap symbols like modules, functions, or classes into backticks, so they are rendered in a `monospace font`. - Wrap arguments into asterisks so they are *italicized* like in API documentation: `Added new argument *an_argument*.` - If you mention functions or methods, add parentheses at the end of their names: `attrs.func()` or `attrs.Class.method()`. This makes the changelog a lot more readable. - Prefer simple past tense or constructions with "now". Example entries: ```md Added `attrs.validators.func()`. The feature really *is* awesome. ``` or: ```md `attrs.func()` now doesn't crash the Large Hadron Collider anymore when passed the *foobar* argument. The bug really *was* nasty. ``` --- If you want to reference multiple issues, copy the news fragment to another filename. Towncrier will merge all news fragments with identical contents into one entry with multiple links to the respective pull requests. `tox run -e changelog` will render the current changelog to the terminal if you have any doubts. ## Governance *attrs* is maintained by [team of volunteers](https://github.com/python-attrs) that is always open to new members that share our vision of a fast, lean, and magic-free library that empowers programmers to write better code with less effort. If you'd like to join, just get a pull request merged and ask to be added in the very same pull request! **The simple rule is that everyone is welcome to review/merge pull requests of others but nobody is allowed to merge their own code.** [Hynek Schlawack](https://hynek.me/about/) acts reluctantly as the [BDFL](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life) and has the final say over design decisions. ## See You on GitHub! Again, this whole file is mainly to help you to get started by codifying tribal knowledge and expectations to save you time and turnarounds. It is **not** meant to be a barrier to entry, so don't be afraid to open half-finished PRs and ask questions if something is unclear! Please note that this project is released with a Contributor [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. Please report any harm to Hynek Schlawack in any way you find appropriate. [semantic newlines]: https://rhodesmill.org/brandon/2012/one-sentence-per-line/ [install *uv*]: https://docs.astral.sh/uv/getting-started/installation/ [llm]: AI_POLICY.md python-attrs-attrs-61c0e09/.github/FUNDING.yml 0000664 0000000 0000000 00000000152 15157001312 0021020 0 ustar 00root root 0000000 0000000 --- github: hynek tidelift: pypi/attrs thanks_dev: u/gh/python-attrs custom: https://hynek.me/say-thanks/ python-attrs-attrs-61c0e09/.github/PULL_REQUEST_TEMPLATE.md 0000664 0000000 0000000 00000005146 15157001312 0023014 0 ustar 00root root 0000000 0000000 # Summary # Pull Request Check List - [ ] I acknowledge this project's [**AI policy**](https://github.com/python-attrs/attrs/blob/main/.github/AI_POLICY.md). - [ ] This pull requests is [**not** from my `main` branch](https://hynek.me/articles/pull-requests-branch/). - Consider granting [push permissions to the PR branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork), so maintainers can fix minor issues themselves without pestering you. - [ ] There's **tests** for all new and changed code. - [ ] Changes or additions to public APIs are reflected in our type stubs (files ending in ``.pyi``). - [ ] ...and used in the stub test file `typing-examples/baseline.py` or, if necessary, `typing-examples/mypy.py`. - [ ] If they've been added to `attr/__init__.pyi`, they've *also* been re-imported in `attrs/__init__.pyi`. - [ ] The **documentation** has been updated. - [ ] New functions/classes have to be added to `docs/api.rst` by hand. - [ ] Changes to the signatures of `@attr.s()` and `@attrs.define()` have to be added by hand too. - [ ] Changed/added classes/methods/functions have appropriate `versionadded`, `versionchanged`, or `deprecated` [directives](http://www.sphinx-doc.org/en/stable/markup/para.html#directive-versionadded). The next version is the second number in the current release + 1. The first number represents the current year. So if the current version on PyPI is 26.2.0, the next version is gonna be 26.3.0. If the next version is the first in the new year, it'll be 27.1.0. - [ ] Documentation in `.rst` and `.md` files is written using [semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/). - [ ] Changes have news fragments in [`changelog.d`](https://github.com/python-attrs/attrs/blob/main/changelog.d). python-attrs-attrs-61c0e09/.github/SECURITY.md 0000664 0000000 0000000 00000001663 15157001312 0021004 0 ustar 00root root 0000000 0000000 # Security Policy ## Supported Versions We are following [Calendar Versioning](https://calver.org) with generous backwards-compatibility guarantees. Therefore we only support the latest version. Put simply, you shouldn't ever be afraid to upgrade as long as you're only using our public APIs. Whenever there is a need to break compatibility, it is announced in the changelog, and raises a `DeprecationWarning` for a year (if possible) before it's finally really broken. > [!WARNING] > The structure of the `attrs.Attribute` class is exempt from this rule. > It *will* change in the future, but since it should be considered read-only, that shouldn't matter. > > However if you intend to build extensions on top of *attrs* you have to anticipate that. ## Reporting a Vulnerability To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. python-attrs-attrs-61c0e09/.github/dependabot.yml 0000664 0000000 0000000 00000000467 15157001312 0022044 0 ustar 00root root 0000000 0000000 --- version: 2 updates: - package-ecosystem: github-actions directory: / schedule: interval: monthly cooldown: # https://blog.yossarian.net/2025/11/21/We-should-all-be-using-dependency-cooldowns default-days: 7 groups: github-actions: patterns: - "*" python-attrs-attrs-61c0e09/.github/workflows/ 0000775 0000000 0000000 00000000000 15157001312 0021242 5 ustar 00root root 0000000 0000000 python-attrs-attrs-61c0e09/.github/workflows/build-docset.yml 0000664 0000000 0000000 00000001442 15157001312 0024344 0 ustar 00root root 0000000 0000000 --- name: Build docset on: push: tags: ["*"] workflow_dispatch: env: PIP_DISABLE_PIP_VERSION_CHECK: "1" PIP_NO_PYTHON_VERSION_WARNING: "1" permissions: {} jobs: docset: runs-on: ubuntu-latest steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 persist-credentials: false - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: "3.x" - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - run: uvx --with=tox-uv tox run -e docset - uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: docset path: attrs.tgz python-attrs-attrs-61c0e09/.github/workflows/ci.yml 0000664 0000000 0000000 00000015043 15157001312 0022363 0 ustar 00root root 0000000 0000000 --- name: CI on: merge_group: push: branches: [main] tags: ["*"] pull_request: workflow_dispatch: env: FORCE_COLOR: "1" PIP_DISABLE_PIP_VERSION_CHECK: "1" PIP_NO_PYTHON_VERSION_WARNING: "1" permissions: {} jobs: build-package: name: Build & verify package runs-on: ubuntu-latest steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 persist-credentials: false - uses: hynek/build-and-inspect-python-package@efb823f52190ad02594531168b7a2d5790e66516 # v2.14.0 id: baipp outputs: # Used to define the matrix for tests below. The value is based on # packaging metadata (trove classifiers). supported-python-versions: ${{ steps.baipp.outputs.supported_python_classifiers_json_array }} tests: name: Tests & Mypy on ${{ matrix.python-version }} runs-on: ubuntu-latest needs: build-package strategy: fail-fast: false matrix: # Created by the build-and-inspect-python-package action above. python-version: ${{ fromJson(needs.build-package.outputs.supported-python-versions) }} steps: - name: Download pre-built packages uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: Packages path: dist - run: tar xf dist/*.tar.gz --strip-components=1 - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version: ${{ matrix.python-version }} allow-prereleases: true - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - name: Prepare tox env: V: ${{ matrix.python-version }} run: | DO_MYPY=1 if [[ "$V" == "3.9" ]]; then DO_MYPY=0 fi echo DO_MYPY=$DO_MYPY >>$GITHUB_ENV echo TOX_PYTHON=py$(echo $V | tr -d .) >>$GITHUB_ENV - run: > uvx --with=tox-uv tox run -e $TOX_PYTHON-mypy if: env.DO_MYPY == '1' - name: Remove src to ensure tests run against wheel run: rm -rf src - run: > uvx --with=tox-uv tox run --installpkg dist/*.whl -e $TOX_PYTHON-tests - name: Upload coverage data uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: coverage-data-${{ matrix.python-version }} path: .coverage.* include-hidden-files: true if-no-files-found: ignore tests-pypy: name: Tests on ${{ matrix.python-version }} runs-on: ubuntu-latest needs: build-package strategy: fail-fast: false matrix: python-version: - pypy-3.10 steps: - name: Download pre-built packages uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: Packages path: dist - run: | tar xf dist/*.tar.gz --strip-components=1 rm -rf src # ensure tests run against wheel - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - run: > uvx --with=tox-uv tox run --installpkg dist/*.whl -e pypy3-tests coverage: name: Combine & check coverage runs-on: ubuntu-latest needs: tests steps: - name: Download pre-built packages uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: Packages path: dist - run: tar xf dist/*.tar.gz --strip-components=1 - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - name: Download coverage data uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: pattern: coverage-data-* merge-multiple: true - name: Combine coverage & fail if it's <100%. run: | uv tool install --python $(cat .python-version-default) coverage coverage combine coverage html --skip-covered --skip-empty # Report and write to summary. coverage report --format=markdown >> $GITHUB_STEP_SUMMARY # Report again and fail if under 100%. coverage report --fail-under=100 - name: Upload HTML report if check failed. uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0 with: name: html-report path: htmlcov if: ${{ failure() }} docs: name: Run doctests & render changelog runs-on: ubuntu-latest needs: build-package steps: - name: Download pre-built packages uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: Packages path: dist - run: tar xf dist/*.tar.gz --strip-components=1 - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - run: uvx --with=tox-uv tox run -e docs-doctests,changelog typing: name: Check types using supported type checkers runs-on: ubuntu-latest steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: persist-credentials: false - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - run: > uvx --with=tox-uv --python $(cat .python-version-default) tox run -f typing install-dev: name: Verify dev env runs-on: ubuntu-latest steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: persist-credentials: false - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - run: uv sync --python $(cat .python-version-default) - name: Ensure we can import attr and attrs packages run: | source .venv/bin/activate python -Ic 'import attr; print(attr.__version__)' python -Ic 'import attrs; print(attrs.__version__)' # Ensure everything required is passing for branch protection. required-checks-pass: if: always() needs: - coverage - tests-pypy - docs - install-dev - typing runs-on: ubuntu-latest steps: - name: Decide whether the needed jobs succeeded or failed uses: re-actors/alls-green@05ac9388f0aebcb5727afa17fcccfecd6f8ec5fe # v1.2.2 with: jobs: ${{ toJSON(needs) }} python-attrs-attrs-61c0e09/.github/workflows/codeql-analysis.yml 0000664 0000000 0000000 00000001646 15157001312 0025064 0 ustar 00root root 0000000 0000000 --- name: CodeQL on: schedule: - cron: "30 22 * * 4" permissions: contents: read jobs: analyze: name: Analyze runs-on: ubuntu-latest permissions: actions: read contents: read security-events: write strategy: fail-fast: false matrix: language: [python] steps: - name: Checkout repository uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: persist-credentials: false - name: Initialize CodeQL uses: github/codeql-action/init@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6 with: languages: ${{ matrix.language }} - name: Autobuild uses: github/codeql-action/autobuild@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6 - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6 python-attrs-attrs-61c0e09/.github/workflows/codspeed.yml 0000664 0000000 0000000 00000002154 15157001312 0023555 0 ustar 00root root 0000000 0000000 --- name: CodSpeed Benchmarks on: push: branches: [main] tags: ["*"] paths: - src/**.py - bench/** - .github/workflows/codspeed.yml pull_request: paths: - src/**.py - bench/** - .github/workflows/codspeed.yml workflow_dispatch: env: FORCE_COLOR: "1" PIP_DISABLE_PIP_VERSION_CHECK: "1" PIP_NO_PYTHON_VERSION_WARNING: "1" permissions: {} jobs: codspeed: name: Run CodSpeed benchmarks runs-on: ubuntu-latest steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: persist-credentials: false - uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0 with: python-version-file: .python-version-default - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - name: Run CodSpeed benchmarks uses: CodSpeedHQ/action@281164b0f014a4e7badd2c02cecad9b595b70537 # v4.11.1 with: mode: simulation token: ${{ secrets.CODSPEED_TOKEN }} run: uvx --with tox-uv tox run -e codspeed python-attrs-attrs-61c0e09/.github/workflows/pinact.yml 0000664 0000000 0000000 00000000676 15157001312 0023254 0 ustar 00root root 0000000 0000000 --- name: Pinact on: schedule: - cron: "30 22 * * 4" workflow_dispatch: permissions: {} jobs: pinact: runs-on: ubuntu-latest permissions: contents: write steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: persist-credentials: false - name: Pin actions uses: suzuki-shunsuke/pinact-action@1081f5ad49ac904b7d977784f338145150a32112 # v1.4.0 python-attrs-attrs-61c0e09/.github/workflows/pypi-package.yml 0000664 0000000 0000000 00000004272 15157001312 0024344 0 ustar 00root root 0000000 0000000 --- name: Build & upload PyPI package on: push: branches: [main] tags: ["*"] release: types: - published workflow_dispatch: jobs: # Always build & lint package. build-package: name: Build & verify package runs-on: ubuntu-latest permissions: attestations: write id-token: write steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 persist-credentials: false - uses: hynek/build-and-inspect-python-package@efb823f52190ad02594531168b7a2d5790e66516 # v2.14.0 with: attest-build-provenance-github: 'true' # Upload to Test PyPI on every commit on main. release-test-pypi: name: Publish in-dev package to test.pypi.org environment: release-test-pypi if: github.repository_owner == 'python-attrs' && github.event_name == 'push' && github.ref == 'refs/heads/main' runs-on: ubuntu-latest needs: build-package permissions: id-token: write steps: - name: Download packages built by build-and-inspect-python-package uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: Packages path: dist - name: Upload package to Test PyPI uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0 with: attestations: true repository-url: https://test.pypi.org/legacy/ # Upload to real PyPI on GitHub Releases. release-pypi: name: Publish released package to pypi.org environment: release-pypi if: github.repository_owner == 'python-attrs' && github.event.action == 'published' runs-on: ubuntu-latest needs: build-package permissions: id-token: write steps: - name: Download packages built by build-and-inspect-python-package uses: actions/download-artifact@70fc10c6e5e1ce46ad2ea6f2b72d43f7d47b13c3 # v8.0.0 with: name: Packages path: dist - name: Upload package to PyPI uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0 with: attestations: true python-attrs-attrs-61c0e09/.github/workflows/zizmor.yml 0000664 0000000 0000000 00000002071 15157001312 0023317 0 ustar 00root root 0000000 0000000 # https://github.com/woodruffw/zizmor name: Zizmor on: push: branches: ["main"] pull_request: branches: ["*"] permissions: contents: read jobs: zizmor: name: Zizmor latest via PyPI runs-on: ubuntu-latest permissions: security-events: write steps: - name: Checkout repository uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: persist-credentials: false - uses: hynek/setup-cached-uv@757bedc3f972eb7227a1aa657651f15a8527c817 # v2.3.0 - name: Run zizmor 🌈 run: uvx zizmor --format sarif . > results.sarif env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Upload SARIF file uses: github/codeql-action/upload-sarif@0d579ffd059c29b07949a3cce3983f0780820c98 # v4.32.6 with: # Path to SARIF file relative to the root of the repository sarif_file: results.sarif # Optional category for the results # Used to differentiate multiple results for one commit category: zizmor python-attrs-attrs-61c0e09/.gitignore 0000664 0000000 0000000 00000000277 15157001312 0017643 0 ustar 00root root 0000000 0000000 *.egg-info *.pyc .DS_Store .cache .coverage* .direnv .envrc .hypothesis .mypy_cache .pytest_cache .tox .vscode .venv* build dist docs/_build htmlcov tmp* attrs.docset attrs.tgz Justfile t.py python-attrs-attrs-61c0e09/.pre-commit-config.yaml 0000664 0000000 0000000 00000001735 15157001312 0022134 0 ustar 00root root 0000000 0000000 --- ci: autoupdate_schedule: monthly repos: - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.15.6 hooks: - id: ruff-check args: [--fix, --exit-non-zero-on-fix] - id: ruff-format - repo: https://github.com/econchick/interrogate rev: 1.7.0 hooks: - id: interrogate args: [tests] - repo: https://github.com/codespell-project/codespell rev: v2.4.2 hooks: - id: codespell args: [--exclude-file=tests/test_mypy.yml, --skip=*.svg] - repo: https://github.com/abravalheri/validate-pyproject rev: v0.25 hooks: - id: validate-pyproject # Optional extra validations from SchemaStore: additional_dependencies: ["validate-pyproject-schema-store[all]"] - repo: https://github.com/pre-commit/pre-commit-hooks rev: v6.0.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer exclude: docs/_static - id: check-toml - id: check-yaml python-attrs-attrs-61c0e09/.python-version-default 0000664 0000000 0000000 00000000005 15157001312 0022267 0 ustar 00root root 0000000 0000000 3.14 python-attrs-attrs-61c0e09/.readthedocs.yaml 0000664 0000000 0000000 00000000735 15157001312 0021101 0 ustar 00root root 0000000 0000000 --- version: 2 build: os: ubuntu-lts-latest tools: # Keep version in sync with tox.ini/docs. python: "3.13" jobs: create_environment: # Need the tags to calculate the version (sometimes). - git fetch --tags - asdf plugin add uv - asdf install uv latest - asdf global uv latest build: html: - uvx --with tox-uv tox run -e docs-sponsors - uvx --with tox-uv tox run -e docs-build -- $READTHEDOCS_OUTPUT python-attrs-attrs-61c0e09/CHANGELOG.md 0000664 0000000 0000000 00000214251 15157001312 0017463 0 ustar 00root root 0000000 0000000 # Changelog Versions follow [Calendar Versioning](https://calver.org) with a strict backwards-compatibility policy. The **first number** of the version is the year. The **second number** is incremented with each release, starting at 1 for each year. The **third number** is when we need to start branches for older releases (only for emergencies). You can find our backwards-compatibility policy [here](https://github.com/python-attrs/attrs/blob/main/.github/SECURITY.md). Changes for the upcoming release can be found in the [`changelog.d` directory](https://github.com/python-attrs/attrs/tree/main/changelog.d) in our repository. ## [26.1.0](https://github.com/python-attrs/attrs/tree/26.1.0) - 2026-03-19 ### Backwards-incompatible Changes - Field aliases are now resolved *before* calling `field_transformer`, so transformers receive fully populated `Attribute` objects with usable `alias` values instead of `None`. The new `Attribute.alias_is_default` flag indicates whether the alias was auto-generated (`True`) or explicitly set by the user (`False`). [#1509](https://github.com/python-attrs/attrs/issues/1509) ### Changes - Fix type annotations for `attrs.validators.optional()`, so it no longer rejects tuples with more than one validator. [#1496](https://github.com/python-attrs/attrs/issues/1496) - The `attrs.validators.disabled()` contextmanager can now be nested. [#1513](https://github.com/python-attrs/attrs/issues/1513) - Frozen classes can set `on_setattr=attrs.setters.NO_OP` in addition to `None`. [#1515](https://github.com/python-attrs/attrs/issues/1515) - It's now possible to pass *attrs* **instances** in addition to *attrs* **classes** to `attrs.fields()`. [#1529](https://github.com/python-attrs/attrs/issues/1529) ## [25.4.0](https://github.com/python-attrs/attrs/tree/25.4.0) - 2025-10-06 ### Backwards-incompatible Changes - Class-level `kw_only=True` behavior is now consistent with `dataclasses`. Previously, a class that sets `kw_only=True` makes all attributes keyword-only, including those from base classes. If an attribute sets `kw_only=False`, that setting is ignored, and it is still made keyword-only. Now, only the attributes defined in that class that doesn't explicitly set `kw_only=False` are made keyword-only. This shouldn't be a problem for most users, unless you have a pattern like this: ```python @attrs.define(kw_only=True) class Base: a: int b: int = attrs.field(default=1, kw_only=False) @attrs.define class Subclass(Base): c: int ``` Here, we have a `kw_only=True` *attrs* class (`Base`) with an attribute that sets `kw_only=False` and has a default (`Base.b`), and then create a subclass (`Subclass`) with required arguments (`Subclass.c`). Previously this would work, since it would make `Base.b` keyword-only, but now this fails since `Base.b` is positional, and we have a required positional argument (`Subclass.c`) following another argument with defaults. [#1457](https://github.com/python-attrs/attrs/issues/1457) ### Changes - Values passed to the `__init__()` method of `attrs` classes are now correctly passed to `__attrs_pre_init__()` instead of their default values (in cases where *kw_only* was not specified). [#1427](https://github.com/python-attrs/attrs/issues/1427) - Added support for Python 3.14 and [PEP 749](https://peps.python.org/pep-0749/). [#1446](https://github.com/python-attrs/attrs/issues/1446), [#1451](https://github.com/python-attrs/attrs/issues/1451) - `attrs.validators.deep_mapping()` now allows to leave out either *key_validator* xor *value_validator*. [#1448](https://github.com/python-attrs/attrs/issues/1448) - `attrs.validators.deep_iterator()` and `attrs.validators.deep_mapping()` now accept lists and tuples for all validators and wrap them into a `attrs.validators.and_()`. [#1449](https://github.com/python-attrs/attrs/issues/1449) - Added a new **experimental** way to inspect classes: `attrs.inspect(cls)` returns the _effective_ class-wide parameters that were used by *attrs* to construct the class. The returned class is the same data structure that *attrs* uses internally to decide how to construct the final class. [#1454](https://github.com/python-attrs/attrs/issues/1454) - Fixed annotations for `attrs.field(converter=...)`. Previously, a `tuple` of converters was only accepted if it had exactly one element. [#1461](https://github.com/python-attrs/attrs/issues/1461) - The performance of `attrs.asdict()` has been improved by 45–260%. [#1463](https://github.com/python-attrs/attrs/issues/1463) - The performance of `attrs.astuple()` has been improved by 49–270%. [#1469](https://github.com/python-attrs/attrs/issues/1469) - The type annotation for `attrs.validators.or_()` now allows for different types of validators. This was only an issue on Pyright. [#1474](https://github.com/python-attrs/attrs/issues/1474) ## [25.3.0](https://github.com/python-attrs/attrs/tree/25.3.0) - 2025-03-13 ### Changes - Restore support for generator-based `field_transformer`s. [#1417](https://github.com/python-attrs/attrs/issues/1417) ## [25.2.0](https://github.com/python-attrs/attrs/tree/25.2.0) - 2025-03-12 ### Changes - Checking mandatory vs non-mandatory attribute order is now performed after the field transformer, since the field transformer may change attributes and/or their order. [#1147](https://github.com/python-attrs/attrs/issues/1147) - `attrs.make_class()` now allows for Unicode class names. [#1406](https://github.com/python-attrs/attrs/issues/1406) - Speed up class creation by 30%-50% by compiling methods only once and using a variety of other techniques. [#1407](https://github.com/python-attrs/attrs/issues/1407) - The error message if an attribute has both an annotation and a type argument will now disclose _what_ attribute seems to be the problem. [#1410](https://github.com/python-attrs/attrs/issues/1410) ## [25.1.0](https://github.com/python-attrs/attrs/tree/25.1.0) - 2025-01-25 ### Changes - This release only ensures correct PyPI licensing metadata. [#1386](https://github.com/python-attrs/attrs/issues/1386) ## [24.3.0](https://github.com/python-attrs/attrs/tree/24.3.0) - 2024-12-16 ### Backwards-incompatible Changes - Python 3.7 has been dropped. [#1340](https://github.com/python-attrs/attrs/issues/1340) ### Changes - Introduce `attrs.NothingType`, for annotating types consistent with `attrs.NOTHING`. [#1358](https://github.com/python-attrs/attrs/issues/1358) - Allow mutating `__suppress_context__` and `__notes__` on frozen exceptions. [#1365](https://github.com/python-attrs/attrs/issues/1365) - `attrs.converters.optional()` works again when taking `attrs.converters.pipe()` or another Converter as its argument. [#1372](https://github.com/python-attrs/attrs/issues/1372) - *attrs* instances now support [`copy.replace()`](https://docs.python.org/3/library/copy.html#copy.replace). [#1383](https://github.com/python-attrs/attrs/issues/1383) - `attrs.validators.instance_of()`'s type hints now allow for union types. For example: `instance_of(str | int)` [#1385](https://github.com/python-attrs/attrs/issues/1385) ## [24.2.0](https://github.com/python-attrs/attrs/tree/24.2.0) - 2024-08-06 ### Deprecations - Given the amount of warnings raised in the broader ecosystem, we've decided to only soft-deprecate the *hash* argument to `@define` / `@attr.s`. Please don't use it in new code, but we don't intend to remove it anymore. [#1330](https://github.com/python-attrs/attrs/issues/1330) ### Changes - `attrs.converters.pipe()` (and its syntactic sugar of passing a list for `attrs.field()`'s / `attr.ib()`'s *converter* argument) works again when passing `attrs.setters.convert` to *on_setattr* (which is default for `attrs.define`). [#1328](https://github.com/python-attrs/attrs/issues/1328) - Restored support for PEP [649](https://peps.python.org/pep-0649/) / [749](https://peps.python.org/pep-0749/)-implementing Pythons -- currently 3.14-dev. [#1329](https://github.com/python-attrs/attrs/issues/1329) ## [24.1.0](https://github.com/python-attrs/attrs/tree/24.1.0) - 2024-08-03 ### Backwards-incompatible Changes - `attrs.evolve()` doesn't accept the *inst* argument as a keyword argument anymore. Pass it as the first positional argument instead. [#1264](https://github.com/python-attrs/attrs/issues/1264) - `attrs.validators.provides()` has been removed. The removed code is available as a [gist](https://gist.github.com/hynek/9eaaaeb659808f3519870dfa16d2b6b2) for convenient copy and pasting. [#1265](https://github.com/python-attrs/attrs/issues/1265) - All packaging metadata except from `__version__` and `__version_info__` has been removed from the `attr` and `attrs` modules (for example, `attrs.__url__`). Please use [`importlib.metadata`](https://docs.python.org/3/library/importlib.metadata.html) or [*importlib-metadata*](https://pypi.org/project/importlib-metadata/) instead. [#1268](https://github.com/python-attrs/attrs/issues/1268) - The generated `__eq__` methods have been sped up significantly by generating a chain of attribute comparisons instead of constructing and comparing tuples. This change arguably makes the behavior more correct, but changes it if an attribute compares equal by identity but not value, like `float('nan')`. [#1310](https://github.com/python-attrs/attrs/issues/1310) ### Deprecations - The *repr_ns* argument to `attr.s` is now deprecated. It was a workaround for nested classes in Python 2 and is pointless in Python 3. [#1263](https://github.com/python-attrs/attrs/issues/1263) - The *hash* argument to `@attr.s`, `@attrs.define`, and `make_class()` is now deprecated in favor of *unsafe_hash*, as defined by PEP 681. [#1323](https://github.com/python-attrs/attrs/issues/1323) ### Changes - Allow original slotted `functools.cached_property` classes to be cleaned by garbage collection. Allow `super()` calls in slotted cached properties. [#1221](https://github.com/python-attrs/attrs/issues/1221) - Our type stubs now use modern type notation and are organized such that VS Code's quick-fix prefers the `attrs` namespace. [#1234](https://github.com/python-attrs/attrs/issues/1234) - Preserve `AttributeError` raised by properties of slotted classes with `functools.cached_properties`. [#1253](https://github.com/python-attrs/attrs/issues/1253) - It is now possible to wrap a converter into an `attrs.Converter` and get the current instance and/or the current field definition passed into the converter callable. Note that this is not supported by any type checker, yet. [#1267](https://github.com/python-attrs/attrs/issues/1267) - `attrs.make_class()` now populates the `__annotations__` dict of the generated class, so that `attrs.resolve_types()` can resolve them. [#1285](https://github.com/python-attrs/attrs/issues/1285) - Added the `attrs.validators.or_()` validator. [#1303](https://github.com/python-attrs/attrs/issues/1303) - The combination of a `__attrs_pre_init__` that takes arguments, a kw-only field, and a default on that field does not crash anymore. [#1319](https://github.com/python-attrs/attrs/issues/1319) - `attrs.validators.in_()` now transforms certain unhashable options to tuples to keep the field hashable. This allows fields that use this validator to be used with, for example, `attrs.filters.include()`. [#1320](https://github.com/python-attrs/attrs/issues/1320) - If a class has an *inherited* method called `__attrs_init_subclass__`, it is now called once the class is done assembling. This is a replacement for Python's `__init_subclass__` and useful for registering classes, and similar. [#1321](https://github.com/python-attrs/attrs/issues/1321) ## [23.2.0](https://github.com/python-attrs/attrs/tree/23.2.0) - 2023-12-31 ### Changes - The type annotation for `attrs.resolve_types()` is now correct. [#1141](https://github.com/python-attrs/attrs/issues/1141) - Type stubs now use `typing.dataclass_transform` to decorate dataclass-like decorators, instead of the non-standard `__dataclass_transform__` special form, which is only supported by Pyright. [#1158](https://github.com/python-attrs/attrs/issues/1158) - Fixed serialization of namedtuple fields using `attrs.asdict/astuple()` with `retain_collection_types=True`. [#1165](https://github.com/python-attrs/attrs/issues/1165) - `attrs.AttrsInstance` is now a `typing.Protocol` in both type hints and code. This allows you to subclass it along with another `Protocol`. [#1172](https://github.com/python-attrs/attrs/issues/1172) - If *attrs* detects that `__attrs_pre_init__` accepts more than just `self`, it will call it with the same arguments as `__init__` was called. This allows you to, for example, pass arguments to `super().__init__()`. [#1187](https://github.com/python-attrs/attrs/issues/1187) - Slotted classes now transform `functools.cached_property` decorated methods to support equivalent semantics. [#1200](https://github.com/python-attrs/attrs/issues/1200) - Added *class_body* argument to `attrs.make_class()` to provide additional attributes for newly created classes. It is, for example, now possible to attach methods. [#1203](https://github.com/python-attrs/attrs/issues/1203) ## [23.1.0](https://github.com/python-attrs/attrs/tree/23.1.0) - 2023-04-16 ### Backwards-incompatible Changes - Python 3.6 has been dropped and packaging switched to static package data using [Hatch](https://hatch.pypa.io/latest/). [#993](https://github.com/python-attrs/attrs/issues/993) ### Deprecations - The support for *zope-interface* via the `attrs.validators.provides` validator is now deprecated and will be removed in, or after, April 2024. The presence of a C-based package in our development dependencies has caused headaches and we're not under the impression it's used a lot. Let us know if you're using it and we might publish it as a separate package. [#1120](https://github.com/python-attrs/attrs/issues/1120) ### Changes - `attrs.filters.exclude()` and `attrs.filters.include()` now support the passing of attribute names as strings. [#1068](https://github.com/python-attrs/attrs/issues/1068) - `attrs.has()` and `attrs.fields()` now handle generic classes correctly. [#1079](https://github.com/python-attrs/attrs/issues/1079) - Fix frozen exception classes when raised within, for example, `contextlib.contextmanager`, which mutates their `__traceback__` attributes. [#1081](https://github.com/python-attrs/attrs/issues/1081) - `@frozen` now works with type checkers that implement [PEP-681](https://peps.python.org/pep-0681/) (ex. [pyright](https://github.com/microsoft/pyright/)). [#1084](https://github.com/python-attrs/attrs/issues/1084) - Restored ability to unpickle instances pickled before 22.2.0. [#1085](https://github.com/python-attrs/attrs/issues/1085) - `attrs.asdict()`'s and `attrs.astuple()`'s type stubs now accept the `attrs.AttrsInstance` protocol. [#1090](https://github.com/python-attrs/attrs/issues/1090) - Fix slots class cellvar updating closure in CPython 3.8+ even when `__code__` introspection is unavailable. [#1092](https://github.com/python-attrs/attrs/issues/1092) - `attrs.resolve_types()` can now pass `include_extras` to `typing.get_type_hints()` on Python 3.9+, and does so by default. [#1099](https://github.com/python-attrs/attrs/issues/1099) - Added instructions for pull request workflow to `CONTRIBUTING.md`. [#1105](https://github.com/python-attrs/attrs/issues/1105) - Added *type* parameter to `attrs.field()` function for use with `attrs.make_class()`. Please note that type checkers ignore type metadata passed into `make_class()`, but it can be useful if you're wrapping _attrs_. [#1107](https://github.com/python-attrs/attrs/issues/1107) - It is now possible for `attrs.evolve()` (and `attr.evolve()`) to change fields named `inst` if the instance is passed as a positional argument. Passing the instance using the `inst` keyword argument is now deprecated and will be removed in, or after, April 2024. [#1117](https://github.com/python-attrs/attrs/issues/1117) - `attrs.validators.optional()` now also accepts a tuple of validators (in addition to lists of validators). [#1122](https://github.com/python-attrs/attrs/issues/1122) ## [22.2.0](https://github.com/python-attrs/attrs/tree/22.2.0) - 2022-12-21 ### Backwards-incompatible Changes - Python 3.5 is not supported anymore. [#988](https://github.com/python-attrs/attrs/issues/988) ### Deprecations - Python 3.6 is now deprecated and support will be removed in the next release. [#1017](https://github.com/python-attrs/attrs/issues/1017) ### Changes - `attrs.field()` now supports an *alias* option for explicit `__init__` argument names. Get `__init__` signatures matching any taste, peculiar or plain! The [PEP 681 compatible](https://peps.python.org/pep-0681/#field-specifier-parameters) *alias* option can be use to override private attribute name mangling, or add other arbitrary field argument name overrides. [#950](https://github.com/python-attrs/attrs/issues/950) - `attrs.NOTHING` is now an enum value, making it possible to use with, for example, [`typing.Literal`](https://docs.python.org/3/library/typing.html#typing.Literal). [#983](https://github.com/python-attrs/attrs/issues/983) - Added missing re-import of `attr.AttrsInstance` to the `attrs` namespace. [#987](https://github.com/python-attrs/attrs/issues/987) - Fix slight performance regression in classes with custom `__setattr__` and speedup even more. [#991](https://github.com/python-attrs/attrs/issues/991) - Class-creation performance improvements by switching performance-sensitive templating operations to f-strings. You can expect an improvement of about 5% -- even for very simple classes. [#995](https://github.com/python-attrs/attrs/issues/995) - `attrs.has()` is now a [`TypeGuard`](https://docs.python.org/3/library/typing.html#typing.TypeGuard) for `AttrsInstance`. That means that type checkers know a class is an instance of an `attrs` class if you check it using `attrs.has()` (or `attr.has()`) first. [#997](https://github.com/python-attrs/attrs/issues/997) - Made `attrs.AttrsInstance` stub available at runtime and fixed type errors related to the usage of `attrs.AttrsInstance` in Pyright. [#999](https://github.com/python-attrs/attrs/issues/999) - On Python 3.10 and later, call [`abc.update_abstractmethods()`](https://docs.python.org/3/library/abc.html#abc.update_abstractmethods) on dict classes after creation. This improves the detection of abstractness. [#1001](https://github.com/python-attrs/attrs/issues/1001) - *attrs*'s pickling methods now use dicts instead of tuples. That is safer and more robust across different versions of a class. [#1009](https://github.com/python-attrs/attrs/issues/1009) - Added `attrs.validators.not_(wrapped_validator)` to logically invert *wrapped_validator* by accepting only values where *wrapped_validator* rejects the value with a `ValueError` or `TypeError` (by default, exception types configurable). [#1010](https://github.com/python-attrs/attrs/issues/1010) - The type stubs for `attrs.cmp_using()` now have default values. [#1027](https://github.com/python-attrs/attrs/issues/1027) - To conform with [PEP 681](https://peps.python.org/pep-0681/), `attr.s()` and `attrs.define()` now accept *unsafe_hash* in addition to *hash*. [#1065](https://github.com/python-attrs/attrs/issues/1065) ## [22.1.0](https://github.com/python-attrs/attrs/tree/22.1.0) - 2022-07-28 ### Backwards-incompatible Changes - Python 2.7 is not supported anymore. Dealing with Python 2.7 tooling has become too difficult for a volunteer-run project. We have supported Python 2 more than 2 years after it was officially discontinued and feel that we have paid our dues. All version up to 21.4.0 from December 2021 remain fully functional, of course. [#936](https://github.com/python-attrs/attrs/issues/936) - The deprecated `cmp` attribute of `attrs.Attribute` has been removed. This does not affect the *cmp* argument to `attr.s` that can be used as a shortcut to set *eq* and *order* at the same time. [#939](https://github.com/python-attrs/attrs/issues/939) ### Changes - Instantiation of frozen slotted classes is now faster. [#898](https://github.com/python-attrs/attrs/issues/898) - If an `eq` key is defined, it is also used before hashing the attribute. [#909](https://github.com/python-attrs/attrs/issues/909) - Added `attrs.validators.min_len()`. [#916](https://github.com/python-attrs/attrs/issues/916) - `attrs.validators.deep_iterable()`'s *member_validator* argument now also accepts a list of validators and wraps them in an `attrs.validators.and_()`. [#925](https://github.com/python-attrs/attrs/issues/925) - Added missing type stub re-imports for `attrs.converters` and `attrs.filters`. [#931](https://github.com/python-attrs/attrs/issues/931) - Added missing stub for `attr(s).cmp_using()`. [#949](https://github.com/python-attrs/attrs/issues/949) - `attrs.validators._in()`'s `ValueError` is not missing the attribute, expected options, and the value it got anymore. [#951](https://github.com/python-attrs/attrs/issues/951) - Python 3.11 is now officially supported. [#969](https://github.com/python-attrs/attrs/issues/969) ## [21.4.0](https://github.com/python-attrs/attrs/tree/21.4.0) - 2021-12-29 ### Changes - Fixed the test suite on PyPy3.8 where `cloudpickle` does not work. [#892](https://github.com/python-attrs/attrs/issues/892) - Fixed `coverage report` for projects that use `attrs` and don't set a `--source`. [#895](https://github.com/python-attrs/attrs/issues/895), [#896](https://github.com/python-attrs/attrs/issues/896) ## [21.3.0](https://github.com/python-attrs/attrs/tree/21.3.0) - 2021-12-28 ### Backward-incompatible Changes - When using `@define`, converters are now run by default when setting an attribute on an instance -- additionally to validators. Meaning: the new default is `on_setattr=[attrs.setters.convert, attrs.setters.validate]`. This is unfortunately a breaking change, but it was an oversight, impossible to raise a `DeprecationWarning` about, and it's better to fix it now while the APIs are very fresh with few users. [#835](https://github.com/python-attrs/attrs/issues/835), [#886](https://github.com/python-attrs/attrs/issues/886) - `import attrs` has finally landed! As of this release, you can finally import `attrs` using its proper name. Not all names from the `attr` namespace have been transferred; most notably `attr.s` and `attr.ib` are missing. See `attrs.define` and `attrs.field` if you haven't seen our next-generation APIs yet. A more elaborate explanation can be found [On The Core API Names](https://www.attrs.org/en/latest/names.html) This feature is at least for one release **provisional**. We don't *plan* on changing anything, but such a big change is unlikely to go perfectly on the first strike. The API docs have been mostly updated, but it will be an ongoing effort to change everything to the new APIs. Please note that we have **not** moved -- or even removed -- anything from `attr`! Please do report any bugs or documentation inconsistencies! [#887](https://github.com/python-attrs/attrs/issues/887) ### Changes - `attr.asdict(retain_collection_types=False)` (default) dumps collection-esque keys as tuples. [#646](https://github.com/python-attrs/attrs/issues/646), [#888](https://github.com/python-attrs/attrs/issues/888) - `__match_args__` are now generated to support Python 3.10's [Structural Pattern Matching](https://docs.python.org/3.10/whatsnew/3.10.html#pep-634-structural-pattern-matching). This can be controlled by the `match_args` argument to the class decorators on Python 3.10 and later. On older versions, it is never added and the argument is ignored. [#815](https://github.com/python-attrs/attrs/issues/815) - If the class-level *on_setattr* is set to `attrs.setters.validate` (default in `@define` and `@mutable`) but no field defines a validator, pretend that it's not set. [#817](https://github.com/python-attrs/attrs/issues/817) - The generated `__repr__` is significantly faster on Pythons with f-strings. [#819](https://github.com/python-attrs/attrs/issues/819) - Attributes transformed via `field_transformer` are wrapped with `AttrsClass` again. [#824](https://github.com/python-attrs/attrs/issues/824) - Generated source code is now cached more efficiently for identical classes. [#828](https://github.com/python-attrs/attrs/issues/828) - Added `attrs.converters.to_bool()`. [#830](https://github.com/python-attrs/attrs/issues/830) - `attrs.resolve_types()` now resolves types of subclasses after the parents are resolved. [#842](https://github.com/python-attrs/attrs/issues/842) [#843](https://github.com/python-attrs/attrs/issues/843) - Added new validators: `lt(val)` (\< val), `le(va)` (≤ val), `ge(val)` (≥ val), `gt(val)` (> val), and `maxlen(n)`. [#845](https://github.com/python-attrs/attrs/issues/845) - `attrs` classes are now fully compatible with [cloudpickle](https://github.com/cloudpipe/cloudpickle) (no need to disable `repr` anymore). [#857](https://github.com/python-attrs/attrs/issues/857) - Added new context manager `attrs.validators.disabled()` and functions `attrs.validators.(set|get)_disabled()`. They deprecate `attrs.(set|get)_run_validators()`. All functions are interoperable and modify the same internal state. They are not – and never were – thread-safe, though. [#859](https://github.com/python-attrs/attrs/issues/859) - `attrs.validators.matches_re()` now accepts pre-compiled regular expressions in addition to pattern strings. [#877](https://github.com/python-attrs/attrs/issues/877) --- ## [21.2.0](https://github.com/python-attrs/attrs/tree/21.2.0) - 2021-05-07 ### Backward-incompatible Changes - We had to revert the recursive feature for `attr.evolve()` because it broke some use-cases -- sorry! [#806](https://github.com/python-attrs/attrs/issues/806) - Python 3.4 is now blocked using packaging metadata because `attrs` can't be imported on it anymore. To ensure that 3.4 users can keep installing `attrs` easily, we will [yank](https://pypi.org/help/#yanked) 21.1.0 from PyPI. This has **no** consequences if you pin `attrs` to 21.1.0. [#807](https://github.com/python-attrs/attrs/issues/807) ## [21.1.0](https://github.com/python-attrs/attrs/tree/21.1.0) - 2021-05-06 ### Deprecations - The long-awaited, much-talked-about, little-delivered `import attrs` is finally upon us! Since the NG APIs have now been proclaimed stable, the **next** release of `attrs` will allow you to actually `import attrs`. We're taking this opportunity to replace some defaults in our APIs that made sense in 2015, but don't in 2021. So please, if you have any pet peeves about defaults in `attrs`'s APIs, *now* is the time to air your grievances in #487! We're not gonna get such a chance for a second time, without breaking our backward-compatibility guarantees, or long deprecation cycles. Therefore, speak now or forever hold you peace! [#487](https://github.com/python-attrs/attrs/issues/487) - The *cmp* argument to `attr.s()` and `attr.ib()` has been **undeprecated** It will continue to be supported as syntactic sugar to set *eq* and *order* in one go. I'm terribly sorry for the hassle around this argument! The reason we're bringing it back is it's usefulness regarding customization of equality/ordering. The `cmp` attribute and argument on `attr.Attribute` remains deprecated and will be removed later this year. [#773](https://github.com/python-attrs/attrs/issues/773) ### Changes - It's now possible to customize the behavior of `eq` and `order` by passing in a callable. [#435](https://github.com/python-attrs/attrs/issues/435), [#627](https://github.com/python-attrs/attrs/issues/627) - The instant favorite next-generation APIs are not provisional anymore! They are also officially supported by Mypy as of their [0.800 release](https://mypy-lang.blogspot.com/2021/01/mypy-0800-released.html). We hope the next release will already contain an (additional) importable package called `attrs`. [#668](https://github.com/python-attrs/attrs/issues/668), [#786](https://github.com/python-attrs/attrs/issues/786) - If an attribute defines a converter, the type of its parameter is used as type annotation for its corresponding `__init__` parameter. If an `attr.converters.pipe` is used, the first one's is used. [#710](https://github.com/python-attrs/attrs/issues/710) - Fixed the creation of an extra slot for an `attr.ib` when the parent class already has a slot with the same name. [#718](https://github.com/python-attrs/attrs/issues/718) - `__attrs__init__()` will now be injected if `init=False`, or if `auto_detect=True` and a user-defined `__init__()` exists. This enables users to do "pre-init" work in their `__init__()` (such as `super().__init__()`). `__init__()` can then delegate constructor argument processing to `self.__attrs_init__(*args, **kwargs)`. [#731](https://github.com/python-attrs/attrs/issues/731) - `bool(attr.NOTHING)` is now `False`. [#732](https://github.com/python-attrs/attrs/issues/732) - It's now possible to use `super()` inside of properties of slotted classes. [#747](https://github.com/python-attrs/attrs/issues/747) - Allow for a `__attrs_pre_init__()` method that -- if defined -- will get called at the beginning of the `attrs`-generated `__init__()` method. [#750](https://github.com/python-attrs/attrs/issues/750) - Added forgotten `attr.Attribute.evolve()` to type stubs. [#752](https://github.com/python-attrs/attrs/issues/752) - `attrs.evolve()` now works recursively with nested `attrs` classes. [#759](https://github.com/python-attrs/attrs/issues/759) - Python 3.10 is now officially supported. [#763](https://github.com/python-attrs/attrs/issues/763) - `attr.resolve_types()` now takes an optional *attrib* argument to work inside a `field_transformer`. [#774](https://github.com/python-attrs/attrs/issues/774) - `ClassVar`s are now also detected if they come from [typing-extensions](https://pypi.org/project/typing-extensions/). [#782](https://github.com/python-attrs/attrs/issues/782) - To make it easier to customize attribute comparison (#435), we have added the `attr.cmp_with()` helper. See the [new docs on comparison](https://www.attrs.org/en/stable/comparison.html) for more details. [#787](https://github.com/python-attrs/attrs/issues/787) - Added **provisional** support for static typing in `pyright` via [PEP 681](https://peps.python.org/pep-0681/). Both the `pyright` specification and `attrs` implementation may change in future versions of both projects. Your constructive feedback is welcome in both [attrs#795](https://github.com/python-attrs/attrs/issues/795) and [pyright#1782](https://github.com/microsoft/pyright/discussions/1782). [#796](https://github.com/python-attrs/attrs/issues/796) ## [20.3.0](https://github.com/python-attrs/attrs/tree/20.3.0) - 2020-11-05 ### Backward-incompatible Changes - `attr.define()`, `attr.frozen()`, `attr.mutable()`, and `attr.field()` remain **provisional**. This release does **not** change anything about them and they are already used widely in production though. If you wish to use them together with mypy, you can simply drop [this plugin](https://gist.github.com/hynek/1e3844d0c99e479e716169034b5fa963#file-attrs_ng_plugin-py) into your project. Feel free to provide feedback to them in the linked issue #668. We will release the `attrs` namespace once we have the feeling that the APIs have properly settled. [#668](https://github.com/python-attrs/attrs/issues/668) ### Changes - `attr.s()` now has a *field_transformer* hook that is called for all `Attribute`s and returns a (modified or updated) list of `Attribute` instances. `attr.asdict()` has a *value_serializer* hook that can change the way values are converted. Both hooks are meant to help with data (de-)serialization workflows. [#653](https://github.com/python-attrs/attrs/issues/653) - `kw_only=True` now works on Python 2. [#700](https://github.com/python-attrs/attrs/issues/700) - `raise from` now works on frozen classes on PyPy. [#703](https://github.com/python-attrs/attrs/issues/703), [#712](https://github.com/python-attrs/attrs/issues/712) - `attr.asdict()` and `attr.astuple()` now treat `frozenset`s like `set`s with regards to the *retain_collection_types* argument. [#704](https://github.com/python-attrs/attrs/issues/704) - The type stubs for `attr.s()` and `attr.make_class()` are not missing the *collect_by_mro* argument anymore. [#711](https://github.com/python-attrs/attrs/issues/711) --- ## [20.2.0](https://github.com/python-attrs/attrs/tree/20.2.0) - 2020-09-05 ### Backward-incompatible Changes - `attr.define()`, `attr.frozen()`, `attr.mutable()`, and `attr.field()` remain **provisional**. This release fixes a bunch of bugs and ergonomics but they remain mostly unchanged. If you wish to use them together with mypy, you can simply drop [this plugin](https://gist.github.com/hynek/1e3844d0c99e479e716169034b5fa963#file-attrs_ng_plugin-py) into your project. Feel free to provide feedback to them in the linked issue #668. We will release the `attrs` namespace once we have the feeling that the APIs have properly settled. [#668](https://github.com/python-attrs/attrs/issues/668) ### Changes - `attr.define()` et al now correctly detect `__eq__` and `__ne__`. [#671](https://github.com/python-attrs/attrs/issues/671) - `attr.define()` et al's hybrid behavior now also works correctly when arguments are passed. [#675](https://github.com/python-attrs/attrs/issues/675) - It's possible to define custom `__setattr__` methods on slotted classes again. [#681](https://github.com/python-attrs/attrs/issues/681) - In 20.1.0 we introduced the `inherited` attribute on the `attr.Attribute` class to differentiate attributes that have been inherited and those that have been defined directly on the class. It has shown to be problematic to involve that attribute when comparing instances of `attr.Attribute` though, because when sub-classing, attributes from base classes are suddenly not equal to themselves in a super class. Therefore the `inherited` attribute will now be ignored when hashing and comparing instances of `attr.Attribute`. [#684](https://github.com/python-attrs/attrs/issues/684) - `zope.interface` is now a "soft dependency" when running the test suite; if `zope.interface` is not installed when running the test suite, the interface-related tests will be automatically skipped. [#685](https://github.com/python-attrs/attrs/issues/685) - The ergonomics of creating frozen classes using `@define(frozen=True)` and sub-classing frozen classes has been improved: you don't have to set `on_setattr=None` anymore. [#687](https://github.com/python-attrs/attrs/issues/687) --- ## [20.1.0](https://github.com/python-attrs/attrs/tree/20.1.0) - 2020-08-20 ### Backward-incompatible Changes - Python 3.4 is not supported anymore. It has been unsupported by the Python core team for a while now, its PyPI downloads are negligible, and our CI provider removed it as a supported option. It's very unlikely that `attrs` will break under 3.4 anytime soon, which is why we do *not* block its installation on Python 3.4. But we don't test it anymore and will block it once someone reports breakage. [#608](https://github.com/python-attrs/attrs/issues/608) ### Deprecations - Less of a deprecation and more of a heads up: the next release of `attrs` will introduce an `attrs` namespace. That means that you'll finally be able to run `import attrs` with new functions that aren't cute abbreviations and that will carry better defaults. This should not break any of your code, because project-local packages have priority before installed ones. If this is a problem for you for some reason, please report it to our bug tracker and we'll figure something out. The old `attr` namespace isn't going anywhere and its defaults are not changing – this is a purely additive measure. Please check out the linked issue for more details. These new APIs have been added *provisionally* as part of #666 so you can try them out today and provide feedback. Learn more in the [API docs](https://www.attrs.org/en/stable/api.html). [#408](https://github.com/python-attrs/attrs/issues/408) ### Changes - Added `attr.resolve_types()`. It ensures that all forward-references and types in string form are resolved into concrete types. You need this only if you need concrete types at runtime. That means that if you only use types for static type checking, you do **not** need this function. [#288](https://github.com/python-attrs/attrs/issues/288), [#302](https://github.com/python-attrs/attrs/issues/302) - Added `@attr.s(collect_by_mro=False)` argument that if set to `True` fixes the collection of attributes from base classes. It's only necessary for certain cases of multiple-inheritance but is kept off for now for backward-compatibility reasons. It will be turned on by default in the future. As a side-effect, `attr.Attribute` now *always* has an `inherited` attribute indicating whether an attribute on a class was directly defined or inherited. [#428](https://github.com/python-attrs/attrs/issues/428), [#635](https://github.com/python-attrs/attrs/issues/635) - On Python 3, all generated methods now have a docstring explaining that they have been created by `attrs`. [#506](https://github.com/python-attrs/attrs/issues/506) - It is now possible to prevent `attrs` from auto-generating the `__setstate__` and `__getstate__` methods that are required for pickling of slotted classes. Either pass `@attr.s(getstate_setstate=False)` or pass `@attr.s(auto_detect=True)` and implement them yourself: if `attrs` finds either of the two methods directly on the decorated class, it assumes implicitly `getstate_setstate=False` (and implements neither). This option works with dict classes but should never be necessary. [#512](https://github.com/python-attrs/attrs/issues/512), [#513](https://github.com/python-attrs/attrs/issues/513), [#642](https://github.com/python-attrs/attrs/issues/642) - Fixed a `ValueError: Cell is empty` bug that could happen in some rare edge cases. [#590](https://github.com/python-attrs/attrs/issues/590) - `attrs` can now automatically detect your own implementations and infer `init=False`, `repr=False`, `eq=False`, `order=False`, and `hash=False` if you set `@attr.s(auto_detect=True)`. `attrs` will ignore inherited methods. If the argument implies more than one method (for example, `eq=True` creates both `__eq__` and `__ne__`), it's enough for *one* of them to exist and `attrs` will create *neither*. This feature requires Python 3. [#607](https://github.com/python-attrs/attrs/issues/607) - Added `attr.converters.pipe()`. The feature allows combining multiple conversion callbacks into one by piping the value through all of them, and retuning the last result. As part of this feature, we had to relax the type information for converter callables. [#618](https://github.com/python-attrs/attrs/issues/618) - Fixed serialization behavior of non-slots classes with `cache_hash=True`. The hash cache will be cleared on operations which make "deep copies" of instances of classes with hash caching, though the cache will not be cleared with shallow copies like those made by `copy.copy()`. Previously, `copy.deepcopy()` or serialization and deserialization with `pickle` would result in an un-initialized object. This change also allows the creation of `cache_hash=True` classes with a custom `__setstate__`, which was previously forbidden ([#494](https://github.com/python-attrs/attrs/issues/494)). [#620](https://github.com/python-attrs/attrs/issues/620) - It is now possible to specify hooks that are called whenever an attribute is set **after** a class has been instantiated. You can pass `on_setattr` both to `@attr.s()` to set the default for all attributes on a class, and to `@attr.ib()` to overwrite it for individual attributes. `attrs` also comes with a new module `attr.setters` that brings helpers that run validators, converters, or allow to freeze a subset of attributes. [#645](https://github.com/python-attrs/attrs/issues/645), [#660](https://github.com/python-attrs/attrs/issues/660) - **Provisional** APIs called `attr.define()`, `attr.mutable()`, and `attr.frozen()` have been added. They are only available on Python 3.6 and later, and call `attr.s()` with different default values. If nothing comes up, they will become the official way for creating classes in 20.2.0 (see above). **Please note** that it may take some time until mypy – and other tools that have dedicated support for `attrs` – recognize these new APIs. Please **do not** open issues on our bug tracker, there is nothing we can do about it. [#666](https://github.com/python-attrs/attrs/issues/666) - We have also provisionally added `attr.field()` that supplants `attr.ib()`. It also requires at least Python 3.6 and is keyword-only. Other than that, it only dropped a few arguments, but changed no defaults. As with `attr.s()`: `attr.ib()` is not going anywhere. [#669](https://github.com/python-attrs/attrs/issues/669) --- ## [19.3.0](https://github.com/python-attrs/attrs/tree/19.3.0) - 2019-10-15 ### Changes - Fixed `auto_attribs` usage when default values cannot be compared directly with `==`, such as `numpy` arrays. [#585](https://github.com/python-attrs/attrs/issues/585) --- ## [19.2.0](https://github.com/python-attrs/attrs/tree/19.2.0) - 2019-10-01 ### Backward-incompatible Changes - Removed deprecated `Attribute` attribute `convert` per scheduled removal on 2019/1. This planned deprecation is tracked in issue [#307](https://github.com/python-attrs/attrs/issues/307). [#504](https://github.com/python-attrs/attrs/issues/504) - `__lt__`, `__le__`, `__gt__`, and `__ge__` do not consider subclasses comparable anymore. This has been deprecated since 18.2.0 and was raising a `DeprecationWarning` for over a year. [#570](https://github.com/python-attrs/attrs/issues/570) ### Deprecations - The `cmp` argument to `attr.s()` and `attr.ib()` is now deprecated. Please use `eq` to add equality methods (`__eq__` and `__ne__`) and `order` to add ordering methods (`__lt__`, `__le__`, `__gt__`, and `__ge__`) instead – just like with [dataclasses](https://docs.python.org/3/library/dataclasses.html). Both are effectively `True` by default but it's enough to set `eq=False` to disable both at once. Passing `eq=False, order=True` explicitly will raise a `ValueError` though. Since this is arguably a deeper backward-compatibility break, it will have an extended deprecation period until 2021-06-01. After that day, the `cmp` argument will be removed. `attr.Attribute` also isn't orderable anymore. [#574](https://github.com/python-attrs/attrs/issues/574) ### Changes - Updated `attr.validators.__all__` to include new validators added in [#425]. [#517](https://github.com/python-attrs/attrs/issues/517) - Slotted classes now use a pure Python mechanism to rewrite the `__class__` cell when rebuilding the class, so `super()` works even on environments where `ctypes` is not installed. [#522](https://github.com/python-attrs/attrs/issues/522) - When collecting attributes using `@attr.s(auto_attribs=True)`, attributes with a default of `None` are now deleted too. [#523](https://github.com/python-attrs/attrs/issues/523), [#556](https://github.com/python-attrs/attrs/issues/556) - Fixed `attr.validators.deep_iterable()` and `attr.validators.deep_mapping()` type stubs. [#533](https://github.com/python-attrs/attrs/issues/533) - `attr.validators.is_callable()` validator now raises an exception `attr.exceptions.NotCallableError`, a subclass of `TypeError`, informing the received value. [#536](https://github.com/python-attrs/attrs/issues/536) - `@attr.s(auto_exc=True)` now generates classes that are hashable by ID, as the documentation always claimed it would. [#543](https://github.com/python-attrs/attrs/issues/543), [#563](https://github.com/python-attrs/attrs/issues/563) - Added `attr.validators.matches_re()` that checks string attributes whether they match a regular expression. [#552](https://github.com/python-attrs/attrs/issues/552) - Keyword-only attributes (`kw_only=True`) and attributes that are excluded from the `attrs`'s `__init__` (`init=False`) now can appear before mandatory attributes. [#559](https://github.com/python-attrs/attrs/issues/559) - The fake filename for generated methods is now more stable. It won't change when you restart the process. [#560](https://github.com/python-attrs/attrs/issues/560) - The value passed to `@attr.ib(repr=…)` can now be either a boolean (as before) or a callable. That callable must return a string and is then used for formatting the attribute by the generated `__repr__()` method. [#568](https://github.com/python-attrs/attrs/issues/568) - Added `attr.__version_info__` that can be used to reliably check the version of `attrs` and write forward- and backward-compatible code. Please check out the [section on deprecated APIs](https://www.attrs.org/en/stable/api-attr.html#deprecated-apis) on how to use it. [#580](https://github.com/python-attrs/attrs/issues/580) > --- ## [19.1.0](https://github.com/python-attrs/attrs/tree/19.1.0) - 2019-03-03 ### Backward-incompatible Changes - Fixed a bug where deserialized objects with `cache_hash=True` could have incorrect hash code values. This change breaks classes with `cache_hash=True` when a custom `__setstate__` is present. An exception will be thrown when applying the `attrs` annotation to such a class. This limitation is tracked in issue [#494](https://github.com/python-attrs/attrs/issues/494). [#482](https://github.com/python-attrs/attrs/issues/482) ### Changes - Add `is_callable`, `deep_iterable`, and `deep_mapping` validators. - `is_callable`: validates that a value is callable - `deep_iterable`: Allows recursion down into an iterable, applying another validator to every member in the iterable as well as applying an optional validator to the iterable itself. - `deep_mapping`: Allows recursion down into the items in a mapping object, applying a key validator and a value validator to the key and value in every item. Also applies an optional validator to the mapping object itself. You can find them in the `attr.validators` package. [#425] - Fixed stub files to prevent errors raised by mypy's `disallow_any_generics = True` option. [#443](https://github.com/python-attrs/attrs/issues/443) - Attributes with `init=False` now can follow after `kw_only=True` attributes. [#450](https://github.com/python-attrs/attrs/issues/450) - `attrs` now has first class support for defining exception classes. If you define a class using `@attr.s(auto_exc=True)` and subclass an exception, the class will behave like a well-behaved exception class including an appropriate `__str__` method, and all attributes additionally available in an `args` attribute. [#500](https://github.com/python-attrs/attrs/issues/500) - Clarified documentation for hashing to warn that hashable objects should be deeply immutable (in their usage, even if this is not enforced). [#503](https://github.com/python-attrs/attrs/issues/503) --- ## [18.2.0](https://github.com/python-attrs/attrs/tree/18.2.0) - 2018-09-01 ### Deprecations - Comparing subclasses using `<`, `>`, `<=`, and `>=` is now deprecated. The docs always claimed that instances are only compared if the types are identical, so this is a first step to conform to the docs. Equality operators (`==` and `!=`) were always strict in this regard. [#394](https://github.com/python-attrs/attrs/issues/394) ### Changes - `attrs` now ships its own [PEP 484](https://peps.python.org/pep-0484/) type hints. Together with [mypy](http://mypy-lang.org)'s `attrs` plugin, you've got all you need for writing statically typed code in both Python 2 and 3! At that occasion, we've also added [narrative docs](https://www.attrs.org/en/stable/types.html) about type annotations in `attrs`. [#238](https://github.com/python-attrs/attrs/issues/238) - Added *kw_only* arguments to `attr.ib` and `attr.s`, and a corresponding *kw_only* attribute to `attr.Attribute`. This change makes it possible to have a generated `__init__` with keyword-only arguments on Python 3, relaxing the required ordering of default and non-default valued attributes. [#281](https://github.com/python-attrs/attrs/issues/281), [#411](https://github.com/python-attrs/attrs/issues/411) - The test suite now runs with `hypothesis.HealthCheck.too_slow` disabled to prevent CI breakage on slower computers. [#364](https://github.com/python-attrs/attrs/issues/364), [#396](https://github.com/python-attrs/attrs/issues/396) - `attr.validators.in_()` now raises a `ValueError` with a useful message even if the options are a string and the value is not a string. [#383](https://github.com/python-attrs/attrs/issues/383) - `attr.asdict()` now properly handles deeply nested lists and dictionaries. [#395](https://github.com/python-attrs/attrs/issues/395) - Added `attr.converters.default_if_none()` that allows to replace `None` values in attributes. For example `attr.ib(converter=default_if_none(""))` replaces `None` by empty strings. [#400](https://github.com/python-attrs/attrs/issues/400), [#414](https://github.com/python-attrs/attrs/issues/414) - Fixed a reference leak where the original class would remain live after being replaced when `slots=True` is set. [#407](https://github.com/python-attrs/attrs/issues/407) - Slotted classes can now be made weakly referenceable by passing `@attr.s(weakref_slot=True)`. [#420](https://github.com/python-attrs/attrs/issues/420) - Added *cache_hash* option to `@attr.s` which causes the hash code to be computed once and stored on the object. [#426](https://github.com/python-attrs/attrs/issues/426) - Attributes can be named `property` and `itemgetter` now. [#430](https://github.com/python-attrs/attrs/issues/430) - It is now possible to override a base class' class variable using only class annotations. [#431](https://github.com/python-attrs/attrs/issues/431) --- ## [18.1.0](https://github.com/python-attrs/attrs/tree/18.1.0) - 2018-05-03 ### Changes - `x=X(); x.cycle = x; repr(x)` will no longer raise a `RecursionError`, and will instead show as `X(x=...)`. [#95](https://github.com/python-attrs/attrs/issues/95) - `attr.ib(factory=f)` is now syntactic sugar for the common case of `attr.ib(default=attr.Factory(f))`. [#178](https://github.com/python-attrs/attrs/issues/178), [#356](https://github.com/python-attrs/attrs/issues/356) - Added `attr.field_dict()` to return an ordered dictionary of `attrs` attributes for a class, whose keys are the attribute names. [#290](https://github.com/python-attrs/attrs/issues/290), [#349](https://github.com/python-attrs/attrs/issues/349) - The order of attributes that are passed into `attr.make_class()` or the *these* argument of `@attr.s()` is now retained if the dictionary is ordered (in other words: `dict` on Python 3.6 and later, `collections.OrderedDict` otherwise). Before, the order was always determined by the order in which the attributes have been defined which may not be desirable when creating classes programmatically. [#300](https://github.com/python-attrs/attrs/issues/300), [#339](https://github.com/python-attrs/attrs/issues/339), [#343](https://github.com/python-attrs/attrs/issues/343) - In slotted classes, `__getstate__` and `__setstate__` now ignore the `__weakref__` attribute. [#311](https://github.com/python-attrs/attrs/issues/311), [#326](https://github.com/python-attrs/attrs/issues/326) - Setting the cell type is now completely best effort. This fixes `attrs` on Jython. We cannot make any guarantees regarding Jython though, because our test suite cannot run due to dependency incompatibilities. [#321](https://github.com/python-attrs/attrs/issues/321), [#334](https://github.com/python-attrs/attrs/issues/334) - If `attr.s` is passed a *these* argument, it will no longer attempt to remove attributes with the same name from the class body. [#322](https://github.com/python-attrs/attrs/issues/322), [#323](https://github.com/python-attrs/attrs/issues/323) - The hash of `attr.NOTHING` is now vegan and faster on 32bit Python builds. [#331](https://github.com/python-attrs/attrs/issues/331), [#332](https://github.com/python-attrs/attrs/issues/332) - The overhead of instantiating frozen dict classes is virtually eliminated. [#336](https://github.com/python-attrs/attrs/issues/336) - Generated `__init__` methods now have an `__annotations__` attribute derived from the types of the fields. [#363](https://github.com/python-attrs/attrs/issues/363) - We have restructured the documentation a bit to account for `attrs`' growth in scope. Instead of putting everything into the [examples](https://www.attrs.org/en/stable/examples.html) page, we have started to extract narrative chapters. So far, we've added chapters on [initialization](https://www.attrs.org/en/stable/init.html) and [hashing](https://www.attrs.org/en/stable/hashing.html). Expect more to come! [#369](https://github.com/python-attrs/attrs/issues/369), [#370](https://github.com/python-attrs/attrs/issues/370) --- ## [17.4.0](https://github.com/python-attrs/attrs/tree/17.4.0) - 2017-12-30 ### Backward-incompatible Changes - The traversal of MROs when using multiple inheritance was backward: If you defined a class `C` that subclasses `A` and `B` like `C(A, B)`, `attrs` would have collected the attributes from `B` *before* those of `A`. This is now fixed and means that in classes that employ multiple inheritance, the output of `__repr__` and the order of positional arguments in `__init__` changes. Because of the nature of this bug, a proper deprecation cycle was unfortunately impossible. Generally speaking, it's advisable to prefer `kwargs`-based initialization anyways – *especially* if you employ multiple inheritance and diamond-shaped hierarchies. [#298](https://github.com/python-attrs/attrs/issues/298), [#299](https://github.com/python-attrs/attrs/issues/299), [#304](https://github.com/python-attrs/attrs/issues/304) - The `__repr__` set by `attrs` no longer produces an `AttributeError` when the instance is missing some of the specified attributes (either through deleting or after using `init=False` on some attributes). This can break code that relied on `repr(attr_cls_instance)` raising `AttributeError` to check if any `attrs`-specified members were unset. If you were using this, you can implement a custom method for checking this: ``` def has_unset_members(self): for field in attr.fields(type(self)): try: getattr(self, field.name) except AttributeError: return True return False ``` [#308](https://github.com/python-attrs/attrs/issues/308) ### Deprecations - The `attr.ib(convert=callable)` option is now deprecated in favor of `attr.ib(converter=callable)`. This is done to achieve consistency with other noun-based arguments like *validator*. *convert* will keep working until at least January 2019 while raising a `DeprecationWarning`. [#307](https://github.com/python-attrs/attrs/issues/307) ### Changes - Generated `__hash__` methods now hash the class type along with the attribute values. Until now the hashes of two classes with the same values were identical which was a bug. The generated method is also *much* faster now. [#261](https://github.com/python-attrs/attrs/issues/261), [#295](https://github.com/python-attrs/attrs/issues/295), [#296](https://github.com/python-attrs/attrs/issues/296) - `attr.ib`’s *metadata* argument now defaults to a unique empty `dict` instance instead of sharing a common empty `dict` for all. The singleton empty `dict` is still enforced. [#280](https://github.com/python-attrs/attrs/issues/280) - `ctypes` is optional now however if it's missing, a bare `super()` will not work in slotted classes. This should only happen in special environments like Google App Engine. [#284](https://github.com/python-attrs/attrs/issues/284), [#286](https://github.com/python-attrs/attrs/issues/286) - The attribute redefinition feature introduced in 17.3.0 now takes into account if an attribute is redefined via multiple inheritance. In that case, the definition that is closer to the base of the class hierarchy wins. [#285](https://github.com/python-attrs/attrs/issues/285), [#287](https://github.com/python-attrs/attrs/issues/287) - Subclasses of `auto_attribs=True` can be empty now. [#291](https://github.com/python-attrs/attrs/issues/291), [#292](https://github.com/python-attrs/attrs/issues/292) - Equality tests are *much* faster now. [#306](https://github.com/python-attrs/attrs/issues/306) - All generated methods now have correct `__module__`, `__name__`, and (on Python 3) `__qualname__` attributes. [#309](https://github.com/python-attrs/attrs/issues/309) --- ## [17.3.0](https://github.com/python-attrs/attrs/tree/17.3.0) - 2017-11-08 ### Backward-incompatible Changes - Attributes are no longer defined on the class body. This means that if you define a class `C` with an attribute `x`, the class will *not* have an attribute `x` for introspection. Instead of `C.x`, use `attr.fields(C).x` or look at `C.__attrs_attrs__`. The old behavior has been deprecated since version 16.1. ([#253](https://github.com/python-attrs/attrs/issues/253)) ### Changes - `super()` and `__class__` now work with slotted classes on Python 3. ([#102](https://github.com/python-attrs/attrs/issues/102), [#226](https://github.com/python-attrs/attrs/issues/226), [#269](https://github.com/python-attrs/attrs/issues/269), [#270](https://github.com/python-attrs/attrs/issues/270), [#272](https://github.com/python-attrs/attrs/issues/272)) - Added *type* argument to `attr.ib()` and corresponding `type` attribute to `attr.Attribute`. This change paves the way for automatic type checking and serialization (though as of this release `attrs` does not make use of it). In Python 3.6 or higher, the value of `attr.Attribute.type` can alternately be set using variable type annotations (see [PEP 526](https://peps.python.org/pep-0526/)). ([#151](https://github.com/python-attrs/attrs/issues/151), [#214](https://github.com/python-attrs/attrs/issues/214), [#215](https://github.com/python-attrs/attrs/issues/215), [#239](https://github.com/python-attrs/attrs/issues/239)) - The combination of `str=True` and `slots=True` now works on Python 2. ([#198](https://github.com/python-attrs/attrs/issues/198)) - `attr.Factory` is hashable again. ([#204](https://github.com/python-attrs/attrs/issues/204)) - Subclasses now can overwrite attribute definitions of their base classes. That means that you can -- for example -- change the default value for an attribute by redefining it. ([#221](https://github.com/python-attrs/attrs/issues/221), [#229](https://github.com/python-attrs/attrs/issues/229)) - Added new option *auto_attribs* to `@attr.s` that allows to collect annotated fields without setting them to `attr.ib()`. Setting a field to an `attr.ib()` is still possible to supply options like validators. Setting it to any other value is treated like it was passed as `attr.ib(default=value)` -- passing an instance of `attr.Factory` also works as expected. ([#262](https://github.com/python-attrs/attrs/issues/262), [#277](https://github.com/python-attrs/attrs/issues/277)) - Instances of classes created using `attr.make_class()` can now be pickled. ([#282](https://github.com/python-attrs/attrs/issues/282)) --- ## [17.2.0](https://github.com/python-attrs/attrs/tree/17.2.0) - 2017-05-24 ### Changes: - Validators are hashable again. Note that validators may become frozen in the future, pending availability of no-overhead frozen classes. [#192](https://github.com/python-attrs/attrs/issues/192) --- ## [17.1.0](https://github.com/python-attrs/attrs/tree/17.1.0) - 2017-05-16 To encourage more participation, the project has also been moved into a [dedicated GitHub organization](https://github.com/python-attrs/) and everyone is most welcome to join! `attrs` also has a logo now! ```{image} https://www.attrs.org/en/latest/_static/attrs_logo.png :alt: attrs logo ``` ### Backward-incompatible Changes: - `attrs` will set the `__hash__()` method to `None` by default now. The way hashes were handled before was in conflict with [Python's specification](https://docs.python.org/3/reference/datamodel.html#object.__hash__). This *may* break some software although this breakage is most likely just surfacing of latent bugs. You can always make `attrs` create the `__hash__()` method using `@attr.s(hash=True)`. See [#136] for the rationale of this change. :::{warning} Please *do not* upgrade blindly and *do* test your software! *Especially* if you use instances as dict keys or put them into sets! ::: - Correspondingly, `attr.ib`'s *hash* argument is `None` by default too and mirrors the *cmp* argument as it should. ### Deprecations: - `attr.assoc()` is now deprecated in favor of `attr.evolve()` and will stop working in 2018. ### Changes: - Fix default hashing behavior. Now *hash* mirrors the value of *cmp* and classes are unhashable by default. [#136] [#142](https://github.com/python-attrs/attrs/issues/142) - Added `attr.evolve()` that, given an instance of an `attrs` class and field changes as keyword arguments, will instantiate a copy of the given instance with the changes applied. `evolve()` replaces `assoc()`, which is now deprecated. `evolve()` is significantly faster than `assoc()`, and requires the class have an initializer that can take the field values as keyword arguments (like `attrs` itself can generate). [#116](https://github.com/python-attrs/attrs/issues/116) [#124](https://github.com/python-attrs/attrs/pull/124) [#135](https://github.com/python-attrs/attrs/pull/135) - `FrozenInstanceError` is now raised when trying to delete an attribute from a frozen class. [#118](https://github.com/python-attrs/attrs/pull/118) - Frozen-ness of classes is now inherited. [#128](https://github.com/python-attrs/attrs/pull/128) - `__attrs_post_init__()` is now run if validation is disabled. [#130](https://github.com/python-attrs/attrs/pull/130) - Added `attr.validators.in_(options)` that, given the allowed `options`, checks whether the attribute value is in it. This can be used to check constants, enums, mappings, etc. [#181](https://github.com/python-attrs/attrs/pull/181) - Added `attr.validators.and_()` that composes multiple validators into one. [#161](https://github.com/python-attrs/attrs/issues/161) - For convenience, the *validator* argument of `@attr.s` now can take a list of validators that are wrapped using `and_()`. [#138](https://github.com/python-attrs/attrs/issues/138) - Accordingly, `attr.validators.optional()` now can take a list of validators too. [#161](https://github.com/python-attrs/attrs/issues/161) - Validators can now be defined conveniently inline by using the attribute as a decorator. Check out the [validator examples](https://www.attrs.org/en/stable/init.html#decorator) to see it in action! [#143](https://github.com/python-attrs/attrs/issues/143) - `attr.Factory()` now has a *takes_self* argument that makes the initializer to pass the partially initialized instance into the factory. In other words you can define attribute defaults based on other attributes. [#165] [#189](https://github.com/python-attrs/attrs/issues/189) - Default factories can now also be defined inline using decorators. They are *always* passed the partially initialized instance. [#165] - Conversion can now be made optional using `attr.converters.optional()`. [#105](https://github.com/python-attrs/attrs/issues/105) [#173](https://github.com/python-attrs/attrs/pull/173) - `attr.make_class()` now accepts the keyword argument `bases` which allows for subclassing. [#152](https://github.com/python-attrs/attrs/pull/152) - Metaclasses are now preserved with `slots=True`. [#155](https://github.com/python-attrs/attrs/pull/155) --- ## [16.3.0](https://github.com/python-attrs/attrs/tree/16.3.0) - 2016-11-24 ### Changes: - Attributes now can have user-defined metadata which greatly improves `attrs`'s extensibility. [#96](https://github.com/python-attrs/attrs/pull/96) - Allow for a `__attrs_post_init__()` method that -- if defined -- will get called at the end of the `attrs`-generated `__init__()` method. [#111](https://github.com/python-attrs/attrs/pull/111) - Added `@attr.s(str=True)` that will optionally create a `__str__()` method that is identical to `__repr__()`. This is mainly useful with `Exception`s and other classes that rely on a useful `__str__()` implementation but overwrite the default one through a poor own one. Default Python class behavior is to use `__repr__()` as `__str__()` anyways. If you tried using `attrs` with `Exception`s and were puzzled by the tracebacks: this option is for you. - `__name__` is no longer overwritten with `__qualname__` for `attr.s(slots=True)` classes. [#99](https://github.com/python-attrs/attrs/issues/99) --- ## [16.2.0](https://github.com/python-attrs/attrs/tree/16.2.0) - 2016-09-17 ### Changes: - Added `attr.astuple()` that -- similarly to `attr.asdict()` -- returns the instance as a tuple. [#77](https://github.com/python-attrs/attrs/issues/77) - Converters now work with frozen classes. [#76](https://github.com/python-attrs/attrs/issues/76) - Instantiation of `attrs` classes with converters is now significantly faster. [#80](https://github.com/python-attrs/attrs/pull/80) - Pickling now works with slotted classes. [#81](https://github.com/python-attrs/attrs/issues/81) - `attr.assoc()` now works with slotted classes. [#84](https://github.com/python-attrs/attrs/issues/84) - The tuple returned by `attr.fields()` now also allows to access the `Attribute` instances by name. Yes, we've subclassed `tuple` so you don't have to! Therefore `attr.fields(C).x` is equivalent to the deprecated `C.x` and works with slotted classes. [#88](https://github.com/python-attrs/attrs/issues/88) --- ## [16.1.0](https://github.com/python-attrs/attrs/tree/16.1.0) - 2016-08-30 ### Backward-incompatible Changes: - All instances where function arguments were called `cl` have been changed to the more Pythonic `cls`. Since it was always the first argument, it's doubtful anyone ever called those function with in the keyword form. If so, sorry for any breakage but there's no practical deprecation path to solve this ugly wart. ### Deprecations: - Accessing `Attribute` instances on class objects is now deprecated and will stop working in 2017. If you need introspection please use the `__attrs_attrs__` attribute or the `attr.fields()` function that carry them too. In the future, the attributes that are defined on the class body and are usually overwritten in your `__init__` method are simply removed after `@attr.s` has been applied. This will remove the confusing error message if you write your own `__init__` and forget to initialize some attribute. Instead you will get a straightforward `AttributeError`. In other words: decorated classes will work more like plain Python classes which was always `attrs`'s goal. - The serious-business aliases `attr.attributes` and `attr.attr` have been deprecated in favor of `attr.attrs` and `attr.attrib` which are much more consistent and frankly obvious in hindsight. They will be purged from documentation immediately but there are no plans to actually remove them. ### Changes: - `attr.asdict()`'s `dict_factory` arguments is now propagated on recursion. [#45](https://github.com/python-attrs/attrs/issues/45) - `attr.asdict()`, `attr.has()` and `attr.fields()` are significantly faster. [#48](https://github.com/python-attrs/attrs/issues/48) [#51](https://github.com/python-attrs/attrs/issues/51) - Add `attr.attrs` and `attr.attrib` as a more consistent aliases for `attr.s` and `attr.ib`. - Add *frozen* option to `attr.s` that will make instances best-effort immutable. [#60](https://github.com/python-attrs/attrs/issues/60) - `attr.asdict()` now takes `retain_collection_types` as an argument. If `True`, it does not convert attributes of type `tuple` or `set` to `list`. [#69](https://github.com/python-attrs/attrs/issues/69) --- ## [16.0.0](https://github.com/python-attrs/attrs/tree/16.0.0) - 2016-05-23 ### Backward-incompatible Changes: - Python 3.3 and 2.6 are no longer supported. They may work by chance but any effort to keep them working has ceased. The last Python 2.6 release was on October 29, 2013 and is no longer supported by the CPython core team. Major Python packages like Django and Twisted dropped Python 2.6 a while ago already. Python 3.3 never had a significant user base and wasn't part of any distribution's LTS release. ### Changes: - `__slots__` have arrived! Classes now can automatically be [slotted](https://docs.python.org/3/reference/datamodel.html#slots)-style (and save your precious memory) just by passing `slots=True`. [#35](https://github.com/python-attrs/attrs/issues/35) - Allow the case of initializing attributes that are set to `init=False`. This allows for clean initializer parameter lists while being able to initialize attributes to default values. [#32](https://github.com/python-attrs/attrs/issues/32) - `attr.asdict()` can now produce arbitrary mappings instead of Python `dict`s when provided with a `dict_factory` argument. [#40](https://github.com/python-attrs/attrs/issues/40) - Multiple performance improvements. --- ## [15.2.0](https://github.com/python-attrs/attrs/tree/15.2.0) - 2015-12-08 ### Changes: - Added a `convert` argument to `attr.ib`, which allows specifying a function to run on arguments. This allows for simple type conversions, for example, with `attr.ib(convert=int)`. [#26](https://github.com/python-attrs/attrs/issues/26) - Speed up object creation when attribute validators are used. [#28](https://github.com/python-attrs/attrs/issues/28) --- ## [15.1.0](https://github.com/python-attrs/attrs/tree/15.1.0) - 2015-08-20 ### Changes: - Added `attr.validators.optional()` that wraps other validators allowing attributes to be `None`. [#16](https://github.com/python-attrs/attrs/issues/16) - Multi-level inheritance now works. [#24](https://github.com/python-attrs/attrs/issues/24) - `__repr__()` now works with non-redecorated subclasses. [#20](https://github.com/python-attrs/attrs/issues/20) --- ## [15.0.0](https://github.com/python-attrs/attrs/tree/15.0.0) - 2015-04-15 ### Changes: Initial release. [#136]: https://github.com/python-attrs/attrs/issues/136 [#165]: https://github.com/python-attrs/attrs/issues/165 [#425]: https://github.com/python-attrs/attrs/issues/425 python-attrs-attrs-61c0e09/CITATION.cff 0000664 0000000 0000000 00000000327 15157001312 0017541 0 ustar 00root root 0000000 0000000 cff-version: 1.2.0 message: If you use this software, please cite it as below. title: attrs type: software authors: - given-names: Hynek family-names: Schlawack email: hs@ox.cx doi: 10.5281/zenodo.6925130 python-attrs-attrs-61c0e09/LICENSE 0000664 0000000 0000000 00000002125 15157001312 0016652 0 ustar 00root root 0000000 0000000 The MIT License (MIT) Copyright (c) 2015 Hynek Schlawack and the attrs contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. python-attrs-attrs-61c0e09/README.md 0000664 0000000 0000000 00000016357 15157001312 0017140 0 ustar 00root root 0000000 0000000
*attrs* is the Python package that will bring back the **joy** of **writing classes** by relieving you from the drudgery of implementing object protocols (aka [dunder methods](https://www.attrs.org/en/latest/glossary.html#term-dunder-methods)). Trusted by NASA for [Mars missions since 2020](https://github.com/readme/featured/nasa-ingenuity-helicopter)! Its main goal is to help you to write **concise** and **correct** software without slowing down your code. ## Sponsors *attrs* would not be possible without our [amazing sponsors](https://github.com/sponsors/hynek). Especially those generously supporting us at the *The Organization* tier and higher:Please consider joining them to help make attrs’s maintenance more sustainable!
## Example *attrs* gives you a class decorator and a way to declaratively define the attributes on that class: ```pycon >>> from attrs import asdict, define, make_class, Factory >>> @define ... class SomeClass: ... a_number: int = 42 ... list_of_numbers: list[int] = Factory(list) ... ... def hard_math(self, another_number): ... return self.a_number + sum(self.list_of_numbers) * another_number >>> sc = SomeClass(1, [1, 2, 3]) >>> sc SomeClass(a_number=1, list_of_numbers=[1, 2, 3]) >>> sc.hard_math(3) 19 >>> sc == SomeClass(1, [1, 2, 3]) True >>> sc != SomeClass(2, [3, 2, 1]) True >>> asdict(sc) {'a_number': 1, 'list_of_numbers': [1, 2, 3]} >>> SomeClass() SomeClass(a_number=42, list_of_numbers=[]) >>> C = make_class("C", ["a", "b"]) >>> C("foo", "bar") C(a='foo', b='bar') ``` After *declaring* your attributes, *attrs* gives you: - a concise and explicit overview of the class's attributes, - a nice human-readable `__repr__`, - equality-checking methods, - an initializer, - and much more, *without* writing dull boilerplate code again and again and *without* runtime performance penalties. --- This example uses *attrs*'s modern APIs that have been introduced in version 20.1.0, and the *attrs* package import name that has been added in version 21.3.0. The classic APIs (`@attr.s`, `attr.ib`, plus their serious-business aliases) and the `attr` package import name will remain **indefinitely**. Check out [*On The Core API Names*](https://www.attrs.org/en/latest/names.html) for an in-depth explanation! ### Hate Type Annotations!? No problem! Types are entirely **optional** with *attrs*. Simply assign `attrs.field()` to the attributes instead of annotating them with types: ```python from attrs import define, field @define class SomeClass: a_number = field(default=42) list_of_numbers = field(factory=list) ``` ## Data Classes On the tin, *attrs* might remind you of `dataclasses` (and indeed, `dataclasses` [are a descendant](https://hynek.me/articles/import-attrs/) of *attrs*). In practice it does a lot more and is more flexible. For instance, it allows you to define [special handling of NumPy arrays for equality checks](https://www.attrs.org/en/stable/comparison.html#customization), allows more ways to [plug into the initialization process](https://www.attrs.org/en/stable/init.html#hooking-yourself-into-initialization), has a replacement for `__init_subclass__`, and allows for stepping through the generated methods using a debugger. For more details, please refer to our [comparison page](https://www.attrs.org/en/stable/why.html#data-classes), but generally speaking, we are more likely to commit crimes against nature to make things work that one would expect to work, but that are quite complicated in practice. ## Project Information - [**Changelog**](https://www.attrs.org/en/stable/changelog.html) - [**Documentation**](https://www.attrs.org/) - [**PyPI**](https://pypi.org/project/attrs/) - [**Source Code**](https://github.com/python-attrs/attrs) - [**Contributing**](https://github.com/python-attrs/attrs/blob/main/.github/CONTRIBUTING.md) - [**Third-party Extensions**](https://github.com/python-attrs/attrs/wiki/Extensions-to-attrs) - **Get Help**: use the `python-attrs` tag on [Stack Overflow](https://stackoverflow.com/questions/tagged/python-attrs) ### *attrs* for Enterprise Available as part of the [Tidelift Subscription](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek). The maintainers of *attrs* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. python-attrs-attrs-61c0e09/bench/ 0000775 0000000 0000000 00000000000 15157001312 0016724 5 ustar 00root root 0000000 0000000 python-attrs-attrs-61c0e09/bench/test_benchmarks.py 0000664 0000000 0000000 00000010300 15157001312 0022444 0 ustar 00root root 0000000 0000000 """ Benchmark attrs using CodSpeed. """ from __future__ import annotations import functools import time import pytest import attrs pytestmark = pytest.mark.benchmark() ROUNDS = 1_000 def test_create_simple_class(): """ Benchmark creating a simple class without any extras. """ for _ in range(ROUNDS): @attrs.define class LocalC: x: int y: str z: dict[str, int] def test_create_frozen_class(): """ Benchmark creating a frozen class without any extras. """ for _ in range(ROUNDS): @attrs.frozen class LocalC: x: int y: str z: dict[str, int] LocalC(1, "2", {}) def test_create_simple_class_make_class(): """ Benchmark creating a simple class using attrs.make_class(). """ for i in range(ROUNDS): LocalC = attrs.make_class( f"LocalC{i}", { "x": attrs.field(type=int), "y": attrs.field(type=str), "z": attrs.field(type=dict[str, int]), }, ) LocalC(1, "2", {}) @attrs.define class C: x: int = 0 y: str = "foo" z: dict[str, int] = attrs.Factory(dict) def test_instantiate_no_defaults(): """ Benchmark instantiating a class without using any defaults. """ for _ in range(ROUNDS): C(1, "2", {}) def test_instantiate_with_defaults(): """ Benchmark instantiating a class relying on defaults. """ for _ in range(ROUNDS): C() def test_eq_equal(): """ Benchmark comparing two equal instances for equality. """ c1 = C() c2 = C() for _ in range(ROUNDS): c1 == c2 def test_eq_unequal(): """ Benchmark comparing two unequal instances for equality. """ c1 = C() c2 = C(1, "bar", {"baz": 42}) for _ in range(ROUNDS): c1 == c2 @attrs.frozen class HashableC: x: int = 0 y: str = "foo" z: tuple[str] = ("bar",) def test_hash(): """ Benchmark hashing an instance. """ c = HashableC() for _ in range(ROUNDS): hash(c) def test_asdict_complicated(): """ Benchmark instances with non-shortcut fields. """ c = C() ad = attrs.asdict for _ in range(ROUNDS): ad(c) def test_astuple_complicated(): """ Benchmark instances with non-shortcut fields. """ c = C() at = attrs.astuple for _ in range(ROUNDS): at(c) @attrs.define class AtomicFields: a: int = 0 b: Ellipsis = ... c: str = "foo" d: tuple[str] = "bar" e: complex = complex() def test_asdict_atomic(): """ Benchmark atomic-only instances. """ c = AtomicFields() ad = attrs.asdict for _ in range(ROUNDS): ad(c) def test_astuple_atomic(): """ Benchmark atomic-only instances. """ c = AtomicFields() at = attrs.astuple for _ in range(ROUNDS): at(c) class TestCachedProperties: @attrs.define class Slotted: x: int = 0 @functools.cached_property def cached(self): time.sleep(0.1) return 42 @attrs.define(slots=False) class Unslotted: x: int = 0 @functools.cached_property def cached(self): time.sleep(0.1) return 42 def test_first_access(self): """ Benchmark first access to a cached property (computation + storage). """ for _ in range(ROUNDS): c = self.Slotted(42) _ = c.cached def test_repeated_access(self): """ Benchmark repeated access to a cached property (should use stored value). """ c = self.Slotted(42) _ = c.cached # Prime the cache for _ in range(ROUNDS): _ = c.cached def test_create_cached_property_class(self): """ Benchmark creating a class with a cached property """ for _ in range(ROUNDS): @attrs.define class LocalC: x: int y: str z: dict[str, int] @functools.cached_property def cached(self): return 42 python-attrs-attrs-61c0e09/changelog.d/ 0000775 0000000 0000000 00000000000 15157001312 0020016 5 ustar 00root root 0000000 0000000 python-attrs-attrs-61c0e09/changelog.d/towncrier_template.md.jinja 0000664 0000000 0000000 00000001437 15157001312 0025346 0 ustar 00root root 0000000 0000000 {%- if versiondata["version"] == "main" -%} ## Changes for the Upcoming Release :::{warning} These changes reflect the current [development progress](https://github.com/python-attrs/attrs/tree/main) and have **not** been part of a PyPI release yet. ::: {% else -%} ## [{{ versiondata["version"] }}](https://github.com/python-attrs/attrs/tree/{{ versiondata["version"] }}) - {{ versiondata["date"] }} {%- endif %} {% for section, _ in sections.items() %} {% if sections[section] %} {% for category, val in definitions.items() if category in sections[section] %} ### {{ definitions[category]['name'] }} {% for text, values in sections[section][category].items() %} - {{ text }} {{ values|join(',\n ') }} {% endfor %} {% endfor %} {% else %} No significant changes. {% endif %} {% endfor %} python-attrs-attrs-61c0e09/docs/ 0000775 0000000 0000000 00000000000 15157001312 0016575 5 ustar 00root root 0000000 0000000 python-attrs-attrs-61c0e09/docs/Makefile 0000664 0000000 0000000 00000015146 15157001312 0020244 0 ustar 00root root 0000000 0000000 # Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make