Skip to content
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

refactor: Avoid implicit re-exports in main module #543

Closed

Conversation

l0b0
Copy link
Contributor

@l0b0 l0b0 commented Jul 8, 2021

Related Issue(s): #332

Description: Work in progress until I resolve circular imports

PR Checklist:

  • Code is formatted (run pre-commit run --all-files)
  • Tests pass (run scripts/test)
  • Documentation has been updated to reflect changes, if applicable
  • This PR maintains or improves overall codebase code coverage.
  • Changes are added to the CHANGELOG. See the docs for information about adding to the changelog.

@codecov-commenter
Copy link

Codecov Report

Merging #543 (1a02b9f) into main (f2afd5a) will increase coverage by 0.00%.
The diff coverage is 91.66%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #543   +/-   ##
=======================================
  Coverage   94.25%   94.25%           
=======================================
  Files          71       71           
  Lines       10269    10272    +3     
  Branches     1072     1072           
=======================================
+ Hits         9679     9682    +3     
  Misses        422      422           
  Partials      168      168           
Impacted Files Coverage Δ
pystac/collection.py 93.46% <90.00%> (+0.02%) ⬆️
pystac/item_collection.py 93.93% <92.85%> (+0.18%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f2afd5a...1a02b9f. Read the comment docs.

@duckontheweb
Copy link
Contributor

@l0b0 One thing to consider here is that clearing out the top-level __init__.py file would represent a breaking change since it would change the way all of our classes, etc. need to be imported. If that is the ultimate plan, we should probably get this in before a 1.0.0 release.

cc: @lossyrob

@lossyrob
Copy link
Member

As a I mentioned in the other PR, I'm -1 on clearing out the top level of types.

I'm also -1 of making code quality refactors that modify the API at this point, as I think it will slow down a release, which is of higher value IMO.

@duckontheweb
Copy link
Contributor

As a I mentioned in the other PR, I'm -1 on clearing out the top level of types.

I'm also -1 of making code quality refactors that modify the API at this point, as I think it will slow down a release, which is of higher value IMO.

I am in agreement, and based on this comment I believe @l0b0 is as well. If that is the case, and we are not going to make major changes to how users import classes and function from the top-level of PySTAC, then I don't think we need to rush to get this into the 1.0 release.

@l0b0 l0b0 closed this Jul 18, 2021
@l0b0 l0b0 deleted the refactor/avoid-implicit-reexport-in-pystac branch July 18, 2021 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants