1 # Copyright (c) 2016-2022 mudpy authors. Permission to use, copy,
2 # modify, and distribute this software is granted under terms
3 # provided in the LICENSE file distributed with this software.
7 envlist = bandit, codespell, dist, docs, flake8, yamllint, selftest_config, py3
9 ignore_basepython_conflict = True
12 description = run the functional selftest with optimized configuration
14 # TODO(fungi) Switch this to "error" once the following are solved
16 # py311... Cython.Compiler.Main raises FutureWarning "Cython directive
17 # 'language_level' not set, using 2 for now (Py2). This will change in a
18 # later release!" but this can't be matched by message because it has a comma
19 # py311... pip._internal.index.collector and Cython.Tempita raise
20 # DeprecationWarning "'cgi' is deprecated and slated for removal in Python
22 # py311... passlib.utils raises DeprecationWarning "'crypt' is deprecated and
23 # slated for removal in Python 3.13"
24 # py311... mudpy.tests.selftest raises DeprecationWarning "'telnetlib' is
25 # deprecated and slated for removal in Python 3.13"
26 # py310... distutils.command.install raises DeprecationWarning "The
27 # distutils.sysconfig module is deprecated, use sysconfig instead" but this
28 # can't be matched by message because it contains a comma
29 # flake8... flake8.plugins.manager raises DeprecationWarning "SelectableGroups
30 # dict interface is deprecated. Use select."
31 # yamllint... setuptools.command.build_py raises
32 # setuptools._deprecation_warning.SetuptoolsDeprecationWarning "Installing
33 # 'yamllint.conf' as data is deprecated, please list it in `packages`. [...]"
34 # but the message can't be matched because it contains a comma and spans
35 # multiple lines while the custom Warning subclass can't be matched
36 # specifically leading to a blanket ignore for all Warning types in package
38 # multiple callers raise DeprecationWarning "The distutils package is
39 # deprecated and slated for removal in Python 3.12. Use setuptools or check
40 # PEP 632 for potential alternatives"
41 # multiple callers raise DeprecationWarning "Creating a LegacyVersion has been
42 # deprecated and will be removed in the next major release"
44 # setuptools._deprecation_warning.SetuptoolsDeprecationWarning "setup.py
45 # install is deprecated. Use build and pip and other standards-based tools."
46 # but only the message can be matched because the exception is private
48 # setuptools._deprecation_warning.SetuptoolsDeprecationWarning
49 # "setup_requires is deprecated. Supply build dependencies using PEP 517
50 # pyproject.toml build-requires." but only the message can be matched because
51 # the exception is private
53 # setuptools._deprecation_warning.SetuptoolsDeprecationWarning "easy_install
54 # command is deprecated. Use build and pip and other standards-based tools."
55 # but only the message can be matched because the exception is private
56 # setuptools.config.pyprojecttoml raises
57 # setuptools.config.pyprojecttoml._ExperimentalProjectMetadata "Support for
58 # project metadata in `pyproject.toml` is still experimental and may be
59 # removed (or change) in future releases." but the parent Warning class has
61 # pip._vendor.certifi.core and pip._vendor.pep517.in_process raise
62 # DeprecationWarning "path is deprecated. Use files() instead. Refer to
63 # https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy
64 # for migration advice." but this can't be matched by message because it
67 PYTHONWARNDFAULTENCODING = 1
68 PYTHONWARNINGS = error, ignore::FutureWarning:Cython.Compiler.Main, ignore::DeprecationWarning:distutils.command.install, ignore:The distutils package is deprecated and slated for removal in Python 3.12. Use setuptools or check PEP 632 for potential alternatives:DeprecationWarning, ignore:Creating a LegacyVersion has been deprecated and will be removed in the next major release:DeprecationWarning, ignore:SelectableGroups dict interface is deprecated. Use select.:DeprecationWarning:flake8.plugins.manager, ignore:setup.py install is deprecated. Use build and pip and other standards-based tools., ignore:easy_install command is deprecated. Use build and pip and other standards-based tools., ignore::DeprecationWarning:pip._vendor.certifi.core, ignore::DeprecationWarning:pip._vendor.pep517.in_process, ignore:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning:pip._internal.index.collector, ignore:'cgi' is deprecated and slated for removal in Python 3.13:DeprecationWarning:Cython.Tempita, ignore:'crypt' is deprecated and slated for removal in Python 3.13:DeprecationWarning:passlib.utils, ignore:'telnetlib' is deprecated and slated for removal in Python 3.13:DeprecationWarning:mudpy.tests.selftest, ignore::Warning:setuptools.command.build_py, ignore:Support for project metadata in `pyproject.toml` is still experimental and may be removed (or change) in future releases.:Warning:setuptools.config.pyprojecttoml
70 VIRTUALENV_CREATOR = venv
71 commands = mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
76 description = check for potential security risks in source code
79 commands = bandit -r mudpy -x mudpy/tests {posargs}
82 description = find common spelling mistakes in code and documentation
85 commands = codespell {posargs}
88 description = start an interactive demo with the sample config
89 commands = mudpy {posargs}
92 description = build release artifacts and check for conformance
98 {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/dist', ignore_errors=True)"
100 twine check --strict {toxinidir}/dist/*
103 # Build an sdist into a temporary location so we'll have AUTHORS and ChangeLog
105 description = generate hypertext documentation
111 {envpython} -c "import shutil; shutil.rmtree('{toxinidir}/doc/build', ignore_errors=True)"
112 {envpython} -m build --outdir={toxinidir}/doc/build/dist --sdist
113 sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html
116 description = style checks and static analysis of source code
118 deps = flake8-bugbear
119 commands = flake8 {posargs}
121 [testenv:selftest_config]
122 description = run the selftest with the included sample config
123 commands = mudpy_selftest etc/mudpy.yaml
126 # Run the selftest before checking YAML files so we'll be sure to also catch at
127 # least some which are generated by the application, making sure it creates
128 # them with the same style we enforce for those carried in the repository.
129 description = test data files for correct syntax and formatting
134 mudpy_selftest mudpy/tests/fixtures/test_daemon.yaml
135 yamllint --strict {posargs} .
139 exclude = .git, .tox, *lib/python*, *egg, build