Dataclass helpers - libtmux._internal.dataclasses

dataclasses utilities.

Note

This is an internal API not covered by versioning policy.

class libtmux._internal.dataclasses.SkipDefaultFieldsReprMixin

Skip default fields in dataclass() object representation.

See also

object representation

Notes

Credit: Pietro Oldrati, 2022-05-08, Unilicense

https://stackoverflow.com/a/72161437/1396928

Examples

>>> @dataclasses.dataclass()
... class Item:
...     name: str
...     unit_price: float = 1.00
...     quantity_on_hand: int = 0
...

>>> @dataclasses.dataclass(repr=False)
... class ItemWithMixin(SkipDefaultFieldsReprMixin):
...     name: str
...     unit_price: float = 1.00
...     quantity_on_hand: int = 0
...

>>> Item('Test')
Item(name='Test', unit_price=1.0, quantity_on_hand=0)

>>> ItemWithMixin('Test')
ItemWithMixin(name=Test)

>>> Item('Test', quantity_on_hand=2)
Item(name='Test', unit_price=1.0, quantity_on_hand=2)

>>> ItemWithMixin('Test', quantity_on_hand=2)
ItemWithMixin(name=Test, quantity_on_hand=2)

If you want to copy/paste the __repr__() directly, you can omit the repr=False:

>>> @dataclasses.dataclass
... class ItemWithMixin(SkipDefaultFieldsReprMixin):
...     name: str
...     unit_price: float = 1.00
...     quantity_on_hand: int = 0
...     __repr__ = SkipDefaultFieldsReprMixin.__repr__
...

>>> ItemWithMixin('Test')
ItemWithMixin(name=Test)

>>> ItemWithMixin('Test', unit_price=2.00)
ItemWithMixin(name=Test, unit_price=2.0)

>>> item = ItemWithMixin('Test')
>>> item.unit_price = 2.05

>>> item
ItemWithMixin(name=Test, unit_price=2.05)

__repr__()

Omit default fields in object representation.

Return type:

str

Parameters:

self (DataclassInstance)

__weakref__

list of weak references to the object