From 11c3db98174b0e454c007bac052ee6c416591c4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Hells=C3=A9n?= Date: Tue, 8 Jul 2025 01:47:39 +0200 Subject: [PATCH] Refactor Django project files to improve type hinting and code clarity --- .vscode/settings.json | 3 ++ config/asgi.py | 17 ++++---- config/settings.py | 90 +++++++++++++++++++------------------------ config/urls.py | 25 ++++-------- config/wsgi.py | 17 ++++---- manage.py | 22 +++++++---- 6 files changed, 80 insertions(+), 94 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index a2a7598..fbc0c0b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,8 @@ { "cSpell.words": [ + "ASGI", + "isort", + "pydocstyle", "ttvdrops" ] } \ No newline at end of file diff --git a/config/asgi.py b/config/asgi.py index ed7c431..ee676ef 100644 --- a/config/asgi.py +++ b/config/asgi.py @@ -1,16 +1,13 @@ -""" -ASGI config for config project. - -It exposes the ASGI callable as a module-level variable named ``application``. - -For more information on this file, see -https://docs.djangoproject.com/en/5.2/howto/deployment/asgi/ -""" +from __future__ import annotations import os +from typing import TYPE_CHECKING from django.core.asgi import get_asgi_application -os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') +if TYPE_CHECKING: + from django.core.handlers.asgi import ASGIHandler -application = get_asgi_application() +os.environ.setdefault(key="DJANGO_SETTINGS_MODULE", value="config.settings") + +application: ASGIHandler = get_asgi_application() diff --git a/config/settings.py b/config/settings.py index a6eabd1..c19ffa9 100644 --- a/config/settings.py +++ b/config/settings.py @@ -1,26 +1,16 @@ -""" -Django settings for config project. - -Generated by 'django-admin startproject' using Django 5.2.4. - -For more information on this file, see -https://docs.djangoproject.com/en/5.2/topics/settings/ - -For the full list of settings and their values, see -https://docs.djangoproject.com/en/5.2/ref/settings/ -""" +from __future__ import annotations from pathlib import Path # Build paths inside the project like this: BASE_DIR / 'subdir'. -BASE_DIR = Path(__file__).resolve().parent.parent +BASE_DIR: Path = Path(__file__).resolve().parent.parent # Quick-start development settings - unsuitable for production # See https://docs.djangoproject.com/en/5.2/howto/deployment/checklist/ # SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = 'django-insecure-5b+c(lxr3-8o356!qd3_u&x0$)j))56at=&_go+@4gmai-oe2v' +SECRET_KEY = "django-insecure-5b+c(lxr3-8o356!qd3_u&x0$)j))56at=&_go+@4gmai-oe2v" # SECURITY WARNING: don't run with debug turned on in production! DEBUG = True @@ -30,52 +20,52 @@ ALLOWED_HOSTS = [] # Application definition -INSTALLED_APPS = [ - 'django.contrib.admin', - 'django.contrib.auth', - 'django.contrib.contenttypes', - 'django.contrib.sessions', - 'django.contrib.messages', - 'django.contrib.staticfiles', +INSTALLED_APPS: list[str] = [ + "django.contrib.admin", + "django.contrib.auth", + "django.contrib.contenttypes", + "django.contrib.sessions", + "django.contrib.messages", + "django.contrib.staticfiles", ] -MIDDLEWARE = [ - 'django.middleware.security.SecurityMiddleware', - 'django.contrib.sessions.middleware.SessionMiddleware', - 'django.middleware.common.CommonMiddleware', - 'django.middleware.csrf.CsrfViewMiddleware', - 'django.contrib.auth.middleware.AuthenticationMiddleware', - 'django.contrib.messages.middleware.MessageMiddleware', - 'django.middleware.clickjacking.XFrameOptionsMiddleware', +MIDDLEWARE: list[str] = [ + "django.middleware.security.SecurityMiddleware", + "django.contrib.sessions.middleware.SessionMiddleware", + "django.middleware.common.CommonMiddleware", + "django.middleware.csrf.CsrfViewMiddleware", + "django.contrib.auth.middleware.AuthenticationMiddleware", + "django.contrib.messages.middleware.MessageMiddleware", + "django.middleware.clickjacking.XFrameOptionsMiddleware", ] -ROOT_URLCONF = 'config.urls' +ROOT_URLCONF = "config.urls" TEMPLATES = [ { - 'BACKEND': 'django.template.backends.django.DjangoTemplates', - 'DIRS': [], - 'APP_DIRS': True, - 'OPTIONS': { - 'context_processors': [ - 'django.template.context_processors.request', - 'django.contrib.auth.context_processors.auth', - 'django.contrib.messages.context_processors.messages', + "BACKEND": "django.template.backends.django.DjangoTemplates", + "DIRS": [], + "APP_DIRS": True, + "OPTIONS": { + "context_processors": [ + "django.template.context_processors.request", + "django.contrib.auth.context_processors.auth", + "django.contrib.messages.context_processors.messages", ], }, }, ] -WSGI_APPLICATION = 'config.wsgi.application' +WSGI_APPLICATION = "config.wsgi.application" # Database # https://docs.djangoproject.com/en/5.2/ref/settings/#databases DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.sqlite3', - 'NAME': BASE_DIR / 'db.sqlite3', + "default": { + "ENGINE": "django.db.backends.sqlite3", + "NAME": BASE_DIR / "db.sqlite3", } } @@ -83,18 +73,18 @@ DATABASES = { # Password validation # https://docs.djangoproject.com/en/5.2/ref/settings/#auth-password-validators -AUTH_PASSWORD_VALIDATORS = [ +AUTH_PASSWORD_VALIDATORS: list[dict[str, str]] = [ { - 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", }, { - 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator", }, { - 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator", }, { - 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator", }, ] @@ -102,9 +92,9 @@ AUTH_PASSWORD_VALIDATORS = [ # Internationalization # https://docs.djangoproject.com/en/5.2/topics/i18n/ -LANGUAGE_CODE = 'en-us' +LANGUAGE_CODE = "en-us" -TIME_ZONE = 'UTC' +TIME_ZONE = "UTC" USE_I18N = True @@ -114,9 +104,9 @@ USE_TZ = True # Static files (CSS, JavaScript, Images) # https://docs.djangoproject.com/en/5.2/howto/static-files/ -STATIC_URL = 'static/' +STATIC_URL = "static/" # Default primary key field type # https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field -DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' +DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" diff --git a/config/urls.py b/config/urls.py index 35a0802..362fc4e 100644 --- a/config/urls.py +++ b/config/urls.py @@ -1,22 +1,13 @@ -""" -URL configuration for config project. +from __future__ import annotations + +from typing import TYPE_CHECKING -The `urlpatterns` list routes URLs to views. For more information please see: - https://docs.djangoproject.com/en/5.2/topics/http/urls/ -Examples: -Function views - 1. Add an import: from my_app import views - 2. Add a URL to urlpatterns: path('', views.home, name='home') -Class-based views - 1. Add an import: from other_app.views import Home - 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') -Including another URLconf - 1. Import the include() function: from django.urls import include, path - 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) -""" from django.contrib import admin from django.urls import path -urlpatterns = [ - path('admin/', admin.site.urls), +if TYPE_CHECKING: + from django.urls.resolvers import URLResolver + +urlpatterns: list[URLResolver] = [ + path(route="admin/", view=admin.site.urls), ] diff --git a/config/wsgi.py b/config/wsgi.py index e2fbd58..05ced01 100644 --- a/config/wsgi.py +++ b/config/wsgi.py @@ -1,16 +1,13 @@ -""" -WSGI config for config project. - -It exposes the WSGI callable as a module-level variable named ``application``. - -For more information on this file, see -https://docs.djangoproject.com/en/5.2/howto/deployment/wsgi/ -""" +from __future__ import annotations import os +from typing import TYPE_CHECKING from django.core.wsgi import get_wsgi_application -os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') +if TYPE_CHECKING: + from django.core.handlers.wsgi import WSGIHandler -application = get_wsgi_application() +os.environ.setdefault(key="DJANGO_SETTINGS_MODULE", value="config.settings") + +application: WSGIHandler = get_wsgi_application() diff --git a/manage.py b/manage.py index 8e7ac79..c709739 100644 --- a/manage.py +++ b/manage.py @@ -1,22 +1,30 @@ #!/usr/bin/env python """Django's command-line utility for administrative tasks.""" + +from __future__ import annotations + import os import sys -def main(): - """Run administrative tasks.""" - os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings') +def main() -> None: + """Run administrative tasks. + + Raises: + ImportError: If Django cannot be imported. + """ + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings") try: - from django.core.management import execute_from_command_line + from django.core.management import execute_from_command_line # noqa: PLC0415 except ImportError as exc: - raise ImportError( + msg = ( "Couldn't import Django. Are you sure it's installed and " "available on your PYTHONPATH environment variable? Did you " "forget to activate a virtual environment?" - ) from exc + ) + raise ImportError(msg) from exc execute_from_command_line(sys.argv) -if __name__ == '__main__': +if __name__ == "__main__": main()