Add public methods to erddapy module #281
Merged
Conversation
This file contains hidden or 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
- Add public methods to erddapy.__init__ This allows using the URL parsing and interfaces methods directly from the erddapy module, without having to access the core.url and core.interfaces modules.
Contributor
|
If we are going to expose them all at one spot, I'd rather expose them at I think it would help clarify to users that refactoring is going on, and allow them to make an explicit choice which world to live in. It also would decrease the amount that is in a single namespace. import erddapy.core
url = erddapy.core.get_download_url(...) |
- Expose methods in erddapy.core instead of erddapy - Code review for ioos#281
vinisalazar
added a commit
to vinisalazar/erddapy
that referenced
this pull request
Nov 22, 2022
- Code review for ioos#281
Member
|
Yep. I agreed with @abkfenris, putting them all at the root level would be a bit confusing for folks browsing the module. Having them into a |
Contributor
Author
|
Done with 6fdb280. Users can run: import erddapy
erddapy.core.get_download_url()
erddapy.servers
...i.e. no need to |
ocefpaf
approved these changes
Nov 23, 2022
Member
ocefpaf
left a comment
There was a problem hiding this comment.
I'll wait until Friday just in case Alex see this before then.
abkfenris
approved these changes
Nov 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Hi,
while working on the docs for the core interface, I realised that the URL parsing and interfaces methods would have to be directly imported from their respective modules, rather than being accessed from the
erddapymodule. This seemed a bit unintuitive, so I added public methods directly to theerddapy.__init__module.Users can then run:
instead of
which seems much harder to do.
Summary of changes:
erddapy.__init__This allows using the URL parsing and interfaces methods directly from the erddapy module,
without having to access the core.url and core.interfaces modules.