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