Skip to content

Out-Of-The-Box Templates

This file contains all the out-of-the-box templates provided by Statue. At this time Statue supports only a single template, which is the default template. This will be changed in the future.

Default Template

Contexts

fast

Run short-time commands. Good for smoke tests

strict

Strict checks, for ones who never compromise!

format

Reformating commands, with in-file replacements.

Aliases: fmt

test

Checks for test files.

documentation

Commands regarding code documentation.

Aliases: docs

Commands

autoflake

Remove unused imports and variables

Default Arguments: autoflake <source> --in-place --recursive --expand-star-imports --remove-all-unused-imports

Required Contexts: format

Allowed Contexts: fast, test

bandit

Python security checks tool.

Default Arguments: bandit <source> -r --skip=B603

black

Code formatter for python.

Default Arguments: black <source> --check

Allowed Contexts: fast, test

Specified contexts:

darglint

Tool for documentation coverage.

Default Arguments: darglint <source> --docstring-style=sphinx

Allowed Contexts: documentation

flake8

Code style checker for python.

Default Arguments: flake8 <source> --max-line-length=88 --ignore=E203,W503,DAR

Allowed Contexts: fast, test

isort

Tool for sorting and cleaning python imports.

Default Arguments: isort <source> --profile=black --check-only

Allowed Contexts: fast, test

Specified contexts:

  • format: Overrides arguments with --profile=black

mypy

Validate types using mypy.

Default Arguments: mypy <source> --ignore-missing-imports

Allowed Contexts: test

Specified contexts:

  • strict: Adds arguments --strict

pydocstyle

Tool for python docstring style enforcing

Default Arguments: pydocstyle <source> --ignore=D203,D212,D400,D401

Allowed Contexts: documentation

pylint

Python code linter

Default Arguments: pylint <source> --ignore-imports=y --load-plugins=pylint.extensions.docparams --enable=useless-suppression,use-symbolic-message-instead --fail-on=useless-suppression,use-symbolic-message-instead

Specified contexts:

  • documentation: Overrides arguments with --ignore-imports=y --load-plugins=pylint.extensions.docparams --disable=all --enable=C0115,C0304,C0116,C0114 --enable=W9005,W9006,W9008,W9010,W9011,W9012,W9013 --enable=W9014,W9015,W9016,W9017,W9018,W9019,W9020,W9021

  • test: Adds arguments --disable=C0103,C0114,C0115,C0116,C0203,C0204,C0411 --disable=E0401,E0611,E1101,E1120,E1130,E1139 --disable=R0801,R0902,R0903,R0904,R0913 --disable=W0201,W0613,W0621