Source code for djcrud

"""djcrud public API.

:data:`site` is the root :class:`Site` router. Append routers to
``site.routes`` in each app's ``djcrud.py`` module; :meth:`Site.build` imports
those modules via autodiscovery (like Django admin's ``admin.py``).
"""

from django.utils.module_loading import autodiscover_modules

from . import permissions
from . import search
from . import tags
from .router import Router, model_router_codename
from .view import View
from .model import ModelMixin
from . import views
from .static import vite_asset




class ModelRouter(ModelMixin, Router):
    """CRUD router for a single Django model.

    Attributes:
        routes: Default list, detail, create, update, delete, and bulk-delete
            views. Extend with ``ModelRouter.routes + [MyView]`` or
            replace entries by codename (see :class:`~djcrud.registry.Registry`).
        model: Django model class managed by this router.
        icon (str): Bootstrap Icons name for the navigation list view.
        color (str): Bulma color for the navigation list icon.
    """

    routes = [
        views.ListView,
        views.DetailView,
        views.UpdateView,
        views.DeleteView,
        views.DeleteObjectsView,
        views.CreateView,
    ]

    @property
    def codename(self):
        """URL segment from the router class name (kebab-case) or :attr:`model`."""
        return model_router_codename(type(self))



    def has_permission(self, *, user, model, action, perm, obj=None):
        """Return whether *user* may perform *action* via the permission registry."""
        return permissions.has_permission(
            user=user,
            model=model,
            action=action,
            perm=perm,
            obj=obj,
        )




    def get_queryset(self, *, user, model, action, perm, obj=None):
        """Return rows visible to *user* via the permission registry, then all rows."""
        return permissions.get_queryset(
            user=user,
            model=model,
            action=action,
            perm=perm,
            obj=obj,
        )






class Home(views.TemplateView):
    """Site root page at ``/``."""

    urlpath = ""



    def has_permission(self):
        """Allow anonymous access to the home page."""
        return True






class Site(Router):
    """Root site router; autodiscovers ``djcrud.py`` in installed apps."""

    urlpath = ""
    routes = [
        Home,
    ]



    def autodiscover(self):
        """Import ``djcrud`` modules from every installed app."""
        autodiscover_modules("djcrud")
        return self


    def build(self):
        """Autodiscover app routes, then build the route registry.

        Idempotent: if already built, returns self without re-running.
        """
        if getattr(self, "registry", None) is not None:
            return self
        self.autodiscover()
        return super().build()



    def ensure_built(self):
        """Ensure discovery and registry are populated (idempotent).

        Use this in error handlers, site search, debug tools, agents, etc.
        where you need the routes outside normal URLconf evaluation.
        """
        return self.build()




site = Site()