Skip to content

Change __repr__ method to only print if non-None #2287

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

Merged
Fokko merged 1 commit into from
Aug 7, 2025
Merged

Change __repr__ method to only print if non-None #2287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 17 additions & 2 deletions pyiceberg/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,8 @@ class NestedField(IcebergType):
field_type: SerializeAsAny[IcebergType] = Field(alias="type")
required: bool = Field(default=False)
doc: Optional[str] = Field(default=None, repr=False)
initial_default: Optional[DefaultValue] = Field(alias="initial-default", default=None, repr=False) # type: ignore
write_default: Optional[DefaultValue] = Field(alias="write-default", default=None, repr=False) # type: ignore
initial_default: Optional[DefaultValue] = Field(alias="initial-default", default=None, repr=True) # type: ignore
write_default: Optional[DefaultValue] = Field(alias="write-default", default=None, repr=True) # type: ignore

@field_validator("field_type", mode="before")
def convert_field_type(cls, v: Any) -> IcebergType:
Expand Down Expand Up @@ -401,6 +401,21 @@ def __str__(self) -> str:
req = "required" if self.required else "optional"
return f"{self.field_id}: {self.name}: {req} {self.field_type}{doc}"

def __repr__(self) -> str:
"""Return the string representation of the NestedField class."""
parts = [
f"field_id={self.field_id}",
f"name={self.name!r}",
f"field_type={self.field_type!r}",
f"required={self.required}",
]
if self.initial_default is not None:
parts.append(f"initial_default={self.initial_default!r}")
if self.write_default is not None:
parts.append(f"write_default={self.write_default!r}")

return f"NestedField({', '.join(parts)})"

def __getnewargs__(self) -> Tuple[int, str, IcebergType, bool, Optional[str]]:
"""Pickle the NestedField class."""
return (self.field_id, self.name, self.field_type, self.required, self.doc)
Expand Down
15 changes: 15 additions & 0 deletions tests/test_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,6 +525,21 @@ def test_repr_decimal() -> None:
assert repr(DecimalType(19, 25)) == "DecimalType(precision=19, scale=25)"


def test_repr_nested_field_default_nones_should_not_appear() -> None:
assert (
repr(NestedField(1, "required_field", StringType(), required=False, initial_default=None, write_default=None))
== "NestedField(field_id=1, name='required_field', field_type=StringType(), required=False)"
)
assert (
repr(NestedField(1, "required_field", StringType(), required=False, initial_default="hello", write_default=None))
== "NestedField(field_id=1, name='required_field', field_type=StringType(), required=False, initial_default='hello')"
)
assert (
repr(NestedField(1, "required_field", StringType(), required=False, initial_default="hello", write_default="bye"))
== "NestedField(field_id=1, name='required_field', field_type=StringType(), required=False, initial_default='hello', write_default='bye')"
)


def test_serialization_nestedfield() -> None:
expected = '{"id":1,"name":"required_field","type":"string","required":true,"doc":"this is a doc"}'
actual = NestedField(1, "required_field", StringType(), True, "this is a doc").model_dump_json()
Expand Down