refactor: split common helpers into cforge.common package

MatthewGrigsby · MatthewGrigsby · commit 603b51e0d4d4 · 2026-02-12T15:40:48.000-08:00
Signed-off-by: Matthew Grigsby &lt;38010437+MatthewGrigsby@users.noreply.github.com&gt;
diff --git a/cforge/commands/deploy/deploy.py b/cforge/commands/deploy/deploy.py
@@ -11,7 +11,7 @@
 import typer
 
 # First-Party
-from cforge.common import get_console
+from cforge.common.console import get_console
 
 
 def deploy() -> None:
diff --git a/cforge/commands/metrics/metrics.py b/cforge/commands/metrics/metrics.py
@@ -11,11 +11,9 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    get_console,
-    make_authenticated_request,
-    print_json,
-)
+from cforge.common.console import get_console
+from cforge.common.http import make_authenticated_request
+from cforge.common.render import print_json
 
 
 def metrics_get(
diff --git a/cforge/commands/resources/a2a.py b/cforge/commands/resources/a2a.py
@@ -16,14 +16,11 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-    prompt_for_schema,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.prompting import prompt_for_schema
+from cforge.common.render import print_json, print_table
 from mcpgateway.schemas import A2AAgentCreate, A2AAgentUpdate
 
 
diff --git a/cforge/commands/resources/mcp_servers.py b/cforge/commands/resources/mcp_servers.py
@@ -16,14 +16,11 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-    prompt_for_schema,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.prompting import prompt_for_schema
+from cforge.common.render import print_json, print_table
 from mcpgateway.schemas import GatewayCreate, GatewayUpdate
 
 
diff --git a/cforge/commands/resources/plugins.py b/cforge/commands/resources/plugins.py
@@ -1,8 +1,6 @@
 # -*- coding: utf-8 -*-
-"""Location: ./cforge/commands/resources/plugins.py
-Copyright 2025
+"""
 SPDX-License-Identifier: Apache-2.0
-Authors: Matthew Grigsby
 
 CLI command group: plugins
 
@@ -15,23 +13,14 @@
     to support them.
 """
 
-# Standard
 from typing import Any, Dict, Optional
 
-# Third-Party
 import typer
 
-# First-Party
-from cforge.common import (
-    CaseInsensitiveEnum,
-    AuthenticationError,
-    CLIError,
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import AuthenticationError, CaseInsensitiveEnum, CLIError, handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.render import print_json, print_table
 
 
 class PluginMode(CaseInsensitiveEnum):
diff --git a/cforge/commands/resources/prompts.py b/cforge/commands/resources/prompts.py
@@ -16,14 +16,11 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-    prompt_for_schema,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.prompting import prompt_for_schema
+from cforge.common.render import print_json, print_table
 from mcpgateway.schemas import PromptCreate, PromptUpdate
 
 
diff --git a/cforge/commands/resources/resources.py b/cforge/commands/resources/resources.py
@@ -16,14 +16,11 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-    prompt_for_schema,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.prompting import prompt_for_schema
+from cforge.common.render import print_json, print_table
 from mcpgateway.schemas import ResourceCreate, ResourceUpdate
 
 
diff --git a/cforge/commands/resources/tools.py b/cforge/commands/resources/tools.py
@@ -16,16 +16,11 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    CLIError,
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-    prompt_for_json_schema,
-    prompt_for_schema,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import CLIError, handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.prompting import prompt_for_json_schema, prompt_for_schema
+from cforge.common.render import print_json, print_table
 from mcpgateway.schemas import ToolCreate, ToolUpdate
 
 
diff --git a/cforge/commands/resources/virtual_servers.py b/cforge/commands/resources/virtual_servers.py
@@ -16,14 +16,11 @@
 import typer
 
 # First-Party
-from cforge.common import (
-    get_console,
-    handle_exception,
-    make_authenticated_request,
-    print_json,
-    print_table,
-    prompt_for_schema,
-)
+from cforge.common.console import get_console
+from cforge.common.errors import handle_exception
+from cforge.common.http import make_authenticated_request
+from cforge.common.prompting import prompt_for_schema
+from cforge.common.render import print_json, print_table
 from mcpgateway.schemas import ServerCreate, ServerUpdate
 
 
diff --git a/cforge/commands/server/run.py b/cforge/commands/server/run.py
@@ -23,7 +23,8 @@
 import typer
 
 # First-Party
-from cforge.common import get_console, make_authenticated_request
+from cforge.common.console import get_console
+from cforge.common.http import make_authenticated_request
 
 
 def run(
diff --git a/cforge/commands/settings/config_schema.py b/cforge/commands/settings/config_schema.py
@@ -16,7 +16,9 @@
 import typer
 
 # First-Party
-from cforge.common import get_console, get_settings, print_json
+from cforge.common.console import get_console
+from cforge.common.render import print_json
+from cforge.config import get_settings
 
 
 def config_schema(
diff --git a/cforge/commands/settings/export.py b/cforge/commands/settings/export.py
@@ -17,7 +17,8 @@
 import typer
 
 # First-Party
-from cforge.common import get_base_url, get_console, make_authenticated_request
+from cforge.common.console import get_console
+from cforge.common.http import get_base_url, make_authenticated_request
 
 
 def export(
diff --git a/cforge/commands/settings/import_cmd.py b/cforge/commands/settings/import_cmd.py
@@ -16,7 +16,8 @@
 import typer
 
 # First-Party
-from cforge.common import get_console, make_authenticated_request
+from cforge.common.console import get_console
+from cforge.common.http import make_authenticated_request
 
 
 def import_cmd(
diff --git a/cforge/commands/settings/login.py b/cforge/commands/settings/login.py
@@ -12,7 +12,8 @@
 import typer
 
 # First-Party
-from cforge.common import get_base_url, get_console, get_token_file, save_token
+from cforge.common.console import get_console
+from cforge.common.http import get_base_url, get_token_file, save_token
 
 
 def login(
diff --git a/cforge/commands/settings/logout.py b/cforge/commands/settings/logout.py
@@ -8,7 +8,8 @@
 """
 
 # First-Party
-from cforge.common import get_console, get_token_file
+from cforge.common.console import get_console
+from cforge.common.http import get_token_file
 
 
 def logout() -> None:
diff --git a/cforge/commands/settings/profiles.py b/cforge/commands/settings/profiles.py
@@ -9,27 +9,29 @@
 
 # Standard
 from datetime import datetime
-from pathlib import Path
-from typing import Optional
 import json
+from pathlib import Path
 import secrets
 import string
+from typing import Optional
 
 # Third-Party
 import typer
 
 # First-Party
-from cforge.common import get_console, print_table, print_json, prompt_for_schema
+from cforge.common.console import get_console
+from cforge.common.prompting import prompt_for_schema
+from cforge.common.render import print_json, print_table
 from cforge.config import get_settings
 from cforge.profile_utils import (
     AuthProfile,
-    ProfileStore,
+    get_active_profile,
     get_all_profiles,
     get_profile,
-    get_active_profile,
-    set_active_profile,
     load_profile_store,
+    ProfileStore,
     save_profile_store,
+    set_active_profile,
 )
 
 
diff --git a/cforge/commands/settings/support_bundle.py b/cforge/commands/settings/support_bundle.py
@@ -15,7 +15,7 @@
 import typer
 
 # First-Party
-from cforge.common import get_console
+from cforge.common.console import get_console
 
 
 def support_bundle(
diff --git a/cforge/commands/settings/version.py b/cforge/commands/settings/version.py
@@ -8,7 +8,8 @@
 """
 
 # First-Party
-from cforge.common import get_console, make_authenticated_request
+from cforge.common.console import get_console
+from cforge.common.http import make_authenticated_request
 from mcpgateway import __version__
 
 
diff --git a/cforge/commands/settings/whoami.py b/cforge/commands/settings/whoami.py
@@ -8,7 +8,9 @@
 """
 
 # First-Party
-from cforge.common import get_console, get_settings, get_token_file, load_token
+from cforge.common.console import get_console
+from cforge.common.http import get_token_file, load_token
+from cforge.config import get_settings
 from cforge.profile_utils import get_active_profile
 
 
diff --git a/cforge/common/__init__.py b/cforge/common/__init__.py
@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+"""Copyright 2025
+SPDX-License-Identifier: Apache-2.0
+
+Shared CLI helper modules.
+
+This package groups cross-cutting utilities used by command modules:
+console/app construction, error handling, HTTP/auth access, Rich rendering,
+and schema-driven prompting. Consumers should import from concrete submodules
+instead of importing from `cforge.common` directly.
+"""
diff --git a/cforge/common/console.py b/cforge/common/console.py
@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+"""
+SPDX-License-Identifier: Apache-2.0
+
+Console and CLI application factories.
+
+This module centralizes creation of the shared Rich console and Typer app.
+Both are cached so commands across the process use consistent output and app
+configuration without repeated construction.
+"""
+
+from functools import lru_cache
+
+from rich.console import Console
+import typer
+
+
+@lru_cache
+def get_console() -> Console:
+    """Get the console singleton."""
+    return Console()
+
+
+@lru_cache
+def get_app() -> typer.Typer:
+    """Get the typer singleton."""
+    return typer.Typer(
+        name="mcpgateway",
+        help="MCP Gateway - Production-grade MCP Gateway & Proxy CLI",
+        add_completion=True,
+        rich_markup_mode="rich",
+    )
diff --git a/cforge/common/errors.py b/cforge/common/errors.py
diff --git a/cforge/common/http.py b/cforge/common/http.py
diff --git a/cforge/common/prompting.py b/cforge/common/prompting.py
diff --git a/cforge/common/render.py b/cforge/common/render.py
diff --git a/cforge/main.py b/cforge/main.py
diff --git a/tests/commands/resources/test_plugins.py b/tests/commands/resources/test_plugins.py
diff --git a/tests/commands/settings/test_login.py b/tests/commands/settings/test_login.py
diff --git a/tests/commands/settings/test_logout.py b/tests/commands/settings/test_logout.py
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/test_common.py b/tests/test_common.py
