Compare commits

...
8 Commits
7 changed files with 157 additions and 60 deletions
+17
View File
@@ -12,6 +12,7 @@ def parse_endpoint(value: str | None, default_port: int = 0) -> list[dict]:
Returns: Returns:
List of dicts with uvicorn bind kwargs (host/port or uds). List of dicts with uvicorn bind kwargs (host/port or uds).
Two entries may be returned for IPv4 and IPv6 (all interaces).
Supported forms: Supported forms:
- None or empty -> [{host: "localhost", port: default_port}] - None or empty -> [{host: "localhost", port: default_port}]
@@ -65,3 +66,19 @@ def parse_endpoint(value: str | None, default_port: int = 0) -> list[dict]:
ipaddress.ip_address(host) ipaddress.ip_address(host)
return [{"host": host, "port": port}] return [{"host": host, "port": port}]
def parse_endpoints(
listen: str | list[str] | None = None, default_port: int = 8000
) -> list[dict]:
"""Parse listen strings into a list of endpoint dicts.
Args:
listen: Endpoint string(s) (see parse_endpoint for formats).
default_port: Port to use when not specified in listen args.
"""
if listen is None:
listen = [f"localhost:{default_port}"]
elif isinstance(listen, str):
listen = [listen]
return [ep for s in listen for ep in parse_endpoint(s, default_port)]
+4 -8
View File
@@ -6,7 +6,7 @@ from contextlib import suppress
import uvicorn import uvicorn
from uvicorn import Config, Server from uvicorn import Config, Server
from .hostutil import parse_endpoint from .hostutil import parse_endpoints
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@@ -30,13 +30,9 @@ def run(
workers: Number of worker processes (requires uvicorn.run, single endpoint only). workers: Number of worker processes (requires uvicorn.run, single endpoint only).
**uvicorn_config: Additional uvicorn config options (overrides all other settings). **uvicorn_config: Additional uvicorn config options (overrides all other settings).
""" """
if listen is None: endpoints = parse_endpoints(listen, default_port)
listen = [f"localhost:{default_port}"] if not endpoints:
elif isinstance(listen, str): raise ValueError("No endpoints to serve; check listen configuration")
listen = [listen]
endpoints: list[dict] = []
for ep in listen:
endpoints.extend(parse_endpoint(ep, default_port))
conf: dict[str, object] = {"app": app, "reload": reload, "workers": workers} conf: dict[str, object] = {"app": app, "reload": reload, "workers": workers}
proxy = os.getenv("FORWARDED_ALLOW_IPS", "127.0.0.1,::1") proxy = os.getenv("FORWARDED_ALLOW_IPS", "127.0.0.1,::1")
+128 -44
View File
@@ -21,6 +21,7 @@ import subprocess
import sys import sys
from pathlib import Path from pathlib import Path
from textwrap import indent from textwrap import indent
from typing import Literal
import tomlkit import tomlkit
@@ -38,12 +39,16 @@ def print_boxed(text: str) -> None:
print(f"{'' * width}") print(f"{'' * width}")
def ruff_format_content(content: str, target_path: Path) -> str: def ruff_format_content(
content: str, target_path: Path, *, mode: Literal["isort", "full"] = "full"
) -> str:
"""Format Python content using ruff with project settings. """Format Python content using ruff with project settings.
Writes to a temp file (.new.py) next to target, runs ruff check (import sorting) Writes to a temp file next to target, runs ruff check (import sorting)
and ruff format on it, reads back the result, and cleans up. and optionally ruff format on it, reads back the result, and cleans up.
Returns the formatted content, or original if ruff fails. Returns the formatted content, or original if ruff fails.
mode='isort' only sorts imports; mode='full' also formats.
""" """
temp_file = target_path.with_suffix(".new.py") temp_file = target_path.with_suffix(".new.py")
try: try:
@@ -65,6 +70,8 @@ def ruff_format_content(content: str, target_path: Path) -> str:
cwd=target_path.parent, cwd=target_path.parent,
capture_output=True, capture_output=True,
) )
if mode == "isort":
return temp_file.read_text("UTF-8")
# Then format # Then format
result = subprocess.run( result = subprocess.run(
["uv", "run", "--with", "ruff", "ruff", "format", str(temp_file)], ["uv", "run", "--with", "ruff", "ruff", "format", str(temp_file)],
@@ -253,23 +260,20 @@ def find_import_insertion_line(source: str) -> int:
return 2 if source.startswith("#!") else 1 return 2 if source.startswith("#!") else 1
def extract_existing_ports(project_dir: Path) -> tuple[int, int, int] | None: def extract_existing_ports(
project_dir: Path, main: Path
) -> tuple[int, int, int] | None:
"""Extract existing port configuration from project files. """Extract existing port configuration from project files.
Returns (default, vite, dev) or None if not found. Returns (default, vite, dev) or None if not found.
""" """
module_name = find_module_name(project_dir)
if not module_name:
return None
default_port = None default_port = None
vite_port = None vite_port = None
dev_port = None dev_port = None
# Try to extract DEFAULT_PORT from __main__.py # Try to extract DEFAULT_PORT from the CLI main module
main_file = project_dir / module_name / "__main__.py" if main.exists():
if main_file.exists(): content = main.read_text("UTF-8")
content = main_file.read_text("UTF-8")
match = re.search(r"DEFAULT_PORT\s*=\s*(\d+)", content) match = re.search(r"DEFAULT_PORT\s*=\s*(\d+)", content)
if match: if match:
default_port = int(match.group(1)) default_port = int(match.group(1))
@@ -427,10 +431,43 @@ def _find_app_in_subpackage(subpkg_dir: Path) -> tuple[Path, str] | None:
return None return None
def _find_existing_cli_entrypoint(project_dir: Path, module_name: str) -> str | None: def _add_devmode_to_main(content: str) -> str:
"""Add DEVMODE variable to an existing main module."""
lines = content.splitlines()
# Check if os is imported
has_os_import = any("import os" in line for line in lines)
# Find the first import line
insert_idx = 0
for i, line in enumerate(lines):
stripped = line.strip()
if stripped.startswith("import ") or stripped.startswith("from "):
insert_idx = i + 1
elif stripped and not stripped.startswith("#"):
break
# Insert imports and DEVMODE after existing imports
new_lines = []
if not has_os_import:
new_lines.append("import os")
new_lines.extend(
[
"",
"# Added by fastapi-vue-setup",
'DEVMODE = os.getenv("ENVPREFIX_DEV") == "1"',
"",
]
)
lines[insert_idx:insert_idx] = new_lines
return "\n".join(lines)
def _find_existing_cli_module_path(project_dir: Path, module_name: str) -> str | None:
"""Check if pyproject.toml already has a CLI entrypoint for this module. """Check if pyproject.toml already has a CLI entrypoint for this module.
Returns the entrypoint string if found, None otherwise. Returns the module path (e.g., 'module.subpkg.__main__') if found, None otherwise.
""" """
pyproject = project_dir / "pyproject.toml" pyproject = project_dir / "pyproject.toml"
if not pyproject.exists(): if not pyproject.exists():
@@ -448,7 +485,10 @@ def _find_existing_cli_entrypoint(project_dir: Path, module_name: str) -> str |
# Look for any script that references our module # Look for any script that references our module
for script_name, entry in scripts.items(): for script_name, entry in scripts.items():
if isinstance(entry, str) and entry.startswith(f"{module_name}."): if isinstance(entry, str) and entry.startswith(f"{module_name}."):
return f'{script_name} = "{entry}"' # Extract module path from "module.subpkg.__main__:main"
if ":" in entry:
module_path, _ = entry.rsplit(":", 1)
return module_path
return None return None
@@ -517,7 +557,7 @@ def render_template(template: str, **kwargs) -> str:
def patch_app_file( def patch_app_file(
path: Path, module_name: str, app_var: str, dry: bool = False path: Path, main_module_path: str, app_var: str, dry: bool = False
) -> bool: ) -> bool:
"""Patch an existing app.py with frontend integration. """Patch an existing app.py with frontend integration.
@@ -535,7 +575,7 @@ def patch_app_file(
# Check what's already patched # Check what's already patched
has_frontend = "from fastapi_vue import Frontend" in content has_frontend = "from fastapi_vue import Frontend" in content
has_devmode = f"from {module_name}.__main__ import DEVMODE" in content has_devmode = f"from {main_module_path} import DEVMODE" in content
has_debug_arg = re.search(r"FastAPI\s*\([^)]*debug\s*=", content) is not None has_debug_arg = re.search(r"FastAPI\s*\([^)]*debug\s*=", content) is not None
has_lifespan = "await frontend.load()" in content has_lifespan = "await frontend.load()" in content
@@ -550,7 +590,7 @@ def patch_app_file(
if not has_frontend: if not has_frontend:
imports.extend(["from pathlib import Path", "from fastapi_vue import Frontend"]) imports.extend(["from pathlib import Path", "from fastapi_vue import Frontend"])
if not has_devmode: if not has_devmode:
imports.append(f"from {module_name}.__main__ import DEVMODE") imports.append(f"from {main_module_path} import DEVMODE")
if imports: if imports:
insert_line = find_import_insertion_line(content) insert_line = find_import_insertion_line(content)
lines = content.splitlines(keepends=True) lines = content.splitlines(keepends=True)
@@ -679,6 +719,8 @@ def patch_app_file(
print(f"✅ Would patch {path}") print(f"✅ Would patch {path}")
return True return True
# Sort imports only (avoid full formatting of user code)
content = ruff_format_content(content, path, mode="isort")
path.write_text(content, "UTF-8", newline="\n") path.write_text(content, "UTF-8", newline="\n")
print(f"✅ Patched {path}") print(f"✅ Patched {path}")
@@ -800,7 +842,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry: bool = False) -> bool:
target_file = app_vue target_file = app_vue
if target_file is None: if target_file is None:
print("️ No Vue file found to patch, skipping frontend health check") print("️ No default App.vue found to patch, not adding /api/health check")
return False return False
original_content = target_file.read_text("UTF-8") original_content = target_file.read_text("UTF-8")
@@ -845,7 +887,7 @@ def patch_frontend_health_check(frontend_dir: Path, dry: bool = False) -> bool:
else: else:
# Minimal App.vue - only patch if it contains the default welcome message # Minimal App.vue - only patch if it contains the default welcome message
if "<h1>You did it!</h1>" not in content: if "<h1>You did it!</h1>" not in content:
print(f"️ Skipping {target_file} (not a default Vue template)") print(f"️ Skipping {target_file} (not a Vue demo app)")
return False return False
# Insert before the </p> tag # Insert before the </p> tag
template_end = content.find("</template>") template_end = content.find("</template>")
@@ -987,6 +1029,7 @@ def _write_fallback_file(
existing_content = fallback_path.read_text("UTF-8") existing_content = fallback_path.read_text("UTF-8")
if existing_content == content: if existing_content == content:
print(f"✔️ {fallback_path} (already up to date)") print(f"✔️ {fallback_path} (already up to date)")
_new_files_written.append((fallback_path, original_path))
return False return False
if dry: if dry:
@@ -1247,13 +1290,28 @@ def cmd_setup(args: argparse.Namespace) -> int:
else: else:
print(f"📦 Module: {module_name}") print(f"📦 Module: {module_name}")
module_dir = project_dir / module_name
scripts_dir = project_dir / "scripts"
fastapi_vue_scripts = scripts_dir / "fastapi-vue"
# Check if project already has a CLI entrypoint in pyproject.toml
existing_cli_module = _find_existing_cli_module_path(project_dir, module_name)
# Determine main module path for DEVMODE import
main_module_path = existing_cli_module or f"{module_name}.__main__"
if existing_cli_module:
print(f"️ Using existing CLI: {existing_cli_module}")
# Resolve the CLI main module to a file path
main = project_dir / Path(*main_module_path.split(".")).with_suffix(".py")
# Determine port configuration # Determine port configuration
# Priority: --ports argument > existing project values > defaults # Priority: --ports argument > existing project values > defaults
if args.ports: if args.ports:
default_port, vite_port, dev_port = parse_ports(args.ports) default_port, vite_port, dev_port = parse_ports(args.ports)
ports_note = "(--ports)" ports_note = "(--ports)"
else: else:
existing_ports = extract_existing_ports(project_dir) existing_ports = extract_existing_ports(project_dir, main)
if existing_ports: if existing_ports:
default_port, vite_port, dev_port = existing_ports default_port, vite_port, dev_port = existing_ports
ports_note = "(kept for upgrade)" ports_note = "(kept for upgrade)"
@@ -1268,6 +1326,11 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Title for templates # Title for templates
project_title = module_name.replace("_", " ").title() project_title = module_name.replace("_", " ").title()
# Find existing FastAPI app
app_info = (
find_fastapi_app(module_dir, project_dir) if module_dir.exists() else None
)
# Template variables # Template variables
tpl_vars = { tpl_vars = {
"MODULE_NAME": module_name, "MODULE_NAME": module_name,
@@ -1277,28 +1340,22 @@ def cmd_setup(args: argparse.Namespace) -> int:
"TEMPLATE_DEV_PORT": str(dev_port), "TEMPLATE_DEV_PORT": str(dev_port),
"ENVPREFIX": module_name.upper(), "ENVPREFIX": module_name.upper(),
"PROJECT_CLI": module_name, "PROJECT_CLI": module_name,
"MAIN_MODULE": main_module_path,
} }
module_dir = project_dir / module_name
scripts_dir = project_dir / "scripts"
fastapi_vue_scripts = scripts_dir / "fastapi-vue"
# Find existing FastAPI app
app_info = (
find_fastapi_app(module_dir, project_dir) if module_dir.exists() else None
)
if app_info: if app_info:
app_file, app_var = app_info app_file, app_var = app_info
print(f"📍 Found FastAPI app: {app_var} in {app_file.name}") print(f"📍 Found FastAPI app: {app_var} in {app_file.name}")
tpl_vars["APP_VAR"] = app_var tpl_vars["APP_VAR"] = app_var
tpl_vars["APP_MODULE"] = app_file.stem # Dotted module path relative to project dir (e.g. "paskia.fastapi.mainapp")
app_module = ".".join(app_file.relative_to(project_dir).with_suffix("").parts)
tpl_vars["APP_MODULE"] = app_module
else: else:
print("📍 No existing FastAPI app found, will create new one") print("📍 No existing FastAPI app found, will create new one")
app_file = None app_file = None
app_var = "app" app_var = "app"
tpl_vars["APP_VAR"] = app_var tpl_vars["APP_VAR"] = app_var
tpl_vars["APP_MODULE"] = "app" tpl_vars["APP_MODULE"] = f"{module_name}.app"
# Create directories # Create directories
if not dry: if not dry:
@@ -1351,7 +1408,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
# === Handle app module === # === Handle app module ===
if app_file: if app_file:
# Existing app: patch with import, route, and try to patch lifespan # Existing app: patch with import, route, and try to patch lifespan
patch_app_file(app_file, module_name, app_var, dry=dry) patch_app_file(app_file, main_module_path, app_var, dry=dry)
else: else:
# No app: create full app.py # No app: create full app.py
# Create __init__.py if missing # Create __init__.py if missing
@@ -1368,14 +1425,16 @@ def cmd_setup(args: argparse.Namespace) -> int:
write_file(app_file_path, content, overwrite=False, dry=dry) write_file(app_file_path, content, overwrite=False, dry=dry)
# === Handle __main__.py === # === Handle __main__.py ===
main_file = module_dir / "__main__.py" if existing_cli_module:
# Existing CLI entrypoint - write .new.py beside the existing main module
main_fallback = main.with_suffix(".new.py")
else:
main_fallback = module_dir / "__main__.new.py" main_fallback = module_dir / "__main__.new.py"
main_file = module_dir / "__main__.py"
template = load_template("backend/__main__.py") template = load_template("backend/__main__.py")
main_content = render_template(template, **tpl_vars) main_content = render_template(template, **tpl_vars)
# Check if project already has a CLI entrypoint in pyproject.toml
existing_cli = _find_existing_cli_entrypoint(project_dir, module_name)
if main_file.exists(): if main_file.exists():
# File exists: update if it has the auto-upgrade marker, otherwise use fallback # File exists: update if it has the auto-upgrade marker, otherwise use fallback
write_file( write_file(
@@ -1385,7 +1444,7 @@ def cmd_setup(args: argparse.Namespace) -> int:
dry=dry, dry=dry,
fallback_path=main_fallback, fallback_path=main_fallback,
) )
elif not existing_cli: elif not existing_cli_module:
# No file and no existing entrypoint: create new __main__.py # No file and no existing entrypoint: create new __main__.py
write_file( write_file(
main_file, main_file,
@@ -1394,8 +1453,29 @@ def cmd_setup(args: argparse.Namespace) -> int:
dry=dry, dry=dry,
) )
else: else:
# No file but has existing entrypoint - don't create (user has custom CLI setup) # Existing CLI entrypoint: write our template as .new.py beside the existing module
print(f"️ Skipping __main__.py (package already has CLI: {existing_cli})") # and also patch the existing module with DEVMODE if needed
_write_fallback_file(
main,
main_fallback,
main_content,
dry=dry,
executable=False,
)
if main.exists():
content = main.read_text("UTF-8")
if "DEVMODE" not in content:
new_content = _add_devmode_to_main(content)
new_file = main.with_suffix(".new.py")
_write_fallback_file(
main,
new_file,
new_content,
dry=dry,
executable=False,
)
else:
print(f"⚠️ Existing CLI main module {main} not found")
# === Update vite.config.js/ts === # === Update vite.config.js/ts ===
frontend_dir = project_dir / "frontend" frontend_dir = project_dir / "frontend"
@@ -1493,12 +1573,16 @@ def cmd_setup(args: argparse.Namespace) -> int:
# Show merge note if any .new.py files were written # Show merge note if any .new.py files were written
if _new_files_written: if _new_files_written:
print() print()
print( print("⚠️ Some files could not be auto-upgraded because you customized them.")
"⚠️ Note: Some files could not be auto-upgraded because you customized them."
)
print(" Please manually merge the following files:") print(" Please manually merge the following files:")
for new_file, original_file in _new_files_written: for new_file, original_file in _new_files_written:
print(f"{new_file.name}{original_file.name}") try:
new_rel = new_file.relative_to(project_dir)
orig_rel = original_file.relative_to(project_dir)
except ValueError:
new_rel = new_file.name
orig_rel = original_file.name
print(f"{new_rel}{orig_rel}")
print() print()
# Clear the list for potential subsequent runs # Clear the list for potential subsequent runs
_new_files_written.clear() _new_files_written.clear()
+3 -3
View File
@@ -17,12 +17,12 @@ def main():
help=(f"Endpoint (default: localhost:{DEFAULT_PORT})."), help=(f"Endpoint (default: localhost:{DEFAULT_PORT})."),
) )
args = parser.parse_args() args = parser.parse_args()
dev = {"reload": True, "reload_dirs": ["MODULE_NAME"]} dev = {"reload": True, "reload_dirs": ["paskia"]} if DEVMODE else {}
server.run( server.run(
"MODULE_NAME.APP_MODULE:APP_VAR", "APP_MODULE:APP_VAR",
listen=args.listen, listen=args.listen,
default_port=DEFAULT_PORT, default_port=DEFAULT_PORT,
**(dev if DEVMODE else {}), **dev,
) )
+1 -1
View File
@@ -3,7 +3,7 @@ from pathlib import Path
from fastapi import FastAPI from fastapi import FastAPI
from fastapi_vue import Frontend from fastapi_vue import Frontend
from MODULE_NAME.__main__ import DEVMODE from MAIN_MODULE import DEVMODE
# Vue Frontend static files # Vue Frontend static files
frontend = Frontend(Path(__file__).with_name("frontend-build")) frontend = Frontend(Path(__file__).with_name("frontend-build"))
+1 -1
View File
@@ -11,7 +11,7 @@
*/ */
export default function fastapiVue({ paths = ["/api"] } = {}) { export default function fastapiVue({ paths = ["/api"] } = {}) {
const backendUrl = process.env.ENVPREFIX_BACKEND_URL || "http://localhost:TEMPLATE_DEFAULT_PORT" const backendUrl = process.env.ENVPREFIX_BACKEND_URL || "http://localhost:TEMPLATE_DEV_PORT"
// Build proxy configuration for each path // Build proxy configuration for each path
const proxy = {} const proxy = {}
+3 -3
View File
@@ -58,12 +58,12 @@ def main():
parser.add_argument( parser.add_argument(
"-l", "-l",
"--listen", "--listen",
metavar="host:port", metavar="addr",
help=f"Vite (default: localhost:{DEFAULT_VITE_PORT})", help=f"Vite (default: localhost:{DEFAULT_VITE_PORT})",
) )
parser.add_argument( parser.add_argument(
"--backend", "--backend",
metavar="host:port", metavar="addr",
help=f"FastAPI (default: localhost:{DEFAULT_DEV_PORT})", help=f"FastAPI (default: localhost:{DEFAULT_DEV_PORT})",
) )
args, extra_args = parser.parse_known_args() args, extra_args = parser.parse_known_args()
@@ -72,7 +72,7 @@ def main():
HELP_EPILOG = """ HELP_EPILOG = """
scripts/devserver.py [args to PROJECT_CLI] Other options are forwarded to PROJECT_CLI [args]
JS_RUNTIME environment variable can be used to select the JS runtime: JS_RUNTIME environment variable can be used to select the JS runtime:
npm, deno, bun, or full path to the runtime executable (node maps to npm). npm, deno, bun, or full path to the runtime executable (node maps to npm).