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