Merge branch 'main' into feat/update_tests

svlandeg · svlandeg · commit 8766a6b4b614 · 2025-11-11T17:15:45.000+01:00
diff --git a/.github/workflows/issue-manager.yml b/.github/workflows/issue-manager.yml
@@ -38,6 +38,10 @@ jobs:
               },
               "waiting": {
                 "delay": 2628000,
-                "message": "As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR."
+                "message": "As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR.",
+                "reminder": {
+                    "before": "P3D",
+                    "message": "Heads-up: this will be closed in 3 days unless there’s new activity."
+                }
               }
             }
diff --git a/.github/workflows/smokeshow.yml b/.github/workflows/smokeshow.yml
@@ -25,15 +25,15 @@ jobs:
         with:
           python-version: '3.9'
       - name: Setup uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           version: "0.4.15"
           enable-cache: true
           cache-dependency-glob: |
             requirements**.txt
             pyproject.toml
       - run: uv pip install -r requirements-github-actions.txt
-      - uses: actions/download-artifact@v5
+      - uses: actions/download-artifact@v6
         with:
           name: coverage-html
           path: htmlcov
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -30,19 +30,26 @@ jobs:
       matrix:
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         python-version: ["3.14"]
+        pydantic-version: ["v1", "v2"]
         include:
           - os: windows-latest
             python-version: "3.8"
+            pydantic-version: "v1"
           - os: macos-latest
             python-version: "3.9"
+            pydantic-version: "v2"
           - os: ubuntu-latest
             python-version: "3.10"
+            pydantic-version: "v1"
           - os: windows-latest
             python-version: "3.11"
+            pydantic-version: "v2"
           - os: macos-latest
             python-version: "3.12"
+            pydantic-version: "v1"
           - os: ubuntu-latest
             python-version: "3.13"
+            pydantic-version: "v2"
       fail-fast: false
     runs-on: ${{ matrix.os }}
     steps:
@@ -56,7 +63,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Setup uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           version: "0.4.15"
           enable-cache: true
@@ -71,18 +78,21 @@ jobs:
           limit-access-to-actor: true
       - name: Install Dependencies
         run: uv pip install -r requirements-tests.txt
+      - name: Install Pydantic v1
+        if: matrix.pydantic-version == 'v1'
+        run: uv pip install "pydantic<2.0.0"
       - name: Lint
         run: bash scripts/lint.sh
       - run: mkdir coverage
       - name: Test
         run: bash scripts/test.sh
         env:
-          COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}
-          CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}
+          COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-pydantic-${{ matrix.pydantic-version }}
+          CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}-pydantic-${{ matrix.pydantic-version }}
       - name: Store coverage files
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
-          name: coverage-${{ runner.os }}-${{ matrix.python-version }}
+          name: coverage-${{ runner.os }}-${{  matrix.python-version }}-pydantic-${{ matrix.pydantic-version }}
           path: coverage
           include-hidden-files: true
 
@@ -99,15 +109,15 @@ jobs:
         with:
           python-version: '3.8'
       - name: Setup uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           version: "0.4.15"
           enable-cache: true
           cache-dependency-glob: |
             requirements**.txt
             pyproject.toml
       - name: Get coverage files
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           pattern: coverage-*
           path: coverage
@@ -118,7 +128,7 @@ jobs:
       - run: coverage report
       - run: coverage html --title "Coverage for ${{ github.sha }}"
       - name: Store coverage HTML
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: coverage-html
           path: htmlcov
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,7 +14,7 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.13.0
+    rev: v0.14.4
     hooks:
     -   id: ruff
         args:
diff --git a/pyproject.toml b/pyproject.toml
@@ -7,7 +7,8 @@ authors = [
 ]
 requires-python = ">=3.8"
 readme = "README.md"
-license = {text = "MIT"}
+license = "MIT"
+license-files = ["LICENSE"]
 classifiers = [
     "Intended Audience :: Information Technology",
     "Intended Audience :: System Administrators",
@@ -22,7 +23,6 @@ classifiers = [
     "Development Status :: 4 - Beta",
     "Framework :: FastAPI",
     "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
@@ -31,12 +31,12 @@ classifiers = [
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
-    "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
     "typer >= 0.15.1",
     "uvicorn[standard] >= 0.15.0",
     "rich-toolkit >= 0.14.8",
+    "tomli >= 2.0.0; python_version < '3.11'"
 ]
 
 [project.optional-dependencies]
diff --git a/release-notes.md b/release-notes.md
@@ -2,6 +2,42 @@
 
 ## Latest Changes
 
+### Internal
+
+* ⬆ Bump ruff from 0.14.2 to 0.14.4. PR [#239](https://github.com/fastapi/fastapi-cli/pull/239) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#238](https://github.com/fastapi/fastapi-cli/pull/238) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
+
+## 0.0.16
+
+### Fixes
+
+* 🐛 Fix support for Pydantic v1. PR [#240](https://github.com/fastapi/fastapi-cli/pull/240) by [@patrick91](https://github.com/patrick91).
+
+## 0.0.15
+
+### Features
+
+* ✨ Add support for reading configuration from `pyproject.toml`. PR [#236](https://github.com/fastapi/fastapi-cli/pull/236) by [@patrick91](https://github.com/patrick91).
+
+You can use it in `pyproject.toml` like:
+
+```toml
+[tool.fastapi]
+entrypoint = "some.importable_module:app_name"
+```
+
+### Internal
+
+* ⬆ Bump actions/upload-artifact from 4 to 5. PR [#232](https://github.com/fastapi/fastapi-cli/pull/232) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump ruff from 0.14.1 to 0.14.2. PR [#231](https://github.com/fastapi/fastapi-cli/pull/231) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump actions/download-artifact from 5 to 6. PR [#233](https://github.com/fastapi/fastapi-cli/pull/233) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#235](https://github.com/fastapi/fastapi-cli/pull/235) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
+* 🔧 Add PEP-639 license metadata. PR [#234](https://github.com/fastapi/fastapi-cli/pull/234) by [@svlandeg](https://github.com/svlandeg).
+* ⬆ Bump astral-sh/setup-uv from 6 to 7. PR [#223](https://github.com/fastapi/fastapi-cli/pull/223) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* ⬆ Bump ruff from 0.13.0 to 0.14.1. PR [#228](https://github.com/fastapi/fastapi-cli/pull/228) by [@dependabot[bot]](https://github.com/apps/dependabot).
+* 🔧 Configure reminder for `waiting` label in `issue-manager`. PR [#227](https://github.com/fastapi/fastapi-cli/pull/227) by [@YuriiMotov](https://github.com/YuriiMotov).
+* ⬆ [pre-commit.ci] pre-commit autoupdate. PR [#215](https://github.com/fastapi/fastapi-cli/pull/215) by [@pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci).
+
 ## 0.0.14
 
 ### Upgrades
diff --git a/requirements-tests.txt b/requirements-tests.txt
@@ -3,7 +3,7 @@
 pytest >=4.4.0,<9.0.0
 coverage[toml] >=6.2,<8.0
 mypy ==1.14.1
-ruff ==0.13.0
+ruff ==0.14.4
 # Needed explicitly by fastapi-cli-slim
 fastapi-slim
 uvicorn
diff --git a/src/fastapi_cli/__init__.py b/src/fastapi_cli/__init__.py
@@ -1 +1 @@
-__version__ = "0.0.14"
+__version__ = "0.0.16"
diff --git a/src/fastapi_cli/cli.py b/src/fastapi_cli/cli.py
@@ -3,10 +3,12 @@
 from typing import Any, List, Union
 
 import typer
+from pydantic import ValidationError
 from rich import print
 from rich.tree import Tree
 from typing_extensions import Annotated
 
+from fastapi_cli.config import FastAPIConfig
 from fastapi_cli.discover import get_import_data, get_import_data_from_import_string
 from fastapi_cli.exceptions import FastAPICLIException
 
@@ -111,11 +113,37 @@ def _run(
             "Searching for package file structure from directories with [blue]__init__.py[/blue] files"
         )
 
+        if entrypoint and (path or app):
+            toolkit.print_line()
+            toolkit.print(
+                "[error]Cannot use --entrypoint together with path or --app arguments"
+            )
+            toolkit.print_line()
+            raise typer.Exit(code=1)
+
         try:
-            if entrypoint:
-                import_data = get_import_data_from_import_string(entrypoint)
-            else:
+            config = FastAPIConfig.resolve(entrypoint=entrypoint)
+        except ValidationError as e:
+            toolkit.print_line()
+            toolkit.print("[error]Invalid configuration in pyproject.toml:")
+            toolkit.print_line()
+
+            for error in e.errors():
+                field = ".".join(str(loc) for loc in error["loc"])
+                toolkit.print(f"  [red]•[/red] {field}: {error['msg']}")
+
+            toolkit.print_line()
+
+            raise typer.Exit(code=1) from None
+
+        try:
+            # Resolve import data with priority: CLI path/app > config entrypoint > auto-discovery
+            if path or app:
                 import_data = get_import_data(path=path, app_name=app)
+            elif config.entrypoint:
+                import_data = get_import_data_from_import_string(config.entrypoint)
+            else:
+                import_data = get_import_data()
         except FastAPICLIException as e:
             toolkit.print_line()
             toolkit.print(f"[error]{e}")
diff --git a/src/fastapi_cli/config.py b/src/fastapi_cli/config.py
@@ -0,0 +1,50 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, StrictStr
+from pydantic.version import VERSION as PYDANTIC_VERSION
+
+logger = logging.getLogger(__name__)
+
+PYDANTIC_VERSION_MINOR_TUPLE = tuple(int(x) for x in PYDANTIC_VERSION.split(".")[:2])
+PYDANTIC_V2 = PYDANTIC_VERSION_MINOR_TUPLE[0] == 2
+
+
+class FastAPIConfig(BaseModel):
+    entrypoint: Optional[StrictStr] = None
+
+    @classmethod
+    def _read_pyproject_toml(cls) -> Dict[str, Any]:
+        """Read FastAPI configuration from pyproject.toml in current directory."""
+        pyproject_path = Path.cwd() / "pyproject.toml"
+
+        if not pyproject_path.exists():
+            return {}
+
+        try:
+            import tomllib  # type: ignore[import-not-found, unused-ignore]
+        except ImportError:
+            try:
+                import tomli as tomllib  # type: ignore[no-redef, import-not-found, unused-ignore]
+            except ImportError:  # pragma: no cover
+                logger.debug("tomli not available, skipping pyproject.toml")
+                return {}
+
+        with open(pyproject_path, "rb") as f:
+            data = tomllib.load(f)
+
+            return data.get("tool", {}).get("fastapi", {})  # type: ignore
+
+    @classmethod
+    def resolve(cls, entrypoint: Optional[str] = None) -> "FastAPIConfig":
+        config = cls._read_pyproject_toml()
+
+        if entrypoint is not None:
+            config["entrypoint"] = entrypoint
+
+        # Pydantic v2 uses model_validate, v1 uses parse_obj
+        if not PYDANTIC_V2:
+            return cls.parse_obj(config)  # type: ignore[no-any-return, unused-ignore]
+
+        return cls.model_validate(config)  # type: ignore[no-any-return, unused-ignore, attr-defined]
diff --git a/tests/assets/pyproject_config/another_module.py b/tests/assets/pyproject_config/another_module.py
@@ -0,0 +1,8 @@
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
diff --git a/tests/assets/pyproject_config/my_module.py b/tests/assets/pyproject_config/my_module.py
@@ -0,0 +1,8 @@
+from fastapi import FastAPI
+
+app = FastAPI()
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
diff --git a/tests/assets/pyproject_config/pyproject.toml b/tests/assets/pyproject_config/pyproject.toml
@@ -0,0 +1,2 @@
+[tool.fastapi]
+entrypoint = "my_module:app"
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -45,6 +45,21 @@ def test_dev() -> None:
         assert "🐍 single_file_app.py" in result.output
 
 
+def test_dev_no_args_auto_discovery() -> None:
+    """Test that auto-discovery works when no args and no pyproject.toml entrypoint"""
+    with changing_dir(assets_path / "default_files" / "default_main"):
+        with patch.object(uvicorn, "run") as mock_run:
+            result = runner.invoke(app, ["dev"])  # No path argument
+            assert result.exit_code == 0, result.output
+            assert mock_run.called
+            assert mock_run.call_args
+            assert mock_run.call_args.kwargs["app"] == "main:app"
+            assert mock_run.call_args.kwargs["host"] == "127.0.0.1"
+            assert mock_run.call_args.kwargs["port"] == 8000
+            assert mock_run.call_args.kwargs["reload"] is True
+        assert "Using import string: main:app" in result.output
+
+
 def test_dev_package() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
@@ -189,6 +204,23 @@ def test_dev_env_vars_and_args() -> None:
         )
 
 
+def test_entrypoint_mutually_exclusive_with_path() -> None:
+    result = runner.invoke(app, ["dev", "mymodule.py", "--entrypoint", "other:app"])
+
+    assert result.exit_code == 1
+    assert (
+        "Cannot use --entrypoint together with path or --app arguments" in result.output
+    )
+
+
+def test_entrypoint_mutually_exclusive_with_app() -> None:
+    result = runner.invoke(app, ["dev", "--app", "myapp", "--entrypoint", "other:app"])
+    assert result.exit_code == 1
+    assert (
+        "Cannot use --entrypoint together with path or --app arguments" in result.output
+    )
+
+
 def test_run() -> None:
     with changing_dir(assets_path):
         with patch.object(uvicorn, "run") as mock_run:
diff --git a/tests/test_cli_pyproject.py b/tests/test_cli_pyproject.py

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,10 @@ jobs:`
`38`	`38`	`},`
`39`	`39`	`"waiting": {`
`40`	`40`	`"delay": 2628000,`
`41`		`- "message": "As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR."`
	`41`	`+ "message": "As this PR has been waiting for the original user for a while but seems to be inactive, it's now going to be closed. But if there's anyone interested, feel free to create a new PR.",`
	`42`	`+ "reminder": {`
	`43`	`+ "before": "P3D",`
	`44`	`+ "message": "Heads-up: this will be closed in 3 days unless there’s new activity."`
	`45`	`+ }`
`42`	`46`	`}`
`43`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.0.14"`
	`1`	`+__version__ = "0.0.16"`