nhsavage
commented
4 years ago - Package and Modules names all comply with pep8
-
we do not have any classes, exceptions or types defined in the library as yet
There are a fairly large number of non-compliant variables and a few functions, Using pylint:
analysis.py:22:0: C0103: Argument name "P" doesn't conform to snake_case naming style (invalid-name)
analysis.py:22:0: C0103: Argument name "Q" doesn't conform to snake_case naming style (invalid-name)
analysis.py:22:0: C0103: Argument name "T" doesn't conform to snake_case naming style (invalid-name)
analysis.py:78:4: C0103: Variable name "LC" doesn't conform to snake_case naming style (invalid-name)
analysis.py:79:4: C0103: Variable name "RL1" doesn't conform to snake_case naming style (invalid-name)
analysis.py:80:4: C0103: Variable name "TM" doesn't conform to snake_case naming style (invalid-name)
analysis.py:81:4: C0103: Variable name "EPSILON" doesn't conform to snake_case naming style (invalid-name)
analysis.py:82:4: C0103: Variable name "R" doesn't conform to snake_case naming style (invalid-name)
analysis.py:83:4: C0103: Variable name "RV" doesn't conform to snake_case naming style (invalid-name)
analysis.py:93:4: C0103: Variable name "TD" doesn't conform to snake_case naming style (invalid-name)
analysis.py:98:4: C0103: Variable name "P1" doesn't conform to snake_case naming style (invalid-name)
analysis.py:101:4: C0103: Variable name "RL" doesn't conform to snake_case naming style (invalid-name)
analysis.py:104:4: C0103: Variable name "V_PRES" doesn't conform to snake_case naming style (invalid-name)
analysis.py:112:4: C0103: Variable name "Q0" doesn't conform to snake_case naming style (invalid-name)
analysis.py:117:4: C0103: Variable name "ES0" doesn't conform to snake_case naming style (invalid-name)
analysis.py:118:4: C0103: Variable name "RT" doesn't conform to snake_case naming style (invalid-name)
analysis.py:134:0: C0103: Argument name "xi" doesn't conform to snake_case naming style (invalid-name)
analysis.py:134:0: C0103: Argument name "yi" doesn't conform to snake_case naming style (invalid-name)
analysis.py:184:0: C0103: Argument name "xi" doesn't conform to snake_case naming style (invalid-name)
analysis.py:184:0: C0103: Argument name "yi" doesn't conform to snake_case naming style (invalid-name)
analysis.py:234:4: C0103: Variable name "n" doesn't conform to snake_case naming style (invalid-name)
analysis.py:243:18: C0103: Variable name "xp" doesn't conform to snake_case naming style (invalid-name)
analysis.py:243:22: C0103: Variable name "yp" doesn't conform to snake_case naming style (invalid-name)
analysis.py:466:0: C0103: Argument name "pc" doesn't conform to snake_case naming style (invalid-name)
analysis.py:691:4: C0103: Variable name "ll" doesn't conform to snake_case naming style (invalid-name)
analysis.py:737:4: C0103: Variable name "ll" doesn't conform to snake_case naming style (invalid-name)
preparation.py:64:4: C0103: Variable name "cs" doesn't conform to snake_case naming style (invalid-name)
preparation.py:80:4: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
preparation.py:80:7: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
utils.py:126:0: C0103: Argument name "c1" doesn't conform to snake_case naming style (invalid-name)
utils.py:126:0: C0103: Argument name "c2" doesn't conform to snake_case naming style (invalid-name)
utils.py:271:12: C0103: Variable name "c" doesn't conform to snake_case naming style (invalid-name)
utils.py:291:12: C0103: Variable name "ca" doesn't conform to snake_case naming style (invalid-name)
utils.py:349:4: C0103: Variable name "a" doesn't conform to snake_case naming style (invalid-name)
utils.py:349:7: C0103: Variable name "b" doesn't conform to snake_case naming style (invalid-name)
utils.py:444:0: C0103: Function name "convertFromUMStamp" doesn't conform to snake_case naming style (invalid-name)
utils.py:468:4: C0103: Variable name "d" doesn't conform to snake_case naming style (invalid-name)
utils.py:470:4: C0103: Variable name "yr" doesn't conform to snake_case naming style (invalid-name)
utils.py:475:8: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:479:8: C0103: Variable name "d" doesn't conform to snake_case naming style (invalid-name)
utils.py:480:8: C0103: Variable name "hr" doesn't conform to snake_case naming style (invalid-name)
utils.py:481:8: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:487:0: C0103: Function name "convertToUMStamp" doesn't conform to snake_case naming style (invalid-name)
utils.py:487:0: C0103: Argument name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:522:4: C0103: Variable name "YY" doesn't conform to snake_case naming style (invalid-name)
utils.py:527:8: C0103: Variable name "UMstr" doesn't conform to snake_case naming style (invalid-name)
utils.py:530:8: C0103: Variable name "d" doesn't conform to snake_case naming style (invalid-name)
utils.py:531:8: C0103: Variable name "hr" doesn't conform to snake_case naming style (invalid-name)
utils.py:532:8: C0103: Variable name "UMstr" doesn't conform to snake_case naming style (invalid-name)
utils.py:540:0: C0103: Function name "precisYY" doesn't conform to snake_case naming style (invalid-name)
utils.py:540:0: C0103: Argument name "y" doesn't conform to snake_case naming style (invalid-name)
utils.py:563:4: C0103: Variable name "YY" doesn't conform to snake_case naming style (invalid-name)
utils.py:568:0: C0103: Function name "precisD2" doesn't conform to snake_case naming style (invalid-name)
utils.py:568:0: C0103: Argument name "c" doesn't conform to snake_case naming style (invalid-name)
utils.py:626:0: C0103: Function name "UMFileList" doesn't conform to snake_case naming style (invalid-name)
utils.py:668:4: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:676:16: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:678:16: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:686:12: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
utils.py:694:12: C0103: Variable name "dt" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:39:8: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:43:8: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:65:4: C0103: Variable name "ax" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:76:0: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:76:0: C0103: Argument name "y" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:76:0: C0103: Argument name "CI_region" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:76:0: C0103: Argument name "CI_slope" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:105:17: C0103: Variable name "xp" doesn't conform to snake_case naming style (invalid-name)
visualisation.py:105:21: C0103: Variable name "yp" doesn't conform to snake_case naming style (invalid-name)
PEP8 states: https://www.python.org/dev/peps/pep-0008/#naming-conventions "The naming conventions of Python's library are a bit of a mess, so we'll never get this completely consistent -- nevertheless, here are the currently recommended naming standards. New modules and packages (including third party frameworks) should be written to these standards, but where an existing library has a different style, internal consistency is preferred."
This issue will review our existing code and where it does not meet the naming conventions change the code to align it with those standards