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

Make modules private #86

Open
4 tasks
tobinus opened this issue Dec 3, 2019 · 0 comments
Open
4 tasks

Make modules private #86

tobinus opened this issue Dec 3, 2019 · 0 comments

Comments

@tobinus
Copy link
Owner

tobinus commented Dec 3, 2019

Right now, it is entirely possible to do something like:

from podgen.podcast import Podcast

instead of the intended:

from podgen import Podcast

This is problematic because code which uses PodGen may rely on the module names and module contents being the way they are now. It is therefore more challenging to make changes to the inner organization of PodGen.

In new minor version:

  • Change name of modules so they start with an underscore
  • Create aliases under the old public names which make available the same contents as before (to preserve backwards compatibility)
  • Emit DeprecationWarning when the aliases are run (i.e. imported)

In new major version:

  • Remove the aliases.
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