Column

Column

djadmin.dataclasses.Column

Specification for a list_display column.

Supports both Django admin style (strings/callables) and enhanced configuration with additional metadata.

New in Milestone 2: - filter: Filter configuration (for filtering plugins like djadmin-filters) - order: Ordering configuration (for ordering plugins like djadmin-filters)

Class Attributes

Attribute	Type	Description
field	-	Field name (string) or callable to display
label	-	Optional override for column label
empty_value	-	Display value for None/empty (default: '-')
classes	-	CSS classes for this column
filter	-	Filter configuration (True/False/Filter instance/None)
order	-	Order configuration (True/False/Order instance/None)

Method Resolution Order

1. djadmin.dataclasses.Column

Attributes

Attribute	Value	Defined in
__annotations__	{'field': 'str | Callable', 'label': 'str | None', 'empty...	djadmin.dataclasses.Column
__dataclass_fields__	{'field': Field(name='field',type='str | Callable',defaul...	djadmin.dataclasses.Column
__dataclass_params__	_DataclassParams(init=True,repr=True,eq=True,order=False,...	djadmin.dataclasses.Column
__hash__	None	djadmin.dataclasses.Column
__match_args__	('field', 'label', 'empty_value', 'classes', 'filter', 'o...	djadmin.dataclasses.Column
classes		djadmin.dataclasses.Column
empty_value	-	djadmin.dataclasses.Column
filter	None	djadmin.dataclasses.Column
label	None	djadmin.dataclasses.Column
order	None	djadmin.dataclasses.Column

Methods

__eq__(self, other)

Defined in: <class 'djadmin.dataclasses.Column'>

Return self==value.

__init__(self, field: 'str | Callable', label: 'str | None' = None, empty_value: 'str' = '-', classes: 'str' = '', filter: 'bool | Filter | None' = None, order: 'bool | Order | None' = None) -> None

Defined in: <class 'djadmin.dataclasses.Column'>

Initialize self. See help(type(self)) for accurate signature.

__repr__(self)

Defined in: <class 'djadmin.dataclasses.Column'>

Return repr(self).

field_label @property

Defined in: <class 'djadmin.dataclasses.Column'>

Get label, falling back to field_name if not set

field_name @property

Defined in: <class 'djadmin.dataclasses.Column'>

Get field name as string (for template use)

from_field(field) @classmethod

Defined in: <class 'djadmin.dataclasses.Column'>

Create Column from string or callable (Django admin compat).

Args: field: String field name, callable, or Column instance

Returns: Column instance

Source code in dataclasses.py line 45

    @classmethod
    def from_field(cls, field):
        """
        Create Column from string or callable (Django admin compat).

        Args:
            field: String field name, callable, or Column instance

        Returns:
            Column instance
        """
        if isinstance(field, cls):
            return field
        return cls(field=field)

Fields

Field	Type	Related To
__dict__	getset_descriptor	-
__weakref__	getset_descriptor	-