perfact-api-pd-fastapi 1.0__tar.gz → 1.2__tar.gz

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perfact-api-pd-fastapi
-Version: 1.0
+Version: 1.2
 Summary: PerFact API - SQLAlchemy+FastAPI pd apis package
 Author-email: Viktor Dick <viktor.dick@perfact.de>
 License-Expression: GPL-2.0-or-later
@@ -13,6 +13,7 @@ Requires-Dist: fastapi[standard-no-fastapi-cloud-cli]
 Requires-Dist: perfact-api-pp
 Requires-Dist: perfact-api-pd
 Requires-Dist: perfact-api-main
+Requires-Dist: perfact-api-it
 
 # PerFact API - pd - APIs
 

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/pyproject.toml

@@ -20,6 +20,7 @@ dependencies = [
     "perfact-api-pp",
     "perfact-api-pd",
     "perfact-api-main",
+    "perfact-api-it",
 ]
 dynamic = ["version"]
 requires-python = ">=3.10"

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/src/perfact/api/pd_fastapi/__init__.py

@@ -1,6 +1,7 @@
 from fastapi import FastAPI
 from perfact.api.main.dbsession import APIRouter
 
+from .grafana import mount as grafanamount
 from .kpi import mount as kpi_mount
 from .kpi import routes_assignd as kpi_routes_assignd
 from .pdunit import mount as pdunitmount
@@ -9,6 +10,7 @@ from .performancedata import mount as performancemount
 
 routes = APIRouter()
 routes_pdord = APIRouter()
+routes_grafana = APIRouter()
 
 
 def mount(app: FastAPI):
@@ -16,8 +18,10 @@ def mount(app: FastAPI):
     pdunitmount(routes)
     pdunitlch_mount(routes)
     performancemount(routes_pdord)
+    grafanamount(routes_grafana)
     app.include_router(routes, prefix="/pd")
     app.include_router(routes_pdord, prefix="/pd/pdord")
+    app.include_router(routes_grafana, prefix="/pd/grafana")
 
 
 def mount_assignd(app: FastAPI):

perfact_api_pd_fastapi-1.2/src/perfact/api/pd_fastapi/grafana.py

@@ -0,0 +1,155 @@
+from typing import Any, Sequence
+
+from fastapi import HTTPException, status
+from perfact.api.base import VisibilityPolicy
+from perfact.api.main import VisibilityRegistryDep
+from perfact.api.main.auth import Auth, require_roles
+from perfact.api.main.dbsession import APIRouter, DBSession
+from perfact.api.pd.model.pdunit import PdUnit
+from perfact.api.pd.services import get_failure_times, pdunit_downtime_grafana_resp
+from perfact.api.pd.services.grafana import (
+    QueryRequest,
+    Target,
+    VariableRequest,
+    extract_grafana_timerange,
+)
+from pydantic import BaseModel, Field
+from sqlalchemy import select
+
+routes = APIRouter()
+
+
+def _filter_visible_pdunit_ids(
+    session: DBSession,
+    auth: Auth,
+    policy: VisibilityPolicy,
+    pdunit_ids: list[int],
+) -> list[int]:
+    """Return only PdUnit IDs visible to the current user."""
+    return list(
+        session.scalars(
+            select(PdUnit.id)
+            .where(PdUnit.id.in_(pdunit_ids))
+            .where(policy.filter(auth))
+        ).all()
+    )
+
+
+@routes.get("/", tags=["pd.grafana"], summary="Grafana health check")
+def grafana_health() -> dict[str, str]:
+    """Default Grafana route to check if the endpoint is available"""
+    return {"status": "ok"}
+
+
+@require_roles("PdKpi")
+@routes.post("/metrics", tags=["pd.grafana"], summary="Grafana metrics discovery")
+def grafana_metrics() -> list[Any]:
+    """
+    Returns a list of possible metrics which Grafana can use to display data.
+    Current available Metrics:
+    - pd.kpi.downtime: categorized downtime of workcenters
+    """
+    return [
+        {"label": "PdUnit Downtime", "value": "pd.kpi.downtime"},
+    ]
+
+
+@routes.post("/annotations", tags=["pd.grafana"], summary="Grafana annotations")
+def grafana_annotations() -> list:
+    return []
+
+
+class VariableDefinition(BaseModel):
+    text: str = Field(alias="__text")
+    value: str | int = Field(alias="__value")
+
+
+@require_roles("PdKpi", "PdRead")
+@routes.post(
+    "/variable",
+    tags=["pd.grafana"],
+    summary="Grafana variables",
+    response_model=Sequence[VariableDefinition],
+)
+def grafana_variables(
+    session: DBSession,
+    auth: Auth,
+    visibility: VisibilityRegistryDep,
+    req: VariableRequest,
+) -> Sequence[Any]:
+    """
+    Currently available variables:
+    - pd.pdunit: all visible pdunits for the requesting user
+    """
+    if auth is None:
+        raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED)
+    if req.payload is None:
+        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST)
+
+    target = req.payload.get("target", None)
+    if target == "pd.pdunit":
+        policy = visibility.get(PdUnit)
+        return (
+            session.execute(
+                select(PdUnit.num.label("__text"), PdUnit.id.label("__value")).filter(
+                    policy.filter(auth)
+                )
+            )
+            .mappings()
+            .all()
+        )
+
+    raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST)
+
+
+@require_roles("PdKpi")
+@routes.post("/query", tags=["pd.grafana"], summary="Grafana query (actually get data)")
+def grafana_query(
+    session: DBSession,
+    auth: Auth,
+    visibility: VisibilityRegistryDep,
+    query: QueryRequest,
+) -> list[dict[str, Any]]:
+    """
+    Actually query data from the database.
+    Supply targets to specify which metric to query.
+    All available metrics can be seen in /metrics
+    """
+    if auth is None:
+        raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED)
+    policy = visibility.get(PdUnit)
+
+    targets = query.targets
+    if not targets and (query.target or query.payload):
+        targets = [Target(target=query.target, payload=query.payload)]
+
+    if not targets:
+        return []
+
+    response: list[dict[str, Any]] = []
+    for target in targets:
+        if target.target not in {None, "pd.kpi.downtime"}:
+            continue
+
+        pdunit_ids = []
+        if target.payload is not None:
+            pdunit_ids = [int(x) for x in target.payload.get("pdunit", [])]
+        pdunit_ids = _filter_visible_pdunit_ids(session, auth, policy, pdunit_ids)
+        starttime, endtime = extract_grafana_timerange(query)
+
+        if (
+            not pdunit_ids
+            or starttime is None
+            or endtime is None
+            or starttime >= endtime
+        ):
+            response.append(pdunit_downtime_grafana_resp([], target.refId))
+            continue
+
+        rows = get_failure_times(session, pdunit_ids, starttime, endtime)
+        response.append(pdunit_downtime_grafana_resp(rows, target.refId))
+    return response
+
+
+def mount(app: APIRouter):
+    app.include_router(routes)

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/src/perfact/api/pd_fastapi/kpi.py

@@ -1,11 +1,13 @@
 from datetime import datetime
 from typing import Annotated, Optional
 
-from fastapi import HTTPException
+from fastapi import HTTPException, Query, status
+from perfact.api.base import VisibilityPolicy
 from perfact.api.main import Auth, VisibilityRegistryDep
 from perfact.api.main.auth import require_roles
 from perfact.api.main.dbsession import APIRouter, DBSession
 from perfact.api.pd.model.pdunit import PdUnit
+from perfact.api.pd.services import get_failure_times
 from perfact.api.pd.services.oee.availability import compute_availability
 from perfact.api.pd.services.oee.breakdown import oee_breakdown_computation
 from perfact.api.pd.services.oee.prod_metrics import (
@@ -43,6 +45,22 @@ def _require_visible_unit(
     return unit
 
 
+def _filter_visible_pdunit_ids(
+    session: DBSession,
+    auth: Auth,
+    policy: VisibilityPolicy,
+    pdunit_ids: list[int],
+) -> list[int]:
+    """Return only PdUnit IDs visible to the current user."""
+    return list(
+        session.scalars(
+            select(PdUnit.id)
+            .where(PdUnit.id.in_(pdunit_ids))
+            .where(policy.filter(auth))
+        ).all()
+    )
+
+
 def parse_datetime_with_UTC_offset(value: str) -> datetime:
     try:
         return datetime.fromisoformat(value)
@@ -256,5 +274,26 @@ def oee_trend_aggregation(
     }
 
 
+@routes.get("/kpi/downtime", tags=["pd"], summary="PdUnit downtime")
+@require_roles("PdKpi")
+def pdunit_downtime_calculation(
+    session: DBSession,
+    auth: Auth,
+    visibility: VisibilityRegistryDep,
+    starttime: datetime,
+    endtime: datetime,
+    pdunit_ids: list[int] = Query(),
+) -> list:
+    if auth is None:
+        raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED)
+    if not pdunit_ids:
+        return []
+    policy = visibility.get(PdUnit)
+    pdunit_ids = _filter_visible_pdunit_ids(session, auth, policy, pdunit_ids)
+    if not pdunit_ids:
+        return []
+    return get_failure_times(session, pdunit_ids, starttime, endtime)
+
+
 def mount(app: APIRouter):
     app.include_router(routes)

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/src/perfact_api_pd_fastapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perfact-api-pd-fastapi
-Version: 1.0
+Version: 1.2
 Summary: PerFact API - SQLAlchemy+FastAPI pd apis package
 Author-email: Viktor Dick <viktor.dick@perfact.de>
 License-Expression: GPL-2.0-or-later
@@ -13,6 +13,7 @@ Requires-Dist: fastapi[standard-no-fastapi-cloud-cli]
 Requires-Dist: perfact-api-pp
 Requires-Dist: perfact-api-pd
 Requires-Dist: perfact-api-main
+Requires-Dist: perfact-api-it
 
 # PerFact API - pd - APIs
 

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/src/perfact_api_pd_fastapi.egg-info/SOURCES.txt

@@ -2,6 +2,7 @@ README.md
 pyproject.toml
 tox.ini
 src/perfact/api/pd_fastapi/__init__.py
+src/perfact/api/pd_fastapi/grafana.py
 src/perfact/api/pd_fastapi/kpi.py
 src/perfact/api/pd_fastapi/pdunit.py
 src/perfact/api/pd_fastapi/pdunitlch.py

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/src/perfact_api_pd_fastapi.egg-info/requires.txt

@@ -2,3 +2,4 @@ fastapi[standard-no-fastapi-cloud-cli]
 perfact-api-pp
 perfact-api-pd
 perfact-api-main
+perfact-api-it

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/src/perfact_api_pd_fastapi.egg-info/scm_file_list.json

@@ -3,19 +3,20 @@
     "README.md",
     "pyproject.toml",
     "tox.ini",
-    "src/perfact/api/pd_fastapi/__init__.py",
-    "src/perfact/api/pd_fastapi/kpi.py",
     "src/perfact/api/pd_fastapi/performancedata.py",
-    "src/perfact/api/pd_fastapi/pdunit.py",
+    "src/perfact/api/pd_fastapi/grafana.py",
     "src/perfact/api/pd_fastapi/py.typed",
+    "src/perfact/api/pd_fastapi/kpi.py",
+    "src/perfact/api/pd_fastapi/__init__.py",
     "src/perfact/api/pd_fastapi/pdunitlch.py",
-    "tests/__init__.py",
-    "tests/conftest.py",
-    "tests/test_kpi.py",
-    "tests/test_init.py",
+    "src/perfact/api/pd_fastapi/pdunit.py",
     "tests/helpers.py",
     "tests/locustfile.py",
+    "tests/test_init.py",
+    "tests/test_kpi.py",
+    "tests/__init__.py",
     "tests/test_pdunit.py",
+    "tests/conftest.py",
     "tests/test_performance.py"
   ]
 }

perfact_api_pd_fastapi-1.2/src/perfact_api_pd_fastapi.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.2",
+  "distance": 0,
+  "node": "g23f9e71ace0327b4a1e5f9488a191b8ffe17585a",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-06-26"
+}

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/tests/helpers.py

@@ -1,4 +1,4 @@
-from fastapi.routing import APIRoute, _IncludedRouter
+from fastapi.routing import APIRoute
 
 
 def collect_paths(router, prefix: str = "") -> set[str]:
@@ -11,7 +11,7 @@ def collect_paths(router, prefix: str = "") -> set[str]:
     for route in router.routes:
         if isinstance(route, APIRoute):
             paths.add(prefix + route.path)
-        elif isinstance(route, _IncludedRouter):
+        elif hasattr(route, "original_router") and hasattr(route, "include_context"):
             sub_prefix = prefix + (route.include_context.prefix or "")
             paths |= collect_paths(route.original_router, sub_prefix)
     return paths

{perfact_api_pd_fastapi-1.0 → perfact_api_pd_fastapi-1.2}/tox.ini

@@ -25,6 +25,7 @@ deps =
     perfact-api-main
     perfact-api-pd
     perfact-api-pp
+    perfact-api-it
 
 commands =
     ruff format --check

perfact_api_pd_fastapi-1.0/src/perfact_api_pd_fastapi.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "1.0",
-  "distance": 0,
-  "node": "gfb2c87d0ac4741b17796b2fd015fa54fc09cd710",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-06-24"
-}