quickdbd-cli 0.1.9__tar.gz → 0.1.10__tar.gz

{quickdbd_cli-0.1.9 → quickdbd_cli-0.1.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: quickdbd-cli
-Version: 0.1.9
+Version: 0.1.10
 Summary: Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit.
 Project-URL: Homepage, https://github.com/MarkPhamm/quickdbd-cli
 Author: Minh (Mark) Pham
@@ -387,7 +387,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.1.9
+      - uses: MarkPhamm/quickdbd-cli@v0.1.10
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html
@@ -410,7 +410,7 @@ Run your dbt setup first, then let the action generate the schema:
 
 ```yaml
       # … dbt deps && dbt build && dbt docs generate
-      - uses: MarkPhamm/quickdbd-cli@v0.1.9
+      - uses: MarkPhamm/quickdbd-cli@v0.1.10
         with:
           dbt-manifest: target/
           dbt-args: --infer-fks
@@ -425,7 +425,7 @@ Commit `erd/` so pull requests can be compared with `main`. Set `dbt-check: true
 ```yaml
 repos:
   - repo: https://github.com/MarkPhamm/quickdbd-cli
-    rev: v0.1.9
+    rev: v0.1.10
     hooks:
       - id: qdbd-check
         files: ^erd/.*\.txt$

{quickdbd_cli-0.1.9 → quickdbd_cli-0.1.10}/README.md

@@ -359,7 +359,7 @@ jobs:
     permissions: { contents: read, pull-requests: write }
     steps:
       - uses: actions/checkout@v4
-      - uses: MarkPhamm/quickdbd-cli@v0.1.9
+      - uses: MarkPhamm/quickdbd-cli@v0.1.10
         with:
           path: erd/                  # schema file(s) or folder(s)
           output: site/index.html
@@ -382,7 +382,7 @@ Run your dbt setup first, then let the action generate the schema:
 
 ```yaml
       # … dbt deps && dbt build && dbt docs generate
-      - uses: MarkPhamm/quickdbd-cli@v0.1.9
+      - uses: MarkPhamm/quickdbd-cli@v0.1.10
         with:
           dbt-manifest: target/
           dbt-args: --infer-fks
@@ -397,7 +397,7 @@ Commit `erd/` so pull requests can be compared with `main`. Set `dbt-check: true
 ```yaml
 repos:
   - repo: https://github.com/MarkPhamm/quickdbd-cli
-    rev: v0.1.9
+    rev: v0.1.10
     hooks:
       - id: qdbd-check
         files: ^erd/.*\.txt$

{quickdbd_cli-0.1.9 → quickdbd_cli-0.1.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "quickdbd-cli"
-version = "0.1.9"
+version = "0.1.10"
 description = "Compile QuickDBD-syntax schema files into interactive HTML ER diagrams, with no table limit."
 readme = "README.md"
 license = "Apache-2.0"

quickdbd_cli-0.1.10/src/quickdbd_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.10"

{quickdbd_cli-0.1.9 → quickdbd_cli-0.1.10}/src/quickdbd_cli/cli.py

@@ -318,7 +318,9 @@ def cmd_serve(args) -> int:
     from .serve import serve
 
     project = _open(args)
-    return serve(project, port=args.port, open_browser=not args.no_open, read_only=args.read_only)
+    # Without --port, a busy 8765 (e.g. a second `qdbd serve`) moves on to the next free port.
+    port, tries = (args.port, 1) if args.port is not None else (8765, 20)
+    return serve(project, port=port, open_browser=not args.no_open, read_only=args.read_only, tries=tries)
 
 
 def build_parser() -> argparse.ArgumentParser:
@@ -437,7 +439,7 @@ def build_parser() -> argparse.ArgumentParser:
 
     sp = sub.add_parser("serve", help="live editor: reload on save, drag tables to arrange")
     paths(sp)
-    sp.add_argument("--port", type=int, default=8765)
+    sp.add_argument("--port", type=int, help="port to listen on (default: 8765, or the next free one)")
     sp.add_argument("--layout")
     sp.add_argument("--no-open", action="store_true", help="don't open a browser")
     sp.add_argument(

{quickdbd_cli-0.1.9 → quickdbd_cli-0.1.10}/src/quickdbd_cli/serve.py

@@ -9,6 +9,7 @@ the server never writes anything.
 
 from __future__ import annotations
 
+import errno
 import json
 import sys
 import threading
@@ -190,11 +191,29 @@ def _handler(state: State, title: str):
     return Handler
 
 
-def make_server(project: Project, port: int = 8765, read_only: bool = False) -> tuple[ThreadingHTTPServer, State]:
-    """Bind the HTTP server (port 0 picks a free port) without starting it."""
+class PortInUse(OSError):
+    pass
+
+
+def make_server(
+    project: Project, port: int = 8765, read_only: bool = False, tries: int = 1
+) -> tuple[ThreadingHTTPServer, State]:
+    """Bind the HTTP server without starting it. Port 0 picks a free port; with ``tries`` > 1, a busy port
+    moves on to the next one (port, port+1, ...)."""
     state = State(project, read_only=read_only)
     title = project.inputs[0].stem if len(project.inputs) == 1 else "diagram"
-    server = ThreadingHTTPServer(("127.0.0.1", port), _handler(state, title))
+    server = None
+    for p in range(port, port + max(tries, 1)) if port else [0]:
+        try:
+            server = ThreadingHTTPServer(("127.0.0.1", p), _handler(state, title))
+            break
+        except OSError as e:
+            if e.errno != errno.EADDRINUSE:
+                raise
+    if server is None:
+        last = port + max(tries, 1) - 1
+        span = f"ports {port}-{last} are" if last > port else f"port {port} is"
+        raise PortInUse(f"{span} already in use (another qdbd serve?); pick one with --port")
     server.daemon_threads = True
     return server, state
 
@@ -210,8 +229,14 @@ def poll_once(state: State) -> bool:
     return True
 
 
-def serve(project: Project, port: int = 8765, open_browser: bool = True, read_only: bool = False) -> int:
-    server, state = make_server(project, port, read_only=read_only)
+def serve(
+    project: Project, port: int = 8765, open_browser: bool = True, read_only: bool = False, tries: int = 1
+) -> int:
+    try:
+        server, state = make_server(project, port, read_only=read_only, tries=tries)
+    except PortInUse as e:
+        print(f"error: {e}", file=sys.stderr)
+        return 2
     for d in state.diagnostics:
         print(d["text"], file=sys.stderr)
     url = f"http://127.0.0.1:{server.server_address[1]}/"

{quickdbd_cli-0.1.9 → quickdbd_cli-0.1.10}/tests/test_serve.py

@@ -194,3 +194,36 @@ def test_read_only_refuses_writes_and_never_touches_disk(ro):
     assert poll_once(state)
     assert [t["name"] for t in call(base, "/state")[1]["model"]["tables"]] == ["Customer", "Order", "Product"]
     assert not f.with_name("shop.layout.json").exists()
+
+
+# ------------------------------------------------------------------ busy ports
+
+
+def test_busy_port_moves_to_the_next_free_one(tmp_path):
+    from quickdbd_cli.serve import PortInUse
+
+    f = tmp_path / "shop.txt"
+    f.write_text(SCHEMA)
+    first, _ = make_server(Project.open([f]), port=0)
+    busy = first.server_address[1]
+    try:
+        with pytest.raises(PortInUse, match=f"port {busy} is already in use"):
+            make_server(Project.open([f]), port=busy)
+        second, _ = make_server(Project.open([f]), port=busy, tries=20)
+        assert second.server_address[1] > busy
+        second.server_close()
+    finally:
+        first.server_close()
+
+
+def test_cli_explicit_busy_port_is_a_clean_error(tmp_path, capsys):
+    from quickdbd_cli.cli import main
+
+    f = tmp_path / "shop.txt"
+    f.write_text(SCHEMA)
+    first, _ = make_server(Project.open([f]), port=0)
+    try:
+        assert main(["serve", str(f), "--no-open", "--port", str(first.server_address[1])]) == 2
+        assert "already in use" in capsys.readouterr().err
+    finally:
+        first.server_close()

quickdbd_cli-0.1.9/src/quickdbd_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.9"