RFC: Exceptions to PEP-8 Adoption for RTEMS Tools

[Sebastian Huber]

On 19/03/2020 07:31, Sebastian Huber wrote:

> Hello Gedare,
>
> I am open for all exceptions provided
>
> * there is a well known tool available which can format the code 
> automatically with the exceptions,
>
> * the static analyzer tools can be configured to give good results 
> with the exceptions, and
>
> * the exceptions are a best practice in a larger and well known Python 
> project.

I checked in the first version of the guide:

https://docs.rtems.org/branches/master/eng/python-devel.html

We should refine it now step by step. In particular, it would be good to 
add some best practice parts to the Testing section.

An open issue is how we would like to run the development tools. 
Integrate it in the build system (waf)? Run them through other standard 
Python tools for module  packaging, testing, and deployment? Run this 
tool with waf?

For the static analysis tools flake8, pylint, and mypy you can use configuration files. For pylint, you can dump the default configuration with "pylint
--generate-rcfile". Should we use a particular pylint version to generate configuration file for the RTEMS Project or should we just use whatever a future version will use as default?  I am not sure about the mypy configuration.

How do we want to install the Python development tools? In the
rtems-qual repository I simply set up a virtual environment with a Makefile:

https://git.rtems.org/sebh/rtems-qual.git/tree/Makefile

I think we should install specific versions of the tools to avoid that
different developers get different tool reports.