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