feat: support metric custom column ordering and sub-setting #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
nh13
had a problem deploying
to
github-actions-ci
GitHub Actions
Failure
nh13
had a problem deploying
to
github-actions-ci
GitHub Actions
Failure
nh13
had a problem deploying
to
github-actions-ci
GitHub Actions
Failure
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #178 +/- ##
==========================================
- Coverage 89.21% 89.20% -0.02%
==========================================
Files 18 18
Lines 2068 2084 +16
Branches 457 464 +7
==========================================
+ Hits 1845 1859 +14
- Misses 146 147 +1
- Partials 77 78 +1 ☔ View full report in Codecov by Sentry. |
tfenne
requested changes
Aug 15, 2024
fgpyo/util/metric.py
Outdated
| return header | ||
|
|
||
| @classmethod | ||
| def _header(cls, field_types: Optional[List[FieldType]] = None) -> List[str]: |
There was a problem hiding this comment.
Could I suggest calling this something else - e.g. _fields_to_write()? My reasoning:
- It's a little confusing to have
header()and_header() - More importantly, I might think this would allow me to provide a custom header that doesn't match field names (e.g.
[f.replace("_", " ") for f in in self.header()]
There was a problem hiding this comment.
Why is field_types optional? Given this is a function called by the Metric class itself, it feels like it should either always be provided, or be removed. How does the user who overrides this know whether or not they'll get a value?
nh13
commented
Aug 15, 2024
There was a problem hiding this comment.
- I've changed
_headerto_fields_to_write - This PR does not allow a customer header that doesn't match the field names, as we use the names returned from the
header()method to look up attributes on the class (see theyield getattr(self, name)in thevalues()method) - I've made
field_typesnot optional. Good catch, as this was a left-over from a previous attempt.
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.
Fixes #177