Files
portfolio-hub/app/schemas/portfolio.py
T
genichin e2226e28b6 feat: implement asset catalog database foundation (BAT-001, REQ-009/011/014)
Asset Catalog Model Implementation (BAT-001):
- Introduce assets table with UUID PK, symbol UNIQUE, markets TEXT[] array
- Define MarketCode enum (KRX, NXT, SOR, NASDAQ, NYSE, UPBIT, BITHUMB)
- Add Asset domain model with catalog properties
- Implement asset CRUD protocols in portfolio_repository
- Add PostgreSQL asset CRUD operations with GIN index on markets

Portfolio Model Refactoring (REQ-011):
- Add portfolios.asset_id UUID FK to assets(asset_id) ON DELETE RESTRICT
- Remove portfolios.symbol and portfolios.market columns
- Update Portfolio domain model to reference asset_id instead of symbol/market
- Refactor all portfolio queries to JOIN assets catalog
- Update all repository methods to use asset references

Data Migration (REQ-014):
- Create 20260519_0017 Alembic revision for assets table creation
- Create 20260519_0018 Alembic revision for atomic data migration:
  * Extract unique symbol combinations from portfolios
  * Aggregate markets using ARRAY_AGG(DISTINCT market)
  * Populate assets catalog with extracted data
  * Update portfolios.asset_id to reference new assets
  * Remove legacy symbol/market columns in single transaction
- Implement migration with rollback support

Requirements Approved (REQ-001~008):
- REQ-001~008 transitioned from Proposed to Approved
- Complete tag model requirement set with implementation readiness

New Requirements Approved (REQ-009~015):
- REQ-009: assets table schema (approved, included in BAT-001)
- REQ-010: admin asset catalog CRUD (approved, future BAT-002)
- REQ-011: portfolios asset_id FK (approved, included in BAT-001)
- REQ-012: portfolio create catalog validation (approved, future BAT-002)
- REQ-013: GET /v1/assets token branching (approved, future BAT-002)
- REQ-014: portfolios data migration (approved, included in BAT-001)
- REQ-015: asset catalog baseline docs (approved)

Code Changes:
- app/domain/models.py: Add Asset model, MarketCode enum, Portfolio asset_id FK
- app/repositories/portfolio_repository.py: Define asset CRUD protocol
- app/repositories/postgres.py: Implement asset operations with full CRUD
- app/api/v1_assets.py: Remove symbol/market direct references
- app/cli/commands/portfolio.py: Update portfolio commands for asset references
- app/schemas/portfolio.py: Update portfolio schema with asset_id
- All portfolio operations throughout codebase: Use asset references

Testing:
- Add test_asset_catalog.py for asset CRUD operations
- Verify REQ-009 AC-1~5 (asset catalog creation, lookup, uniqueness)
- Verify REQ-011 AC-1~5 (FK constraint, portfolio asset reference)
- Verify REQ-014 AC-1~6 (migration atomicity, data correctness, rollback)
- Update existing tests for asset model usage

Documentation:
- Create BAT-001 batch documents (planning, design, implementation, verification)
- Update dcy-001 with implementation details and confirmed architecture
- Add 8 new requirement documents (REQ-009~015)
- Update docs/discovery/index.md with batch entry

Impact:
- Database: assets catalog table, portfolios refactored to reference assets
- Migration: 2 new Alembic revisions (0017 assets, 0018 portfolio migration)
- API: Symbol/market now accessed through asset references
- CLI: Portfolio commands require asset reference pattern
- All existing portfolio data preserved and correctly migrated
2026-05-19 15:59:20 +00:00

190 lines
4.8 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
created_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 = ""
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
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):
name: str # required, overrides Optional from PortfolioBase; used as (owner_user_id, name) identifier
asset_id: str
strategy_name: str = "target_value"
strategy_params: dict[str, Any] = Field(default_factory=dict)
active_strategy_id: str | None = None
avabile_strategies: list[str] | None = None
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"이름은 [a-zA-Z0-9._:-] 문자만 허용하며 1~100자여야 합니다: {v!r}"
)
return v
class UpdatePortfolioRequest(BaseModel):
broker: str | None = None
status: str | None = None
name: str | None = None
strategy_name: str | None = None
strategy_params: dict[str, Any] | None = None
active_strategy_id: str | None = None
avabile_strategies: list[str] | None = None
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):
name: str
config: str
class UpdateStrategySetRequest(BaseModel):
name: str | None = None
config: str | None = None