tests: Adding Django test project (#447)

* tests: Adding Django test project

Author: fgmacedo

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
   hooks:
   - id: mypy
     name: Mypy
-    entry: poetry run mypy statemachine/ tests/
+    entry: poetry run mypy --namespace-packages --explicit-package-bases statemachine/ tests/
     types: [python]
     language: system
     pass_filenames: false

conftest.py

@@ -1,3 +1,5 @@
+import sys
+
 import pytest
 
 
@@ -21,3 +23,11 @@ def __init__(self):
     doctest_namespace["State"] = State
     doctest_namespace["StateMachine"] = StateMachine
     doctest_namespace["asyncio"] = ContribAsyncio()
+
+
+def pytest_ignore_collect(collection_path, path, config):
+    if sys.version_info >= (3, 10):  # noqa: UP036
+        return None
+
+    if "django_project" in str(path):
+        return True

poetry.lock

@@ -39,18 +39,21 @@ diagrams = ["pydot"]
 python = ">=3.7"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "*"
-pytest-cov = "*"
-pytest-sugar = "^1.0.0"
 pydot = "^2.0.0"
 ruff = "^0.4.8"
 pre-commit = "*"
 mypy = "*"
+
+[tool.poetry.group.tests.dependencies]
+pytest = "*"
+pytest-cov = "*"
+pytest-sugar = "^1.0.0"
 pytest-mock = "^3.10.0"
 pytest-profiling = "^1.7.0"
 pytest-benchmark = "^4.0.0"
 pytest-asyncio = "*"
-sphinx-rtd-theme = "^2.0.0"
+django = { version = "^5.0.3", python = ">3.10" }
+pytest-django = { version = "^4.8.0", python = ">3.8" }
 
 [tool.poetry.group.docs.dependencies]
 Sphinx = "*"
@@ -71,12 +74,14 @@ asyncio_mode = "auto"
 markers = [
     """slow: marks tests as slow (deselect with '-m "not slow"')""",
 ]
+python_files = ["tests.py", "test_*.py", "*_tests.py"]
 
 [tool.mypy]
 python_version = "3.12"
 warn_return_any = true
 warn_unused_configs = true
 disable_error_code = "annotation-unchecked"
+mypy_path = "$MYPY_CONFIG_FILE_DIR/tests/django_project"
 
 [[tool.mypy.overrides]]
 module = [

pyproject.toml

@@ -1,14 +1,14 @@
 import warnings
 
+from .utils import qualname
+
 try:
-    _has_django = True
     from django.utils.module_loading import autodiscover_modules
-except ImportError:
+except ImportError:  # pragma: no cover
     # Not a django project
-    autodiscover_modules = None
-    _has_django = False
+    def autodiscover_modules(module_name: str):
+        pass
 
-from .utils import qualname
 
 _REGISTRY = {}
 _initialized = False
@@ -39,8 +39,5 @@ def init_registry():
 
 
 def load_modules(modules=None):
-    if not _has_django:
-        return
-
     for module in modules:
         autodiscover_modules(module)

statemachine/registry.py

@@ -1,11 +1,14 @@
 import sys
 from datetime import datetime
+from typing import List
 
 import pytest
 
+collect_ignore_glob: List[str] = []
+
 # We support Python 3.8+ positional only syntax
 if sys.version_info[:2] < (3, 8):  # noqa: UP036
-    collect_ignore_glob = ["*_positional_only.py"]
+    collect_ignore_glob.append("*_positional_only.py")
 
 
 @pytest.fixture()

tests/conftest.py

@@ -0,0 +1,11 @@
+from django.http import HttpResponse
+from django.urls import re_path
+
+
+def home(request):
+    return HttpResponse("WE LOVE DJANGO")
+
+
+urlpatterns = [
+    re_path(r"^$", home, name="homepage"),
+]

tests/django_project/app.py

@@ -0,0 +1,25 @@
+from pathlib import Path
+
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+DEBUG = True
+
+ROOT_URLCONF = "app"
+
+INSTALLED_APPS = [
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+    "workflow",
+]
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": ":memory:",
+    }
+}
+
+WSGI_APPLICATION = "core.wsgi.application"

tests/django_project/core/__init__,.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for project 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.0/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
+
+application = get_wsgi_application()