perfact-api-pd-fastapi 1.7__tar.gz → 1.8__tar.gz

{perfact_api_pd_fastapi-1.7 → perfact_api_pd_fastapi-1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perfact-api-pd-fastapi
-Version: 1.7
+Version: 1.8
 Summary: PerFact API - SQLAlchemy+FastAPI pd apis package
 Author-email: Viktor Dick <viktor.dick@perfact.de>
 License-Expression: GPL-2.0-or-later

{perfact_api_pd_fastapi-1.7 → perfact_api_pd_fastapi-1.8}/src/perfact/api/pd_fastapi/kpi.py

@@ -6,7 +6,10 @@ 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.availability import (
+    compute_availability,
+    compute_productive_seconds,
+)
 from perfact.api.pd.services.oee.breakdown import oee_breakdown_computation
 from perfact.api.pd.services.oee.prod_metrics import (
     compute_performance,
@@ -67,18 +70,17 @@ def oee_performance(
     session: DBSession,
     starttime: datetime,
     stoptime: datetime,
-) -> float:
+) -> float | None:
     """
-    Route for OEE availability
+    Route for OEE performance
     Uses the performance_computation function
-    Returns single floating point value
+    Returns a single floating point value, or null when there is no productive
+    (isexecution) time in the window.
     """
     records = get_prod_records(session, unit.id, starttime, stoptime)
     spans = get_state_spans(session, unit.id, starttime, stoptime)
-    isexecution_spans = [s for s in spans if s.isexecution]
-    return compute_performance(
-        records, starttime, stoptime, isexecution_spans=isexecution_spans
-    )
+    execution_seconds = compute_productive_seconds(spans, starttime, stoptime)
+    return compute_performance(records, starttime, stoptime, execution_seconds)
 
 
 @routes.get("/kpi/oee/quality", tags=["pd"], summary="Route for OEE quality")
@@ -108,7 +110,7 @@ class OEECalculationResponse(BaseModel):
     """
 
     availability: float
-    performance: float
+    performance: float | None
     quality: float | None
     oee: float | None
     planned_machine_time_seconds: float
@@ -132,12 +134,16 @@ def oee_calculation(
     shifts = list(session.scalars(unit.shifts_in_range_stmt(starttime, stoptime)).all())
     availability = compute_availability(spans, shifts, starttime, stoptime)
     prod_records = get_prod_records(session, unit.id, starttime, stoptime)
-    isexecution_spans = [s for s in spans if s.isexecution]
+    execution_seconds = compute_productive_seconds(spans, starttime, stoptime)
     performance = compute_performance(
-        prod_records, starttime, stoptime, isexecution_spans=isexecution_spans
+        prod_records, starttime, stoptime, execution_seconds
     )
     quality = compute_quality(prod_records, starttime, stoptime)
-    oee = availability * performance * quality if quality is not None else None
+    oee = (
+        availability * performance * quality
+        if performance is not None and quality is not None
+        else None
+    )
     summary = oee_workcenter_time_computation(session, unit.id, starttime, stoptime)
     return OEECalculationResponse(
         availability=availability,
@@ -156,7 +162,7 @@ class OEEBreakdownResponse(BaseModel):
     setup_time_deviation_seconds: float
     productive_time_seconds: float
     availability: float
-    performance: float
+    performance: float | None
     quality: float | None
     oee: float | None
     pdordprd_quantitytotal: float

{perfact_api_pd_fastapi-1.7 → perfact_api_pd_fastapi-1.8}/src/perfact_api_pd_fastapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perfact-api-pd-fastapi
-Version: 1.7
+Version: 1.8
 Summary: PerFact API - SQLAlchemy+FastAPI pd apis package
 Author-email: Viktor Dick <viktor.dick@perfact.de>
 License-Expression: GPL-2.0-or-later

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

@@ -0,0 +1,8 @@
+{
+  "tag": "1.8",
+  "distance": 0,
+  "node": "gabbf5b824885446fb287a1a5d88e4faed71b933e",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-07-31"
+}

{perfact_api_pd_fastapi-1.7 → perfact_api_pd_fastapi-1.8}/tests/test_kpi.py

@@ -1,5 +1,5 @@
 import asyncio
-from datetime import datetime, timezone
+from datetime import datetime, timedelta, timezone
 from unittest.mock import Mock
 
 import pytest
@@ -151,35 +151,41 @@ def test_oee_calculation_returns_combined_values(
     assert result.pdordprd_quantity == 9.0
 
 
-def test_oee_performance_route_passes_only_isexecution_spans(
+def test_oee_performance_route_denominator_is_productive_time(
     monkeypatch: pytest.MonkeyPatch,
 ) -> None:
-    """oee_performance passes only isexecution spans to compute_performance.
-
-    Non-execution spans (e.g. setup) must be excluded so that production records
-    recorded during setup are not included in the performance numerator/denominator.
+    """oee_performance passes Productive Time (only isexecution spans) as the
+    performance denominator; setup/other active spans do not count.
     """
     session: Session = Mock()
-    pdunit_id = 7
     unit = Mock()
-    unit.id = pdunit_id
+    unit.id = 7
     starttime = datetime(2025, 1, 1, tzinfo=timezone.utc)
     stoptime = datetime(2025, 1, 2, tzinfo=timezone.utc)
 
-    dummy_range: PsycopgRange[datetime] = PsycopgRange(None, None)
     exec_span = StateSpan(
-        pdord_id=1, range=dummy_range, isactive=True, isexecution=True
+        pdord_id=1,
+        range=PsycopgRange(starttime, starttime + timedelta(hours=1), bounds="[)"),
+        isactive=True,
+        isexecution=True,
     )
     setup_span = StateSpan(
-        pdord_id=1, range=dummy_range, isactive=True, isexecution=False
+        pdord_id=1,
+        range=PsycopgRange(
+            starttime + timedelta(hours=1),
+            starttime + timedelta(hours=2),
+            bounds="[)",
+        ),
+        isactive=True,
+        isexecution=False,
     )
-    captured_isexecution_spans: list[StateSpan] = []
+    captured: dict[str, float] = {}
 
     monkeypatch.setattr(kpi, "get_prod_records", lambda *_: [])
     monkeypatch.setattr(kpi, "get_state_spans", lambda *_: [exec_span, setup_span])
 
-    def fake_compute_performance(records, start, stop, isexecution_spans=None):
-        captured_isexecution_spans.extend(isexecution_spans or [])
+    def fake_compute_performance(records, start, stop, execution_seconds):
+        captured["execution_seconds"] = execution_seconds
         return 0.82
 
     monkeypatch.setattr(kpi, "compute_performance", fake_compute_performance)
@@ -187,41 +193,47 @@ def test_oee_performance_route_passes_only_isexecution_spans(
     coro = kpi.oee_performance(unit, session, starttime, stoptime)
     asyncio.run(coro)  # type: ignore[arg-type]
 
-    assert exec_span in captured_isexecution_spans
-    assert setup_span not in captured_isexecution_spans
+    # only the 1 h isexecution span contributes; the setup span is excluded
+    assert captured["execution_seconds"] == pytest.approx(3600.0)
 
 
-def test_oee_calculation_performance_uses_only_isexecution_spans(
+def test_oee_calculation_denominator_is_productive_time(
     monkeypatch: pytest.MonkeyPatch,
 ) -> None:
-    """oee_calculation passes only isexecution spans to compute_performance.
-
-    Non-execution spans must be excluded so the work-centre performance matches
-    the per-operation breakdown performance for single-operation scenarios.
+    """oee_calculation uses Productive Time (only isexecution spans) as the
+    performance denominator.
     """
     session: Session = Mock()
     session.scalars.return_value.all.return_value = []  # type: ignore[attr-defined]
-    pdunit_id = 3
     unit = Mock()
-    unit.id = pdunit_id
+    unit.id = 3
     starttime = datetime(2025, 2, 1, tzinfo=timezone.utc)
     stoptime = datetime(2025, 2, 2, tzinfo=timezone.utc)
 
-    dummy_range: PsycopgRange[datetime] = PsycopgRange(None, None)
     exec_span = StateSpan(
-        pdord_id=1, range=dummy_range, isactive=True, isexecution=True
+        pdord_id=1,
+        range=PsycopgRange(starttime, starttime + timedelta(hours=1), bounds="[)"),
+        isactive=True,
+        isexecution=True,
     )
     setup_span = StateSpan(
-        pdord_id=1, range=dummy_range, isactive=True, isexecution=False
+        pdord_id=1,
+        range=PsycopgRange(
+            starttime + timedelta(hours=1),
+            starttime + timedelta(hours=2),
+            bounds="[)",
+        ),
+        isactive=True,
+        isexecution=False,
     )
-    captured_isexecution_spans: list[StateSpan] = []
+    captured: dict[str, float] = {}
 
     monkeypatch.setattr(kpi, "get_state_spans", lambda *_: [exec_span, setup_span])
     monkeypatch.setattr(kpi, "compute_availability", lambda *_, **__: 0.9)
     monkeypatch.setattr(kpi, "get_prod_records", lambda *_: [])
 
-    def fake_compute_performance(records, start, stop, isexecution_spans=None):
-        captured_isexecution_spans.extend(isexecution_spans or [])
+    def fake_compute_performance(records, start, stop, execution_seconds):
+        captured["execution_seconds"] = execution_seconds
         return 0.8
 
     monkeypatch.setattr(kpi, "compute_performance", fake_compute_performance)
@@ -242,8 +254,8 @@ def test_oee_calculation_performance_uses_only_isexecution_spans(
     coro = kpi.oee_calculation(unit, session, starttime, stoptime)
     asyncio.run(coro)  # type: ignore[arg-type]
 
-    assert exec_span in captured_isexecution_spans
-    assert setup_span not in captured_isexecution_spans
+    # only the 1 h isexecution span contributes; the setup span is excluded
+    assert captured["execution_seconds"] == pytest.approx(3600.0)
 
 
 def test_mount_includes_kpi_routes() -> None:

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

@@ -1,8 +0,0 @@
-{
-  "tag": "1.7",
-  "distance": 0,
-  "node": "g4aa2bc0baa5e5d3232ee124539082fc3c08f47a1",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-07-09"
-}