Skip to content

Docs: clarify current behaviour/motivation for slots=True and autogeneration of __get/setstate__#521

Merged
hynek merged 9 commits intopython-attrs:masterfrom
andhus:clarify_docs_on_slots_and_pickle
Jul 20, 2019
Merged

Docs: clarify current behaviour/motivation for slots=True and autogeneration of __get/setstate__#521
hynek merged 9 commits intopython-attrs:masterfrom
andhus:clarify_docs_on_slots_and_pickle

Conversation

@andhus
Copy link
Copy Markdown
Contributor

@andhus andhus commented Mar 23, 2019

This clarifies current behaviour wrt: #512

Pull Request Check List

(If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.)

  • Added tests for changed code.
  • New features have been added to our Hypothesis testing strategy.
  • Changes or additions to public APIs are reflected in our type stubs (files ending in .pyi).
    • ...and used in the stub test file tests/typing_example.py.
  • Updated documentation for changed code.
    • New functions/classes have to be added to docs/api.rst by hand.
    • Changes to the signature of @attr.s() have to be added by hand too.
    • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives.
  • Documentation in .rst files is written using semantic newlines.
  • Changes (and possible deprecations) have news fragments in changelog.d.

@andhus andhus changed the title Clarify current behaviour and motivation for slots=True and autogeneration of __get/setstate__ Docs: clarify current behaviour/motivation for slots=True and autogeneration of __get/setstate__ Mar 23, 2019
Comment thread docs/glossary.rst
Comment thread docs/glossary.rst Outdated
Copy link
Copy Markdown
Member

@hynek hynek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm super sorry I've been procrastinating on this issue for so long, mostly because I was confused. Now I've finally double-checked the implementation and you're right.

Also you're right, we should make attrs more pickle-friendly, despite all its warts.

@hynek hynek merged commit b5e825d into python-attrs:master Jul 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants