Merge branch 'main' into uv

Author: bckohan

.github/workflows/test.yml

@@ -341,6 +341,9 @@ jobs:
       run: |
         just test ./tests/verify_environment.py
         just test-bash || exit 1
+        sudo apt-get remove --purge -y powershell
+        source .venv/bin/activate
+        pytest --cov-append ./tests/shellcompletion/test_shell_resolution.py::test_get_win_shell_failure || exit 1
 
     - name: Store coverage files
       uses: actions/upload-artifact@v4
@@ -658,14 +661,14 @@ jobs:
       shell: powershell
     - name: Run Powershell Tab Completion Tests
       run: |
-        just test ./tests/verify_environment.py
-        just test-powershell
-        if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+        just test ./tests/verify_environment.py; if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+        .venv\Scripts\activate.ps1; cmd /c "pytest --cov-append ./tests/shellcompletion/test_shell_resolution.py::TestShellResolution::test_powershell"; if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+        just test-powershell; if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
       shell: powershell
     - name: Test CMD shell failure
       run: |
         call .venv\Scripts\activate
-        pytest --cov-append ./tests/shellcompletion/test_shell_resolution.py::test_get_win_shell_failure
+        pytest --cov-append ./tests/shellcompletion/test_shell_resolution.py::test_get_win_shell_failure || exit 1
       shell: cmd
     - name: Store coverage files
       uses: actions/upload-artifact@v4
@@ -727,9 +730,9 @@ jobs:
     - name: Run Powershell Tab Completion Tests
       run: |
         just test ./tests/verify_environment.py
-        just test-pwsh
-        if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
-      shell: powershell
+        .venv\Scripts\activate.ps1; cmd /c "pytest --cov-append ./tests/shellcompletion/test_shell_resolution.py::TestShellResolution::test_pwsh"; if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+        just test-pwsh; if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+      shell: pwsh
     - name: Test CMD shell failure
       run: |
         call .venv\Scripts\activate

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 Brian Kohan
+Copyright (c) 2023-2025 Brian Kohan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

doc/.readthedocs.yaml

@@ -11,15 +11,14 @@ build:
   tools:
     python: "3.12"
   jobs:
-    post_create_environment:
-      - pip install poetry
     post_install:
-      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry install -E rich --with docs
+      - pip install uv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs --link-mode=copy
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: doc/source/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
-  - pdf
+  - pdf

doc/source/changelog.rst

@@ -7,6 +7,7 @@ Change Log
 v3.1.0 (2024-03-xx)
 ===================
 
+* Fixed `Shell completion tests let failures through in CI <https://github.com/django-commons/django-typer/issues/194>`_
 * Fixed `fish completion installs should respect XDG_CONFIG_HOME <https://github.com/django-commons/django-typer/issues/193>`_
 * Fixed `zsh completion installs should respect ZDOTDIR <https://github.com/django-commons/django-typer/issues/192>`_
 * Implemented `Support Django 5.2 <https://github.com/django-commons/django-typer/issues/188>`_

doc/source/conf.py

@@ -6,8 +6,7 @@
 import shutil
 import django
 
-sys.path.append(str(Path(__file__).parent.parent / 'tests'))
-sys.path.append(str(Path(__file__).parent.parent / 'examples'))
+sys.path.append(str(Path(__file__).parent.parent.parent))
 sys.path.append(str(Path(__file__).parent / 'ext'))
 
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings.base')

pyproject.toml

@@ -143,13 +143,14 @@ command_line = "-m pytest --cov=django_typer"
 
 [tool.coverage.paths]
 source = [
-    "django_typer"
+    "src/django_typer"
 ]
 
 [tool.pyright]
 exclude = ["tests/**/*"]
 include = [
-    "src/django_typer"
+    "src/django_typer",
+    "*/site-packages/django_typer"
 ]
 
 [tool.ruff]

src/django_typer/apps.py

@@ -30,28 +30,25 @@ def check_traceback_config(app_configs, **kwargs) -> t.List[CheckMessage]:
     warnings: t.List[CheckMessage] = []
     if use_rich_tracebacks():
         tb_config = traceback_config()
-        try:
-            from rich import traceback  # pyright: ignore[reportMissingImports]
+        from rich import traceback  # pyright: ignore[reportMissingImports]
 
-            expected = {
-                "no_install",
-                "short",
-                *inspect.signature(traceback.install).parameters.keys(),
-            }
-            unexpected = set(tb_config.keys()) - expected
-            if unexpected:
-                warnings.append(
-                    CheckWarning(
-                        "DT_RICH_TRACEBACK_CONFIG",
-                        hint="Unexpected parameters encountered: {keys}.".format(
-                            keys=", ".join(unexpected)
-                        ),
-                        obj=settings.SETTINGS_MODULE,
-                        id="django_typer.W001",
-                    )
+        expected = {
+            "no_install",
+            "short",
+            *inspect.signature(traceback.install).parameters.keys(),
+        }
+        unexpected = set(tb_config.keys()) - expected
+        if unexpected:
+            warnings.append(
+                CheckWarning(
+                    "DT_RICH_TRACEBACK_CONFIG",
+                    hint="Unexpected parameters encountered: {keys}.".format(
+                        keys=", ".join(unexpected)
+                    ),
+                    obj=settings.SETTINGS_MODULE,
+                    id="django_typer.W001",
                 )
-        except ImportError:
-            pass
+            )
     return warnings
 
 

tests/test_tracebacks.py

@@ -19,7 +19,7 @@ def test_default_traceback(self):
         ]
         self.assertIn("Traceback (most recent call last)", result)
         self.assertIn("Exception: This is a test exception", result)
-        if rich_installed:
+        if self.rich_installed:
             self.assertIn("────────", result)
             # locals should not be present
             self.assertNotIn("name = 'me'", result)
@@ -54,7 +54,7 @@ def test_tb_command_overrides(self):
         )[1]
         self.assertIn("Traceback (most recent call last)", result)
         self.assertIn("Exception: This is a test exception", result)
-        if rich_installed:
+        if self.rich_installed:
             self.assertIn("────────", result)
             # locals should be present
             self.assertIn("name = 'me'", result)
@@ -114,7 +114,7 @@ def test_traceback_set_to_false(self):
     @override_settings(DT_RICH_TRACEBACK_CONFIG=True)
     def test_traceback_set_to_true(self):
         self.assertEqual(traceback_config(), {"show_locals": False})
-        self.assertIs(use_rich_tracebacks(), rich_installed)
+        self.assertIs(use_rich_tracebacks(), self.rich_installed)
 
     @override_settings(DT_RICH_TRACEBACK_CONFIG=None)
     def test_traceback_set_to_none(self):
@@ -156,7 +156,7 @@ def test_traceback_no_locals_short_false(self):
         )[1]
         self.assertIn("Traceback (most recent call last)", result)
         self.assertIn("Exception: This is a test exception", result)
-        if rich_installed:
+        if self.rich_installed:
             self.assertIn("────────", result)
             self.assertGreater(len(re.findall(r"\.py:\d+", result) or []), 0)
 
@@ -199,7 +199,7 @@ def test_colored_traceback(self):
         result = run_command(
             "test_command1", "--force-color", "delete", "Brian", "--throw"
         )[1]
-        if rich_installed:
+        if self.rich_installed:
             self.assertIn("\x1b", result)
 
         result = run_command(