Formatters

A formatter is a tool to format your code style automatically: remove unused imports or add new lines at the end of file etc.

Tools are setuped in the template are described below

Hint

You can run all these formatters with make format. Do it when you do not want to waste time on code formatting by a hard

black

Black is a formatter for your code style.

Suppose you have a file

file.py

def  foo(a:int, b =  1):
    print (1 +1)
def bar(): pass

Run this

Terminal

black file.py

and get this

file.py

def foo(a: int, b=1):
    print(1 + 1)


def bar():
    pass

It's useful for adding new lines between definitions and breaking too long lines of code, but it does not fix everything by PEP8. It is just for boilerplate fixes. Anyway, you should know PEP8 by hard so there won't be any issues with naming. If you are not sure with about your PEP8 knowledge, check out pylint.

isort

isort is a formatter to fix your imports order to alphabet order and to divide imports to sections by PEP8

The same way as black this

import pytest
import pathlib, os
from sumsub import sum

Converted to

import os
import pathlib

from sumsub import sum

import pytest

It correctly divides into three sections of built-in, local, and third-party imports

autoflake

autoflake is a more lightweight and just remove unused imports and unused variables as reported by pyflakes. The template is configured only for unused imports