drinx.private_field

Contents

drinx.private_field#

drinx.private_field(*, default=<dataclasses._MISSING_TYPE object>, default_factory=<dataclasses._MISSING_TYPE object>, repr=True, hash=None, compare=True, metadata=None, kw_only=<dataclasses._MISSING_TYPE object>, static=False, on_setattr=(), on_getattr=())[source]#

Define a private (non-init) dataclass field with optional JAX static marking.

Convenience wrapper around field() with init=False pre-set. The field is excluded from __init__ and must be assigned inside __post_init__ or via a default/default_factory.

Parameters:

  • default (Any) – Default value for the field.

  • default_factory (Union[Callable[[], Any], Any]) – Zero-argument callable returning the default value.

  • repr (bool) – Include the field in the generated __repr__.

  • hash (bool | None) – Include the field in __hash__ (None defers to compare).

  • compare (bool) – Include the field in __eq__ and ordering methods.

  • metadata (dict[str, Any] | None) – Additional metadata merged with the jax_static entry.

  • kw_only (Any) – Override the class-level kw_only setting for this field.

  • static (bool) – When True, mark the field as JAX-static. Defaults to False.

Return type:

Any

Returns:

A dataclasses.Field descriptor (typed as Any).

Contents