fix: formatted and lint the codebase

Author: arvind-4

app.py

@@ -1,7 +1,9 @@
+"""Entry point for the WSGI server to serve the Django application."""
+
 import os
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'backend.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
 
-app = get_wsgi_application()
+app = get_wsgi_application()

backend/__init__.py

@@ -0,0 +1 @@
+"""Backend module for the application."""

backend/asgi.py

@@ -1,5 +1,4 @@
-"""
-ASGI config for backend project.
+"""ASGI config for backend project.
 
 It exposes the ASGI callable as a module-level variable named ``application``.
 
@@ -11,6 +10,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'backend.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
 
 application = get_asgi_application()

backend/constants.py

@@ -1,21 +1,28 @@
-import os
-from backend.env import config
+"""Constants for the entire application."""
+
 from functools import lru_cache
 
+from backend.env import config
+
 
 def convert_to_list(value: str) -> list[str]:
-    return [item.strip() for item in value.split(',')]
+    """Convert a comma-separated string to a list of strings."""
+    return [item.strip() for item in value.split(",")]
 
-class Constants(object):
-    DJANGO_DEBUG: bool = config("DJANGO_DEBUG",cast=bool)
+
+class Constants:
+    """Constants for the application."""
+
+    DJANGO_DEBUG: bool = config("DJANGO_DEBUG", cast=bool)
     DJANGO_ALLOWED_HOSTS: list[str] = convert_to_list(
-        value=config("DJANGO_ALLOWED_HOSTS", cast=str)
+        value=config("DJANGO_ALLOWED_HOSTS", cast=str),
     )
     DJANGO_SECRET_KEY: str = config("DJANGO_SECRET_KEY", cast=str)
     USE_POSTGRES: bool = config("USE_POSTGRES", cast=bool, default=False)
     DATABASE_URL: str = config("DATABASE_URL", cast=str)
 
-    
+
 @lru_cache
 def get_constants() -> Constants:
+    """Get the constants for the application."""
     return Constants()

backend/db.py

@@ -1,21 +1,22 @@
-import sys
+"""Configuration for the database."""
+
 import dj_database_url
 from django.conf import settings
 
 from backend.constants import get_constants
 
 constants = get_constants()
 
-BASE_DIR = getattr(settings, 'BASE_DIR')
+BASE_DIR = settings.BASE_DIR
 
 DATABASES = {}
 
 if constants.DJANGO_DEBUG:
     DATABASES = {
         "default": {
             "ENGINE": "django.db.backends.sqlite3",
-            "NAME": BASE_DIR / "db.sqlite3", 
-        }
+            "NAME": BASE_DIR / "db.sqlite3",
+        },
     }
 else:
-    DATABASES['default'] = dj_database_url.config()
+    DATABASES["default"] = dj_database_url.config()

backend/env.py

@@ -1,16 +1,22 @@
+"""Configure environment variables for the application."""
+
 import pathlib
 from functools import lru_cache
-from decouple import Config, RepositoryEnv, config as config_default
-from django.conf import settings
+
+from decouple import Config, RepositoryEnv
+from decouple import config as config_default
 
 BASE_DIR = pathlib.Path(__file__).parent.parent
 
 ENV_PATH = BASE_DIR / ".env"
 
-@lru_cache()
-def get_config():
+
+@lru_cache
+def get_config() -> Config:
+    """Get the configuration from the .env file if it exists."""
     if ENV_PATH.exists():
         return Config(RepositoryEnv(ENV_PATH))
     return config_default
 
-config = get_config()
+
+config = get_config()

backend/settings.py

@@ -1,16 +1,7 @@
-"""
-Django settings for backend project.
-
-Generated by 'django-admin startproject' using Django 3.2.
-
-For more information on this file, see
-https://docs.djangoproject.com/en/3.2/topics/settings/
-
-For the full list of settings and their values, see
-https://docs.djangoproject.com/en/3.2/ref/settings/
-"""
+"""Django settings for backend project."""
 
 from pathlib import Path
+
 from backend.constants import get_constants
 
 constants = get_constants()
@@ -24,78 +15,78 @@
 ALLOWED_HOSTS = constants.DJANGO_ALLOWED_HOSTS
 
 INSTALLED_APPS = [
-    'django.contrib.admin',
-    'django.contrib.auth',
-    'django.contrib.contenttypes',
-    'django.contrib.sessions',
-    'django.contrib.messages',
-    'django.contrib.staticfiles',
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
 ]
 
 MIDDLEWARE = [
-    'django.middleware.security.SecurityMiddleware',
-    'whitenoise.middleware.WhiteNoiseMiddleware',
-    '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',
+    "django.middleware.security.SecurityMiddleware",
+    "whitenoise.middleware.WhiteNoiseMiddleware",
+    "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 = 'backend.urls'
+ROOT_URLCONF = "backend.urls"
 
 TEMPLATES = [
     {
-        'BACKEND': 'django.template.backends.django.DjangoTemplates',
-        'DIRS': [BASE_DIR / 'templates'],
-        'APP_DIRS': True,
-        'OPTIONS': {
-            'context_processors': [
-                'django.template.context_processors.debug',
-                'django.template.context_processors.request',
-                'django.contrib.auth.context_processors.auth',
-                'django.contrib.messages.context_processors.messages',
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [BASE_DIR / "templates"],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
             ],
         },
     },
 ]
 
-WSGI_APPLICATION = 'backend.wsgi.application'
+WSGI_APPLICATION = "backend.wsgi.application"
 
 AUTH_PASSWORD_VALIDATORS = [
     {
-        '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",
     },
 ]
 
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = "en-us"
 
-TIME_ZONE = 'Asia/Kolkata'
+TIME_ZONE = "Asia/Kolkata"
 
 USE_I18N = True
 
 USE_L10N = True
 
 USE_TZ = True
 
-STATIC_URL = '/static/'
+STATIC_URL = "/static/"
 
 STATICFILES_DIRS = [
-    BASE_DIR / 'static',
+    BASE_DIR / "static",
 ]
-STATIC_ROOT = BASE_DIR / 'staticfiles_build' / 'static'
+STATIC_ROOT = BASE_DIR / "staticfiles_build" / "static"
 
-DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
-from backend.db import * # noqa: F401
+from backend.db import *  # noqa: F403, E402

backend/urls.py

@@ -1,25 +1,11 @@
-"""backend URL Configuration
+"""backend URL Configuration for the project."""
 
-The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/3.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
-
 from django.views.generic import TemplateView
 
 urlpatterns = [
-    path('admin/', admin.site.urls),
-    path('', TemplateView.as_view(template_name='index.html')),
-    path('about/', TemplateView.as_view(template_name='about.html')),
+    path("admin/", admin.site.urls),
+    path("", TemplateView.as_view(template_name="index.html")),
+    path("about/", TemplateView.as_view(template_name="about.html")),
 ]

backend/wsgi.py

@@ -1,5 +1,4 @@
-"""
-WSGI config for backend project.
+"""WSGI config for backend project.
 
 It exposes the WSGI callable as a module-level variable named ``application``.
 
@@ -11,6 +10,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'backend.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
 
-application = get_wsgi_application()
+application = get_wsgi_application()

manage.py

@@ -1,22 +1,23 @@
 #!/usr/bin/env python
 """Django's command-line utility for administrative tasks."""
+
 import os
 import sys
 
 
-def main():
+def main() -> None:
     """Run administrative tasks."""
-    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'backend.settings')
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:
         raise ImportError(
             "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?"
+            "forget to activate a virtual environment?",
         ) from exc
     execute_from_command_line(sys.argv)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()