feat: add configurable JsonClient class for dependency injection
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 76/100
Línea de trabajo
Comienza en campus_python/init.py, centrándote en la clase Campus y en sus propiedades auth y api. Revisa después tests/flask_test/campus_request.py para comprobar la estructura del cliente inyectado y verifica que ambas propiedades usen la clase configurada, mientras que el valor predeterminado siga siendo CampusRequest; el ejemplo de documentación y la publicación de la versión menor aparecen como elementos adicionales de la lista de comprobación.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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)
- Lenguaje dominante
- Python
- Estrellas
- 0
- Forks
- 0
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de nyjc-computing/campus-api-python
-
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
-
Add Timetable resource Abierto
nyjc-computing/campus-api-python#2 · 1 asignado ·
Todos los issues de nyjc-computing/campus-api-python
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100