Python Academy · 강의

모델 정의하기

클래스를 테이블에 매핑하기

모델 정의하기은(는) CoddyKit의 무료 Python Academy 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Python Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Python Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

모델을 테이블에 매핑하기

SQLAlchemy ORM에서 모델은 데이터베이스 테이블에 매핑되는 Python 클래스입니다. 각 인스턴스는 하나의 행이 됩니다.

모델은 공유된 Base 클래스를 상속합니다.

from sqlalchemy.orm import DeclarativeBase
class Base(DeclarativeBase):
    pass
print('Base class ready')

tablename

모든 모델은 __tablename__에 테이블 이름을 설정합니다. SQLAlchemy는 SQL을 생성할 때 이 값을 사용합니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
print(User.__tablename__)

Mapped로 열 정의하기

최신 SQLAlchemy에서는 형식 힌트로 열을 선언합니다: Mapped[int]와 mapped_column()입니다. 형식 힌트는 Python 형식을 설정하고 열 형식을 알려 줍니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str]
    age: Mapped[int]
print('User has id, name, age')

기본 키

primary_key=True로 열을 기본 키로 지정합니다. 정수 기본 키는 기본적으로 자동 증가합니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class Product(Base):
    __tablename__ = 'products'
    id: Mapped[int] = mapped_column(primary_key=True)
    title: Mapped[str]
print('id is the primary key')

선택적 열

NULL 값을 허용하려면 Mapped[str | None] 또는 Optional[str]을 사용합니다. 일반적인 Mapped[str]은 NOT NULL입니다.

from typing import Optional
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    nickname: Mapped[Optional[str]]
print('nickname can be NULL')

기본값과 고유성

mapped_column()은 unique=True와 default= 같은 옵션을 받아 제약 조건과 대체 값을 추가합니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    email: Mapped[str] = mapped_column(unique=True)
    active: Mapped[bool] = mapped_column(default=True)
print('email is unique, active defaults to True')

문자열 길이

문자열 길이가 필요한 데이터베이스에서는 mapped_column(String(50))으로 길이를 설정합니다.

from sqlalchemy import String
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str] = mapped_column(String(50))
print('name limited to 50 chars')

스키마 생성하기

Base.metadata.create_all(engine)은 Base를 상속하는 모든 모델의 테이블을 생성합니다.

from sqlalchemy import create_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str]
engine = create_engine('sqlite:///:memory:')
Base.metadata.create_all(engine)
print('Schema created')

인스턴스 생성하기

일반적인 Python 객체처럼 모델을 인스턴스화하고 열 값을 키워드 인수로 전달하여 행을 만듭니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str]
u = User(name='Alice')
print(u.name)

repr 추가하기

사용자 지정 __repr__을 정의하면 객체의 데이터를 명확하게 표시할 수 있어 디버깅이 쉬워집니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str]
    def __repr__(self):
        return 'User(name=' + self.name + ')'
print(repr(User(name='Bob')))

모델은 일반적인 Python으로 유지됩니다

모델도 여전히 일반적인 클래스입니다. 데이터에 대해 동작하는 메서드와 속성을 추가하여 동작과 영속성을 함께 구성할 수 있습니다.

from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
class Base(DeclarativeBase):
    pass
class User(Base):
    __tablename__ = 'users'
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str]
    def greet(self):
        return 'Hi, ' + self.name
print(User(name='Carol').greet())

빠른 확인

모델 정의 능력을 확인해 보세요.

복습

ORM 모델을 정의하는 방법을 배웠습니다.

모델은 DeclarativeBase를 상속하고 __tablename__을 설정합니다
열에는 Mapped[type]과 mapped_column()을 사용합니다
primary_key, unique, default로 제약 조건을 추가합니다
create_all()이 테이블을 생성합니다

자주 묻는 질문