Testing

enable_tests

Whether tests should be performed with pytest.

Example:

enable_tests: True

Required: no

Default: True

Type: Boolean

mypy_deps

A list of additional packages to install in Tox when running mypy. Usually type stubs.

mypy_deps:
  - docutils-stubs
  - webcolors-stubs
  - gi-stubs

Required: no

Default: [ ]

Type: Sequence of String

extra_lint_paths

A list of additional files or directories to check with flake8 and mypy.

extra_lint_paths:
  - tools
  - utils
  - demo.py

New in version 2022.4.4.

Required: no

Default: [ ]

Type: Sequence of String

extra_testenv_commands

A list of additional commands to run in the primary testenv, after running the tests themselves.

extra_testenv_commands:
  - python coverage-fixup.py

New in version 2022.4.4.

Required: no

Default: [ ]

Type: Sequence of String

mypy_plugins

A list of plugins to enable for mypy.

Example:

mypy_plugins:
  - /one/plugin.py
  - other.plugin
  - custom_plugin:custom_entry_point

See https://mypy.readthedocs.io/en/stable/extending_mypy.html#extending-mypy-using-plugins for more info.

Required: no

Default: [ ]

Type: Sequence of String

tests_dir

The directory containing tests, relative to the repository root.

tests_dir: "tests"

If undefined it is assumed to be tests.

Required: no

Default: tests

Type: String

tox_build_requirements

A list of additional Python build requirements for Tox.

Example:

tox_build_requirements:
  - setuptools

Required: no

Default: [ ]

Type: Sequence of String

tox_requirements

A list of additional Python requirements for Tox.

Example:

tox_requirements:
  - flake8

Required: no

Default: [ ]

Type: Sequence of String

tox_testenv_extras

The “Extra” requirement to install when installing the package in the Tox testenv.

See https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies

Example:

tox_testenv_extras:
  - docs

Required: no

Default: <blank>

Type: String

mypy_version

The version of mypy to use.

Example:

mypy_version: 0.790

Changed in version 2021.2.18: The default is now 0.800

Changed in version 2021.8.11: The default is now 0.910

Changed in version 2022.4.4: The default is now 0.931

Changed in version $VERSION: The default is now 0.971

Required: no

Default: 0.971

Type: String or Float

enable_devmode

Enable Python Development Mode when running tests.

Example:

enable_devmode: True

Required: no

Default: True

Type: Boolean

tox_unmanaged

A list of section names in tox.ini which should not be managed by repo-helper.

Example:

tox_unmanaged:
  - "testenv"
  - "flake8"

Required: no

Default: [ ]

Type: Sequence of String

min_coverage

The minimum permitted test coverage percentage.

Example:

mypy_version: 0.790

New in version 2020.1.27.

Required: no

Default: 80

Type: String or Float

github_ci_requirements

Additional steps to run in GitHub actions before and after installing dependencies.

New in version 2021.8.11.

Example:

github_ci_requirements:
  Linux:
    pre:
     - sudo apt update
     - sudo apt install python3-gi
  macOS:
    post:
     - "Installation Complete!"

Required: no

Default: { }

Type: Mapping of String to Mapping of String to Sequence of String