[MAINTENANCE] ExpectationSuite API cleanup
#9875
Conversation
✅ Deploy Preview for niobium-lead-7998 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| assert all( | ||
| mine.isEquivalentTo(theirs) | ||
| for (mine, theirs) in zip( | ||
| single_expectation_suite.expectation_configurations, | ||
| different_suite.expectation_configurations, | ||
| ) | ||
| ) |
There was a problem hiding this comment.
Took the guts of the isEquivalentTo method and used it for the assertion here
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #9875 +/- ##
===========================================
- Coverage 78.63% 78.61% -0.03%
===========================================
Files 484 484
Lines 42537 42394 -143
===========================================
- Hits 33450 33329 -121
+ Misses 9087 9065 -22
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| return removed_expectations | ||
|
|
||
| def find_expectation_indexes( | ||
| def _find_expectation_indexes( |
There was a problem hiding this comment.
This is used by other methods so it has to stay around but I don't think it needs to be public
There was a problem hiding this comment.
I feel like we're misusing this. This method isn't private; it's deprecated. And it's already not in the public api. typing-extensions has a deprecated decorator. Thoughts on just using that?
There was a problem hiding this comment.
I suppose I care less about the distinction if the only external use case is in a test
There was a problem hiding this comment.
Just to close the loop on this, this method is only ever used within this class (at least after the other deletions in this file).
| self.meta["citations"].append(citation) | ||
|
|
||
| # noinspection PyPep8Naming | ||
| def isEquivalentTo(self, other): |
There was a problem hiding this comment.
I thought this one was too hard to pull out? Awesome if we can do it now!
| return removed_expectations | ||
|
|
||
| def find_expectation_indexes( | ||
| def _find_expectation_indexes( |
There was a problem hiding this comment.
I feel like we're misusing this. This method isn't private; it's deprecated. And it's already not in the public api. typing-extensions has a deprecated decorator. Thoughts on just using that?
Delete any extraneous methods we don't need (citations, filtering, etc). Also, make any methods private if we can.
invoke lint(usesruff format+ruff check)For more information about contributing, see Contribute.
After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!