chore: eliminate sys.path.insert hacks — migrate to package-relative imports by sheepdestroyer · Pull Request #271 · sheepdestroyer/LLM-Routing

sheepdestroyer · 2026-07-12T15:18:03Z

What

This PR removes vestigial sys.path.insert hacks from scripts in scripts/, migrating to standard package-relative imports with ImportError fallbacks. It also adds a missing __init__.py to the router/ directory and normalizes structured content parsing in chat_helpers.py.

Fixes #266

Changes

Import cleanup (9 scripts)

Removed sys.path.insert hacks from all scripts in scripts/ and verification/
Replaced with from scripts.chat_helpers import parse_chat_response + ImportError fallback
Added try/except ImportError pattern to 7 scripts importing chat_helpers — ensures they remain runnable via both python scripts/foo.py (direct) and package imports

Router package

Added router/__init__.py to make router a proper Python package
Updated router/main.py to use from router.circuit_breaker import get_breaker (package-aware absolute import)
Note: relative import from .circuit_breaker was tested but reverted — it fails when test modules import main.py directly via from main import ... with PYTHONPATH=.:router

chat_helpers.py

Added _normalize_chat_content() helper that handles structured content payloads from alt providers (lists of dicts, nested content, etc.)
Updated parse_chat_response() to use the new normalizer for both content and reasoning_content

upgrade-prod.sh

Self-copy guard: re-execs from /tmp so rsync can safely update the script itself
Centralized cleanup via trap
Non-interactive mode support (auto-proceeds in CI/cron)
Pre-flight .env validation
Split rsync into individual safe calls per directory

Misc

Removed unused imports (asyncio, time) from test files

Previously PR #270 — closed and reopened with review fixes applied.

Summary by CodeRabbit

Bug Fixes
- Improved reliability when running tests, verification tools, benchmarks, and classification scripts across different environments.
- Fixed module loading so router-related features and circuit-breaker checks resolve consistently.
Tests
- Updated automated tests to validate the application through its packaged module structure.
- Preserved existing test coverage and assertions while improving test execution consistency.

Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

- Revert 'from .circuit_breaker' to 'from router.circuit_breaker' in main.py: relative imports break when main.py is imported directly as 'main' (tests use 'from main import ...' with PYTHONPATH=.:router) - Add try/except ImportError fallback to 'from scripts.chat_helpers' across all 7 scripts (4 in scripts/, 3 in verification/) so they remain runnable via both package import and direct execution

sourcery-ai

Sorry @sheepdestroyer, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

coderabbitai · 2026-07-12T15:18:10Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3c40c14b-3ab6-4474-8839-925477757525

📥 Commits

Reviewing files that changed from the base of the PR and between 3f7f503 and 031ce42.

📒 Files selected for processing (22)

.github/workflows/test.yml
router/__init__.py
router/agy_proxy.py
router/main.py
router/tests/test_dashboard_data.py
router/tests/test_detect_active_tool.py
router/tests/test_estimate_prompt_tokens.py
router/tests/test_get_gemini_oauth_status.py
router/tests/test_get_goose_sessions.py
router/tests/test_load_persisted_stats.py
router/tests/test_resolve_external_urls.py
scripts/benchmark_classifier.py
scripts/benchmark_tokens.py
scripts/classify_direct.py
scripts/reclassify_all.py
scripts/retry_errors.py
scripts/verification/verification_helpers.py
scripts/verification/verify_breaker.py
scripts/verification/verify_canonical_endpoints.py
scripts/verification/verify_ollama_routing.py
tests/test_a2_verify.py
tests/test_models_proxy.py

📝 Walkthrough

Walkthrough

The change standardizes package-qualified imports across router modules, scripts, and tests, adds conditional import fallbacks for standalone scripts, and updates CI commands to use the repository root and router configuration path.

Changes

Package import migration

Layer / File(s)	Summary
Router module import wiring `router/agy_proxy.py`, `router/main.py`	Circuit-breaker imports now use `router.circuit_breaker`.
Script import fallbacks `scripts/benchmark_.py`, `scripts/classify_direct.py`, `scripts/reclassify_all.py`, `scripts/retry_errors.py`, `scripts/verification/`	Scripts prefer package-qualified imports and conditionally adjust `sys.path` when direct imports fail.
Test package wiring `router/tests/*`, `tests/test_a2_verify.py`, `tests/test_models_proxy.py`	Tests import router implementations through package paths and update mock targets accordingly.
CI execution paths `.github/workflows/test.yml`	Test and integration commands use `PYTHONPATH=.`; unit tests explicitly set `CONFIG_PATH=router/config.yaml`.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

sheepdestroyer/LLM-Routing#167: Adds coverage for the same router.main.load_persisted_stats functionality whose test imports are rewired here.

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch chore/eliminate-sys-path-hacks-565508234636993796

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

gemini-code-assist

Code Review

This pull request refactors import paths and removes manual sys.path modifications across several scripts and verification helpers. While this cleans up the import structure, the reviewer identified multiple instances where removing sys.path or using relative imports as fallbacks will break direct script execution (resulting in ModuleNotFoundError or ImportError due to a lack of parent package context). The feedback recommends implementing robust fallback blocks that append the necessary directories to sys.path only when the primary import fails.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

gemini-code-assist · 2026-07-12T15:20:33Z

-sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
-sys.path.insert(0, str(Path(__file__).resolve().parent.parent / "router"))

 from router.main import estimate_prompt_tokens, METADATA_OVERHEAD


Removing the sys.path modification completely breaks direct execution of this script (e.g., python scripts/benchmark_tokens.py), raising a ModuleNotFoundError: No module named 'router'. To preserve direct execution support without environment variables, add a fallback block that appends the parent directory to sys.path if the import fails.

Suggested change

from router.main import estimate_prompt_tokens, METADATA_OVERHEAD

try:

from router.main import estimate_prompt_tokens, METADATA_OVERHEAD

except ImportError:

sys.path.append(str(Path(__file__).resolve().parent.parent))

from router.main import estimate_prompt_tokens, METADATA_OVERHEAD

gemini-code-assist · 2026-07-12T15:20:33Z

+try:
+    from scripts.chat_helpers import parse_chat_response
+except ImportError:
+    from ..chat_helpers import parse_chat_response


When this script is run directly or imported by another script run directly (e.g., python scripts/verification/verify_ollama_routing.py), the package context is lost (__package__ is None). As a result, the relative import fallback from ..chat_helpers import parse_chat_response will fail with ImportError: attempted relative import with no known parent package. To prevent this crash, use a fallback that appends the repository root to sys.path instead of a relative import.

Suggested change

try:

from scripts.chat_helpers import parse_chat_response

except ImportError:

from ..chat_helpers import parse_chat_response

try:

from scripts.chat_helpers import parse_chat_response

except ImportError:

import sys

from pathlib import Path

sys.path.append(str(Path(__file__).resolve().parent.parent.parent))

from scripts.chat_helpers import parse_chat_response

gemini-code-assist · 2026-07-12T15:20:33Z

-from pathlib import Path
-sys.path.insert(0, str(Path(__file__).resolve().parent.parent.parent))
-
 from router.circuit_breaker import get_breaker


Removing the sys.path modification completely breaks direct execution of this script (e.g., python scripts/verification/verify_breaker.py), raising a ModuleNotFoundError: No module named 'router'. To preserve direct execution support, add a fallback block that appends the repository root to sys.path if the import fails.

Suggested change

from router.circuit_breaker import get_breaker

try:

from router.circuit_breaker import get_breaker

except ImportError:

import sys

from pathlib import Path

sys.path.append(str(Path(__file__).resolve().parent.parent.parent))

from router.circuit_breaker import get_breaker

gemini-code-assist · 2026-07-12T15:20:33Z

+try:
+    from scripts.chat_helpers import parse_chat_response
+except ImportError:
+    from ..chat_helpers import parse_chat_response


When this script is run directly (e.g., python scripts/verification/verify_canonical_endpoints.py), the package context is lost, causing the relative import fallback from ..chat_helpers import parse_chat_response to fail with ImportError: attempted relative import with no known parent package. To prevent this crash, use a fallback that appends WORKDIR to sys.path instead of a relative import.

Suggested change

try:

from scripts.chat_helpers import parse_chat_response

except ImportError:

from ..chat_helpers import parse_chat_response

try:

from scripts.chat_helpers import parse_chat_response

except ImportError:

import sys

sys.path.append(str(WORKDIR))

from scripts.chat_helpers import parse_chat_response

gemini-code-assist · 2026-07-12T15:20:33Z

+try:
+    from scripts.chat_helpers import parse_chat_response
+except ImportError:
+    from ..chat_helpers import parse_chat_response


When this script is run directly (e.g., python scripts/verification/verify_ollama_routing.py), the package context is lost, causing the relative import fallback from ..chat_helpers import parse_chat_response to fail with ImportError: attempted relative import with no known parent package. To prevent this crash, use a fallback that appends WORKDIR to sys.path instead of a relative import.

Suggested change

try:

from scripts.chat_helpers import parse_chat_response

except ImportError:

from ..chat_helpers import parse_chat_response

try:

from scripts.chat_helpers import parse_chat_response

except ImportError:

import sys

sys.path.append(str(WORKDIR))

from scripts.chat_helpers import parse_chat_response

…e imports This commit: - Removes sys.path.insert hacks from scripts/ - Adds router/__init__.py to make router a package - Updates router/main.py and router/agy_proxy.py to use package-aware imports - Updates tests and mocks to use absolute package paths - Updates CI workflow to use standard PYTHONPATH=. - Ensures both CLI and package execution modes work correctly Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>

Gemini Code Assist correctly identified that the PR's removal of sys.path hacks broke direct execution of all 9 scripts. When Python runs a script, it REPLACES sys.path[0] (the CWD) with the script's directory — so cross- package imports (router.*, scripts.chat_helpers) fail with ModuleNotFoundError. Two failure patterns, two fixes: 1. Scripts in scripts/ importing scripts.chat_helpers: try/except with bare 'from chat_helpers' fallback (found in sys.path[0]) 2. Scripts in scripts/verification/ importing scripts.chat_helpers or router.*: try/except with sys.path.insert to repo root (parents[2]) Verified: all 9 scripts now run successfully via both 'python scripts/X.py' (direct) and package imports (from scripts.X import ...)

sheepdestroyer · 2026-07-12T16:09:28Z

Closing in favor of a fresh PR with all review fixes applied. See #272.

google-labs-jules Bot and others added 3 commits July 12, 2026 14:04

chore: eliminate sys.path.insert hacks in scripts

b17b0e8

Co-authored-by: sheepdestroyer <1377479+sheepdestroyer@users.noreply.github.com>

Update router/main.py

a1820f5

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

sourcery-ai Bot reviewed Jul 12, 2026

View reviewed changes

gemini-code-assist Bot reviewed Jul 12, 2026

View reviewed changes

google-labs-jules Bot and others added 2 commits July 12, 2026 15:26

sheepdestroyer closed this Jul 12, 2026

This was referenced Jul 12, 2026

chore: eliminate sys.path.insert hacks — migrate to package-relative imports #272

Closed

chore: eliminate sys.path.insert hacks — migrate to package-relative imports #273

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: eliminate sys.path.insert hacks — migrate to package-relative imports#271

chore: eliminate sys.path.insert hacks — migrate to package-relative imports#271
sheepdestroyer wants to merge 5 commits into
masterfrom
chore/eliminate-sys-path-hacks-565508234636993796

sheepdestroyer commented Jul 12, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

sourcery-ai Bot left a comment

Uh oh!

coderabbitai Bot commented Jul 12, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Uh oh!

sheepdestroyer commented Jul 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

sheepdestroyer commented Jul 12, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Changes

Import cleanup (9 scripts)

Router package

chat_helpers.py

upgrade-prod.sh

Misc

Summary by CodeRabbit

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented Jul 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot Jul 12, 2026

Choose a reason for hiding this comment

Uh oh!

sheepdestroyer commented Jul 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

sheepdestroyer commented Jul 12, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 12, 2026 •

edited

Loading