#pyo3 #attributes #automatic #python #derive #methods #repr

macro pyo3_special_method_derive_macro_0_21

Automatically derive Python dunder methods for your Rust code

1 unstable release

0.4.2 Jul 20, 2024

#20 in #repr

35 downloads per month
Used in pyo3_special_method_deriv…

MIT license

49KB
959 lines

pyo3-special-method-derive

This crate enables you to automatically derive Python dunder methods for your Rust crate using PyO3.

Key features

  • The following methods may be automatically derived on structs and enums:
    • __str__
    • __repr__
    • __dir__
    • __getattr__
    • __dict__
  • Support for structs and enums (only unit and complex enums due to a PyO3 limitation)
  • Support for skipping variants or fields with the #[pyo3_smd(skip)] attribute
  • Automatically skip struct fields which are not pub
  • Support for skipping variants or fields for __str__ or __repr__ differently with the #[pyo3_smd_str(skip)] and #[pyo3_smd_str(repr)] attributes

Example

#[pyclass]
#[derive(Dir, Str, Repr)]
struct Person {
    pub name: String,
    occupation: String,
    #[pyo3_smd(skip)]
    pub phone_num: String,
}

PyO3 feature note

To use pyo3-special-method-derive, you should enable the multiple-pymethods feature on PyO3:

pyo3 = { version = "0.21", features = ["multiple-pymethods"] }

Dependencies

~4.5–9.5MB
~102K SLoC