Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add repr kwarg to field function and Field C struct #543

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

feat: add repr kwarg to field function and Field C struct #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c35e03c
feat: add `repr` kwarg to `field` function and `Field` C struct
lmmx Sep 5, 2023
2f15b6f
feat(_core): change repr attribute parsing from bool to int, add miss…
lmmx Sep 5, 2023
f1522e8
feat: add `repr` parameter to `field` function signatures in `__init_…
lmmx Sep 5, 2023
b5de933
feat(repr): support configurable `Field` repr
lmmx Sep 6, 2023
54e5bd3
test: add test coverage for `Field.repr` in `__repr__` and `__rich_re…
lmmx Sep 7, 2023
b2bc6fc
feat(rich repr): skip `repr=False` fields from the `__rich_repr__` as…
lmmx Sep 7, 2023
267ab27
test: coverage for callable repr feature
lmmx Sep 7, 2023
775bed8
feat: support for callable Field repr
lmmx Sep 7, 2023
d109a19
fix(attribute type): all tests pass
lmmx Sep 7, 2023
7e68029
fix: improve memory management
lmmx Sep 8, 2023
78ae7e6
test: cover TypeErrors from `Field.repr` with non-bool/callable argum…
lmmx Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
## PyCharm/IntelliJ-generated files
*.iml
.idea/
## Vim-generated files
*.sw[op]

# Python cached sources
__pycache__/
Expand Down
6 changes: 4 additions & 2 deletions msgspec/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@
)


def field(*, default=NODEFAULT, default_factory=NODEFAULT, name=None):
return _Field(default=default, default_factory=default_factory, name=name)
def field(*, default=NODEFAULT, default_factory=NODEFAULT, name=None, repr=True):
return _Field(
default=default, default_factory=default_factory, name=name, repr=repr
)


def from_builtins(
Expand Down
8 changes: 5 additions & 3 deletions msgspec/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ class _NoDefault(enum.Enum):
NODEFAULT = _NoDefault.NODEFAULT

@overload
def field(*, default: T, name: Optional[str] = None) -> T: ...
def field(*, default: T, name: Optional[str] = None, repr: bool = True) -> T: ...
@overload
def field(*, default_factory: Callable[[], T], name: Optional[str] = None) -> T: ...
def field(
*, default_factory: Callable[[], T], name: Optional[str] = None, repr: bool = True
) -> T: ...
@overload
def field(*, name: Optional[str] = None) -> Any: ...
def field(*, name: Optional[str] = None, repr: bool = True) -> Any: ...
@dataclass_transform(field_specifiers=(field,))
class Struct:
__struct_fields__: ClassVar[Tuple[str, ...]]
Expand Down
Loading