xcpcio 0.63.4__py3-none-any.whl → 0.63.6__py3-none-any.whl

xcpcio/__version__.py

@@ -1 +1,4 @@
-__version__ = "0.63.4"
+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '0.63.6'

xcpcio/ccs/__init__.py

@@ -1,3 +1,3 @@
-from . import contest_archiver, model
+from . import api_server, contest_archiver, model
 
-__all__ = [model, contest_archiver]
+__all__ = [model, contest_archiver, api_server]

xcpcio/ccs/api_server/__init__.py

@@ -0,0 +1,9 @@
+"""
+Contest API Server Package
+
+Modern FastAPI-based implementation of the Contest API specification.
+"""
+
+from .server import ContestAPIServer
+
+__all__ = [ContestAPIServer]

xcpcio/ccs/api_server/dependencies.py

@@ -0,0 +1,48 @@
+"""
+FastAPI Dependencies
+
+Dependency injection system for Contest API Server.
+"""
+
+from pathlib import Path
+from typing import Annotated
+
+from fastapi import Depends
+
+from .services.contest_service import ContestService
+
+# Global contest service instance cache
+_contest_service_instance = None
+
+
+def get_contest_service() -> ContestService:
+    """
+    Dependency that provides ContestService instance.
+
+    This is configured by the main server class and cached globally.
+
+    Returns:
+        ContestService instance
+
+    Raises:
+        RuntimeError: If service not configured
+    """
+    global _contest_service_instance
+    if _contest_service_instance is None:
+        raise RuntimeError("ContestService not configured. Call configure_dependencies() first.")
+    return _contest_service_instance
+
+
+def configure_dependencies(contest_package_dir: Path) -> None:
+    """
+    Configure the dependency injection system.
+
+    Args:
+        contest_package_dir: Path to contest package directory
+    """
+    global _contest_service_instance
+    _contest_service_instance = ContestService(contest_package_dir)
+
+
+# Type alias for dependency injection
+ContestServiceDep = Annotated[ContestService, Depends(get_contest_service)]

xcpcio/ccs/api_server/routes/__init__.py

@@ -0,0 +1,50 @@
+"""
+Routes package for Contest API Server
+
+Contains all API route definitions organized by functionality.
+"""
+
+from fastapi import APIRouter
+
+from . import (
+    access,
+    awards,
+    clarifications,
+    contests,
+    general,
+    groups,
+    judgement_types,
+    judgements,
+    languages,
+    organizations,
+    problems,
+    runs,
+    submissions,
+    teams,
+)
+
+
+def create_router() -> APIRouter:
+    """Create and configure the main API router"""
+    router = APIRouter(prefix="/api")
+
+    # Include all route modules
+    router.include_router(access.router, tags=["Access"])
+    router.include_router(awards.router, tags=["Awards"])
+    router.include_router(clarifications.router, tags=["Clarifications"])
+    router.include_router(contests.router, tags=["Contests"])
+    router.include_router(general.router, tags=["General"])
+    router.include_router(groups.router, tags=["Groups"])
+    router.include_router(judgements.router, tags=["Judgements"])
+    router.include_router(judgement_types.router, tags=["Judgement types"])
+    router.include_router(languages.router, tags=["Languages"])
+    router.include_router(organizations.router, tags=["Organizations"])
+    router.include_router(problems.router, tags=["Problems"])
+    router.include_router(runs.router, tags=["Runs"])
+    router.include_router(submissions.router, tags=["Submissions"])
+    router.include_router(teams.router, tags=["Teams"])
+
+    return router
+
+
+__all__ = ["create_router"]

xcpcio/ccs/api_server/routes/access.py

@@ -0,0 +1,20 @@
+import logging
+from typing import Any, Dict
+
+from fastapi import APIRouter
+
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/access",
+    summary="Get Access Information",
+    description="Get access capabilities and visible endpoints for current client",
+    response_model=Dict[str, Any],
+)
+async def get_access(contest_id: str, service: ContestServiceDep) -> Dict[str, Any]:
+    """Get access information for the current client"""
+    return service.get_access_info(contest_id)

xcpcio/ccs/api_server/routes/awards.py

@@ -0,0 +1,38 @@
+import logging
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, Path
+
+from ...model import Award, Awards
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/awards",
+    summary="Get Awards",
+    description="Get all awards in the contest",
+    response_model=Awards,
+)
+async def get_awards(
+    contest_id: str = Path(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> List[Dict[str, Any]]:
+    """Get all awards"""
+    return service.get_awards(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/awards/{award_id}",
+    summary="Get Award",
+    description="Get specific award information",
+    response_model=Award,
+)
+async def get_award(
+    contest_id: str = Path(..., description="Contest identifier"),
+    award_id: str = Path(..., description="Award identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific award information"""
+    return service.get_award(contest_id, award_id)

xcpcio/ccs/api_server/routes/clarifications.py

@@ -0,0 +1,42 @@
+import logging
+from typing import Any, Dict, List, Optional
+
+from fastapi import APIRouter, Path, Query
+
+from ...model import Clarification, Clarifications
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/clarifications",
+    summary="Get Clarifications",
+    description="Get all clarifications, optionally filtered",
+    response_model=Clarifications,
+)
+async def get_clarifications(
+    contest_id: str = Path(..., description="Contest identifier"),
+    from_team_id: Optional[str] = Query(None, description="Filter by sender team ID (empty string for null)"),
+    to_team_id: Optional[str] = Query(None, description="Filter by recipient team ID (empty string for null)"),
+    problem_id: Optional[str] = Query(None, description="Filter by problem ID (empty string for null)"),
+    service: ContestServiceDep = None,
+) -> List[Dict[str, Any]]:
+    """Get all clarifications, optionally filtered"""
+    return service.get_clarifications(contest_id, from_team_id, to_team_id, problem_id)
+
+
+@router.get(
+    "/contests/{contest_id}/clarifications/{clarification_id}",
+    summary="Get Clarification",
+    description="Get specific clarification information",
+    response_model=Clarification,
+)
+async def get_clarification(
+    contest_id: str = Path(..., description="Contest identifier"),
+    clarification_id: str = Path(..., description="Clarification identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific clarification information"""
+    return service.get_clarification(contest_id, clarification_id)

xcpcio/ccs/api_server/routes/contests.py

@@ -0,0 +1,74 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, HTTPException
+from fastapi import Path as FastAPIPath
+from fastapi.responses import FileResponse
+
+from ...model import Contest, State
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get("/contests", summary="Get Contests", description="Get list of all contests", response_model=List[Contest])
+async def get_contests(service: ContestServiceDep) -> List[Dict[str, Any]]:
+    """Get all contests"""
+    return service.get_contests()
+
+
+@router.get(
+    "/contests/{contest_id}",
+    summary="Get Contest",
+    description="Get specific contest information",
+    response_model=Contest,
+)
+async def get_contest(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> Dict[str, Any]:
+    """Get specific contest information"""
+    return service.get_contest(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/state",
+    summary="Get Contest State",
+    description="Get current contest state (started, ended, frozen, etc.)",
+    response_model=State,
+)
+async def get_state(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> Dict[str, Any]:
+    """Get contest state"""
+    return service.get_contest_state(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/contest/banner",
+    summary="Get Contest Banner",
+    description="Get banner image for the contest",
+    response_class=FileResponse,
+)
+async def get_contest_banner(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> FileResponse:
+    """Get contest banner file"""
+    service.validate_contest_id(contest_id)
+
+    # Expected href pattern for this endpoint
+    expected_href = f"contests/{contest_id}/contest/banner"
+
+    try:
+        banners = service.contest_data.get("banner", [])
+        for banner in banners:
+            href = banner["href"]
+            if href == expected_href:
+                filename = banner["filename"]
+                banner_file: Path = service.contest_package_dir / "contest" / filename
+                if banner_file.exists():
+                    mime_type = banner["mime"]
+                    return FileResponse(path=banner_file, media_type=mime_type, filename=filename)
+    except Exception as e:
+        raise HTTPException(status_code=404, detail=f"Banner not found. [contest_id={contest_id}] [err={e}]")

xcpcio/ccs/api_server/routes/general.py

@@ -0,0 +1,32 @@
+import logging
+from datetime import datetime
+from typing import Any, Dict
+
+from fastapi import APIRouter
+
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/",
+    summary="API Information",
+    description="Get API version and provider information",
+    response_model=Dict[str, Any],
+)
+async def get_api_info(service: ContestServiceDep) -> Dict[str, Any]:
+    """Get API information and provider details"""
+    return service.get_api_info()
+
+
+@router.get("/health", summary="Health Check", description="Check server health status", response_model=Dict[str, Any])
+async def health_check(service: ContestServiceDep) -> Dict[str, Any]:
+    """Health check endpoint"""
+    return {
+        "status": "healthy",
+        "timestamp": datetime.now().isoformat(),
+        "contest_package": str(service.contest_package_dir),
+        "api_version": "2023-06",
+    }

xcpcio/ccs/api_server/routes/groups.py

@@ -0,0 +1,41 @@
+import logging
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, Path
+
+from ...model import (
+    Group,
+    Groups,
+)
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/groups",
+    summary="Get Groups",
+    description="Get all team groups in the contest",
+    response_model=Groups,
+)
+async def get_groups(
+    contest_id: str = Path(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> List[Dict[str, Any]]:
+    """Get all groups"""
+    return service.get_groups(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/groups/{group_id}",
+    summary="Get Group",
+    description="Get specific group information",
+    response_model=Group,
+)
+async def get_group(
+    contest_id: str = Path(..., description="Contest identifier"),
+    group_id: str = Path(..., description="Group identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific group information"""
+    return service.get_group(contest_id, group_id)

xcpcio/ccs/api_server/routes/judgement_types.py

@@ -0,0 +1,41 @@
+import logging
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, Path
+
+from ...model import (
+    JudgementType,
+    JudgementTypes,
+)
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/judgement-types",
+    summary="Get Judgement Types",
+    description="Get all judgement types available in the contest",
+    response_model=JudgementTypes,
+)
+async def get_judgement_types(
+    contest_id: str = Path(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> List[Dict[str, Any]]:
+    """Get all judgement types"""
+    return service.get_judgement_types(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/judgement-types/{judgement_type_id}",
+    summary="Get Judgement Type",
+    description="Get specific judgement type information",
+    response_model=JudgementType,
+)
+async def get_judgement_type(
+    contest_id: str = Path(..., description="Contest identifier"),
+    judgement_type_id: str = Path(..., description="Judgement type identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific judgement type information"""
+    return service.get_judgement_type(contest_id, judgement_type_id)

xcpcio/ccs/api_server/routes/judgements.py

@@ -0,0 +1,40 @@
+import logging
+from typing import Any, Dict, List, Optional
+
+from fastapi import APIRouter, Path, Query
+
+from ...model import Judgement, Judgements
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/judgements",
+    summary="Get Judgements",
+    description="Get all judgements, optionally filtered by submission",
+    response_model=Judgements,
+)
+async def get_judgements(
+    contest_id: str = Path(..., description="Contest identifier"),
+    submission_id: Optional[str] = Query(None, description="Filter judgements by submission ID"),
+    service: ContestServiceDep = None,
+) -> List[Dict[str, Any]]:
+    """Get all judgements, optionally filtered by submission"""
+    return service.get_judgements(contest_id, submission_id)
+
+
+@router.get(
+    "/contests/{contest_id}/judgements/{judgement_id}",
+    summary="Get Judgement",
+    description="Get specific judgement information",
+    response_model=Judgement,
+)
+async def get_judgement(
+    contest_id: str = Path(..., description="Contest identifier"),
+    judgement_id: str = Path(..., description="Judgement identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific judgement information"""
+    return service.get_judgement(contest_id, judgement_id)

xcpcio/ccs/api_server/routes/languages.py

@@ -0,0 +1,41 @@
+import logging
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, Path
+
+from ...model import (
+    Language,
+    Languages,
+)
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/languages",
+    summary="Get Languages",
+    description="Get all programming languages available for submission",
+    response_model=Languages,
+)
+async def get_languages(
+    contest_id: str = Path(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> List[Dict[str, Any]]:
+    """Get all programming languages"""
+    return service.get_languages(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/languages/{language_id}",
+    summary="Get Language",
+    description="Get specific language information",
+    response_model=Language,
+)
+async def get_language(
+    contest_id: str = Path(..., description="Contest identifier"),
+    language_id: str = Path(..., description="Language identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific language information"""
+    return service.get_language(contest_id, language_id)

xcpcio/ccs/api_server/routes/organizations.py

@@ -0,0 +1,82 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, HTTPException
+from fastapi import Path as FastAPIPath
+from fastapi.responses import FileResponse
+
+from ...model import (
+    Organization,
+    Organizations,
+)
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/organizations",
+    summary="Get Organizations",
+    description="Get all organizations in the contest",
+    response_model=Organizations,
+)
+async def get_organizations(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> List[Dict[str, Any]]:
+    """Get all organizations"""
+    return service.get_organizations(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/organizations/{organization_id}",
+    summary="Get Organization",
+    description="Get specific organization information",
+    response_model=Organization,
+)
+async def get_organization(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"),
+    organization_id: str = FastAPIPath(..., description="Organization identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific organization information"""
+    return service.get_organization(contest_id, organization_id)
+
+
+@router.get(
+    "/contests/{contest_id}/organizations/{organization_id}/logo",
+    summary="Get Organization Logo",
+    description="Get logo file for a specific organization",
+    response_class=FileResponse,
+)
+async def get_organization_logo(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"),
+    organization_id: str = FastAPIPath(..., description="Organization identifier"),
+    service: ContestServiceDep = None,
+) -> FileResponse:
+    """Get organization logo file"""
+    service.validate_contest_id(contest_id)
+
+    # Get organization from indexed data
+    org = service.organizations_by_id.get(organization_id)
+    if not org:
+        raise HTTPException(status_code=404, detail=f"Organization {organization_id} not found")
+
+    # Expected href pattern for this endpoint
+    expected_href = f"contests/{contest_id}/organizations/{organization_id}/logo"
+
+    try:
+        logos = org["logo"]
+        for logo in logos:
+            href = logo["href"]
+            if href == expected_href:
+                filename = logo["filename"]
+                logo_file: Path = service.contest_package_dir / "organizations" / organization_id / filename
+                if logo_file.exists():
+                    mime_type = logo["mime"]
+                    return FileResponse(path=logo_file, media_type=mime_type, filename=filename)
+    except Exception as e:
+        raise HTTPException(
+            status_code=404, detail=f"Logo file not found. [organization_id={organization_id}] [err={e}]"
+        )

xcpcio/ccs/api_server/routes/problems.py

@@ -0,0 +1,77 @@
+import logging
+from pathlib import Path
+from typing import Any, Dict, List
+
+from fastapi import APIRouter, HTTPException
+from fastapi import Path as FastAPIPath
+from fastapi.responses import FileResponse
+
+from ...model import Problem, Problems
+from ..dependencies import ContestServiceDep
+
+router = APIRouter()
+logger = logging.getLogger(__name__)
+
+
+@router.get(
+    "/contests/{contest_id}/problems",
+    summary="Get Problems",
+    description="Get all problems in the contest",
+    response_model=Problems,
+)
+async def get_problems(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"), service: ContestServiceDep = None
+) -> List[Dict[str, Any]]:
+    """Get all problems in the contest"""
+    return service.get_problems(contest_id)
+
+
+@router.get(
+    "/contests/{contest_id}/problems/{problem_id}",
+    summary="Get Problem",
+    description="Get specific problem information",
+    response_model=Problem,
+)
+async def get_problem(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"),
+    problem_id: str = FastAPIPath(..., description="Problem identifier"),
+    service: ContestServiceDep = None,
+) -> Dict[str, Any]:
+    """Get specific problem information"""
+    return service.get_problem(contest_id, problem_id)
+
+
+@router.get(
+    "/contests/{contest_id}/problems/{problem_id}/statement",
+    summary="Get Problem Statement",
+    description="Get problem statement file",
+    response_class=FileResponse,
+)
+async def get_problem_statement(
+    contest_id: str = FastAPIPath(..., description="Contest identifier"),
+    problem_id: str = FastAPIPath(..., description="Problem identifier"),
+    service: ContestServiceDep = None,
+) -> FileResponse:
+    """Get problem statement file"""
+    service.validate_contest_id(contest_id)
+
+    # Get problem from indexed data
+    problem: Dict = service.problems_by_id.get(problem_id)
+    if not problem:
+        raise HTTPException(status_code=404, detail=f"Problem {problem_id} not found")
+
+    # Expected href pattern for this endpoint
+    expected_href = f"contests/{contest_id}/problems/{problem_id}/statement"
+
+    try:
+        statements = problem.get("statement", [])
+        for statement in statements:
+            href = statement["href"]
+            filename = statement["filename"]
+            if href == expected_href and filename:
+                statement_file: Path = service.contest_package_dir / "problems" / problem_id / filename
+                if statement_file.exists():
+                    mime_type = statement["mime"]
+                    return FileResponse(path=statement_file, media_type=mime_type, filename=filename)
+    except Exception as e:
+        raise HTTPException(status_code=404, detail=f"Statement not found. [problem_id={problem_id}] [err={e}]")