Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

Welcome to cattrs’s documentation!

Contents:

• cattrs
  • Features
  • Additional documentation
  • Credits
• Installation
  • Stable release
  • From sources
• Common usage examples
  • Using Pendulum for Dates and Time
  • Using factory hooks
• Converters
  • Global converter
  • Converter objects
  • cattr.GenConverter
• What you can structure and how
  • Primitive values
  • Collections and other generics
  • attrs classes and dataclasses
  • Using attribute types and converters
  • Registering custom structuring hooks
  • Structuring hook factories
• What you can unstructure and how
  • Primitive types and collections
  • Customizing collection unstructuring
  • typing.Annotated
  • attrs classes and dataclasses
  • Unstructuring hook factories
• Preconfigured converters
  • Standard library json
  • ujson
  • orjson
  • msgpack
  • bson
  • pyyaml
  • tomlkit
• Customizing class un/structuring
  • Using cattr.gen.GenConverter
  • Manual un/structuring hooks
  • Using cattr.gen generators
• Tips for handling unions
  • Unstructuring unions with extra metadata
• Benchmarking
  • A Sample Workflow
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Tips
• History
  • 1.9.0 (UNRELEASED)
  • 1.8.0 (2021-08-13)
  • 1.7.1 (2021-05-28)
  • 1.7.0 (2021-05-26)
  • 1.6.0 (2021-04-28)
  • 1.5.0 (2021-04-15)
  • 1.4.0 (2021-03-21)
  • 1.3.0 (2021-02-25)
  • 1.2.0 (2021-01-31)
  • 1.1.2 (2020-11-29)
  • 1.1.1 (2020-10-30)
  • 1.1.0 (2020-10-29)
  • 1.0.0 (2019-12-27)
  • 0.9.1 (2019-10-26)
  • 0.9.0 (2018-07-22)
  • 0.8.1 (2018-06-19)
  • 0.8.0 (2018-04-14)
  • 0.7.0 (2018-04-12)
  • 0.6.0 (2017-12-25)
  • 0.5.0 (2017-12-11)
  • 0.4.0 (2017-07-17)
  • 0.3.0 (2017-03-18)
  • 0.2.0 (2016-10-02)
  • 0.1.0 (2016-08-13)

Indices and tables

• Index

• Module Index

• Search Page