xref: /qemu/python/setup.cfg (revision b88651cb) 
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 >= 90.0
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]
74extend-ignore = E722  # Prefer pylint's bare-except checks to flake8's
75exclude = __pycache__,
76
77[mypy]
78strict = True
79python_version = 3.6
80warn_unused_configs = True
81namespace_packages = True
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-urwid]
97ignore_missing_imports = True
98
99[mypy-urwid_readline]
100ignore_missing_imports = True
101
102[mypy-pygments]
103ignore_missing_imports = True
104
105[pylint.messages control]
106# Disable the message, report, category or checker with the given id(s). You
107# can either give multiple identifiers separated by comma (,) or put this
108# option multiple times (only on the command line, not in the configuration
109# file where it should appear only once). You can also use "--disable=all" to
110# disable everything first and then reenable specific checks. For example, if
111# you want to run only the similarities checker, you can use "--disable=all
112# --enable=similarities". If you want to run only the classes checker, but have
113# no Warning level messages displayed, use "--disable=all --enable=classes
114# --disable=W".
115disable=consider-using-f-string,
116        consider-using-with,
117        too-many-arguments,
118        too-many-function-args,  # mypy handles this with less false positives.
119        too-many-instance-attributes,
120        no-member,  # mypy also handles this better.
121
122[pylint.basic]
123# Good variable names which should always be accepted, separated by a comma.
124good-names=i,
125           j,
126           k,
127           ex,
128           Run,
129           _,   # By convention: Unused variable
130           fh,  # fh = open(...)
131           fd,  # fd = os.open(...)
132           c,   # for c in string: ...
133           T,   # for TypeVars. See pylint#3401
134
135[pylint.similarities]
136# Ignore imports when computing similarities.
137ignore-imports=yes
138ignore-signatures=yes
139
140# Minimum lines number of a similarity.
141# TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
142min-similarity-lines=6
143
144
145[isort]
146force_grid_wrap=4
147force_sort_within_sections=True
148include_trailing_comma=True
149line_length=72
150lines_after_imports=2
151multi_line_output=3
152
153# tox (https://tox.readthedocs.io/) is a tool for running tests in
154# multiple virtualenvs. This configuration file will run the test suite
155# on all supported python versions. To use it, "pip install tox" and
156# then run "tox" from this directory. You will need all of these versions
157# of python available on your system to run this test.
158
159[tox:tox]
160envlist = py36, py37, py38, py39, py310
161skip_missing_interpreters = true
162
163[testenv]
164allowlist_externals = make
165deps =
166    .[devel]
167    .[fuse]  # Workaround to trigger tox venv rebuild
168    .[tui]   # Workaround to trigger tox venv rebuild
169commands =
170    make check
171
172# Coverage.py [https://coverage.readthedocs.io/en/latest/] is a tool for
173# measuring code coverage of Python programs. It monitors your program,
174# noting which parts of the code have been executed, then analyzes the
175# source to identify code that could have been executed but was not.
176
177[coverage:run]
178concurrency = multiprocessing
179source = qemu/
180parallel = true
181