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 package conform to python conventions #2

Open
2 of 7 tasks
mnunberg opened this issue Aug 28, 2018 · 0 comments
Open
2 of 7 tasks

Make package conform to python conventions #2

mnunberg opened this issue Aug 28, 2018 · 0 comments

Comments

@mnunberg
Copy link
Contributor

mnunberg commented Aug 28, 2018

  • No PascalCase/camelCase filenames. Only underscores are acceptable as word delimters in file names/package names
  • Only classes should have PascalCase, no functions with PascalCase
  • Use class Foo(object) and not class Foo:
  • Use str.format rather than %
  • Variables not intended for public use should be underscore prefixed
  • No variables should have PascalCase. Ideally, no variables should even be camelCase
  • Keep stuff out of init.py. __init__.py is supposed to be a "landing page" kind of module which imports other Python modules and performs some setup/sanity (which isn't needed in this package anyway), not the main module source. This was a bad practice in rmtest, but since this is a new module, let's make it good from the start.
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