search

mdolab / .github

0 stars 3 forks source link

Enforce python naming convention #66

Open eirikurj opened 2 days ago

eirikurj commented 2 days ago

Description of feature

Our python code is mostly CamelCase, but there are exceptions. To keep the python MDO Lab codebase and APIs consistent and predicable, we could and probably should integrate some tools into our testing to enforce this.

Potential solution

There are several tools available, but one option that fits into our current tools is to use the flake8 extension, pep8-naming.

Feel free to suggest other tools or approaches.

ewu63 commented 2 days ago

So the actual standard for Python is to use snake_case for functions and variables (as noted in PEP8) and somewhat enforced by the flake8 extension you linked. The fact that we (implicitly) used camelCase always bothered me but it's probably too difficult to change at this point, though automatic tools such as this one that leverages rope exists. Perhaps worth a discussion.