DM-20915: Add str(Formatter) and force Formatter to require an arg for constructor #178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update tests to match, switching some of them to using getFormatterClass so that the parameter is irrelevant.
TallJimbo
approved these changes
Aug 6, 2019
| raise TypeError("File descriptor must be a FileDescriptor") | ||
| self._fileDescriptor = fileDescriptor | ||
|
|
||
| def __str__(self): | ||
| return f"{self.name()}@{self.fileDescriptor.location.path}" | ||
|
|
There was a problem hiding this comment.
Seems like it'd be straightforward to add the ideal kind of __repr__, too.
There was a problem hiding this comment.
Yes, it was straightforward here but required I added repr() to FileDescriptor and Location and also that I cleaned up repr() for StorageClass to make it less chatty. You now get a repr that looks something like:
lsst.daf.butler.formatters.jsonFormatter.JsonFormatter(FileDescriptor(Location('/Users/timj/work/lsstsw3/build/daf_butler/a', 'B'), StorageClass('xxx'), readStorageClass=StorageClass('yyy')))
@TallJimbo you might want to take a look at all the new code now.
There was a problem hiding this comment.
Looks good. I didn't know about {!r}, and I'm glad that I now do.
Having it return "builtins.str" serves no useful purpose and it's much easier to return "str" and "dict".
Previously the python type to name conversion was deferred until the python type was needed. This is unnecessary and causes problems with repr() implementations. Now always extract the full name using getFullTypeName.
Make it more compact by removing entities that are defaulted.
Now consistent in mentioning it returns a Formatter class not Formatter instance.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is no longer any gain in allowing an optional FileDescriptor argument so remove that option.