xref: /qemu/python/setup.cfg (revision 0ec8384f) 
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    Programming Language :: Python :: 3.11
23    Typing :: Typed
24
25[options]
26python_requires = >= 3.6
27packages =
28    qemu.qmp
29    qemu.machine
30    qemu.utils
31
32[options.package_data]
33* = py.typed
34
35[options.extras_require]
36# For the devel group, When adding new dependencies or bumping the minimum
37# version, use e.g. "pipenv install --dev pylint==3.0.0".
38# Subsequently, edit 'Pipfile' to remove e.g. 'pylint = "==3.0.0'.
39devel =
40    avocado-framework >= 90.0
41    flake8 >= 3.6.0
42    fusepy >= 2.0.4
43    isort >= 5.1.2
44    mypy >= 0.780
45    pylint >= 2.8.0
46    tox >= 3.18.0
47    urwid >= 2.1.2
48    urwid-readline >= 0.13
49    Pygments >= 2.9.0
50
51# Provides qom-fuse functionality
52fuse =
53    fusepy >= 2.0.4
54
55# QMP TUI dependencies
56tui =
57    urwid >= 2.1.2
58    urwid-readline >= 0.13
59    Pygments >= 2.9.0
60
61[options.entry_points]
62console_scripts =
63    qom = qemu.utils.qom:main
64    qom-set = qemu.utils.qom:QOMSet.entry_point
65    qom-get = qemu.utils.qom:QOMGet.entry_point
66    qom-list = qemu.utils.qom:QOMList.entry_point
67    qom-tree = qemu.utils.qom:QOMTree.entry_point
68    qom-fuse = qemu.utils.qom_fuse:QOMFuse.entry_point [fuse]
69    qemu-ga-client = qemu.utils.qemu_ga_client:main
70    qmp-shell = qemu.qmp.qmp_shell:main
71    qmp-shell-wrap = qemu.qmp.qmp_shell:main_wrap
72    qmp-tui = qemu.qmp.qmp_tui:main [tui]
73
74[flake8]
75# Prefer pylint's bare-except checks to flake8's
76extend-ignore = E722
77exclude = __pycache__,
78
79[mypy]
80strict = True
81python_version = 3.6
82warn_unused_configs = True
83namespace_packages = True
84warn_unused_ignores = False
85
86[mypy-qemu.utils.qom_fuse]
87# fusepy has no type stubs:
88allow_subclassing_any = True
89
90[mypy-qemu.qmp.qmp_tui]
91# urwid and urwid_readline have no type stubs:
92allow_subclassing_any = True
93
94# The following missing import directives are because these libraries do not
95# provide type stubs. Allow them on an as-needed basis for mypy.
96[mypy-fuse]
97ignore_missing_imports = True
98
99[mypy-urwid]
100ignore_missing_imports = True
101
102[mypy-urwid_readline]
103ignore_missing_imports = True
104
105[mypy-pygments]
106ignore_missing_imports = True
107
108[pylint.messages control]
109# Disable the message, report, category or checker with the given id(s). You
110# can either give multiple identifiers separated by comma (,) or put this
111# option multiple times (only on the command line, not in the configuration
112# file where it should appear only once). You can also use "--disable=all" to
113# disable everything first and then reenable specific checks. For example, if
114# you want to run only the similarities checker, you can use "--disable=all
115# --enable=similarities". If you want to run only the classes checker, but have
116# no Warning level messages displayed, use "--disable=all --enable=classes
117# --disable=W".
118disable=consider-using-f-string,
119        consider-using-with,
120        too-many-arguments,
121        too-many-function-args,  # mypy handles this with less false positives.
122        too-many-instance-attributes,
123        no-member,  # mypy also handles this better.
124
125[pylint.basic]
126# Good variable names which should always be accepted, separated by a comma.
127good-names=i,
128           j,
129           k,
130           ex,
131           Run,
132           _,   # By convention: Unused variable
133           fh,  # fh = open(...)
134           fd,  # fd = os.open(...)
135           c,   # for c in string: ...
136           T,   # for TypeVars. See pylint#3401
137
138[pylint.similarities]
139# Ignore imports when computing similarities.
140ignore-imports=yes
141ignore-signatures=yes
142
143# Minimum lines number of a similarity.
144# TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
145min-similarity-lines=6
146
147
148[isort]
149force_grid_wrap=4
150force_sort_within_sections=True
151include_trailing_comma=True
152line_length=72
153lines_after_imports=2
154multi_line_output=3
155
156# tox (https://tox.readthedocs.io/) is a tool for running tests in
157# multiple virtualenvs. This configuration file will run the test suite
158# on all supported python versions. To use it, "pip install tox" and
159# then run "tox" from this directory. You will need all of these versions
160# of python available on your system to run this test.
161
162[tox:tox]
163envlist = py36, py37, py38, py39, py310, py311
164skip_missing_interpreters = true
165
166[testenv]
167allowlist_externals = make
168deps =
169    .[devel]
170    .[fuse]  # Workaround to trigger tox venv rebuild
171    .[tui]   # Workaround to trigger tox venv rebuild
172commands =
173    make check
174
175# Coverage.py [https://coverage.readthedocs.io/en/latest/] is a tool for
176# measuring code coverage of Python programs. It monitors your program,
177# noting which parts of the code have been executed, then analyzes the
178# source to identify code that could have been executed but was not.
179
180[coverage:run]
181concurrency = multiprocessing
182source = qemu/
183parallel = true
184