google / google/python-spanner-orm

Re-write Model to use dataclasses.

Open
#97 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
41
Forks
17
PR merge metrics
No merged PRs in 30d

Description

`Model` currently uses a metaclass (which is disallowed by the style guide for good reasons) and `Field`s which make type checking tricky. (The class attribute is of type `Field`, but the instance attribute with the same name is of type `str`, `int`, or whatever that specific field stores.) I think most of this could be solved by switching to something based on `dataclasses`. E.g., in Python 3.9+:

```python
@dataclasses.dataclass
class Foo(spanner_orm.Model):
foo: Annotated[int, spanner_orm.primary_key]
```

Or in older versions of Python:
```python
@dataclasses.dataclass
class Foo(spanner_orm.Model):
foo: int = dataclasses.field(metadata={spanner_orm.PRIMARY_KEY: True})
```

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.