feat: add configurable JsonClient class for dependency injection
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 76/100
Direzione di ricerca
Inizia in campus_python/init.py, concentrandoti sulla classe Campus e sulle sue proprietà auth e api. Esamina quindi tests/flask_test/campus_request.py per verificare la struttura del client iniettato e verifica che entrambe le proprietà utilizzino la classe configurata, mentre il valore predefinito rimanga CampusRequest; l'esempio nella documentazione e il rilascio della versione minor sono elencati come elementi aggiuntivi della checklist.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Feature Request: Configurable JsonClient Class for Dependency Injection
Problem
When testing Campus services that use campus_python.Campus, we need to replace the default CampusRequest with a test-compatible version that routes to Flask test clients instead of making real HTTP requests.
Current Workaround: Monkey-Patching
Currently, we have to monkey-patch the CampusRequest class:
import campus_python
from tests.flask_test import TestCampusRequest
# Replace CampusRequest globally
campus_python.json_client.CampusRequest = TestCampusRequest
campus_python.CampusRequest = TestCampusRequest # Also patch module reference
Problems with this approach:
- ❌ Fragile - requires patching multiple module-level references
- ❌ Hard to debug - changes global state
- ❌ Confusing - not obvious that
CampusRequesthas been replaced - ❌ Brittle - may break if campus-api-python internals change
Proposed Solution
Add a configurable class attribute to allow dependency injection of the JsonClient class:
class Campus:
"""Unified Campus client interface."""
# Configurable JsonClient class
json_client_class: type[JsonClient] = CampusRequest
@property
def auth(self) -> AuthRoot:
if not hasattr(self, "_auth"):
# Use json_client_class instead of hardcoded CampusRequest
self._auth = AuthRoot(
json_client=self.json_client_class(
base_url=base_url,
timeout=self.timeout,
)
)
return self._auth
@property
def api(self) -> ApiRoot:
if not hasattr(self, "_api"):
self._api = ApiRoot(
json_client=self.json_client_class(
base_url=base_url,
timeout=self.timeout,
)
)
return self._api
Usage in Tests
import campus_python
from tests.flask_test import TestCampusRequest
def setup():
# Configure campus_python to use test client
campus_python.Campus.json_client_class = TestCampusRequest
# Now all Campus instances use TestCampusRequest
campus = campus_python.Campus(timeout=60)
campus.auth.root.authenticate(...) # Uses Flask test clients!
Benefits
- ✅ Clean dependency injection - No monkey-patching required
- ✅ Explicit configuration - Clear what JsonClient is being used
- ✅ Backward compatible - Defaults to
CampusRequest - ✅ Test-friendly - Easy to inject test doubles
- ✅ Flexible - Allows custom JsonClient implementations for:
- Testing (Flask test clients)
- Mocking (for unit tests)
- Custom HTTP backends (async, retry logic, etc.)
Implementation Details
Changes Required
File: campus_python/__init__.py
-
Add class attribute:
class Campus: json_client_class: type[JsonClient] = CampusRequest -
Replace hardcoded
CampusRequest(...)withself.json_client_class(...):- In
authproperty (line ~81) - In
apiproperty (line ~107)
- In
Example Custom JsonClient
from campus_python.json_client.interface import JsonClient, JsonResponse
class CustomJsonClient(JsonClient):
"""Custom JsonClient with special behavior."""
def __init__(self, base_url: str | None = None, **kwargs):
self.base_url = base_url or ""
# ... custom initialization ...
def get(self, path: str, query: dict | None = None) -> JsonResponse:
# ... custom implementation ...
pass
# ... implement other methods ...
# Use it
campus_python.Campus.json_client_class = CustomJsonClient
Backward Compatibility
✅ Fully backward compatible - Default value is CampusRequest, so existing code continues to work without changes.
Related
- Campus services repo: https://github.com/nyjc-computing/campus
- Issue #485: Inconsistent HTTP client patterns in tests
- Current workaround in:
tests/flask_test/campus_request.py
Alternatives Considered
-
Constructor parameter (
Campus(json_client_class=...))- ❌ Doesn't work for services that instantiate
Campus()internally (campus.auth, campus.api)
- ❌ Doesn't work for services that instantiate
-
Global function (
set_json_client_class())- ❌ More verbose than class attribute
- ❌ Requires additional function to maintain
-
Keep monkey-patching
- ❌ Fragile and confusing
Implementation Checklist
- Add
json_client_classclass attribute toCampus - Update
authproperty to useself.json_client_class - Update
apiproperty to useself.json_client_class - Add docstring explaining the configuration option
- Add example to README or documentation
- Release as minor version bump (e.g., v2.1.0)
- Lingua principale
- Python
- Stelle
- 0
- Fork
- 0
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di nyjc-computing/campus-api-python
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
-
Add Timetable resource Aperta
nyjc-computing/campus-api-python#2 · 1 assegnatario ·
Tutte le issue di nyjc-computing/campus-api-python
Issue simili
-
documentation help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
simonw/sqlite-utils#872 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100