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.
Pre-existing docs were misleading in several ways (see below), this PR clarifies the README and also shows caveats with using
monorepo.load_package
(in particular that it breaks modularity, can cause module clashes and duplicate modules that can result in silent runtime bugs, see PR README).IMO monorepo.load_package should be deprecated and this PR suggests simple and standard alternatives to achieve same goals (using uniform import syntax from anywhere in monorepo) by simply adding monorepo root to PYTHONPATH (either programmatically or on command line).
foo.bar_function()
in the README gave the impression it would work for modules but it only works for packages (eg ifbar_function()
is in foo/init.py)foo = monorepo.load_package("example.package.foo")
was mis-leading as the returned name is not used, eg:There is code in the wild that falls into this trap, eg
starfo*/read_data_test.py: char_dataset = monorepo.load_package("common.dataset.dataset")