Remove needless argument checks from gaia
#2682
Merged
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
`astroquery.gaia.GaiaClass` contained a handful of needless argument checks: - In `load_data()` separately checking for `retrieval_type` being `None` is not needed because the value is checked later on, unless `avoid_datatype_check` is explicitly set to `True`. - In `load_data()` checking for `ids` being `None` only makes a difference if `None` is the explicitly specified value, but any other possible invalid value would pass this check, so it is not very useful. - In `cross_match()` several arguments were given default values and the code then checked if any of those arguments had the default value. It is better to not specify the default value at all and to let Python itself ensure that the mandatory argument values are specified.
Codecov Report
@@ Coverage Diff @@
## main #2682 +/- ##
==========================================
- Coverage 69.19% 69.18% -0.01%
==========================================
Files 304 304
Lines 22539 22529 -10
==========================================
- Hits 15595 15587 -8
+ Misses 6944 6942 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
bsipocz
approved these changes
Mar 13, 2023
| def cross_match(self, *, full_qualified_table_name_a=None, | ||
| full_qualified_table_name_b=None, | ||
| results_table_name=None, | ||
| def cross_match(self, *, full_qualified_table_name_a, |
There was a problem hiding this comment.
yes, I suppose we could have kept these positional args, but I think there is no need to change them now.
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.
astroquery.gaia.GaiaClasscontained a handful of needless argument checks:load_data()separately checking forretrieval_typebeingNone(its default value is"ALL") is not needed because the value is checked later on, unlessavoid_datatype_checkis explicitly set toTrue:astroquery/astroquery/gaia/core.py
Lines 245 to 250 in 03c8420
load_data()checking foridsbeingNoneonly makes a difference ifNoneis the explicitly specified value, but any other possible invalid value would pass this check, so it is not very useful.cross_match()several arguments were given default values and the code then checked if any of those arguments had the default value. It is better to not specify the default value at all and to let Python itself ensure that the mandatory argument values are specified. This is not only simpler but also ensures that the error message contains the correct argument name, and if multiple arguments are missing then Python's error message makes that clear too.