Справочник API
Ручной справочник публичных экспортов. Импортируйте из подпакетов, не из
самого django_chassis.
from django_chassis.mixins import ChassisAdminMixin, ChassisAdminSiteMixin
from django_chassis.options import SearchOption, RowActionsOption
from django_chassis.components import DashboardMetric
from django_chassis.views import PermissionAdminPage
from django_chassis.decorators import object_action
Миксины
ChassisAdminMixin
from django_chassis.mixins import ChassisAdminMixin
Должен стоять перед ModelAdmin в MRO.
| Атрибут | Тип | По умолчанию |
|---|---|---|
options | list[AdminOption] | [RowActionsOption()] |
chassis_settings | Settings | Settings() |
chassis_link_first_column | bool | False |
change_list_template | str | admin/chassis/change_list.html |
change_form_template | str | admin/chassis/change_form.html |
См. ModelAdmin.
ChassisAdminSiteMixin
from django_chassis.mixins import ChassisAdminSiteMixin
Должен стоять перед AdminSite в MRO.
Ключевые атрибуты: chassis_brand_name, chassis_brand_logo_static_path, chassis_brand_favicon_static_path,
sidebar_items, chassis_page_classes, chassis_permission_options,
chassis_modal_classes,
dashboard_component_classes, dashboard_blocks, navbar_button_classes,
user_menu_item_classes, show_recent_actions, include_users_module,
include_users_sidebar.
Хуки: get_dashboard_service(), get_navbar_service(),
get_chassis_modal_service(), get_chassis_page_service(),
get_sidebar_service(), get_sidebar_items(),
get_users_sidebar_section(), get_chassis_brand(),
get_chassis_brand_badge(), get_chassis_footer_context().
Модуль пользователей: Пользователи и доступ.
Добавлено в 1.0.21Полные логотипы сохраняют исходные пропорции. Если название входит в изображение, задайте chassis_brand_name = None. Для отдельного квадратного favicon используйте chassis_brand_favicon_static_path или BrandDTO.favicon_static_path; при None используется логотип.
ReadOnlyAdminMixin / NoDeleteAdminMixin
Запрещают add/change/delete или только delete.
Виджеты форм
CopyableTextInput
Добавлено в 1.0.18
from django_chassis.widgets import CopyableTextInput
Редактируемое текстовое поле с кнопкой копирования и настраиваемым prefix.
Префикс включается в копируемый текст, но не отправляется в значении формы.
Подробнее: виджеты форм.
Options
Все классы option — frozen dataclass. Назначение полей, значения по умолчанию, валидация и регион UI: каталог options.
| Класс | Обязательные параметры |
|---|---|
SearchOption | fields |
FiltersOption | fields |
DateHierarchyOption | field |
FieldTabsOption | field, choices |
ForeignKeyTabsOption | groups или field+model |
ForeignKeyTabGroupOption | field, model |
BadgeFieldsOption | fields |
CopyableFieldsOption | fields |
PrettyJsonOption | fields |
DecimalAmountOption | fields |
RelatedFieldsOption | fields |
RelatedFieldOption | field, label; необязательные help_text, empty_value_display |
RelatedCollectionsOption | collections |
RelatedCollectionOption | model, foreign_key, value_field, label; необязательные field_class, widget_attrs, save_method |
RowActionsOption | actions необязателен |
RowActionOption | action_type, label, color, icon_class |
ListActionsOption | actions |
ListActionOption | url_name, label |
ObjectActionsOption | actions необязателен, dropdown необязателен |
ObjectActionsDropdownOption | actions |
RelatedEntitiesOption | sections |
RelatedEntityOption | slug, title, get_items_method, table |
TableOption | columns |
TableColumnOption | field, label |
TableActionOption | url_name, label, icon_class |
TableActionUrlKwargOption | name, value |
ImportOption | permission |
ExportOption | permission |
Settings | все необязательные |
PermissionOption | app_label, model, codename, name |
AdminPageGroupOption | slug, label, icon_class |
SidebarSectionOption | slug, label, icon_class, items |
SidebarModelItemOption | model |
SidebarPageItemOption | page_slug |
SidebarLinkOption | slug, label, icon_class, url_name, icon_color |
ImportOption / ExportOption поднимают ValueError, если permission
пустой или если formats / filter_fields — пустой список.
Декораторы
object_action
from django_chassis.decorators import object_action
@object_action(
description,
*,
permission=None,
confirmation=None,
color=ButtonColor.PRIMARY,
icon_class=None,
condition=None,
condition_method=None,
)
condition и condition_method взаимоисключающие. См.
Объектные действия.
chassis_related_items
Помечает classmethod ModelAdmin как провайдер связанной таблицы.
Сигнатура: (cls, request, obj) -> QuerySet | Sequence.
Страницы
from django_chassis.views import ...
| Класс | Доступ |
|---|---|
AdminPage | абстрактная база |
PermissionAdminPage | permission: PermissionOption, начинается с view_ |
PersonalAdminPage | авторизованный staff; без групп navbar/dashboard |
SuperuserAdminPage | активный суперпользователь |
AdminInformationPage | структурированные секции / alerts / timelines |
AdminObjectPage[T] | маршруты списка/объекта плюс объектные действия |
UserCreationAdminPage | страница модуля пользователей; свои права страницы/доступа плюс User view/add/change |
Компоненты dashboard
from django_chassis.components import ...
| Класс | Реализовать |
|---|---|
DashboardComponent | as_dto() (абстрактный) |
DashboardMetric | get_value() |
DashboardChart | get_data() -> DashboardChartDataDTO |
DashboardAlert | видимость + сообщение |
DashboardAction | тело маршрутизируемого действия |
DashboardToggleAction | варианты true/false |
Общие поля: slug, label, order, status.
DashboardBlockDTO(slug, title, block_type, component_slugs, row=1, group='default', size=4, order=100, is_global=False, live_refresh_interval_seconds=None)
DashboardChartDataDTO(value, period_label, series, unit=None)
DashboardChartSeriesDTO(label, color, points)
DashboardChartPointDTO(label, value) — value это Decimal.
Модальные компоненты
Добавлено в 1.0.7AdminModal задаёт ленивый GET/POST fragment со своей реализацией
has_view_permission(). PermissionAdminModal получает эту проверку из
зарегистрированного PermissionOption. Оба класса экспортируются из
django_chassis.components; см. Модальные компоненты.
AdminModal.max_width необязательно ограничивает окно CSS-длиной с учётом
размера viewport.
DTO и renderer-ы представления
Добавлено в 1.0.9AdminTreeDTO(nodes, label, empty_text) и
AdminTreeNodeDTO(label, children=[], icon_class=None, badge=None)
экспортируются из django_chassis.dto. render_admin_tree(tree=...) и
render_field_help(label=..., help_text=...) экспортируются из
django_chassis.renderers.
Сервисы
Публичные классы сервисов явно экспортируются пакетом, поэтому их можно
импортировать из django_chassis.services:
from django_chassis.services import DashboardService, TableService
AdminModalService регистрирует классы modal, публикует их защищённые URL и
строит отфильтрованный по правам контекст trigger.
PaginationService.build_keyset(...) адаптирует cursor-pagination к тому же
шаблонному контракту pages, result_count и локализованного object_name,
что и PaginationService.build(...). Передайте текущий request, число
результатов страницы, следующий cursor и имена параметров cursor, его истории
и номера страницы.
PaginationService.build(...) принимает необязательный base_url для ссылок
на fragment endpoint, в том числе для пагинации modal.
Права
from django_chassis.permissions import has_request_user_permission
has_request_user_permission(request, 'catalog.view_book') -> bool
Настройка: CHASSIS_PERMISSION_CHECK = 'group_only' | 'user_has_perm'.
Enum (выборочно)
| Enum | Значения |
|---|---|
RowActionType | view, change, delete, history |
RowActionDisplay | icon, button |
TabDisplay | buttons, select |
PermissionCheck | group_only, user_has_perm |
ImportFormat | JSON, XML |
ExportFormat | JSON, XML, CSV, XLSX |
ImportBackend / ExportBackend | PYTHON_QUEUE, INLINE, WORKER (CELERY alias) Изменено в 1.0.19 |
DashboardBlockType | alerts, metrics, actions, metrics_and_actions, chart |
DashboardComponentStatus | active, disabled, hidden, error |
DashboardMetricResultType | одно значение / таблица / stacked |
ButtonColor | primary, secondary, success, danger, … |
См. также
API фоновых задач
Добавлено в 1.0.19WorkerProvider, WorkerTaskDTO, WorkerService: Background tasks.