fix(types): update factory functions and managers to use ProjectXBase instead of ProjectX

- Update create_trading_suite and all factory functions to accept ProjectXBase
- Fix OrderManager, PositionManager, RealtimeDataManager, and OrderBook constructors
- Update all related protocols and type annotations
- Fix MultiTimeframeStrategy example to use ProjectXBase type
- Resolve linting errors for type compatibility across the entire codebase
- All tests pass successfully after type system updates

Author: TexasCoding

examples/06_multi_timeframe_strategy.py

@@ -25,9 +25,11 @@
 import logging
 import signal
 from datetime import datetime
+from typing import Any
 
 from project_x_py import (
     ProjectX,
+    ProjectXBase,
     create_trading_suite,
 )
 from project_x_py.indicators import RSI, SMA
@@ -48,8 +50,8 @@ class MultiTimeframeStrategy:
 
     def __init__(
         self,
-        client: ProjectX,
-        trading_suite: dict,
+        client: ProjectXBase,
+        trading_suite: dict[str, Any],
         symbol: str = "MNQ",
         max_position_size: int = 2,
         risk_percentage: float = 0.02,

src/project_x_py/__init__.py

@@ -23,6 +23,8 @@
 
 from typing import Any
 
+from project_x_py.client.base import ProjectXBase
+
 __version__ = "2.0.4"
 __author__ = "TexasCoding"
 
@@ -174,7 +176,7 @@
 # Factory functions - Updated to be async-only
 async def create_trading_suite(
     instrument: str,
-    project_x: ProjectX,
+    project_x: ProjectXBase,
     jwt_token: str | None = None,
     account_id: str | None = None,
     timeframes: list[str] | None = None,
@@ -284,7 +286,7 @@ async def create_trading_suite(
 
 
 def create_order_manager(
-    project_x: ProjectX,
+    project_x: ProjectXBase,
     realtime_client: ProjectXRealtimeClient | None = None,
 ) -> OrderManager:
     """
@@ -314,7 +316,7 @@ def create_order_manager(
 
 
 def create_position_manager(
-    project_x: ProjectX,
+    project_x: ProjectXBase,
     realtime_client: ProjectXRealtimeClient | None = None,
     order_manager: OrderManager | None = None,
 ) -> PositionManager:
@@ -380,7 +382,7 @@ def create_realtime_client(
 
 def create_data_manager(
     instrument: str,
-    project_x: ProjectX,
+    project_x: ProjectXBase,
     realtime_client: ProjectXRealtimeClient,
     timeframes: list[str] | None = None,
 ) -> RealtimeDataManager:

src/project_x_py/client/__init__.py

@@ -99,7 +99,5 @@ class ProjectX(ProjectXBase):
         >>> # ... trading logic ...
     """
 
-    pass
-
 
 __all__ = ["ProjectX", "RateLimiter"]

src/project_x_py/client/auth.py

@@ -9,11 +9,11 @@
 
 import pytz
 
-from ..exceptions import ProjectXAuthenticationError
-from ..models import Account
+from project_x_py.exceptions import ProjectXAuthenticationError
+from project_x_py.models import Account
 
 if TYPE_CHECKING:
-    from .base import ProjectXBase
+    from .protocols import ProjectXClientProtocol
 
 logger = logging.getLogger(__name__)
 
@@ -27,12 +27,12 @@ def __init__(self):
         self.token_expiry: datetime.datetime | None = None
         self._authenticated = False
 
-    async def _refresh_authentication(self: "ProjectXBase") -> None:
+    async def _refresh_authentication(self: "ProjectXClientProtocol") -> None:
         """Refresh authentication if token is expired or about to expire."""
         if self._should_refresh_token():
             await self.authenticate()
 
-    def _should_refresh_token(self: "ProjectXBase") -> bool:
+    def _should_refresh_token(self: "ProjectXClientProtocol") -> bool:
         """Check if token should be refreshed."""
         if not self.token_expiry:
             return True
@@ -41,7 +41,7 @@ def _should_refresh_token(self: "ProjectXBase") -> bool:
         buffer_time = timedelta(minutes=5)
         return datetime.datetime.now(pytz.UTC) >= (self.token_expiry - buffer_time)
 
-    async def authenticate(self: "ProjectXBase") -> None:
+    async def authenticate(self: "ProjectXClientProtocol") -> None:
         """
         Authenticate with ProjectX API and select account.
 
@@ -133,12 +133,12 @@ async def authenticate(self: "ProjectXBase") -> None:
             f"Authenticated successfully. Using account: {selected_account.name}"
         )
 
-    async def _ensure_authenticated(self: "ProjectXBase") -> None:
+    async def _ensure_authenticated(self: "ProjectXClientProtocol") -> None:
         """Ensure client is authenticated before making API calls."""
         if not self._authenticated or self._should_refresh_token():
             await self.authenticate()
 
-    async def list_accounts(self: "ProjectXBase") -> list[Account]:
+    async def list_accounts(self: "ProjectXClientProtocol") -> list[Account]:
         """
         List all accounts available to the authenticated user.
 

src/project_x_py/client/base.py

@@ -4,11 +4,13 @@
 import os
 from collections.abc import AsyncGenerator
 from contextlib import asynccontextmanager
-from typing import Any
 
-from ..config import ConfigManager
-from ..exceptions import ProjectXAuthenticationError
-from ..models import Account, ProjectXConfig
+import httpx
+
+from project_x_py.config import ConfigManager
+from project_x_py.exceptions import ProjectXAuthenticationError
+from project_x_py.models import Account, ProjectXConfig
+
 from .auth import AuthenticationMixin
 from .cache import CacheMixin
 from .http import HttpMixin
@@ -49,6 +51,9 @@ def __init__(
         self.api_key = api_key
         self.account_name = account_name
 
+        # Ensure _client is properly typed
+        self._client: httpx.AsyncClient | None = None
+
         # Use provided config or create default
         self.config = config or ProjectXConfig()
         self.base_url = self.config.api_url

src/project_x_py/client/cache.py

@@ -7,10 +7,10 @@
 
 import polars as pl
 
-from ..models import Instrument
+from project_x_py.models import Instrument
 
 if TYPE_CHECKING:
-    from .base import ProjectXBase
+    from .protocols import ProjectXClientProtocol
 
 logger = logging.getLogger(__name__)
 
@@ -35,7 +35,7 @@ def __init__(self):
         # Performance monitoring
         self.cache_hit_count = 0
 
-    async def _cleanup_cache(self: "ProjectXBase") -> None:
+    async def _cleanup_cache(self: "ProjectXClientProtocol") -> None:
         """Clean up expired cache entries."""
         current_time = time.time()
 

src/project_x_py/client/http.py

@@ -6,7 +6,7 @@
 
 import httpx
 
-from ..exceptions import (
+from project_x_py.exceptions import (
     ProjectXAuthenticationError,
     ProjectXConnectionError,
     ProjectXDataError,
@@ -16,7 +16,7 @@
 )
 
 if TYPE_CHECKING:
-    from .base import ProjectXBase
+    from .protocols import ProjectXClientProtocol
 
 logger = logging.getLogger(__name__)
 
@@ -29,7 +29,7 @@ def __init__(self):
         self._client: httpx.AsyncClient | None = None
         self.api_call_count = 0
 
-    async def _create_client(self: "ProjectXBase") -> httpx.AsyncClient:
+    async def _create_client(self: "ProjectXClientProtocol") -> httpx.AsyncClient:
         """
         Create an optimized httpx async client with connection pooling and retries.
 
@@ -73,14 +73,14 @@ async def _create_client(self: "ProjectXBase") -> httpx.AsyncClient:
 
         return client
 
-    async def _ensure_client(self: "ProjectXBase") -> httpx.AsyncClient:
+    async def _ensure_client(self: "ProjectXClientProtocol") -> httpx.AsyncClient:
         """Ensure HTTP client is initialized."""
         if self._client is None:
             self._client = await self._create_client()
         return self._client
 
     async def _make_request(
-        self: "ProjectXBase",
+        self: "ProjectXClientProtocol",
         method: str,
         endpoint: str,
         data: dict[str, Any] | None = None,
@@ -137,7 +137,12 @@ async def _make_request(
                     )
                     await asyncio.sleep(retry_after)
                     return await self._make_request(
-                        method, endpoint, data, params, headers, retry_count + 1
+                        method=method,
+                        endpoint=endpoint,
+                        data=data,
+                        params=params,
+                        headers=headers,
+                        retry_count=retry_count + 1,
                     )
                 raise ProjectXRateLimitError("Rate limit exceeded after retries")
 
@@ -153,7 +158,12 @@ async def _make_request(
                     # Try to refresh authentication
                     await self._refresh_authentication()
                     return await self._make_request(
-                        method, endpoint, data, params, headers, retry_count + 1
+                        method=method,
+                        endpoint=endpoint,
+                        data=data,
+                        params=params,
+                        headers=headers,
+                        retry_count=retry_count + 1,
                     )
                 raise ProjectXAuthenticationError("Authentication failed")
 
@@ -183,7 +193,12 @@ async def _make_request(
                     )
                     await asyncio.sleep(wait_time)
                     return await self._make_request(
-                        method, endpoint, data, params, headers, retry_count + 1
+                        method=method,
+                        endpoint=endpoint,
+                        data=data,
+                        params=params,
+                        headers=headers,
+                        retry_count=retry_count + 1,
                     )
                 raise ProjectXServerError(
                     f"Server error: {response.status_code} - {response.text}"
@@ -212,7 +227,7 @@ async def _make_request(
                 raise ProjectXError(f"Unexpected error: {e}") from e
             raise
 
-    async def get_health_status(self: "ProjectXBase") -> dict[str, Any]:
+    async def get_health_status(self: "ProjectXClientProtocol") -> dict[str, Any]:
         """
         Get API health status and client statistics.
 

src/project_x_py/client/market_data.py

@@ -9,11 +9,11 @@
 import polars as pl
 import pytz
 
-from ..exceptions import ProjectXInstrumentError
-from ..models import Instrument
+from project_x_py.exceptions import ProjectXInstrumentError
+from project_x_py.models import Instrument
 
 if TYPE_CHECKING:
-    from .base import ProjectXBase
+    from .protocols import ProjectXClientProtocol
 
 logger = logging.getLogger(__name__)
 
@@ -22,7 +22,7 @@ class MarketDataMixin:
     """Mixin class providing market data functionality."""
 
     async def get_instrument(
-        self: "ProjectXBase", symbol: str, live: bool = False
+        self: "ProjectXClientProtocol", symbol: str, live: bool = False
     ) -> Instrument:
         """
         Get detailed instrument information with caching.
@@ -71,7 +71,9 @@ async def get_instrument(
         return instrument
 
     def _select_best_contract(
-        self: "ProjectXBase", instruments: list[dict[str, Any]], search_symbol: str
+        self: "ProjectXClientProtocol",
+        instruments: list[dict[str, Any]],
+        search_symbol: str,
     ) -> dict[str, Any]:
         """
         Select the best matching contract from search results.
@@ -130,7 +132,7 @@ def _select_best_contract(
         return instruments[0]
 
     async def search_instruments(
-        self: "ProjectXBase", query: str, live: bool = False
+        self: "ProjectXClientProtocol", query: str, live: bool = False
     ) -> list[Instrument]:
         """
         Search for instruments by symbol or name.
@@ -159,7 +161,7 @@ async def search_instruments(
         return [Instrument(**contract) for contract in contracts_data]
 
     async def get_bars(
-        self: "ProjectXBase",
+        self: "ProjectXClientProtocol",
         symbol: str,
         days: int = 8,
         interval: int = 5,