agronholm / agronholm/sqlacodegen

Dataclass Mapping changed in sqalchemy 2.0

Open
#248 12 comments 0 reactions 1 assignee Claimed by @sheinbergon View on GitHub
Dominant language
Python
Stars
2.4k
Forks
284
Avg merge
2d 1h
Merged PRs (30d)
1

Description

Refer: https://docs.sqlalchemy.org/en/20/orm/dataclasses.html#orm-declarative-native-dataclasses

Current documented dataclass style is:

```python
from sqlalchemy.orm import DeclarativeBase
from sqlalchemy.orm import Mapped
from sqlalchemy.orm import mapped_column
from sqlalchemy.orm import MappedAsDataclass

class Base(MappedAsDataclass, DeclarativeBase):
"""subclasses will be converted to dataclasses"""

class User(Base):
__tablename__ = "user_account"

id: Mapped[int] = mapped_column(init=False, primary_key=True)
name: Mapped[str]
```

or at least:

```python
from sqlalchemy.orm import Mapped
from sqlalchemy.orm import mapped_column
from sqlalchemy.orm import registry

reg = registry()

@reg.mapped_as_dataclass
class User:
__tablename__ = "user_account"

id: Mapped[int] = mapped_column(init=False, primary_key=True)
name: Mapped[str]
```

Columns type should be `Mapped[int]` not `int` which is different with current sqlacodegen and the new `mapped_column` is much more readable.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.