Code style#

In case you contribute code, we generally ask for following the code style we are using already. This is a general Python style, with 4 spaces as the delimiter, nothing groundbreaking here :)

Formatting/Linting#

Import sorting is controlled by isort. An isort configuration is part of the setup.cfg in the root directory.

For code formatting we use Black.

For linting we use Flake8. A Flake8 configuration is part of the setup.cfg in the root directory.

There is a helper script to reformat the code under support/run_formatter.py and the tests will also verify this formatting.

Logging#

Python supports a number of different logging patterns - for more information see here and Python’s F-String for String Interpolation and Formatting and here

Given most performance measurements show f-strings to be preferred we request that their style is followed e.g.

logger.info(f"Fetching common steps from '{url}'.")