]> git.proxmox.com Git - mirror_qemu.git/blame - python/setup.cfg
bsd-user: Implement mount, umount and nmount
[mirror_qemu.git] / python / setup.cfg
CommitLineData
ea1213b7
JS
1[metadata]
2name = qemu
3afc3290 3version = file:VERSION
ea1213b7
JS
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
3c8de38c
JS
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
7f179082 22 Typing :: Typed
ea1213b7
JS
23
24[options]
25python_requires = >= 3.6
26packages =
37094b6d 27 qemu.qmp
ea1213b7
JS
28 qemu.machine
29 qemu.utils
ef42440d 30
7f179082
JS
31[options.package_data]
32* = py.typed
33
dbe75f55 34[options.extras_require]
3afa3501
JS
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'.
dbe75f55 38devel =
4320f717 39 avocado-framework >= 90.0
dbe75f55 40 flake8 >= 3.6.0
c63f3b0b 41 fusepy >= 2.0.4
dbe75f55 42 isort >= 5.1.2
74a1505d 43 mypy >= 0.780
dbe75f55 44 pylint >= 2.8.0
3c8de38c 45 tox >= 3.18.0
974e2f47
NB
46 urwid >= 2.1.2
47 urwid-readline >= 0.13
f37c34d6 48 Pygments >= 2.9.0
dbe75f55 49
c63f3b0b
JS
50# Provides qom-fuse functionality
51fuse =
52 fusepy >= 2.0.4
53
b1a9b1f7 54# QMP TUI dependencies
974e2f47
NB
55tui =
56 urwid >= 2.1.2
57 urwid-readline >= 0.13
f37c34d6 58 Pygments >= 2.9.0
974e2f47 59
7c4c595f
JS
60[options.entry_points]
61console_scripts =
0347c4c4
JS
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
37094b6d
JS
69 qmp-shell = qemu.qmp.qmp_shell:main
70 qmp-shell-wrap = qemu.qmp.qmp_shell:main_wrap
b1a9b1f7 71 qmp-tui = qemu.qmp.qmp_tui:main [tui]
7c4c595f 72
81f8c446
JS
73[flake8]
74extend-ignore = E722 # Prefer pylint's bare-except checks to flake8's
21d0b866 75exclude = __pycache__,
81f8c446 76
e941c844
JS
77[mypy]
78strict = True
79python_version = 3.6
80warn_unused_configs = True
0542a4c9 81namespace_packages = True
e7874a50 82warn_unused_ignores = False
e941c844 83
0347c4c4 84[mypy-qemu.utils.qom_fuse]
30ec845c
JS
85# fusepy has no type stubs:
86allow_subclassing_any = True
87
b1a9b1f7 88[mypy-qemu.qmp.qmp_tui]
aeb6b48a
NB
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.
30ec845c 94[mypy-fuse]
aeb6b48a
NB
95ignore_missing_imports = True
96
97[mypy-urwid]
98ignore_missing_imports = True
99
100[mypy-urwid_readline]
30ec845c
JS
101ignore_missing_imports = True
102
f37c34d6
NB
103[mypy-pygments]
104ignore_missing_imports = True
105
ef42440d
JS
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".
eb8033f6 116disable=consider-using-f-string,
5c66d7d8
DB
117 consider-using-with,
118 too-many-arguments,
29a8ea9b 119 too-many-function-args, # mypy handles this with less false positives.
5c66d7d8 120 too-many-instance-attributes,
4cd17f37 121 no-member, # mypy also handles this better.
ef42440d
JS
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,
d229f1c8
JS
130 _, # By convention: Unused variable
131 fh, # fh = open(...)
132 fd, # fd = os.open(...)
133 c, # for c in string: ...
35b9a85a 134 T, # for TypeVars. See pylint#3401
ef42440d
JS
135
136[pylint.similarities]
137# Ignore imports when computing similarities.
138ignore-imports=yes
5690b437 139ignore-signatures=yes
158ac451 140
22305c2a
JS
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
158ac451
JS
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
3c8de38c
JS
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
6f651a6d 162skip_missing_interpreters = true
3c8de38c
JS
163
164[testenv]
165allowlist_externals = make
c63f3b0b
JS
166deps =
167 .[devel]
168 .[fuse] # Workaround to trigger tox venv rebuild
974e2f47 169 .[tui] # Workaround to trigger tox venv rebuild
3c8de38c
JS
170commands =
171 make check
a4ffaecd
JS
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