alces-software / adminware

A sandbox CLI for running commands remotely across nodes
1 stars 0 forks source link

Review the use of `__naming` in adminware #170

Closed WilliamMcCumstie closed 5 years ago

WilliamMcCumstie commented 5 years ago

Python loves to use its _ when naming things. For the most part they are advisory only and don't make much difference. However there is a standard set out here: https://dbader.org/blog/meaning-of-underscores-in-python

The main exception to this is __leading_double_underscores. This actually causes the python interpreter to mangle the name in an effort to protect the method from future inheritance. This is basically never the intended use case in adminware.

At some point we need to go through and rename the __methods to be _methods. The only exception to this is the database.Base.__reconstructor method (TBA). This method is used as part of the model loading process and should not be overridden.