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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contracts-hj3415
-Version: 0.4.0
+Version: 0.5.0
 Summary: DTO pakages for hj3415
 Keywords: example,demo
 Author-email: Hyungjin Kim <hj3415@gmail.com>
@@ -10,6 +10,5 @@ Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pydantic>=2.7
 
 

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

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "contracts-hj3415"                          # PyPI 이름 (하이픈 허용)
-version = "0.4.0"
+version = "0.5.0"
 description = "DTO pakages for hj3415"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -18,9 +18,26 @@ classifiers = [
 ]
 
 dependencies = [
-  "pydantic>=2.7",
 ]
 
 [tool.flit.module]
 name = "contracts_hj3415"
 path = "src/contracts_hj3415"
+
+
+[tool.pyright]
+typeCheckingMode = "strict"
+
+pythonVersion = "3.11"
+pythonPlatform = "All"
+
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+exclude = [
+  "**/__pycache__",
+  ".venv",
+  "build",
+  "tests",
+  "dist",
+]

contracts_hj3415-0.5.0/src/contracts_hj3415/analysis/features.py

@@ -0,0 +1,34 @@
+# contracts_hj3415/analysis/features.py
+from __future__ import annotations
+
+from typing import Any, Literal, TypedDict
+
+from contracts_hj3415.nfs.types import Endpoint, MetricKey
+
+AggKind = Literal["sum", "avg"]
+PeriodKind = Literal["y", "q"]
+
+
+class FeatureValue(TypedDict):
+    value: float | None
+    picked: str | None
+    from_kind: PeriodKind | None
+
+
+class MetricDiagnostics(TypedDict):
+    ok: bool
+    reason: str | None
+    details: dict[str, Any]  # pyright: ignore[reportExplicitAny]
+
+
+class LatestAndTtm(TypedDict):
+    latest_y: FeatureValue
+    latest_q: FeatureValue
+    ttm_q: FeatureValue
+    chosen: FeatureValue
+    diag: MetricDiagnostics
+
+
+class FeaturesPayload(TypedDict):
+    endpoint: Endpoint
+    blocks: dict[MetricKey, LatestAndTtm]

contracts_hj3415-0.5.0/src/contracts_hj3415/analysis/payloads.py

@@ -0,0 +1,8 @@
+# contracts_hj3415/analysis/payloads.py
+from __future__ import annotations
+
+from typing import TypeAlias
+
+from contracts_hj3415.analysis.features import FeaturesPayload
+
+AnalysisPayloadDTO: TypeAlias = FeaturesPayload

contracts_hj3415-0.5.0/src/contracts_hj3415/analysis/types.py

@@ -0,0 +1,9 @@
+# contracts_hj3415/analysis/types.py
+from __future__ import annotations
+
+from typing import Literal, TypeAlias
+
+AnalysisService: TypeAlias = Literal[
+    "features",
+    "red",
+]

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

@@ -0,0 +1,46 @@
+# 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(),
+    }

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

@@ -0,0 +1,17 @@
+# contracts_hj3415/common/types.py
+from __future__ import annotations
+
+from typing import Literal, TypeAlias, TypedDict
+
+Topic: TypeAlias = Literal["nfs", "universe", "analysis"]
+
+CodeKey: TypeAlias = str
+
+Num: TypeAlias = float | int | None
+
+
+class EnvelopeMeta(TypedDict, total=False):
+    source: str  # "scraper2" / "krx" / "analyser2" / ...
+    trace_id: str
+    note: str
+    tags: list[str]

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/c101_dto.py → contracts_hj3415-0.5.0/src/contracts_hj3415/nfs/c101.py

@@ -1,13 +1,15 @@
-# contracts_hj3415/nfs/c101_dto.py
+# contracts_hj3415/nfs/c101.py
 from __future__ import annotations
 
+from typing import Any, Literal, TypeAlias
+
+from contracts_hj3415.common.types import Num
 from typing_extensions import TypedDict
-from typing import Any
-from .nfs_dto import NfsDTO
-from .types import PeriodKey, Num, MetricKey
 
-Scalar = str | float | int | None
-ValuesMap = dict[PeriodKey, Num]
+from .types import MetricKey, PeriodKey
+
+Scalar: TypeAlias = str | float | int | None
+ValuesMap: TypeAlias = dict[PeriodKey, Num]
 
 
 class C101Blocks(TypedDict):
@@ -17,11 +19,10 @@ class C101Blocks(TypedDict):
     기업개요: dict[str, Scalar]
     펀더멘털: dict[MetricKey, ValuesMap]
 
-    어닝서프라이즈: dict[str, Any]
+    어닝서프라이즈: dict[str, Any]  # pyright: ignore[reportExplicitAny]
     연간컨센서스: dict[MetricKey, ValuesMap]
 
+
 class C101Payload(TypedDict):
+    endpoint: Literal["c101"]
     blocks: C101Blocks
-
-class C101DTO(NfsDTO):
-    payload: C101Payload

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/c103_dto.py → contracts_hj3415-0.5.0/src/contracts_hj3415/nfs/c103.py

@@ -1,12 +1,15 @@
-# contracts_hj3415/nfs/c103_dto.py
+# contracts_hj3415/nfs/c103.py
 from __future__ import annotations
 
+from typing import Literal, TypeAlias
+
+from contracts_hj3415.common.types import Num
 from typing_extensions import TypedDict
-from .nfs_dto import NfsDTO
-from .types import Num, MetricKey, PeriodKey
 
+from .types import MetricKey, PeriodKey
+
+C103ValuesMap: TypeAlias = dict[PeriodKey, Num]
 
-C103ValuesMap = dict[PeriodKey, Num]
 
 class C103Blocks(TypedDict):
     손익계산서y: dict[MetricKey, C103ValuesMap]
@@ -27,9 +30,6 @@ class C103Labels(TypedDict):
 
 
 class C103Payload(TypedDict):
+    endpoint: Literal["c103"]
     blocks: C103Blocks
     labels: C103Labels
-
-
-class C103DTO(NfsDTO):
-    payload: C103Payload

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/c104_dto.py → contracts_hj3415-0.5.0/src/contracts_hj3415/nfs/c104.py

@@ -1,12 +1,12 @@
-# contracts_hj3415/nfs/c104_dto.py
+# contracts_hj3415/nfs/c104.py
 from __future__ import annotations
+from typing import Literal, TypeAlias
 
+from contracts_hj3415.common.types import Num
 from typing_extensions import TypedDict
-from .nfs_dto import NfsDTO
-from .types import Num, MetricKey, PeriodKey
+from .types import MetricKey, PeriodKey
 
-
-C104ValuesMap = dict[PeriodKey, Num]
+C104ValuesMap:TypeAlias = dict[PeriodKey, Num]
 
 class C104Blocks(TypedDict):
     수익성y: dict[MetricKey, C104ValuesMap]
@@ -34,11 +34,7 @@ class C104Labels(TypedDict):
     가치분석q: dict[MetricKey, str]
 
 
-
 class C104Payload(TypedDict):
+    endpoint: Literal["c104"]
     blocks: C104Blocks
     labels: C104Labels
-
-
-class C104DTO(NfsDTO):
-    payload: C104Payload

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/c106_dto.py → contracts_hj3415-0.5.0/src/contracts_hj3415/nfs/c106.py

@@ -1,12 +1,14 @@
-# contracts_hj3415/nfs/c106_dto.py
+# contracts_hj3415/nfs/c106.py
 from __future__ import annotations
 
+from typing import Literal, TypeAlias
+
+from contracts_hj3415.common.types import CodeKey, Num
 from typing_extensions import TypedDict
-from .nfs_dto import NfsDTO
-from .types import Num, MetricKey, CodeKey
 
+from .types import MetricKey
 
-C106ValuesMap = dict[CodeKey, Num]
+C106ValuesMap: TypeAlias = dict[CodeKey, Num]
 
 
 class C106Blocks(TypedDict):
@@ -20,9 +22,6 @@ class C106Labels(TypedDict):
 
 
 class C106Payload(TypedDict):
+    endpoint: Literal["c106"]
     blocks: C106Blocks
     labels: C106Labels
-
-
-class C106DTO(NfsDTO):
-    payload: C106Payload

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/c108_dto.py → contracts_hj3415-0.5.0/src/contracts_hj3415/nfs/c108.py

@@ -1,12 +1,13 @@
-# contracts_hj3415/nfs/c108_dto.py
+# contracts_hj3415/nfs/c108.py
 from __future__ import annotations
 
+from typing import Literal, TypeAlias
+
 from typing_extensions import TypedDict
-from .nfs_dto import NfsDTO
-from .types import MetricKey
 
+from .types import MetricKey
 
-C108ValuesMap = dict[MetricKey, str|int|None]
+C108ValuesMap: TypeAlias = dict[MetricKey, str | int | None]
 
 
 class C108Blocks(TypedDict):
@@ -14,8 +15,5 @@ class C108Blocks(TypedDict):
 
 
 class C108Payload(TypedDict):
+    endpoint: Literal["c108"]
     blocks: C108Blocks
-
-
-class C108DTO(NfsDTO):
-    payload: C108Payload

contracts_hj3415-0.5.0/src/contracts_hj3415/nfs/payloads.py

@@ -0,0 +1,14 @@
+# contracts_hj3415/nfs/payloads.py
+from __future__ import annotations
+
+from typing import TypeAlias
+
+from contracts_hj3415.nfs.c101 import C101Payload
+from contracts_hj3415.nfs.c103 import C103Payload
+from contracts_hj3415.nfs.c104 import C104Payload
+from contracts_hj3415.nfs.c106 import C106Payload
+from contracts_hj3415.nfs.c108 import C108Payload
+
+NfsPayloadDTO: TypeAlias = (
+    C101Payload | C103Payload | C104Payload | C106Payload | C108Payload
+)

{contracts_hj3415-0.4.0 → contracts_hj3415-0.5.0}/src/contracts_hj3415/nfs/types.py

@@ -1,13 +1,13 @@
 # contracts_hj3415/nfs/types.py
 from __future__ import annotations
 
-from typing import Mapping, Any, Literal, TypeAlias
+from typing import Literal, TypeAlias
 
-C101BlockKeys = Literal[
+C101BlockKey: TypeAlias = Literal[
     "요약", "시세", "주주현황", "기업개요", "펀더멘털", "어닝서프라이즈", "연간컨센서스"
 ]
 
-C103BlockKeys = Literal[
+C103BlockKey: TypeAlias = Literal[
     "손익계산서y",
     "손익계산서q",
     "재무상태표y",
@@ -16,8 +16,7 @@ C103BlockKeys = Literal[
     "현금흐름표q",
 ]
 
-
-C104BlockKeys = Literal[
+C104BlockKey: TypeAlias = Literal[
     "수익성y",
     "성장성y",
     "안정성y",
@@ -30,32 +29,21 @@ C104BlockKeys = Literal[
     "가치분석q",
 ]
 
-
-# C106===========================
-
-C106BlockKeys = Literal[
+C106BlockKey: TypeAlias = Literal[
     "y",
     "q",
 ]
 
-
-# C108============================
-
-C108BlockKeys = Literal["리포트",]
+C108BlockKey: TypeAlias = Literal["리포트",]
 
 
 # General====================
 
-MetricKey = str
-PeriodKey = str
-CodeKey = str
-Num = float | int | None
-
-Endpoints = Literal["c101", "c103", "c104", "c106", "c108"]
-
+MetricKey: TypeAlias = str
+PeriodKey: TypeAlias = str
 
-Payload = Mapping[str, Any]
+Endpoint: TypeAlias = Literal["c101", "c103", "c104", "c106", "c108"]
 
-BlockKeys: TypeAlias = (
-    C101BlockKeys | C103BlockKeys | C104BlockKeys | C106BlockKeys | C108BlockKeys
+BlockKey: TypeAlias = (
+    C101BlockKey | C103BlockKey | C104BlockKey | C106BlockKey | C108BlockKey
 )

contracts_hj3415-0.5.0/src/contracts_hj3415/universe/krx300.py

@@ -0,0 +1,20 @@
+# contracts_hj3415/universe/dto.py
+from __future__ import annotations
+
+from typing import Any, TypedDict
+
+from contracts_hj3415.common.types import CodeKey
+from contracts_hj3415.universe.types import Universe
+
+
+class UniverseItem(TypedDict, total=False):
+    code: CodeKey
+    name: str
+    market: str
+    meta: dict[str, Any]  # pyright: ignore[reportExplicitAny]
+
+
+class KRX300Payload(TypedDict):
+    source: str
+    universe: Universe
+    blocks: list[UniverseItem]

contracts_hj3415-0.5.0/src/contracts_hj3415/universe/payloads.py

@@ -0,0 +1,8 @@
+# contracts_hj3415/universe/payloads.py
+from __future__ import annotations
+
+from typing import TypeAlias
+
+from contracts_hj3415.universe.krx300 import KRX300Payload
+
+UniversePayloadDTO: TypeAlias = KRX300Payload

contracts_hj3415-0.5.0/src/contracts_hj3415/universe/types.py

@@ -0,0 +1,6 @@
+# contracts_hj3415/universe/types.py
+from __future__ import annotations
+
+from typing import Literal, TypeAlias
+
+Universe: TypeAlias = Literal["KRX300",]

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/constants.py

@@ -1,49 +0,0 @@
-# contracts_hj3415/nfs/constants.py
-from __future__ import annotations
-
-
-ENDPOINTS: tuple[str, ...] = ("c101", "c103", "c104", "c106", "c108")
-
-
-C101_BLOCK_KEYS: tuple[str, ...] = (
-    "요약",
-    "시세",
-    "주주현황",
-    "기업개요",
-    "펀더멘털",
-    "어닝서프라이즈",
-    "연간컨센서스",
-)
-
-
-C103_BLOCK_KEYS: tuple[str, ...] = (
-    "손익계산서y",
-    "손익계산서q",
-    "재무상태표y",
-    "재무상태표q",
-    "현금흐름표y",
-    "현금흐름표q",
-)
-
-
-C104_BLOCK_KEYS: tuple[str, ...] = (
-    "수익성y",
-    "성장성y",
-    "안정성y",
-    "활동성y",
-    "가치분석y",
-    "수익성q",
-    "성장성q",
-    "안정성q",
-    "활동성q",
-    "가치분석q",
-)
-
-
-C106_BLOCK_KEYS: tuple[str, ...] = (
-    "y",
-    "q",
-)
-
-
-C108_BLOCK_KEYS: tuple[str, ...] = ("리포트",)

contracts_hj3415-0.4.0/src/contracts_hj3415/nfs/nfs_dto.py

@@ -1,17 +0,0 @@
-# contracts_hj3415/nfs/nfs_dto.py
-from __future__ import annotations
-
-from datetime import datetime
-from pydantic import BaseModel, ConfigDict
-from .types import Endpoints, Payload
-
-
-class NfsDTO(BaseModel):
-    code: str
-    asof: datetime
-    endpoint: Endpoints
-    payload: Payload
-
-    model_config = ConfigDict(extra="ignore")
-
-

contracts_hj3415-0.4.0/src/contracts_hj3415/universe/constants.py

@@ -1,4 +0,0 @@
-# contracts_hj3415/universe/constants.py
-from __future__ import annotations
-
-UNIVERSE_NAMES: tuple[str, ...] = ("krx300",)

contracts_hj3415-0.4.0/src/contracts_hj3415/universe/dto.py

@@ -1,17 +0,0 @@
-# contracts_hj3415/universe/dto.py
-from __future__ import annotations
-
-from typing import Any, TypedDict
-
-class UniverseItemDTO(TypedDict, total=False):
-    code: str              # required by convention
-    name: str
-    market: str
-    meta: dict[str, Any]
-
-
-class UniversePayloadDTO(TypedDict):
-    universe: str
-    asof: str              # ISO string 권장 (UTC). datetime을 넘겨도 되지만 계약은 str이 깔끔함
-    source: str
-    items: list[UniverseItemDTO]

contracts_hj3415-0.4.0/src/contracts_hj3415/universe/types.py

@@ -1,6 +0,0 @@
-# contracts_hj3415/universe/dto.py
-from __future__ import annotations
-
-from typing import Literal
-
-UniverseNames = Literal["krx300",]