contracts-hj3415 0.5.0__tar.gz → 0.5.1__tar.gz

{contracts_hj3415-0.5.0 → contracts_hj3415-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contracts-hj3415
-Version: 0.5.0
+Version: 0.5.1
 Summary: DTO pakages for hj3415
 Keywords: example,demo
 Author-email: Hyungjin Kim <hj3415@gmail.com>

{contracts_hj3415-0.5.0 → contracts_hj3415-0.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "contracts-hj3415"                          # PyPI 이름 (하이픈 허용)
-version = "0.5.0"
+version = "0.5.1"
 description = "DTO pakages for hj3415"
 readme = "README.md"
 requires-python = ">=3.11"

{contracts_hj3415-0.5.0 → contracts_hj3415-0.5.1}/src/contracts_hj3415/analysis/features.py

@@ -30,5 +30,6 @@ class LatestAndTtm(TypedDict):
 
 
 class FeaturesPayload(TypedDict):
+    service: Literal["features"]
     endpoint: Endpoint
     blocks: dict[MetricKey, LatestAndTtm]

contracts_hj3415-0.5.1/src/contracts_hj3415/common/__init__.py

@@ -0,0 +1,7 @@
+from .envelope import make_nfs_envelope, make_analysis_envelope, make_universe_envelope
+
+__all__ = [  # pyright: ignore[reportUnsupportedDunderAll]
+    make_nfs_envelope,
+    make_analysis_envelope,
+    make_universe_envelope,
+]

contracts_hj3415-0.5.1/src/contracts_hj3415/common/envelope.py

@@ -0,0 +1,92 @@
+# contracts_hj3415/common/envelope.py
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Literal, TypedDict
+
+from contracts_hj3415.analysis.payloads import AnalysisPayloadDTO
+from contracts_hj3415.common.types import CodeKey, EnvelopeMeta, Source
+
+# topic별 payload 유니온
+from contracts_hj3415.nfs.payloads import NfsPayloadDTO
+from contracts_hj3415.universe.payloads import UniversePayloadDTO
+from contracts_hj3415.universe.types import Universe
+
+
+class NfsEnvelopeDTO(TypedDict):
+    topic: Literal["nfs"]
+    key: CodeKey
+    asof: datetime
+    payload: NfsPayloadDTO
+    meta: EnvelopeMeta
+
+
+class UniverseEnvelopeDTO(TypedDict):
+    topic: Literal["universe"]
+    key: Universe
+    asof: datetime
+    payload: UniversePayloadDTO
+    meta: EnvelopeMeta
+
+
+class AnalysisEnvelopeDTO(TypedDict):
+    topic: Literal["analysis"]
+    key: CodeKey
+    asof: datetime
+    payload: AnalysisPayloadDTO
+    meta: EnvelopeMeta
+
+
+def _make_empty_envelope_meta(source: Source = "") -> EnvelopeMeta:
+    return {"source": source, "trace_id": "", "note": "", "tags": []}
+
+
+# ---------- topic별 convenience wrappers ----------
+
+
+def make_nfs_envelope(
+    *,
+    key: CodeKey,
+    asof: datetime,
+    payload: NfsPayloadDTO,
+    meta: EnvelopeMeta | None = None,
+) -> NfsEnvelopeDTO:
+    return {
+        "topic": "nfs",
+        "key": key,
+        "asof": asof,
+        "payload": payload,
+        "meta": meta or _make_empty_envelope_meta("scraper2"),
+    }
+
+
+def make_universe_envelope(
+    *,
+    key: Universe,
+    asof: datetime,
+    payload: UniversePayloadDTO,
+    meta: EnvelopeMeta | None = None,
+) -> UniverseEnvelopeDTO:
+    return {
+        "topic": "universe",
+        "key": key,
+        "asof": asof,
+        "payload": payload,
+        "meta": meta or _make_empty_envelope_meta("krx"),
+    }
+
+
+def make_analysis_envelope(
+    *,
+    key: str,
+    asof: datetime,
+    payload: AnalysisPayloadDTO,
+    meta: EnvelopeMeta | None = None,
+) -> AnalysisEnvelopeDTO:
+    return {
+        "topic": "analysis",
+        "key": key,
+        "asof": asof,
+        "payload": payload,
+        "meta": meta or _make_empty_envelope_meta("analyser2"),
+    }

{contracts_hj3415-0.5.0 → contracts_hj3415-0.5.1}/src/contracts_hj3415/common/types.py

@@ -9,9 +9,11 @@ CodeKey: TypeAlias = str
 
 Num: TypeAlias = float | int | None
 
+Source: TypeAlias = Literal["", "scraper2", "krx", "analyser2"]
+
 
 class EnvelopeMeta(TypedDict, total=False):
-    source: str  # "scraper2" / "krx" / "analyser2" / ...
+    source: Source
     trace_id: str
     note: str
     tags: list[str]

contracts_hj3415-0.5.0/src/contracts_hj3415/common/envelope.py

@@ -1,46 +0,0 @@
-# contracts_hj3415/common/envelope.py
-from __future__ import annotations
-
-from datetime import datetime
-from typing import TypedDict
-
-from contracts_hj3415.analysis.payloads import AnalysisPayloadDTO
-from contracts_hj3415.common.types import EnvelopeMeta, Topic
-
-# topic별 payload 유니온
-from contracts_hj3415.nfs.payloads import NfsPayloadDTO
-from contracts_hj3415.universe.payloads import UniversePayloadDTO
-
-
-class EnvelopeDTO(TypedDict):
-    """
-    모노레포 공통 운반 상자 DTO
-
-    - key: topic별 식별자(문자열). 예)
-      - nfs: "005930"
-      - universe: "krx300"
-      - analysis: "red:005930"
-    """
-
-    topic: Topic
-    key: str
-    asof: datetime
-    payload: NfsPayloadDTO | UniversePayloadDTO | AnalysisPayloadDTO
-    meta: EnvelopeMeta
-
-
-def make_envelope(
-    *,
-    topic: Topic,
-    key: str,
-    asof: datetime,
-    payload: NfsPayloadDTO | UniversePayloadDTO | AnalysisPayloadDTO,
-    meta: EnvelopeMeta | None = None,
-) -> EnvelopeDTO:
-    return {
-        "topic": topic,
-        "key": key,
-        "asof": asof,
-        "payload": payload,
-        "meta": meta or EnvelopeMeta(),
-    }