#pyo3 #python #methods

pyo3_special_method_derive

Automatically derive Python dunder methods for your Rust code

14 unstable releases (3 breaking)

0.4.2 Jul 20, 2024
0.4.1 Jul 19, 2024
0.3.1 Jul 19, 2024
0.3.0 Jun 25, 2024
0.1.3 Jun 17, 2024

#478 in Development tools

Download history 684/week @ 2024-06-21 179/week @ 2024-06-28 176/week @ 2024-07-05 266/week @ 2024-07-12 953/week @ 2024-07-19 503/week @ 2024-07-26 246/week @ 2024-08-02 514/week @ 2024-08-09 446/week @ 2024-08-16 805/week @ 2024-08-23 342/week @ 2024-08-30 905/week @ 2024-09-06 465/week @ 2024-09-13 397/week @ 2024-09-20 621/week @ 2024-09-27 1127/week @ 2024-10-04

2,634 downloads per month

MIT license

16KB
326 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.22", features = ["multiple-pymethods"] }

Dependencies

~3.5MB
~77K SLoC