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

Inconsistent namespace packaging approach #44

Open
shiviser opened this issue Mar 11, 2021 · 1 comment
Open

Inconsistent namespace packaging approach #44

shiviser opened this issue Mar 11, 2021 · 1 comment

Comments

@shiviser
Copy link

shiviser commented Mar 11, 2021

Observation
This package uses the native namespace packaging approach (no init file in fs folder). Also, this package depends on pyfilesystem2 and shares this namespace folder 'fs' with pyfilesystem2.

However, pyfilesystem2 uses the pkg_resources-style namespace approach to declare its namespace folder 'fs' (see fs/init.py).

As a result, this package is inconsistent with the recommendation in pkg_resources-style namespace approach -

If you are creating a new distribution within an existing namespace package that uses this method then it’s recommended to continue using this as the different methods are not cross-compatible and it’s not advisable to try to migrate an existing package.

Problem
In use cases where these two packages are downloaded in seperate directories and both of them are added to the python systempath, the package import does not work due to the aforementioned inconsistency. This is exactly the problem if one uses bazel to manage these external dependencies in a project.

Suggestion
Please use the consistent namespace packaging convention as suggested in the link above.

@shiviser shiviser changed the title Inconsistent namespace approach Inconsistent namespace packaging approach Mar 11, 2021
@shiviser
Copy link
Author

shiviser commented Mar 11, 2021

@althonos also, if this inconsistent namespace packaging is fixed, this issue #13 will not occur.

shiviser added a commit to shiviser/fs.sshfs that referenced this issue Mar 11, 2021
shiviser added a commit to shiviser/fs.sshfs that referenced this issue Mar 11, 2021
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

No branches or pull requests

1 participant