Add tox, mypy and ruff and all the fixes based on ruff and mypy suggestions.

docs/source/conf.py

@@ -31,6 +31,9 @@ release = '0.1'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

file_validator/admin.py

-from django.contrib import admin
-
-# Register your models here.
+"""Admin configuration for the file_validator app."""

file_validator/apps.py

+"""App configuration for file_validator app."""
 from django.apps import AppConfig
 
 
 class FileValidatorConfig(AppConfig):
+    """App configuration for file_validator."""
+
     default_auto_field = "django.db.models.BigAutoField"
     name = "file_validator"

file_validator/forms.py

-# file_validator/forms.py
+"""Form for uploading CSV files."""
 from django import forms
 
 
 class CSVUploadForm(forms.Form):
-    file = forms.FileField(label='Select a CSV file')
+    """Form for uploading CSV files."""
 
-    def clean_file(self):
-        file = self.cleaned_data['file']
+    file = forms.FileField(label="Select a CSV file")
+
+    def clean_file(self) -> str:
+        """Check if the file is a CSV file."""
+        file = self.cleaned_data["file"]
 
         # Check if the file is a CSV
-        if not file.name.endswith('.csv'):
-            raise forms.ValidationError("Only CSV files are allowed")
+        if not file.name.endswith(".csv"):
+            err_msg = "Only CSV files are allowed"
+            raise forms.ValidationError(err_msg)
         return file

file_validator/models.py

-from django.db import models
-
-# Create your models here.
+"""Models for the file_validator app."""

file_validator/tests.py

-from django.test import TestCase
-
-# Create your tests here.
+"""All the tests for the file_validator app."""

file_validator/urls.py

+"""Urls for the file_validator app."""
 from django.urls import path
-from .views import CSVUploadView
+
+from file_validator.views import CSVUploadView
+
 urlpatterns = [
-    path('upload/', CSVUploadView.as_view(), name='upload-file'),
-]
\ No newline at end of file
+    path("upload/", CSVUploadView.as_view(), name="upload-file"),
+]

file_validator/views.py

+"""Contains the views for the file_validator app."""
 import csv
-from django.views.generic.edit import FormView
-from django.urls import reverse_lazy
+
 from django.http import JsonResponse
-from .forms import CSVUploadForm
+from django.urls import reverse_lazy
+from django.views.generic.edit import FormView
+
+from file_validator.forms import CSVUploadForm
 
 
 class CSVUploadView(FormView):
-    template_name = 'upload.html'
+    """View for uploading a CSV file."""
+
+    template_name = "upload.html"
     form_class = CSVUploadForm
-    success_url = reverse_lazy('upload-file')
+    success_url = reverse_lazy("upload-file")
 
-    def get_context_data(self, **kwargs):
-        """
-        This method is called when rendering the form (GET request).
-        """
+    def get_context_data(self, **kwargs: dict) -> dict:
+        """Render the form with no error message on GET request."""
         context = super().get_context_data(**kwargs)
-        context['error'] = None  # No error message on GET request
-        context['message'] = None  # No success message on GET request
+        context["error"] = None  # No error message on GET request
+        context["message"] = None  # No success message on GET request
         return context
 
-    def form_valid(self, form):
-        """
-        This method is called when the form is valid (POST request).
-        It handles the CSV validation and passes appropriate error or success messages to the template.
-        """
-        file_obj = form.cleaned_data['file']
+    def form_valid(self, form: CSVUploadForm) -> JsonResponse:
+        """Handle the CSV validation and passes appropriate error or success messages to the template."""
+        file_obj = form.cleaned_data["file"]
 
         try:
             # Read and decode the CSV file
-            csv_file = file_obj.read().decode('utf-8').splitlines()
+            csv_file = file_obj.read().decode("utf-8").splitlines()
             reader = csv.DictReader(csv_file)
 
             # Example validation: Check for required columns
             # TODO: Add the validation logic here. This is just a sample.
-            required_columns = ['name']
-            missing_columns = [col for col in required_columns if col not in reader.fieldnames]
+            required_columns = ["name"]
+            fieldnames = reader.fieldnames if reader.fieldnames is not None else []
+            missing_columns = [col for col in required_columns if col not in fieldnames]
 
             if missing_columns:
                 # If there are missing columns, return error message as JSON
                 return JsonResponse(
-                    {'status': 'error', 'errors': [f"Missing columns: {', '.join(missing_columns)}"]}, status=400
+                    {"status": "error", "errors": [f"Missing columns: {", ".join(missing_columns)}"]}, status=400
                 )
 
-            return JsonResponse({'status': 'success', 'message': "CSV file is valid"})
+            return JsonResponse({"status": "success", "message": "CSV file is valid"})
 
-        except Exception as e:
-            # If there's an error (e.g., invalid file content), return the error message as JSON
-            return JsonResponse({'status': 'error', 'errors': [str(e)]}, status=400)
+        except (UnicodeDecodeError, csv.Error) as e:
+            # If there"s an error (e.g., invalid file content), return the error message as JSON
+            return JsonResponse({"status": "error", "errors": [str(e)]}, status=400)
+
+    def form_invalid(self, form: CSVUploadForm) -> JsonResponse:
+        """Handle the form when it is invalid (e.g., wrong file type).
 
-    def form_invalid(self, form):
-        """
-        This method is called when the form is invalid (e.g., wrong file type).
         It renders the form again with errors.
         """
-        return JsonResponse({'status': 'error', 'errors': [form.errors]}, status=400)
+        return JsonResponse({"status": "error", "errors": [form.errors]}, status=400)

pyproject.toml

+[tool.mypy]
+mypy_path = "sage_validation"
+exclude = [
+    "venv",
+    "docs",
+    "manage.py",
+
+
+]
+ignore_missing_imports = true  # Ignore imports that are not typed
+disallow_untyped_calls = true    # Disallow calls to untyped functions
+disallow_untyped_defs = true      # Disallow untyped function definitions
+
+[tool.ruff]
+extend-exclude = [
+    "*/migrations",
+    "sage_validation/wsgi.py",
+    "sage_validation/asgi.py",
+    "sage_validation/settings.py",
+    "manage.py",
+    "docs",
+    "theme",
+]
+select = [
+    "A", "ARG", "B", "BLE", "C", "COM", "C4", "C90", "D", "DTZ",
+    "E", "EM", "ERA", "F", "FA", "FBT", "FLY", "FURB", "G", "I",
+    "ICN", "INP", "ISC", "LOG", "N", "PERF", "PGH", "PIE", "PL",
+    "PT", "PTH", "PYI", "Q", "RET", "R", "RET", "RSE", "RUF",
+    "S", "SIM", "SLF", "T", "T20", "TID", "TRY", "UP", "W", "YTT"
+]
+ignore = [
+    "COM812", "D203", "D213", "ISC001", "N805", "PLR0913", "PLR0904", "PLW1514", "D104"
+]
+target-version = "py312"
+line-length = 120
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+

sage_validation/settings.py

@@ -24,7 +24,7 @@ SECRET_KEY = "django-insecure-9tdba&yktxzclzokj^=uxfsmisgeo8(6!p3koa8ndy8s^3x@@y
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = []
+ALLOWED_HOSTS: list[str] = []
 
 # Application definition
 INSTALLED_APPS = [

sage_validation/urls.py

-"""
-URL configuration for sage_validation project.
-
-The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/5.1/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'))
-"""
+"""URL configuration for sage_validation project."""
 from django.contrib import admin
 from django.urls import path
 from django.urls.conf import include

setup.py

-from setuptools import setup, find_packages
+"""Setup script for the sage-validation package."""
+from setuptools import find_packages, setup
 
 setup(
-    name='sage-validation',
-    version='0.1',
+    name="sage-validation",
+    version="0.1",
     packages=find_packages(),
     include_package_data=True,
     install_requires=[
-        'Django==5.1.1'
+        "Django==5.1.1"
     ],
     classifiers=[
-        'Programming Language :: Python :: 3',
-        'Framework :: Django',
-        'Operating System :: OS Independent',
+        "Programming Language :: Python :: 3",
+        "Framework :: Django",
+        "Operating System :: OS Independent",
     ],
-    python_requires='>=3.12'
+    python_requires=">=3.12"
 )

tox.ini

+[tox]
+envlist = py312
+
+[testenv]
+deps =
+    mypy
+    ruff
+commands =
+    ruff check .
+    mypy .