feat: add base models, filters, management command, and admin utilities

Author: Janek Mangold

django/hooks/post_gen_project.py

@@ -3,18 +3,29 @@
 
 project_slug = "{{ cookiecutter.project_slug }}"
 project_path = Path(project_slug)
+common_path = Path("common")
 use_drf = "{{ cookiecutter.use_drf }}" == "y"
 
-def _remove_file(file_path: Path) -> None:
+def _remove_file(file_path: Path):
     """Remove a file if it exists."""
     file_path.unlink(missing_ok=True)
 
+def _remove_dir(dir_path: Path):
+    """Remove a directory if it exists."""
+    if dir_path.is_dir():
+        for item in dir_path.iterdir():
+            if item.is_file():
+                item.unlink(missing_ok=True)
+            elif item.is_dir():
+                _remove_dir(item)
+        dir_path.rmdir()
 
 def handle_drf():
     if use_drf:
         return
 
     _remove_file(project_path / "drf_exception_handler.py")
+    _remove_dir(common_path / "drf")
 
 def main():
     handle_drf()

django/{{ cookiecutter.project_slug }}/common/admin.py

@@ -0,0 +1,26 @@
+from django.contrib import admin
+
+
+class ReadOnlyTabularInline(admin.TabularInline):
+    """
+    A read-only tabular inline for Django admin.
+    """
+
+    can_delete = False
+    extra = 0
+    show_change_link = True
+
+    def get_readonly_fields(self, request, obj=None):
+        """
+        Override to make all fields readonly.
+        """
+        return [field.name for field in self.model._meta.fields]
+
+    def has_add_permission(self, request, obj=None):
+        return False
+
+    def has_change_permission(self, request, obj=None):
+        return False
+
+    def has_delete_permission(self, request, obj=None):
+        return False

django/{{ cookiecutter.project_slug }}/common/drf/__init__.py

@@ -0,0 +1,3 @@
+from .filters import MultipleValuesFilter
+from .renderers import BinaryRenderer
+from .view_set_mixins import MultipleSerializersMixin

django/{{ cookiecutter.project_slug }}/common/drf/filters.py

@@ -0,0 +1,11 @@
+from django.forms import Field
+from django_filters import Filter, FilterSet, MultipleChoiceFilter
+from django_filters.widgets import QueryArrayWidget
+
+
+class MultipleValuesField(Field):
+    widget = QueryArrayWidget
+
+
+class MultipleValuesFilter(MultipleChoiceFilter):
+    field_class = MultipleValuesField

django/{{ cookiecutter.project_slug }}/common/drf/renderers.py

@@ -0,0 +1,15 @@
+from typing import Any, Dict, Optional, Union
+
+from rest_framework.renderers import BaseRenderer
+
+
+class BinaryRenderer(BaseRenderer):
+    """Renderer for binary content like Excel files."""
+
+    media_type = "application/vnd.ms-excel"
+    format = "bin"
+
+    def render(
+        self, data: Any, accepted_media_type: Optional[str] = None, renderer_context: Optional[Dict[str, Any]] = None
+    ) -> Union[bytes, str, None]:
+        return data

django/{{ cookiecutter.project_slug }}/common/drf/view_set_mixins.py

@@ -0,0 +1,21 @@
+class MultipleSerializersMixin:
+    """
+    Mixin for ViewSets that allows to use multiple serializers
+    for different actions. Defaults to serializer_class for all actions.
+    """
+
+    serializer_classes = {}
+    '''The keys should be the actions names: "list", "retrieve", "create", "update", "partial_update", "destroy"'''
+
+    def get_serializer_class(self):
+        """
+        Return the class to use for the serializer.
+        Defaults to using `self.serializer_classes`.
+        """
+        try:
+            return self.serializer_classes[self.action]
+        except KeyError:
+            assert self.serializer_class is not None, (
+                f"Serializer class for action '{self.action}' not found and no default serializer class set."
+            )
+            return self.serializer_class

django/{{ cookiecutter.project_slug }}/common/management_command.py

@@ -0,0 +1,91 @@
+from abc import ABC
+from typing import Callable, Union
+
+from django.core.management.base import BaseCommand as DjangoCommand
+from django.core.management.base import CommandParser
+
+
+class BaseCommand(DjangoCommand, ABC):
+    """BaseCommand that can be inherited and customized."""
+
+    quiet: bool = False
+    """If True, the print statements are quiet."""
+
+    def __init__(self, stdout=None, stderr=None, no_color=False, force_color=False, quiet=False):
+        self.quiet = quiet
+        super().__init__(stdout=stdout, stderr=stderr, no_color=no_color, force_color=force_color)
+
+    def add_arguments(self, parser: CommandParser) -> None:
+        parser.add_argument(
+            "--quiet",
+            action="store_true",
+            default=False,
+            help="Print no information.",
+        )
+
+    def _print_s(
+        self,
+        txt,
+        ending=None,
+    ):
+        """
+        Print given `txt` in SUCCESS style to `self.stdout` (generally green).
+        """
+        self._print(txt=txt, style=self.style.SUCCESS, ending=ending)
+
+    def _print_w(
+        self,
+        txt,
+        ending=None,
+    ):
+        """
+        Print given `txt` in WARNING style to `self.stdout` (generally yellow).
+        """
+        self._print(txt=txt, style=self.style.WARNING, ending=ending)
+
+    def _print_e(
+        self,
+        txt,
+        ending=None,
+    ):
+        """
+        Print given `txt` in ERROR style to `self.stdout` (generally red).
+        """
+        self._print(txt=txt, style=self.style.ERROR, ending=ending)
+
+    def _print_n(
+        self,
+        txt,
+        ending=None,
+    ):
+        """
+        Print given `txt` in NOTICE style to `self.stdout` (generally red, but lighter).
+        """
+        self._print(txt=txt, style=self.style.NOTICE, ending=ending)
+
+    def _print(
+        self,
+        txt,
+        style: Union[None, Callable] = None,
+        ending=None,
+    ):
+        if self.quiet:
+            return
+        if style is not None:
+            self.stdout.write(style(txt), ending=ending)
+        else:
+            self.stdout.write(txt, ending=ending)
+
+    def confirm_action(self, message: str) -> bool:
+        response = input(f"{message} (y/n): ").strip().lower()
+        return response == "y"
+
+    def handle(self, *args, **options):
+        """
+        Override this function to implement the command. Call
+        `super().handle(*args, **options)` first in order to add parsing for
+        `BaseCommand` arguments.
+        """
+
+        if options["quiet"]:
+            self.quiet = True

django/{{ cookiecutter.project_slug }}/common/models.py

@@ -0,0 +1,8 @@
+from django.db import models
+
+class TimestampModel(models.Model):
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    class Meta:
+        abstract = True