Skip to content

metadata string reduction #4040

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
bjlittle merged 2 commits into from
Mar 1, 2021
Merged

metadata string reduction #4040

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b78641c
implement metadata string
rcomer Feb 26, 2021
ca341d6
review actions
rcomer Mar 1, 2021
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
3 changes: 3 additions & 0 deletions docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ This document explains the changes made to Iris for this release
representation of the 64-bit non-cryptographic hash of the object using the
extremely fast `xxhash`_ hashing algorithm. (:pull:`4020`)

#. `@rcomer`_ implemented a string method for metadata classes, so printing

@bjlittle bjlittle Mar 1, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps explicitly clarify, with string -> __str__ ?

these objects skips metadata elements that are set to None. (:pull:`4040`)


🐛 Bugs Fixed
=============
Expand Down
9 changes: 9 additions & 0 deletions lib/iris/common/metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,15 @@ def __ne__(self, other):

return result

def __str__(self):
field_strings = []
for field in self._fields:
value = getattr(self, field)
if value is not None:

@bjlittle bjlittle Mar 1, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rcomer I think that we could be even more liberal here and ignore empty strings perhaps, but definitely and empty dict for the attributes member.

@rcomer rcomer Mar 1, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It took me longer than I care to admit to figure out the logic for this 😆

field_strings.append(f"{field}={value}")

return f"{type(self).__name__}({', '.join(field_strings)})"

def _api_common(
self, other, func_service, func_operation, action, lenient=None
):
Expand Down