Pylint similarity config and rename typing.py to models.py (#245)

crivetimihai · web-flow · commit e3b2c152fa6e · 2025-07-05T13:02:50.000+01:00
* pylint fix translate

Signed-off-by: Mihai Criveti &lt;crivetimihai@gmail.com&gt;

* pylint fixes and renaming typing.py to models.py to avoid conflicts

Signed-off-by: Mihai Criveti &lt;crivetimihai@gmail.com&gt;

---------

Signed-off-by: Mihai Criveti &lt;crivetimihai@gmail.com&gt;
diff --git a/.pylintrc b/.pylintrc
@@ -527,7 +527,7 @@ ignore-imports=yes
 ignore-signatures=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=8
+min-similarity-lines=10
 
 
 [SPELLING]
diff --git a/README.md b/README.md
@@ -1654,7 +1654,7 @@ make lint            # Run lint tools
 │   │   ├── sse_transport.py        # Server-Sent Events transport
 │   │   ├── stdio_transport.py      # stdio transport for embedding
 │   │   └── websocket_transport.py  # WS transport with ping/pong
-│   ├── types.py                    # Core enums / type aliases
+│   ├── models.py                   # Core enums / type aliases
 │   ├── utils
 │   │   ├── create_jwt_token.py     # CLI & library for JWT generation
 │   │   ├── services_auth.py        # Service-to-service auth dependency
diff --git a/mcpgateway/cache/session_registry.py b/mcpgateway/cache/session_registry.py
@@ -23,9 +23,9 @@
 # First-Party
 from mcpgateway.config import settings
 from mcpgateway.db import get_db, SessionMessageRecord, SessionRecord
+from mcpgateway.models import Implementation, InitializeResult, ServerCapabilities
 from mcpgateway.services import PromptService, ResourceService, ToolService
 from mcpgateway.transports import SSETransport
-from mcpgateway.types import Implementation, InitializeResult, ServerCapabilities
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/db.py b/mcpgateway/db.py
@@ -55,7 +55,7 @@
 
 # First-Party
 from mcpgateway.config import settings
-from mcpgateway.types import ResourceContent
+from mcpgateway.models import ResourceContent
 from mcpgateway.utils.create_slug import slugify
 from mcpgateway.utils.db_isready import wait_for_db_ready
 
diff --git a/mcpgateway/federation/discovery.py b/mcpgateway/federation/discovery.py
@@ -30,7 +30,7 @@
 
 # First-Party
 from mcpgateway.config import settings
-from mcpgateway.types import ServerCapabilities
+from mcpgateway.models import ServerCapabilities
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/federation/forward.py b/mcpgateway/federation/forward.py
@@ -28,7 +28,7 @@
 from mcpgateway.config import settings
 from mcpgateway.db import Gateway as DbGateway
 from mcpgateway.db import Tool as DbTool
-from mcpgateway.types import ToolResult
+from mcpgateway.models import ToolResult
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/federation/manager.py b/mcpgateway/federation/manager.py
@@ -33,7 +33,7 @@
 from mcpgateway.db import Gateway as DbGateway
 from mcpgateway.db import Tool as DbTool
 from mcpgateway.federation.discovery import DiscoveryService
-from mcpgateway.types import (
+from mcpgateway.models import (
     ClientCapabilities,
     Implementation,
     InitializeRequest,
diff --git a/mcpgateway/handlers/sampling.py b/mcpgateway/handlers/sampling.py
@@ -17,7 +17,7 @@
 from sqlalchemy.orm import Session
 
 # First-Party
-from mcpgateway.types import CreateMessageResult, ModelPreferences, Role, TextContent
+from mcpgateway.models import CreateMessageResult, ModelPreferences, Role, TextContent
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/main.py b/mcpgateway/main.py
@@ -62,6 +62,14 @@
 from mcpgateway.config import jsonpath_modifier, settings
 from mcpgateway.db import SessionLocal
 from mcpgateway.handlers.sampling import SamplingHandler
+from mcpgateway.models import (
+    InitializeRequest,
+    InitializeResult,
+    ListResourceTemplatesResult,
+    LogLevel,
+    ResourceContent,
+    Root,
+)
 from mcpgateway.schemas import (
     GatewayCreate,
     GatewayRead,
@@ -112,14 +120,6 @@
     SessionManagerWrapper,
     streamable_http_auth,
 )
-from mcpgateway.types import (
-    InitializeRequest,
-    InitializeResult,
-    ListResourceTemplatesResult,
-    LogLevel,
-    ResourceContent,
-    Root,
-)
 from mcpgateway.utils.db_isready import wait_for_db_ready
 from mcpgateway.utils.redis_isready import wait_for_redis_ready
 from mcpgateway.utils.verify_credentials import require_auth, require_auth_override
@@ -1663,7 +1663,7 @@ async def list_roots(
 @root_router.post("", response_model=Root)
 @root_router.post("/", response_model=Root)
 async def add_root(
-    root: Root,  # Accept JSON body using the Root model from types.py
+    root: Root,  # Accept JSON body using the Root model from models.py
     user: str = Depends(require_auth),
 ) -> Root:
     """
diff --git a/mcpgateway/models.py b/mcpgateway/models.py
diff --git a/mcpgateway/schemas.py b/mcpgateway/schemas.py
@@ -30,11 +30,11 @@
 from pydantic import AnyHttpUrl, BaseModel, ConfigDict, Field, field_serializer, field_validator, model_validator, ValidationInfo
 
 # First-Party
-from mcpgateway.types import ImageContent
-from mcpgateway.types import Prompt as MCPPrompt
-from mcpgateway.types import Resource as MCPResource
-from mcpgateway.types import ResourceContent, TextContent
-from mcpgateway.types import Tool as MCPTool
+from mcpgateway.models import ImageContent
+from mcpgateway.models import Prompt as MCPPrompt
+from mcpgateway.models import Resource as MCPResource
+from mcpgateway.models import ResourceContent, TextContent
+from mcpgateway.models import Tool as MCPTool
 from mcpgateway.utils.services_auth import decode_auth, encode_auth
 
 logger = logging.getLogger(__name__)
diff --git a/mcpgateway/services/completion_service.py b/mcpgateway/services/completion_service.py
@@ -20,7 +20,7 @@
 # First-Party
 from mcpgateway.db import Prompt as DbPrompt
 from mcpgateway.db import Resource as DbResource
-from mcpgateway.types import CompleteResult
+from mcpgateway.models import CompleteResult
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/services/gateway_service.py b/mcpgateway/services/gateway_service.py
@@ -624,7 +624,6 @@ async def check_health_of_gateways(self, gateways: List[DbGateway]) -> bool:
         # Reuse a single HTTP client for all requests
         async with httpx.AsyncClient() as client:
             for gateway in gateways:
-
                 logger.debug(f"Checking health of gateway: {gateway.name} ({gateway.url})")
                 try:
                     # Ensure auth_value is a dict
diff --git a/mcpgateway/services/logging_service.py b/mcpgateway/services/logging_service.py
@@ -16,7 +16,7 @@
 from typing import Any, AsyncGenerator, Dict, List, Optional
 
 # First-Party
-from mcpgateway.types import LogLevel
+from mcpgateway.models import LogLevel
 
 
 class LoggingService:
diff --git a/mcpgateway/services/prompt_service.py b/mcpgateway/services/prompt_service.py
@@ -30,8 +30,8 @@
 # First-Party
 from mcpgateway.db import Prompt as DbPrompt
 from mcpgateway.db import PromptMetric, server_prompt_association
+from mcpgateway.models import Message, PromptResult, Role, TextContent
 from mcpgateway.schemas import PromptCreate, PromptRead, PromptUpdate
-from mcpgateway.types import Message, PromptResult, Role, TextContent
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/services/resource_service.py b/mcpgateway/services/resource_service.py
@@ -34,14 +34,14 @@
 from mcpgateway.db import ResourceMetric
 from mcpgateway.db import ResourceSubscription as DbSubscription
 from mcpgateway.db import server_resource_association
+from mcpgateway.models import ResourceContent, ResourceTemplate, TextContent
 from mcpgateway.schemas import (
     ResourceCreate,
     ResourceMetrics,
     ResourceRead,
     ResourceSubscription,
     ResourceUpdate,
 )
-from mcpgateway.types import ResourceContent, ResourceTemplate, TextContent
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/services/root_service.py b/mcpgateway/services/root_service.py
@@ -18,7 +18,7 @@
 
 # First-Party
 from mcpgateway.config import settings
-from mcpgateway.types import Root
+from mcpgateway.models import Root
 
 logger = logging.getLogger(__name__)
 
diff --git a/mcpgateway/services/tool_service.py b/mcpgateway/services/tool_service.py
@@ -39,12 +39,12 @@
 from mcpgateway.db import server_tool_association
 from mcpgateway.db import Tool as DbTool
 from mcpgateway.db import ToolMetric
+from mcpgateway.models import TextContent, ToolResult
 from mcpgateway.schemas import (
     ToolCreate,
     ToolRead,
     ToolUpdate,
 )
-from mcpgateway.types import TextContent, ToolResult
 from mcpgateway.utils.create_slug import slugify
 from mcpgateway.utils.services_auth import decode_auth
 
diff --git a/mcpgateway/translate.py b/mcpgateway/translate.py
@@ -51,27 +51,21 @@
 import shlex
 import signal
 import sys
-from typing import AsyncIterator, List, Optional, Sequence
+from typing import Any, AsyncIterator, Dict, List, Optional, Sequence
 import uuid
 
 # Third-Party
 from fastapi import FastAPI, Request, Response, status
+from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import PlainTextResponse
 from sse_starlette.sse import EventSourceResponse
 import uvicorn
 
-# Conditional imports
-try:
-    # Third-Party
-    from fastapi.middleware.cors import CORSMiddleware
-except ImportError:
-    CORSMiddleware = None
-
 try:
     # Third-Party
     import httpx
 except ImportError:
-    httpx = None
+    httpx = None  # type: ignore[assignment]
 
 LOGGER = logging.getLogger("mcpgateway.translate")
 KEEP_ALIVE_INTERVAL = 30  # seconds - matches the reference implementation
@@ -188,7 +182,7 @@ async def _pump_stdout(self) -> None:
         to the pubsub system.
 
         Raises:
-            asyncio.CancelledError: If the pump task is cancelled.
+            Exception: For any other error encountered while pumping stdout.
         """
         assert self._proc and self._proc.stdout
         reader = self._proc.stdout
@@ -200,10 +194,9 @@ async def _pump_stdout(self) -> None:
                 text = line.decode(errors="replace")
                 LOGGER.debug("← stdio: %s", text.strip())
                 await self._pubsub.publish(text)
-        except asyncio.CancelledError:
-            raise
         except Exception:  # pragma: no cover --best-effort logging
             LOGGER.exception("stdout pump crashed - terminating bridge")
+            raise
 
 
 # ---------------------------------------------------------------------------#
@@ -235,7 +228,7 @@ def _build_fastapi(
     app = FastAPI()
 
     # Add CORS middleware if origins specified
-    if cors_origins and CORSMiddleware:
+    if cors_origins:
         app.add_middleware(
             CORSMiddleware,
             allow_origins=cors_origins,
@@ -261,7 +254,7 @@ async def get_sse(request: Request) -> EventSourceResponse:  # noqa: D401
         queue = pubsub.subscribe()
         session_id = uuid.uuid4().hex
 
-        async def event_gen() -> AsyncIterator[dict]:
+        async def event_gen() -> AsyncIterator[Dict[str, Any]]:
             # 1️⃣ Mandatory "endpoint" bootstrap required by the MCP spec
             endpoint_url = f"{str(request.base_url).rstrip('/')}{message_path}?session_id={session_id}"
             yield {
@@ -425,7 +418,7 @@ async def _shutdown() -> None:
     loop = asyncio.get_running_loop()
     for sig in (signal.SIGINT, signal.SIGTERM):
         with suppress(NotImplementedError):  # Windows lacks add_signal_handler
-            loop.add_signal_handler(sig, lambda _s=sig: asyncio.create_task(_shutdown()))
+            loop.add_signal_handler(sig, lambda: asyncio.create_task(_shutdown()))
 
     LOGGER.info("Bridge ready → http://127.0.0.1:%s/sse", port)
     await server.serve()
@@ -457,15 +450,15 @@ async def _run_sse_to_stdio(url: str, oauth2_bearer: Optional[str]) -> None:
             stderr=sys.stderr,
         )
 
-        async def read_stdout():
+        async def read_stdout() -> None:
             assert process.stdout
             while True:
                 line = await process.stdout.readline()
                 if not line:
                     break
                 print(line.decode().rstrip())
 
-        async def pump_sse_to_stdio():
+        async def pump_sse_to_stdio() -> None:
             async with client.stream("GET", url) as response:
                 async for line in response.aiter_lines():
                     if line.startswith("data: "):
@@ -478,7 +471,7 @@ async def pump_sse_to_stdio():
         await asyncio.gather(read_stdout(), pump_sse_to_stdio())
 
 
-def start_stdio(cmd, port, log_level, cors):
+def start_stdio(cmd: str, port: int, log_level: str, cors: Optional[List[str]]) -> None:
     """Start stdio bridge.
 
     Args:
@@ -493,7 +486,7 @@ def start_stdio(cmd, port, log_level, cors):
     return asyncio.run(_run_stdio_to_sse(cmd, port, log_level, cors))
 
 
-def start_sse(url, bearer):
+def start_sse(url: str, bearer: Optional[str]) -> None:
     """Start SSE bridge.
 
     Args:
diff --git a/mcpgateway/utils/db_isready.py b/mcpgateway/utils/db_isready.py
@@ -55,6 +55,7 @@
     await wait_for_db_ready()          # asynchronous
     wait_for_db_ready(sync=True)       # synchronous / blocking
 """
+
 # Future
 from __future__ import annotations
 
diff --git a/tests/integration/test_integration.py b/tests/integration/test_integration.py
@@ -32,8 +32,8 @@
 
 # First-Party
 from mcpgateway.main import app, require_auth
+from mcpgateway.models import InitializeResult, ResourceContent, ServerCapabilities
 from mcpgateway.schemas import ResourceRead, ServerRead, ToolMetrics, ToolRead
-from mcpgateway.types import InitializeResult, ResourceContent, ServerCapabilities
 
 
 # -----------------------------------------------------------------------------
diff --git a/tests/unit/mcpgateway/db/test_models.py b/tests/unit/mcpgateway/db/test_models.py
diff --git a/tests/unit/mcpgateway/services/test_completion_service.py b/tests/unit/mcpgateway/services/test_completion_service.py
@@ -11,13 +11,13 @@
 import pytest
 
 # First-Party
+from mcpgateway.models import (
+    CompleteResult,
+)
 from mcpgateway.services.completion_service import (
     CompletionError,
     CompletionService,
 )
-from mcpgateway.types import (
-    CompleteResult,
-)
 
 
 class FakeScalarOneResult:
diff --git a/tests/unit/mcpgateway/services/test_logging_service.py b/tests/unit/mcpgateway/services/test_logging_service.py
@@ -27,8 +27,8 @@
 import pytest
 
 # First-Party
+from mcpgateway.models import LogLevel
 from mcpgateway.services.logging_service import LoggingService
-from mcpgateway.types import LogLevel
 
 # ---------------------------------------------------------------------------
 # Basic behaviour
diff --git a/tests/unit/mcpgateway/services/test_prompt_service.py b/tests/unit/mcpgateway/services/test_prompt_service.py
@@ -26,13 +26,13 @@
 # First-Party
 from mcpgateway.db import Prompt as DbPrompt
 from mcpgateway.db import PromptMetric
+from mcpgateway.models import Message, PromptResult, Role
 from mcpgateway.schemas import PromptCreate, PromptRead, PromptUpdate
 from mcpgateway.services.prompt_service import (
     PromptError,
     PromptNotFoundError,
     PromptService,
 )
-from mcpgateway.types import Message, PromptResult, Role
 
 # ---------------------------------------------------------------------------
 # helpers
diff --git a/tests/unit/mcpgateway/test_discovery.py b/tests/unit/mcpgateway/test_discovery.py
@@ -37,7 +37,7 @@ async def discovery():
     async def _fake_gateway_info(url: str):  # noqa: D401, ANN001
         # Return an *empty* capabilities object – structure is unimportant here.
         # First-Party
-        from mcpgateway.types import ServerCapabilities
+        from mcpgateway.models import ServerCapabilities
 
         return ServerCapabilities()
 
diff --git a/tests/unit/mcpgateway/test_forward.py b/tests/unit/mcpgateway/test_forward.py
diff --git a/tests/unit/mcpgateway/test_main.py b/tests/unit/mcpgateway/test_main.py
diff --git a/tests/unit/mcpgateway/test_manager.py b/tests/unit/mcpgateway/test_manager.py
diff --git a/tests/unit/mcpgateway/test_models.py b/tests/unit/mcpgateway/test_models.py
diff --git a/tests/unit/mcpgateway/test_schemas.py b/tests/unit/mcpgateway/test_schemas.py
