perfact-api-pd-fastapi 1.16__tar.gz → 1.18__tar.gz

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perfact-api-pd-fastapi
-Version: 1.16
+Version: 1.18
 Summary: PerFact API - SQLAlchemy+FastAPI pd apis package
 Author-email: Viktor Dick <viktor.dick@perfact.de>
 License-Expression: GPL-2.0-or-later
@@ -14,6 +14,7 @@ Requires-Dist: perfact-api-pp
 Requires-Dist: perfact-api-pd
 Requires-Dist: perfact-api-main
 Requires-Dist: perfact-api-it
+Requires-Dist: perfact-api-i18n-fastapi
 
 # PerFact API - pd - APIs
 

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/pyproject.toml

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

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact/api/pd_fastapi/grafana.py

@@ -1,6 +1,6 @@
 from collections.abc import Callable
 from dataclasses import dataclass
-from typing import Any, Sequence
+from typing import Any, Literal, Sequence
 
 from fastapi import HTTPException, status
 from perfact.api.base import AuthInfo, VisibilityPolicy, VisibilityPolicyRegistry
@@ -120,7 +120,11 @@ class ToolDowntimePayload(BaseModel):
     ``top_n`` is bounded to [1, _TOOL_DOWNTIME_MAX_TOP_N]. The id filters and
     ``sort`` are normalized through the same tolerant parsing the raw handler
     used, so an "All"/cleared template variable ('', [] or the unresolved
-    ``$__all``) still means "no filter".
+    ``$__all``) still means "no filter" / the default.
+
+    ``sort_by`` picks the metric that ranks the top-N tools and orders the
+    output: ``"duration"`` (default, total downtime) or ``"quantity"``
+    (incident count). It is strict: any other value is rejected.
     """
 
     model_config = ConfigDict(populate_by_name=True)
@@ -134,6 +138,7 @@ class ToolDowntimePayload(BaseModel):
     pdtooltype_ids: list[int] = Field(default_factory=list, alias="pdtooltype")
     pdtool_ids: list[int] = Field(default_factory=list, alias="pdtool")
     sort: str = "desc"
+    sort_by: Literal["duration", "quantity"] = "duration"
 
     @field_validator("plant_tssm_ids", "pdtooltype_ids", "pdtool_ids", mode="before")
     @classmethod
@@ -194,6 +199,7 @@ def _tool_downtime_handler(
         pdtooltype_ids=payload.pdtooltype_ids,
         pdtool_ids=pdtool_ids,
         sort=payload.sort,
+        sort_by=payload.sort_by,
     )
     return tool_downtime_grafana_resp(rows, target.refId)
 

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact/api/pd_fastapi/pdunit.py

@@ -2,10 +2,11 @@ from typing import Optional, Sequence
 
 from fastapi import HTTPException
 from perfact.api.base.model import PydanticBase
+from perfact.api.i18n_fastapi import Lang
 from perfact.api.main import Auth, DBSession, VisibilityRegistryDep, require_roles
 from perfact.api.main.dbsession import APIRouter
 from perfact.api.pd.model import PdUnit
-from sqlalchemy import select
+from perfact.api.pd.services import list_pdunits
 
 routes = APIRouter()
 
@@ -26,8 +27,11 @@ class PdUnitGet(PydanticBase):
 )
 @require_roles("PdRead")
 def pdunit_get_all(
-    session: DBSession, auth: Auth, visibility: VisibilityRegistryDep
-) -> Sequence[PdUnit]:
+    session: DBSession,
+    auth: Auth,
+    visibility: VisibilityRegistryDep,
+    lang: Lang,
+) -> Sequence[PdUnitGet]:
     """
     returns all PdUnit which the current user is allowed to see.
     """
@@ -35,7 +39,8 @@ def pdunit_get_all(
     if auth is None:
         raise HTTPException(status_code=401, detail="Not authenticated")
 
-    return session.execute(select(PdUnit).filter(policy.filter(auth))).scalars().all()
+    rows = list_pdunits(session, lang, policy.filter(auth))
+    return [PdUnitGet.model_validate(row) for row in rows]
 
 
 def mount(app: APIRouter):

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact/api/pd_fastapi/pdunitlch.py

@@ -3,17 +3,19 @@ from typing import Optional, Sequence
 
 from fastapi import HTTPException, Query
 from perfact.api.base.model import PydanticBase
+from perfact.api.i18n_fastapi import Lang
 from perfact.api.main import Auth, DBSession, VisibilityRegistryDep, require_roles
 from perfact.api.main.dbsession import APIRouter
-from perfact.api.pd.model import (
-    PdOrdLc,
-    PdOrdLch,
-    PdOrdLct,
-    PdUnit,
-    PdUnitLc,
-    PdUnitLct,
+from perfact.api.pd.model import PdOrdLch, PdUnit, PdUnitLct
+from perfact.api.pd.services import (
+    find_pdunit,
+    get_unit_lch_history,
+    list_pdordlc,
+    list_pdordlch,
+    list_pdordlct,
+    list_pdunitlc,
+    list_pdunitlct,
 )
-from perfact.api.pd.services.pdunitlch import UnitLchHistoryEntry, get_unit_lch_history
 from pydantic import BaseModel, ConfigDict
 from sqlalchemy import select
 
@@ -72,8 +74,10 @@ class PdUnitLchEntryGet(BaseModel):
     response_model=Sequence[PdUnitLcGet],
 )
 @require_roles("PdRead")
-def pdunitlc_get_all(session: DBSession, auth: Auth) -> Sequence[PdUnitLc]:
-    return session.execute(select(PdUnitLc)).scalars().all()
+def pdunitlc_get_all(
+    session: DBSession, auth: Auth, lang: Lang
+) -> Sequence[PdUnitLcGet]:
+    return [PdUnitLcGet.model_validate(row) for row in list_pdunitlc(session, lang)]
 
 
 @routes.get(
@@ -84,7 +88,7 @@ def pdunitlc_get_all(session: DBSession, auth: Auth) -> Sequence[PdUnitLc]:
 )
 @require_roles("PdRead")
 def pdunitlct_get_all(session: DBSession, auth: Auth) -> Sequence[PdUnitLct]:
-    return session.execute(select(PdUnitLct)).scalars().all()
+    return list_pdunitlct(session)
 
 
 @routes.get(
@@ -94,8 +98,8 @@ def pdunitlct_get_all(session: DBSession, auth: Auth) -> Sequence[PdUnitLct]:
     response_model=Sequence[PdOrdLcGet],
 )
 @require_roles("PdRead")
-def pdordlc_get_all(session: DBSession, auth: Auth) -> Sequence[PdOrdLc]:
-    return session.execute(select(PdOrdLc)).scalars().all()
+def pdordlc_get_all(session: DBSession, auth: Auth, lang: Lang) -> Sequence[PdOrdLcGet]:
+    return [PdOrdLcGet.model_validate(row) for row in list_pdordlc(session, lang)]
 
 
 @routes.get(
@@ -105,8 +109,10 @@ def pdordlc_get_all(session: DBSession, auth: Auth) -> Sequence[PdOrdLc]:
     response_model=Sequence[PdOrdLctGet],
 )
 @require_roles("PdRead")
-def pdordlct_get_all(session: DBSession, auth: Auth) -> Sequence[PdOrdLct]:
-    return session.execute(select(PdOrdLct)).scalars().all()
+def pdordlct_get_all(
+    session: DBSession, auth: Auth, lang: Lang
+) -> Sequence[PdOrdLctGet]:
+    return [PdOrdLctGet.model_validate(row) for row in list_pdordlct(session, lang)]
 
 
 @routes.get(
@@ -117,7 +123,7 @@ def pdordlct_get_all(session: DBSession, auth: Auth) -> Sequence[PdOrdLct]:
 )
 @require_roles("PdRead")
 def pdordlch_get_all(session: DBSession, auth: Auth) -> Sequence[PdOrdLch]:
-    return session.execute(select(PdOrdLch)).scalars().all()
+    return list_pdordlch(session)
 
 
 @routes.get(
@@ -130,30 +136,21 @@ def pdordlch_get_all(session: DBSession, auth: Auth) -> Sequence[PdOrdLch]:
 def pdunitlch_get(
     session: DBSession,
     auth: Auth,
+    lang: Lang,
     visibility: VisibilityRegistryDep,
     pdunit_id: Optional[int] = None,
     pdunit_num: Optional[str] = None,
     sample_count: Optional[int] = Query(default=None, ge=1, le=MAX_SAMPLE_COUNT),
     starttime: Optional[datetime.datetime] = None,
     endtime: Optional[datetime.datetime] = None,
-) -> list[UnitLchHistoryEntry]:
-    # Resolve unit from id or num
-    if pdunit_id is not None:
-        unit = session.get(PdUnit, pdunit_id)
-    elif pdunit_num is not None:
-        unit = session.execute(
-            select(PdUnit).where(PdUnit.num == pdunit_num)
-        ).scalar_one_or_none()
-    else:
-        raise HTTPException(status_code=422, detail="Provide pdunit_id or pdunit_num")
-
-    if unit is None:
-        raise HTTPException(
-            status_code=404,
-            detail=f"PdUnit not found: {pdunit_id or pdunit_num!r}",
-        )
+) -> list[PdUnitLchEntryGet]:
+    try:
+        unit = find_pdunit(session, pdunit_id=pdunit_id, pdunit_num=pdunit_num)
+    except ValueError as exc:
+        raise HTTPException(status_code=422, detail=str(exc)) from exc
+    except LookupError as exc:
+        raise HTTPException(status_code=404, detail=str(exc)) from exc
 
-    # Visibility check applies regardless of which lookup path was used
     try:
         policy = visibility.get(PdUnit)
     except KeyError:
@@ -167,17 +164,18 @@ def pdunitlch_get(
         raise HTTPException(status_code=404)
 
     try:
-        return get_unit_lch_history(
+        history = get_unit_lch_history(
             session,
             pdunit_id=unit.id,
             starttime=starttime,
             endtime=endtime,
             sample_count=sample_count,
+            lang=lang,
         )
     except ValueError as exc:
         raise HTTPException(status_code=422, detail=str(exc)) from exc
-    except LookupError as exc:
-        raise HTTPException(status_code=404, detail=str(exc)) from exc
+
+    return [PdUnitLchEntryGet.model_validate(entry) for entry in history]
 
 
 def mount(app: APIRouter) -> None:

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact_api_pd_fastapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perfact-api-pd-fastapi
-Version: 1.16
+Version: 1.18
 Summary: PerFact API - SQLAlchemy+FastAPI pd apis package
 Author-email: Viktor Dick <viktor.dick@perfact.de>
 License-Expression: GPL-2.0-or-later
@@ -14,6 +14,7 @@ Requires-Dist: perfact-api-pp
 Requires-Dist: perfact-api-pd
 Requires-Dist: perfact-api-main
 Requires-Dist: perfact-api-it
+Requires-Dist: perfact-api-i18n-fastapi
 
 # PerFact API - pd - APIs
 

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact_api_pd_fastapi.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ tests/locustfile.py
 tests/test_grafana.py
 tests/test_init.py
 tests/test_kpi.py
+tests/test_lifecycle_lookup_wiring.py
 tests/test_pdunit.py
 tests/test_pdunitlch.py
 tests/test_performance.py

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact_api_pd_fastapi.egg-info/requires.txt

@@ -3,3 +3,4 @@ perfact-api-pp
 perfact-api-pd
 perfact-api-main
 perfact-api-it
+perfact-api-i18n-fastapi

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/src/perfact_api_pd_fastapi.egg-info/scm_file_list.json

@@ -16,6 +16,7 @@
     "tests/test_grafana.py",
     "tests/test_init.py",
     "tests/test_kpi.py",
+    "tests/test_lifecycle_lookup_wiring.py",
     "tests/test_pdunit.py",
     "tests/test_pdunitlch.py",
     "tests/test_performance.py",

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

@@ -0,0 +1,8 @@
+{
+  "tag": "1.18",
+  "distance": 0,
+  "node": "g9f0dd07206a5739cc8062f22dc81bb453502b68f",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-29"
+}

perfact_api_pd_fastapi-1.18/tests/conftest.py

@@ -0,0 +1,58 @@
+import pytest
+from perfact.api.base.model import Base
+from perfact.api.i18n.model import I18nLang
+from perfact.api.pd.model import (
+    PdOrdLc,
+    PdOrdLcI18n,
+    PdOrdLct,
+    PdOrdLctI18n,
+    PdPlant,
+    PdUnit,
+    PdUnitGroup,
+    PdUnitI18n,
+    PdUnitLc,
+    PdUnitLcI18n,
+)
+from pytest_postgresql import factories
+from sqlalchemy import create_engine, text
+from sqlalchemy.orm import Session
+
+postgresql_proc = factories.postgresql_proc()
+postgresql = factories.postgresql("postgresql_proc")
+
+_TABLES = [
+    I18nLang.__table__,
+    PdUnitLc.__table__,
+    PdUnitLcI18n.__table__,
+    PdOrdLc.__table__,
+    PdOrdLcI18n.__table__,
+    PdOrdLct.__table__,
+    PdOrdLctI18n.__table__,
+    PdPlant.__table__,
+    PdUnitGroup.__table__,
+    PdUnit.__table__,
+    PdUnitI18n.__table__,
+]
+
+
+@pytest.fixture
+def db_engine(postgresql):
+    info = postgresql.info
+    url = f"postgresql+psycopg://{info.user}@{info.host}:{info.port}/{info.dbname}"
+    engine = create_engine(url)
+    with engine.begin() as conn:
+        conn.execute(
+            text(
+                "CREATE OR REPLACE FUNCTION db_username() RETURNS text "
+                "LANGUAGE SQL AS 'SELECT current_user'"
+            )
+        )
+    Base.metadata.create_all(engine, tables=_TABLES)
+    yield engine
+    engine.dispose()
+
+
+@pytest.fixture
+def db_session(db_engine):
+    with Session(db_engine) as session:
+        yield session

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/tests/test_grafana.py

@@ -242,6 +242,29 @@ def test_tool_downtime_handler_happy_path(monkeypatch: pytest.MonkeyPatch) -> No
     assert captured["pdtool_ids"] == [5]
 
 
+@pytest.mark.parametrize(
+    "payload, expected",
+    [
+        ({"sort_by": "quantity"}, "quantity"),
+        ({"sort_by": "duration"}, "duration"),
+        ({}, "duration"),  # absent -> default
+    ],
+)
+def test_tool_downtime_payload_sort_by(payload, expected) -> None:
+    assert grafana.ToolDowntimePayload.model_validate(payload).sort_by == expected
+
+
+@pytest.mark.parametrize("value", ["bogus", "", "QUANTITY", None, 1])
+def test_tool_downtime_handler_rejects_invalid_sort_by(value) -> None:
+    target = Target(target="pd.kpi.tool_downtime", payload={"sort_by": value})
+    query = QueryRequest.model_validate({})
+
+    with pytest.raises(HTTPException) as exc:
+        grafana._tool_downtime_handler(Mock(), _auth(), Mock(), target, query)
+
+    assert exc.value.status_code == 400
+
+
 def test_tool_downtime_handler_scopes_to_pdtool_visibility(
     monkeypatch: pytest.MonkeyPatch,
 ) -> None:

perfact_api_pd_fastapi-1.18/tests/test_lifecycle_lookup_wiring.py

@@ -0,0 +1,14 @@
+from perfact.api.main.dbsession import APIRouter
+from perfact.api.pd_fastapi import pdunitlch
+
+
+def test_mount_includes_pdunitlc_pdordlc_pdordlct_routes() -> None:
+    """Mounting registers the lifecycle lookup routes."""
+    from .helpers import collect_paths
+
+    app_router = APIRouter()
+
+    pdunitlch.mount(app_router)
+
+    paths = collect_paths(app_router)
+    assert {"/pdunitlc", "/pdordlc", "/pdordlct"} <= paths

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/tests/test_pdunit.py

@@ -36,7 +36,12 @@ def test_pdunit_get_all_requires_authentication() -> None:
 
     with pytest.raises(HTTPException, match="Not authenticated") as exc_info:
         asyncio.run(
-            pdunit.pdunit_get_all(session=session, auth=None, visibility=visibility)  # type: ignore[arg-type]
+            pdunit.pdunit_get_all(
+                session=session,
+                auth=None,  # type: ignore[arg-type]
+                visibility=visibility,  # type: ignore[arg-type]
+                lang=None,
+            )
         )
 
     assert exc_info.value.status_code == 401

{perfact_api_pd_fastapi-1.16 → perfact_api_pd_fastapi-1.18}/tests/test_pdunitlch.py

@@ -41,8 +41,10 @@ def test_pdunitlchentryget_exposes_pdordlc_name() -> None:
     entry = UnitLchHistoryEntry(
         createtime=datetime.datetime(2024, 1, 1, tzinfo=datetime.timezone.utc),
         pdunitlct_name="start",
+        pdunitlc_id=1,
         pdunitlc_name="running",
         pdord_num="ORD-1",
+        pdordlc_id=2,
         pdordlc_name="active",
     )
 
@@ -55,8 +57,10 @@ def test_pdunitlchentryget_pdordlc_name_none_when_no_active_operation() -> None:
     entry = UnitLchHistoryEntry(
         createtime=datetime.datetime(2024, 1, 1, tzinfo=datetime.timezone.utc),
         pdunitlct_name="start",
+        pdunitlc_id=1,
         pdunitlc_name="running",
         pdord_num=None,
+        pdordlc_id=None,
         pdordlc_name=None,
     )
 

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

@@ -1,8 +0,0 @@
-{
-  "tag": "1.16",
-  "distance": 0,
-  "node": "g8d3b01e2485ef0f77ee363eb02b4cbcad5c680ac",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-10-07"
-}