django-admin-inline-controls 0.1.0__py3-none-any.whl

django_admin_inline_controls/row_actions.py

@@ -0,0 +1,173 @@
+"""Row actions: buttons on each saved row of an inline.
+
+An action is a method of the inline (or a callable) in one of two forms:
+
+- for one row, ``action(inline, request, obj, parent_obj=None)`` — the
+  signature of django-inline-actions, so its actions can be reused as they
+  are;
+- for a queryset, ``action(inline, request, queryset)`` — an inline action
+  (``@inline_action``), run on a queryset with only that row.
+
+Both return ``None`` to re-render the inline with the messages sent through
+``inline.message_user()``, or an ``HttpResponse`` (a file download or a
+redirect). Per-row label, CSS classes and HTML attributes come from the
+action's ``short_description`` / ``css_classes`` / ``attribute_properties``
+or from ``get_<action>_label(obj)`` / ``get_<action>_css(obj)`` /
+``get_<action>_attr(obj)`` on the inline, as in django-inline-actions.
+"""
+
+from __future__ import annotations
+
+import inspect
+from collections.abc import Callable
+from dataclasses import dataclass
+from typing import Any
+
+from django.contrib import messages
+from django.contrib.admin.utils import model_format_dict, quote
+from django.http import HttpRequest, HttpResponseRedirect
+from django.urls import NoReverseMatch, reverse
+from django.utils.html import format_html_join
+from django.utils.safestring import SafeString, mark_safe
+from django.utils.text import capfirst
+from django.utils.translation import gettext
+from django.utils.translation import gettext_lazy as _
+
+from django_admin_inline_controls.actions import delete_selected, inline_action
+
+
+def set_render_context(inline: Any, request: HttpRequest, parent: Any) -> None:
+    """Remember the request and parent object the inline is rendered for: the
+    actions' column only gets the row. On the instance, which the admin
+    creates for each request (``get_inline_instances()``)."""
+    inline._inline_controls_render = (request, parent)
+
+
+def get_render_context(inline: Any) -> tuple[HttpRequest | None, Any]:
+    return getattr(inline, "_inline_controls_render", (None, None))
+
+
+@inline_action(
+    permissions=["delete"],
+    description=_("Delete"),
+    confirmation=_("Delete “%(object)s”? This cannot be undone."),
+)
+def delete(inline: Any, request: HttpRequest, queryset: Any) -> None:
+    """Delete the row (``delete()`` overrides and signals run), recorded in
+    the parent's history, like ``delete_selected``."""
+    return delete_selected(inline, request, queryset)
+
+
+@inline_action(permissions=["view"], description=_("View"))
+def view(inline: Any, request: HttpRequest, obj: Any, parent_obj: Any = None) -> Any:
+    """Open the row's change view (its own ``ModelAdmin``)."""
+    url = change_url(inline, obj)
+    if url is None:  # pragma: no cover - only offered when it has one
+        inline.message_user(request, gettext("This item has no page."), messages.ERROR)
+        return None
+    return HttpResponseRedirect(url)
+
+
+#: Rendered as a link to the row's change view, not a button.
+view.inline_actions_link = True
+
+
+#: Row actions that can be referenced by name in ``inline_actions``.
+BUILTIN_ROW_ACTIONS: dict[str, Callable[..., Any]] = {"delete": delete, "view": view}
+
+
+def change_url(inline: Any, obj: Any) -> str | None:
+    """The change view of ``obj`` in the inline's admin site, if registered."""
+    opts = obj._meta
+    try:
+        return reverse(
+            f"{inline.admin_site.name}:{opts.app_label}_{opts.model_name}_change",
+            args=[quote(obj.pk)],
+        )
+    except NoReverseMatch:
+        return None
+
+
+def takes_one_row(function: Callable[..., Any]) -> bool:
+    """Whether ``function`` acts on one row (``obj``) rather than a queryset."""
+    try:
+        return "obj" in inspect.signature(function).parameters
+    except (TypeError, ValueError):  # pragma: no cover - builtins, C functions
+        return False
+
+
+@dataclass(frozen=True)
+class RowActionSpec:
+    """A row action as offered for one row."""
+
+    name: str
+    function: Callable[..., Any]
+    label: str
+    css_classes: str
+    #: Extra HTML attributes of the button.
+    attrs: SafeString
+    confirmation: str | None
+    #: A link instead of a button (``view``).
+    url: str | None = None
+
+
+def row_action_spec(
+    inline: Any, name: str, function: Callable[..., Any], obj: Any
+) -> RowActionSpec:
+    """``function`` as ``name``'s action for the row ``obj``."""
+    names = {**model_format_dict(inline.model._meta), "object": obj, "count": 1}
+
+    def hook(kind: str) -> Any:
+        method = getattr(inline, f"get_{name}_{kind}", None)
+        return method(obj=obj) if callable(method) else None
+
+    label = hook("label")
+    if label is None:
+        label = getattr(function, "short_description", None)
+        label = (
+            str(label) % names
+            if label is not None
+            else capfirst(name.replace("_", " "))
+        )
+    css = hook("css")
+    if css is None:
+        css = getattr(function, "css_classes", "")
+    attrs = hook("attr")
+    if attrs is None:
+        attrs = getattr(function, "attribute_properties", "")
+    if isinstance(attrs, dict):
+        attrs = format_html_join(" ", '{}="{}"', attrs.items())
+    else:
+        # A string is used as it is, as in django-inline-actions.
+        attrs = mark_safe(attrs)  # noqa: S308
+    confirmation = getattr(function, "confirmation", None)
+    return RowActionSpec(
+        name=name,
+        function=function,
+        label=str(label),
+        css_classes=str(css),
+        attrs=attrs,
+        confirmation=None if confirmation is None else str(confirmation) % names,
+        url=change_url(inline, obj)
+        if getattr(function, "inline_actions_link", False)
+        else None,
+    )
+
+
+def run_row_action(
+    inline: Any, request: HttpRequest, action: RowActionSpec, obj: Any, parent: Any
+) -> Any:
+    """Call the action on the row ``obj`` in the form it was written for."""
+    function = action.function
+    if takes_one_row(function):
+        return function(inline, request, obj, parent_obj=parent)
+    queryset = type(obj)._default_manager.filter(pk=obj.pk)
+    return function(inline, request, queryset)
+
+
+__all__ = [
+    "BUILTIN_ROW_ACTIONS",
+    "RowActionSpec",
+    "delete",
+    "view",
+]

django_admin_inline_controls/static/django_admin_inline_controls/css/contrib/unfold.css

@@ -0,0 +1,111 @@
+/* django-admin-inline-controls: django-unfold's colors, light and dark. */
+/* The tfoot also on its own: the add view has no controls around it. */
+.inline-controls,
+.inline-controls-tfoot {
+    --body-bg: #fff;
+    --body-fg: var(--color-font-default-light);
+    --body-quiet-color: var(--color-font-subtle-light);
+    --border-color: var(--color-base-200);
+    --darkened-bg: var(--color-base-50);
+    --error-fg: var(--color-red-600);
+    --hairline-color: var(--color-base-200);
+    --selected-bg: var(--color-base-100);
+}
+
+.dark .inline-controls,
+.dark .inline-controls-tfoot {
+    --body-bg: var(--color-base-900);
+    --body-fg: var(--color-font-default-dark);
+    --body-quiet-color: var(--color-font-subtle-dark);
+    --border-color: var(--color-base-700);
+    --darkened-bg: var(--color-base-800);
+    --error-fg: var(--color-red-500);
+    --hairline-color: var(--color-base-800);
+    --selected-bg: var(--color-base-800);
+}
+
+.inline-controls-toolbar {
+    margin-bottom: 1rem;
+    border: 1px solid var(--hairline-color);
+    border-radius: var(--border-radius, 6px);
+    color: var(--body-fg);
+}
+
+.inline-controls-footer {
+    color: var(--body-fg);
+}
+
+.inline-controls-toolbar select,
+.inline-controls-toolbar input:not([type="checkbox"], [type="radio"]) {
+    box-sizing: border-box;
+    height: 30px;
+    padding: 0 8px;
+    border: 1px solid var(--border-color);
+    border-radius: var(--border-radius, 6px);
+    color: var(--body-fg);
+    background-color: var(--body-bg);
+    font-size: 0.8125rem;
+}
+
+.inline-controls .button {
+    border: 1px solid var(--border-color);
+    border-radius: var(--border-radius, 6px);
+    color: var(--body-fg);
+    background: var(--body-bg);
+    font-weight: 500;
+}
+
+.inline-controls .button:hover {
+    background: var(--darkened-bg);
+}
+
+.inline-controls a:not(.button) {
+    color: var(--color-primary-600);
+}
+
+.dark .inline-controls a:not(.button) {
+    color: var(--color-primary-500);
+}
+
+.inline-controls-current {
+    color: var(--body-fg);
+}
+
+table tfoot.inline-controls-tfoot.inline-controls-tfoot th,
+table tfoot.inline-controls-tfoot.inline-controls-tfoot td {
+    padding: 0.5rem 0.375rem;
+    border-top: 1px solid var(--hairline-color);
+    background: var(--darkened-bg);
+    color: var(--body-fg);
+    font-size: 0.8125rem;
+    text-align: left;
+}
+
+table
+    tfoot.inline-controls-tfoot.inline-controls-tfoot
+    :is(th, td):first-child {
+    padding-left: 0.75rem;
+}
+
+table tfoot.inline-controls-tfoot.inline-controls-tfoot th {
+    text-align: right;
+}
+
+table
+    tfoot.inline-controls-tfoot.inline-controls-tfoot
+    .inline-controls-footer-label {
+    margin-right: 0.5rem;
+    color: var(--body-quiet-color);
+}
+
+table
+    tfoot.inline-controls-tfoot.inline-controls-tfoot
+    .inline-controls-footer-value {
+    font-weight: 600;
+}
+
+.inline-controls .inline-controls-row-action.button {
+    padding: 0.25rem 0.625rem;
+    font-size: 0.75rem;
+    text-decoration: none;
+}

django_admin_inline_controls/static/django_admin_inline_controls/css/core.css

@@ -0,0 +1,294 @@
+.inline-controls-toolbar {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: flex-end;
+    gap: 8px 24px;
+    padding: 8px 10px;
+    border-bottom: 1px solid var(--hairline-color, #e8e8e8);
+    background: var(--darkened-bg, #f8f8f8);
+}
+
+.inline-controls-actions {
+    display: flex;
+    flex-wrap: wrap;
+    flex-basis: 100%;
+    align-items: center;
+    gap: 6px 10px;
+    font-size: 0.8125rem;
+}
+
+.inline-controls-actions label {
+    display: flex;
+    align-items: center;
+    gap: 6px;
+    float: none;
+    width: auto;
+    min-width: 0;
+    padding: 0;
+    font-weight: normal;
+}
+
+.inline-controls-actions select,
+.inline-controls-actions .button {
+    box-sizing: border-box;
+    height: 30px;
+    margin: 0;
+    font-size: 0.8125rem;
+}
+
+.inline-controls-actions .button {
+    padding: 0 12px;
+    border-radius: 4px;
+    line-height: 1;
+    cursor: pointer;
+}
+
+.inline-controls-selection {
+    color: var(--body-quiet-color, #666);
+}
+
+.inline-controls-select-across[hidden] {
+    display: none;
+}
+
+.inline-controls-select,
+.inline-controls-select-all {
+    margin: 0 6px 0 0;
+    vertical-align: middle;
+}
+
+/* The tabular label line is short and clips; let the checkbox fit. */
+.inline-group .tabular td.original p:has(> .inline-controls-select) {
+    height: auto;
+    overflow: visible;
+}
+
+.inline-controls-filters {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: flex-end;
+    gap: 8px 12px;
+}
+
+.inline-controls-filter {
+    display: flex;
+    flex-direction: column;
+    gap: 2px;
+}
+
+.inline-controls-filter label {
+    float: none;
+    width: auto;
+    min-width: 0;
+    padding: 0;
+    font-size: 0.75rem;
+    font-weight: normal;
+    color: var(--body-quiet-color, #666);
+}
+
+.inline-controls-filter .errorlist {
+    margin: 0;
+}
+
+/* The admin styles text inputs and selects but not date/number inputs or
+   <button>: give every single-line control and the buttons one height. */
+.inline-controls-filter input:not([type="checkbox"], [type="radio"]),
+.inline-controls-filter select:not([multiple]),
+.inline-controls-filter-buttons .button {
+    box-sizing: border-box;
+    height: 30px;
+    margin: 0;
+    font-size: 0.8125rem;
+    vertical-align: middle;
+}
+
+.inline-controls-filter input:not([type="checkbox"], [type="radio"]) {
+    padding: 5px 6px;
+    border: 1px solid var(--border-color, #ccc);
+    border-radius: 4px;
+    color: var(--body-fg, #333);
+    background-color: var(--body-bg, #fff);
+}
+
+.inline-controls-filter-buttons {
+    display: flex;
+    gap: 6px;
+}
+
+.inline-controls-filter-buttons .button {
+    padding: 0 12px;
+    border-radius: 4px;
+    line-height: 1;
+    cursor: pointer;
+}
+
+.inline-controls-ordering {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: center;
+    gap: 4px 12px;
+    font-size: 0.8125rem;
+}
+
+.inline-controls-ordering[hidden] {
+    display: none;
+}
+
+.inline-controls-ordering-label,
+.inline-controls-sort-priority,
+.inline-controls-sort-remove,
+.inline-controls-count {
+    color: var(--body-quiet-color, #666);
+}
+
+.inline-controls-sort-priority {
+    font-size: 0.6875rem;
+}
+
+.inline-controls-sort-remove {
+    margin-left: 2px;
+    text-decoration: none;
+}
+
+.inline-controls-ascending .inline-controls-sort-toggle::after {
+    content: " \25B2";
+    font-size: 0.7em;
+}
+
+.inline-controls-descending .inline-controls-sort-toggle::after {
+    content: " \25BC";
+    font-size: 0.7em;
+}
+
+th.inline-controls-sortable .inline-controls-sort-toggle {
+    color: inherit;
+}
+
+.inline-controls-footer {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: center;
+    gap: 4px 12px;
+    padding: 8px 10px;
+    font-size: 0.8125rem;
+}
+
+.inline-controls-pagination {
+    display: flex;
+    flex-wrap: wrap;
+    align-items: center;
+    gap: 4px;
+}
+
+.inline-controls-page,
+.inline-controls-ellipsis {
+    min-width: 1.5em;
+    padding: 2px 6px;
+    text-align: center;
+}
+
+.inline-controls-current {
+    font-weight: bold;
+    border-radius: 4px;
+    background: var(--selected-bg, #e4e4e4);
+}
+
+.inline-controls-footer:not(.inline-controls-infinite) .inline-controls-count {
+    margin-left: auto;
+}
+
+.inline-controls-infinite {
+    justify-content: center;
+}
+
+.inline-controls-save {
+    display: flex;
+    align-items: center;
+    gap: 8px;
+}
+
+.inline-controls-infinite .inline-controls-save,
+.inline-controls-footer > .inline-controls-save:first-child {
+    margin-left: auto;
+}
+
+.inline-controls-save .button {
+    box-sizing: border-box;
+    height: 30px;
+    margin: 0;
+    padding: 0 12px;
+    border-radius: 4px;
+    font-size: 0.8125rem;
+    line-height: 1;
+    cursor: pointer;
+}
+
+.inline-controls-status-invalid,
+.inline-controls-status-failed,
+.inline-controls-status-error {
+    color: var(--error-fg, #ba2121);
+}
+
+.inline-controls.inline-controls-loading {
+    opacity: 0.6;
+    transition: opacity 0.2s;
+}
+
+.inline-controls-footer-rows {
+    display: flex;
+    flex-direction: column;
+    flex-basis: 100%;
+    gap: 2px;
+}
+
+.inline-controls-footer-row {
+    display: flex;
+    flex-wrap: wrap;
+    gap: 4px 16px;
+}
+
+.inline-controls-footer-label {
+    font-weight: bold;
+}
+
+.inline-controls-footer-column {
+    color: var(--body-quiet-color, #666);
+}
+
+/* Specific enough to beat the admin's own `tfoot td` and inline rules. */
+.inline-group table tfoot.inline-controls-tfoot th,
+.inline-group table tfoot.inline-controls-tfoot td {
+    border-top: 1px solid var(--hairline-color, #e8e8e8);
+    background: var(--darkened-bg, #f8f8f8);
+    font-size: 0.8125rem;
+    font-weight: normal;
+    text-transform: none;
+}
+
+.inline-group table tfoot.inline-controls-tfoot th {
+    text-align: right;
+}
+
+.inline-group table tfoot.inline-controls-tfoot .inline-controls-footer-label {
+    color: var(--body-quiet-color, #666);
+    font-weight: bold;
+}
+
+.inline-group table tfoot.inline-controls-tfoot .inline-controls-footer-value {
+    font-weight: bold;
+}
+
+.inline-controls-row-actions:not([hidden]) {
+    display: inline-flex;
+    gap: 4px;
+}
+
+.inline-controls-row-action.button {
+    margin: 0;
+    padding: 4px 8px;
+    font-size: 0.75rem;
+    line-height: 1.2;
+    white-space: nowrap;
+    text-decoration: none;
+    cursor: pointer;
+}