<aside> 💡

Notation

• 이탤릭은 더 큰 수준의 프로젝트에서 삭제되는 지침이다.
• 볼드는 이전 수준에는 없다가 새로 추가되는 지침이다. </aside>

토이 프로젝트 가이드

• 이 프로젝트는 도메인 주도 설계의 목적과 용어를 차용한 클린 아키텍처를 적용한다.
• Bounded Context가 1개인 경우 사용한다.
• Aggregate라는 개념조차도 불필요할 정도로 작은 구상인 경우 사용한다.

스캐폴드

• root
  • .git/
  • myproject (flat 구조)
    • domain/
      • entities.py
      • value_objects.py
      • repositories.py - infra 레이어에서 구현될 인터페이스, 반환 타입은 도메인 객체
      • gateways.py - infra 레이어에서 구현될 인터페이스, 반환 타입은 파일 상단에 명세
      • exceptions.py
    • application/
      • services.py
    • interface/
      • controllers.py
      • schema.py
      • mappers.py - 도메인 타입 ↔ Request & Response Model. 시스템의 진입점과 웹 프레임워크가 변경될 일이 거의 없으므로, 애플리케이션 계층이 컨트롤러로 값을 반환할 때 중간 DTO를 반환하는 대신, 곧바로 Response를 만들어 반환한다.
    • infra/
      • db_models.py - ORM 프레임워크로 작성한 DB 모델
      • mappers.py - ORM 프레임워크 ↔ 도메인 객체 변환. 이때 SQLAlchemy의 inspect() 같은 함수를 사용하여 repository의 return을 도메인 객체화는 등 보일러플레이트를 최소화한다.
      • repositories.py
      • gateways.py
    • utils.py
    • settings.py
    • db.py
    • main.py - 루트에서 -m package_name.main 으로 실행
  • README.md
  • pyproject.toml
  • …

기술 선택

• pydantic은 v2 이상을 사용한다.
• id 타입은 UUID 대신 ULID를 사용한다.
• 패키지와 의존성은 pyproject.toml과 uv를 통해 관리한다.
• 포매터는 ruff, 타입 체커는 ty를 사용한다.
  • tests/ 디렉토리도 ruff, ty 체킹을 빠뜨리지 않도록 주의한다.
• ORM 프레임워크은 SQLAlchemy를 사용한다.
  • SQLAlchemy는 v2 이상을 사용한다.
• Database는 Supabase를 사용한다.

모범 사례

• SQLAlchemy

  • ORM 클래스를 작성할 때 __repr__에 id와 name을 담아 디버깅을 용이하게 만든다.
  • my_field: Mapped[클래스] 와 같은 방식을 사용한다.
  • nullable 필드는 Mapped[ … | None] 과 같이 자동으로 추론되므로 명시적으로 적지 않는다.
  • 다음은 위 명세들이 반영된 모범 사례 코드다.

• FastAPI

  • Depends: Annotated 폼 - arg: Annotated[Type, Depends(dependable)] - 으로 적는다.

• 환경 변수는 .env 파일에 정의하고, Pydantic의 BaseSettings를 상속받아 관리한다.

  from pydantic_settings import BaseSettings
  from pydantic import computed_field
  
  class Settings(BaseSettings):
      db_driver: str = "postgresql"
      db_host: str = "localhost"
      db_port: int = 5432
      db_user: str = "user"
      db_password: str  # 기본값 없음 = Pydantic 필수값, 즉 반드시 환경변수로부터 전달받아야 함
      db_name: str = "mydb"
      
      @computed_field
      @property
      def DATABASE_URL(self) -> str:
          return f"{self.db_driver}://{self.db_user}:{self.db_password}@{self.db_host}:{self.db_port}/{self.db_name}"
  
  		# .env 파일이 있을 때 명시적으로 읽어오겠다는 의도를 표현하고, "이 프로젝트는 .env 파일을 사용한다"는 문서화 효과를 만든다.
  		model_config = {'env_file': '.env', 'case_sensitive': False}
  
  settings = Settings()  # DB_PASSWORD 환경변수 없으면 에러 발생
  

• vo는 frozen=True로 설정하여 immutable하게 만든다.

  • Pydantic v2 불변 설정: ConfigDict(frozen=True)