* feat: preserve ledger venue provenance * fix: satisfy ledger test lint ratchet * fix: advance image migration inventory
204 lines
5.3 KiB
Python
204 lines
5.3 KiB
Python
"""Portfolio request and response schemas."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime
|
|
from typing import Any, Literal
|
|
|
|
import re as _re
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field, field_validator
|
|
|
|
_PORTFOLIO_NAME_RE = _re.compile(r"^[a-zA-Z0-9가-힣 ._:\-]{1,100}$")
|
|
|
|
|
|
class StrategySetResponse(BaseModel):
|
|
id: str
|
|
name: str
|
|
config: str
|
|
nick: str
|
|
status: Literal["active", "inactive"] = "active"
|
|
revision: int = 1
|
|
created_at: datetime | None = None
|
|
updated_at: datetime | None = None
|
|
|
|
|
|
class LedgerEntryResponse(BaseModel):
|
|
portfolio_id: str
|
|
recorded_at: datetime
|
|
action: str
|
|
price: float
|
|
quantity: float
|
|
fee_amount: float = 0.0
|
|
tax_amount: float = 0.0
|
|
cash_balance_after: float
|
|
asset_quantity_after: float
|
|
total_value_after: float
|
|
profit_buffer_after: float = 0.0
|
|
strategy_set_id: str = "manual"
|
|
note: str = ""
|
|
execution_venue: Literal["KRX", "NXT"] | None = None
|
|
order_venue: Literal["KRX", "NXT", "SOR"] | None = None
|
|
|
|
|
|
class PortfolioBase(BaseModel):
|
|
broker: str = "kis"
|
|
status: str = "enabled"
|
|
name: str | None = None
|
|
|
|
|
|
class PortfolioSummary(BaseModel):
|
|
portfolio_id: str
|
|
broker: str
|
|
status: str
|
|
name: str
|
|
symbol: str
|
|
tags: list[str] = Field(default_factory=list)
|
|
owner_user_id: str | None = None
|
|
cash_balance: float = 0.0
|
|
asset_quantity: float = 0.0
|
|
price: float = 0.0
|
|
profit_buffer: float = 0.0
|
|
active_strategy_id: str | None = None
|
|
strategy_name: str | None = None
|
|
strategy_params: dict[str, Any] = Field(default_factory=dict)
|
|
strategy_revision: int | None = Field(default=None, ge=1)
|
|
avabile_strategies: list[str] | None = None
|
|
managed_by_daemon_id: str | None = None
|
|
created_at: datetime | None = None
|
|
updated_at: datetime | None = None
|
|
last_trade_at: datetime | None = None
|
|
|
|
|
|
class PortfolioListItem(PortfolioSummary):
|
|
total_value: float = 0.0
|
|
|
|
|
|
class PortfolioDetailResponse(BaseModel):
|
|
portfolio: PortfolioSummary
|
|
recent_entries: list[LedgerEntryResponse] = Field(default_factory=list)
|
|
strategy_set: StrategySetResponse | None = None
|
|
live_quantity: float | None = None
|
|
|
|
|
|
class CreatePortfolioRequest(PortfolioBase):
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
name: str # required, overrides Optional from PortfolioBase; used as (owner_user_id, name) identifier
|
|
asset_id: str
|
|
strategy_id: str = Field(..., min_length=1)
|
|
cash_balance: float = Field(default=0.0, ge=0.0)
|
|
asset_quantity: float = Field(default=0.0, ge=0.0)
|
|
asset_price: float = Field(default=0.0, ge=0.0)
|
|
profit_buffer: float = Field(default=0.0, ge=0.0)
|
|
|
|
@field_validator("name")
|
|
@classmethod
|
|
def validate_name(cls, v: str) -> str:
|
|
if not _PORTFOLIO_NAME_RE.match(v):
|
|
raise ValueError(
|
|
f"이름은 한글·영문·숫자·공백·._:- 만 사용 가능하며 1~100자여야 합니다: {v!r}"
|
|
)
|
|
return v
|
|
|
|
|
|
class UpdatePortfolioRequest(BaseModel):
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
broker: str | None = None
|
|
status: str | None = None
|
|
name: str | None = None
|
|
strategy_id: str | None = Field(default=None, min_length=1)
|
|
asset_price: float | None = Field(default=None, ge=0.0)
|
|
managed_by_daemon_id: str | None = None
|
|
|
|
|
|
class BuyRequest(BaseModel):
|
|
quantity: float = Field(gt=0.0)
|
|
price: float = Field(gt=0.0)
|
|
fee: float = Field(default=0.0, ge=0.0)
|
|
tax: float = Field(default=0.0, ge=0.0)
|
|
note: str = ""
|
|
|
|
|
|
class SellRequest(BaseModel):
|
|
quantity: float = Field(gt=0.0)
|
|
price: float = Field(gt=0.0)
|
|
fee: float = Field(default=0.0, ge=0.0)
|
|
tax: float = Field(default=0.0, ge=0.0)
|
|
note: str = ""
|
|
|
|
|
|
class InvestRequest(BaseModel):
|
|
movement_type: Literal["deposit", "profit", "withdraw"]
|
|
amount: float = Field(gt=0.0)
|
|
note: str = ""
|
|
|
|
|
|
class TransferRequest(BaseModel):
|
|
direction: Literal["to-buffer", "from-buffer"]
|
|
amount: float = Field(gt=0.0)
|
|
note: str = ""
|
|
|
|
|
|
class ResetPortfolioRequest(BaseModel):
|
|
infer_symbol: str | None = None
|
|
|
|
|
|
class CommentCreateRequest(BaseModel):
|
|
content: str
|
|
|
|
|
|
class CommentUpdateRequest(BaseModel):
|
|
content: str
|
|
|
|
|
|
class CommentResponse(BaseModel):
|
|
id: str
|
|
portfolio_id: str
|
|
content: str
|
|
created_at: datetime | None = None
|
|
updated_at: datetime | None = None
|
|
|
|
|
|
class PortfolioTagMutationRequest(BaseModel):
|
|
tag: str = Field(min_length=1)
|
|
|
|
@field_validator("tag")
|
|
@classmethod
|
|
def normalize_tag(cls, value: str) -> str:
|
|
normalized = value.strip()
|
|
if not normalized:
|
|
raise ValueError("tag는 비어 있을 수 없습니다")
|
|
return normalized
|
|
|
|
|
|
class PortfolioTagResponse(BaseModel):
|
|
portfolio_id: str
|
|
tag: str
|
|
created_at: datetime | None = None
|
|
|
|
|
|
class ErrorResponse(BaseModel):
|
|
detail: str
|
|
model_config = ConfigDict(extra="ignore")
|
|
|
|
|
|
class CreateStrategySetRequest(BaseModel):
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
name: str
|
|
nick: str | None = Field(default=None, min_length=1)
|
|
config: str
|
|
status: Literal["active", "inactive"] = "active"
|
|
|
|
|
|
class UpdateStrategySetRequest(BaseModel):
|
|
model_config = ConfigDict(extra="forbid")
|
|
|
|
name: str | None = None
|
|
nick: str | None = Field(default=None, min_length=1)
|
|
config: str | None = None
|
|
status: Literal["active", "inactive"] | None = None
|
|
|