Merge remote-tracking branch 'upstream/main' into config

Author: mattmess1221

.github/workflows/smokeshow.yml

@@ -24,12 +24,14 @@ jobs:
 
       - run: pip install smokeshow
 
-      - uses: dawidd6/action-download-artifact@v3.1.4
+      - uses: actions/download-artifact@v4
         with:
-          workflow: test.yml
-          commit: ${{ github.event.workflow_run.head_sha }}
+          name: coverage-html
+          path: htmlcov
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
 
-      - run: smokeshow upload coverage-html
+      - run: smokeshow upload htmlcov
         env:
           SMOKESHOW_GITHUB_STATUS_DESCRIPTION: Coverage {coverage-percentage}
           SMOKESHOW_GITHUB_COVERAGE_THRESHOLD: 100

.github/workflows/test.yml

@@ -31,6 +31,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
+          - "3.12"
       fail-fast: false
     steps:
       - name: Dump GitHub context
@@ -68,9 +69,9 @@ jobs:
           COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
           CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
       - name: Store coverage files
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: coverage
+          name: coverage-${{ matrix.python-version }}
           path: coverage
 
   coverage-combine:
@@ -89,17 +90,18 @@ jobs:
           # cache: "pip"
           # cache-dependency-path: pyproject.toml
       - name: Get coverage files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
-          name: coverage
+          pattern: coverage-*
           path: coverage
+          merge-multiple: true
       - run: pip install coverage[toml]
       - run: ls -la coverage
       - run: coverage combine coverage
       - run: coverage report
       - run: coverage html --show-contexts --title "Coverage for ${{ github.sha }}"
       - name: Store coverage HTML
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coverage-html
           path: htmlcov

pyproject.toml

@@ -71,10 +71,12 @@ source-includes = [
 name = "fastapi-cli-slim"
 
 [tool.tiangolo._internal-slim-build.packages.fastapi-cli]
-include-optional-dependencies = ["standard"]
+# No default dependencies included for now
+include-optional-dependencies = []
 
 [tool.tiangolo._internal-slim-build.packages.fastapi-cli.project]
-optional-dependencies = {}
+# No custom optional dependencies for now
+# optional-dependencies = {}
 
 [tool.pytest.ini_options]
 addopts = [

release-notes.md

@@ -2,6 +2,22 @@
 
 ## Latest Changes
 
+### Refactors
+
+* ♻️ Simplify code in `src/fastapi_cli/discover.py`. PR [#22](https://github.com/tiangolo/fastapi-cli/pull/22) by [@pedroimpulcetto](https://github.com/pedroimpulcetto).
+
+### Internal
+
+* ⬆ Bump ruff from 0.4.3 to 0.4.4. PR [#23](https://github.com/tiangolo/fastapi-cli/pull/23) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* 👷 Enable CI tests for Python 3.12. PR [#27](https://github.com/tiangolo/fastapi-cli/pull/27) by [@tiangolo](https://github.com/tiangolo).
+* 👷 Update Upload/Download artifacts GitHub Actions. PR [#26](https://github.com/tiangolo/fastapi-cli/pull/26) by [@tiangolo](https://github.com/tiangolo).
+
+## 0.0.4
+
+### Fixes
+
+* 🔧 Make FastAPI and Uvicorn optional dependencies, to avoid circular dependencies. PR [#25](https://github.com/tiangolo/fastapi-cli/pull/25) by [@tiangolo](https://github.com/tiangolo).
+
 ### Internal
 
 * ⬆ Bump actions/cache from 3 to 4. PR [#5](https://github.com/tiangolo/fastapi-cli/pull/5) by [@dependabot[bot]](https://github.com/apps/dependabot).

requirements-tests.txt

@@ -3,7 +3,7 @@
 pytest >=4.4.0,<9.0.0
 coverage[toml] >=6.2,<8.0
 mypy ==1.10.0
-ruff ==0.4.3
+ruff ==0.4.4
 # Needed explicitly by fastapi-cli-slim
 fastapi-slim
 uvicorn

src/fastapi_cli/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.3"
+__version__ = "0.0.4"

src/fastapi_cli/cli.py

@@ -3,7 +3,6 @@
 from typing import Any, Union
 
 import typer
-import uvicorn
 from rich import print
 from rich.padding import Padding
 from rich.panel import Panel
@@ -21,6 +20,11 @@
 setup_logging()
 logger = getLogger(__name__)
 
+try:
+    import uvicorn
+except ImportError:  # pragma: no cover
+    uvicorn = None  # type: ignore[assignment]
+
 
 def version_callback(value: bool) -> None:
     if value:
@@ -82,6 +86,10 @@ def _run(
             style="green",
         )
     print(Padding(panel, 1))
+    if not uvicorn:
+        raise FastAPICLIException(
+            "Could not import Uvicorn, try running 'pip install uvicorn'"
+        ) from None
     uvicorn.run(
         app=use_uvicorn_app,
         host=host,

src/fastapi_cli/discover.py

@@ -5,7 +5,6 @@
 from pathlib import Path
 from typing import Union
 
-from fastapi import FastAPI
 from rich import print
 from rich.padding import Padding
 from rich.panel import Panel
@@ -16,26 +15,27 @@
 
 logger = getLogger(__name__)
 
+try:
+    from fastapi import FastAPI
+except ImportError:  # pragma: no cover
+    FastAPI = None  # type: ignore[misc, assignment]
+
 
 def get_default_path() -> Path:
-    path = Path("main.py")
-    if path.is_file():
-        return path
-    path = Path("app.py")
-    if path.is_file():
-        return path
-    path = Path("api.py")
-    if path.is_file():
-        return path
-    path = Path("app/main.py")
-    if path.is_file():
-        return path
-    path = Path("app/app.py")
-    if path.is_file():
-        return path
-    path = Path("app/api.py")
-    if path.is_file():
-        return path
+    potential_paths = (
+        "main.py",
+        "app.py",
+        "api.py",
+        "app/main.py",
+        "app/app.py",
+        "app/api.py",
+    )
+
+    for full_path in potential_paths:
+        path = Path(full_path)
+        if path.is_file():
+            return path
+
     raise FastAPICLIException(
         "Could not find a default file to run, please provide an explicit path"
     )
@@ -107,6 +107,10 @@ def get_app_name(*, mod_data: ModuleData, app_name: Union[str, None] = None) ->
             "Ensure all the package directories have an [blue]__init__.py[/blue] file"
         )
         raise
+    if not FastAPI:  # type: ignore[truthy-function]
+        raise FastAPICLIException(
+            "Could not import FastAPI, try running 'pip install fastapi'"
+        ) from None
     object_names = dir(mod)
     object_names_set = set(object_names)
     if app_name:

tests/test_requirements.py

@@ -0,0 +1,45 @@
+from pathlib import Path
+
+import pytest
+from fastapi_cli.discover import get_import_string
+from fastapi_cli.exceptions import FastAPICLIException
+from typer.testing import CliRunner
+
+from .utils import changing_dir
+
+runner = CliRunner()
+
+assets_path = Path(__file__).parent / "assets"
+
+
+def test_no_uvicorn() -> None:
+    import fastapi_cli.cli
+    import uvicorn
+
+    fastapi_cli.cli.uvicorn = None  # type: ignore[attr-defined, assignment]
+
+    with changing_dir(assets_path):
+        result = runner.invoke(fastapi_cli.cli.app, ["dev", "single_file_app.py"])
+        assert result.exit_code == 1
+        assert result.exception is not None
+        assert (
+            "Could not import Uvicorn, try running 'pip install uvicorn'"
+            in result.exception.args[0]
+        )
+
+    fastapi_cli.cli.uvicorn = uvicorn  # type: ignore[attr-defined]
+
+
+def test_no_fastapi() -> None:
+    import fastapi_cli.discover
+    from fastapi import FastAPI
+
+    fastapi_cli.discover.FastAPI = None  # type: ignore[attr-defined, assignment]
+    with changing_dir(assets_path):
+        with pytest.raises(FastAPICLIException) as exc_info:
+            get_import_string(path=Path("single_file_app.py"))
+        assert "Could not import FastAPI, try running 'pip install fastapi'" in str(
+            exc_info.value
+        )
+
+    fastapi_cli.discover.FastAPI = FastAPI  # type: ignore[attr-defined]