-
Notifications
You must be signed in to change notification settings - Fork 41
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.
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
Improve Metadata class #110
Merged
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
…ata` subclasses.
thodson-usgs
approved these changes
Aug 25, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well done, @edsaac
thank you for contributing.
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.
Implements a base metadata class that can be inherited from each service. This PR follows discussion from #109.
Changes in
dataretrieval.utils
:BaseMetadata
class is implemented such that it is initialized from the a request (md = BaseMetadata(request)
). However, each service should inherit fromBaseMetadata
and implement their particular methods.set_metadata
function is removed, this is handled by the BaseMetadata's methods.Changes in
dataretrieval.nwis
:NWIS_Metadata
class inherits fromutils.BaseMetadata
. It implementssite_info
andvariable_info
as properties and handles the metadata comments.__repr__
of the Metadata object.Example:
Changes in
dataretrieval.wqp
:utils.BaseMetadata
and implementssite_info
property.Example:
Changes in
tests
:Breaking changes:
md.site_info
andmd.variable_info
are no longer callables but class properties. I am not sure why those were implemented to return lambda functions, but my guess is so the service query was only made if they where explicitly called by the user. If that was the case, the@property
decorator should take care of that.