xref: /qemu/python/setup.cfg (revision d051d0e1)
1[metadata]
2name = qemu
3version = file:VERSION
4maintainer = QEMU Developer Team
5maintainer_email = qemu-devel@nongnu.org
6url = https://www.qemu.org/
7download_url = https://www.qemu.org/download/
8description = QEMU Python Build, Debug and SDK tooling.
9long_description = file:PACKAGE.rst
10long_description_content_type = text/x-rst
11classifiers =
12    Development Status :: 3 - Alpha
13    License :: OSI Approved :: GNU General Public License v2 (GPLv2)
14    Natural Language :: English
15    Operating System :: OS Independent
16    Programming Language :: Python :: 3 :: Only
17    Programming Language :: Python :: 3.6
18    Programming Language :: Python :: 3.7
19    Programming Language :: Python :: 3.8
20    Programming Language :: Python :: 3.9
21    Programming Language :: Python :: 3.10
22    Typing :: Typed
23
24[options]
25python_requires = >= 3.6
26packages =
27    qemu.qmp
28    qemu.machine
29    qemu.utils
30
31[options.package_data]
32* = py.typed
33
34[options.extras_require]
35# For the devel group, When adding new dependencies or bumping the minimum
36# version, use e.g. "pipenv install --dev pylint==3.0.0".
37# Subsequently, edit 'Pipfile' to remove e.g. 'pylint = "==3.0.0'.
38devel =
39    avocado-framework >= 87.0
40    flake8 >= 3.6.0
41    fusepy >= 2.0.4
42    isort >= 5.1.2
43    mypy >= 0.770
44    pylint >= 2.8.0
45    tox >= 3.18.0
46
47# Provides qom-fuse functionality
48fuse =
49    fusepy >= 2.0.4
50
51[options.entry_points]
52console_scripts =
53    qom = qemu.qmp.qom:main
54    qom-set = qemu.qmp.qom:QOMSet.entry_point
55    qom-get = qemu.qmp.qom:QOMGet.entry_point
56    qom-list = qemu.qmp.qom:QOMList.entry_point
57    qom-tree = qemu.qmp.qom:QOMTree.entry_point
58    qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
59    qemu-ga-client = qemu.qmp.qemu_ga_client:main
60    qmp-shell = qemu.qmp.qmp_shell:main
61
62[flake8]
63extend-ignore = E722  # Prefer pylint's bare-except checks to flake8's
64exclude = __pycache__,
65
66[mypy]
67strict = True
68python_version = 3.6
69warn_unused_configs = True
70namespace_packages = True
71
72[mypy-qemu.qmp.qom_fuse]
73# fusepy has no type stubs:
74allow_subclassing_any = True
75
76[mypy-fuse]
77# fusepy has no type stubs:
78ignore_missing_imports = True
79
80[pylint.messages control]
81# Disable the message, report, category or checker with the given id(s). You
82# can either give multiple identifiers separated by comma (,) or put this
83# option multiple times (only on the command line, not in the configuration
84# file where it should appear only once). You can also use "--disable=all" to
85# disable everything first and then reenable specific checks. For example, if
86# you want to run only the similarities checker, you can use "--disable=all
87# --enable=similarities". If you want to run only the classes checker, but have
88# no Warning level messages displayed, use "--disable=all --enable=classes
89# --disable=W".
90disable=
91
92[pylint.basic]
93# Good variable names which should always be accepted, separated by a comma.
94good-names=i,
95           j,
96           k,
97           ex,
98           Run,
99           _,   # By convention: Unused variable
100           fh,  # fh = open(...)
101           fd,  # fd = os.open(...)
102           c,   # for c in string: ...
103
104[pylint.similarities]
105# Ignore imports when computing similarities.
106ignore-imports=yes
107
108# Minimum lines number of a similarity.
109# TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
110min-similarity-lines=6
111
112
113[isort]
114force_grid_wrap=4
115force_sort_within_sections=True
116include_trailing_comma=True
117line_length=72
118lines_after_imports=2
119multi_line_output=3
120
121# tox (https://tox.readthedocs.io/) is a tool for running tests in
122# multiple virtualenvs. This configuration file will run the test suite
123# on all supported python versions. To use it, "pip install tox" and
124# then run "tox" from this directory. You will need all of these versions
125# of python available on your system to run this test.
126
127[tox:tox]
128envlist = py36, py37, py38, py39, py310
129skip_missing_interpreters = true
130
131[testenv]
132allowlist_externals = make
133deps =
134    .[devel]
135    .[fuse]  # Workaround to trigger tox venv rebuild
136commands =
137    make check
138