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

Fix repr for Fields that don't define default. (Cherry-pick of #18719) #18724

Merged
merged 1 commit into from
Apr 13, 2023
Merged

Fix repr for Fields that don't define default. (Cherry-pick of #18719) #18724

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
20 changes: 12 additions & 8 deletions src/python/pants/engine/target.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,10 +197,10 @@ def _check_deprecated(cls, raw_value: Optional[Any], address: Address) -> None:
)

def __repr__(self) -> str:
return (
f"{self.__class__}(alias={repr(self.alias)}, value={repr(self.value)}, "
f"default={repr(self.default)})"
)
params = [f"alias={self.alias!r}", f"value={self.value!r}"]
if hasattr(self, "default"):
params.append(f"default={self.default!r}")
return f"{self.__class__}({', '.join(params)})"

def __str__(self) -> str:
return f"{self.alias}={self.value}"
Expand Down Expand Up @@ -269,10 +269,14 @@ def __init__(self, raw_value: Optional[Any], address: Address) -> None:
super().__init__(raw_value, address)

def __repr__(self) -> str:
return (
f"{self.__class__}(alias={repr(self.alias)}, address={self.address}, "
f"value={repr(self.value)}, default={repr(self.default)})"
)
params = [
f"alias={self.alias!r}",
f"address={self.address}",
f"value={self.value!r}",
]
if hasattr(self, "default"):
params.append(f"default={self.default!r}")
return f"{self.__class__}({', '.join(params)})"

def __hash__(self) -> int:
return hash((self.__class__, self.value, self.address))
Expand Down
4 changes: 3 additions & 1 deletion src/python/pants/engine/target_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ class CustomFortranTarget(Target):


def test_required_field() -> None:
class RequiredField(StringField):
class RequiredField(Field):
alias = "field"
required = True

Expand All @@ -409,6 +409,8 @@ class RequiredTarget(Target):
core_fields = (RequiredField,)

address = Address("", target_name="lib")
# No errors getting the repr
assert repr(RequiredField("present", address))

# No errors when defined
RequiredTarget({"field": "present"}, address)
Expand Down