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

[internal] Remove wv_ prefix from module names #195

Open
formatc1702 opened this issue Nov 15, 2020 · 0 comments
Open

[internal] Remove wv_ prefix from module names #195

formatc1702 opened this issue Nov 15, 2020 · 0 comments
Milestone

Comments

@formatc1702
Copy link
Collaborator

Affects

  • wv_bom.py
  • wv_colors.py
  • wv_gv_html.py
  • wv_helper.py
  • wv_html.py

@kvid commented on #151:

Another question that could be discussed here is removing the wv_ prefix from module names.

  • wv_colors.py
  • wv_helper.py
  • wv_html.py
  • wv_bom.py

I am not sure if having a generic name could cause issues if there are other modules with the same name installed on the system (e.g. html.py).

I'm not an expert on this issue, and had to google what has been written by others.

  • PEP8 seems not to recommend the prefixes in the current names:

There's also the style of using a short unique prefix to group related names together. This is not used much in Python, but it is mentioned for completeness.

Modules should have short, all-lowercase names. Underscores can be used in the module name if it improves readability.

  • The Python modules with identical names article is relevant, and it seems that absolute imports that became default in Python3 solves most of the problems with module name clashes.
@formatc1702 formatc1702 added this to the v0.3 milestone Nov 15, 2020
@formatc1702 formatc1702 modified the milestones: v0.3, v0.4 and later Oct 7, 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