Refactor packages to exclude from public namespace #1240
Closed
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
ambrosejcarr
requested review from
ttung,
kne42,
shanaxel42 and
dganguli
and removed request for
kne42
Codecov Report
@@ Coverage Diff @@
## master #1240 +/- ##
===========================================
+ Coverage 67.41% 88.29% +20.87%
===========================================
Files 132 132
Lines 4919 4919
===========================================
+ Hits 3316 4343 +1027
+ Misses 1603 576 -1027
Continue to review full report at Codecov.
|
ambrosejcarr
force-pushed
the
ajc-namespace-cleanup
branch
from
cb7a80f to
a686b1d
Compare
…arfish into ajc-namespace-cleanup * 'ajc-namespace-cleanup' of https://github.com/spacetx/starfish: more travis-only errors... fix error that only occurs on travis get docs building update makefile rules to ignore import ordering in top-level starfish __init__.py appease flake8 refactor packages to exclude from public namespace Reorganize the presentation of the image filtering docs (#1229)
ambrosejcarr
force-pushed
the
ajc-namespace-cleanup
branch
from
998a741 to
718dc7e
Compare
|
Closing in favor of #1244 |
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.
This PR has two main commits:
The post-refactor namespace is a sub-set of the pre-factor namespace; no paths change, paths are only eliminated that are either duplicates, or which should not be exposed to users (e.g. starfish.multiprocessing)
It's also worth noting this was a clean refactor, I did not have to replace the packages whose imports are broken. For example, despite the fact that you can access
starfish.multiprocessingfromimport starfishwe, the developers, always useimport starfish.multiprocessing. Thus, neither users nor developers expect these packages to be present.Before clean-up:
After clean-up:
Question: if we want to continue importing types this way, should we also refactor
starfish.types -> starfish._types?