xref: /openbmc/qemu/python/setup.cfg (revision 35b9a85a)
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    qemu.aqmp
31
32[options.package_data]
33* = py.typed
34
35[options.extras_require]
36# For the devel group, When adding new dependencies or bumping the minimum
37# version, use e.g. "pipenv install --dev pylint==3.0.0".
38# Subsequently, edit 'Pipfile' to remove e.g. 'pylint = "==3.0.0'.
39devel =
40    avocado-framework >= 87.0
41    flake8 >= 3.6.0
42    fusepy >= 2.0.4
43    isort >= 5.1.2
44    mypy >= 0.770
45    pylint >= 2.8.0
46    tox >= 3.18.0
47
48# Provides qom-fuse functionality
49fuse =
50    fusepy >= 2.0.4
51
52[options.entry_points]
53console_scripts =
54    qom = qemu.qmp.qom:main
55    qom-set = qemu.qmp.qom:QOMSet.entry_point
56    qom-get = qemu.qmp.qom:QOMGet.entry_point
57    qom-list = qemu.qmp.qom:QOMList.entry_point
58    qom-tree = qemu.qmp.qom:QOMTree.entry_point
59    qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
60    qemu-ga-client = qemu.qmp.qemu_ga_client:main
61    qmp-shell = qemu.qmp.qmp_shell:main
62
63[flake8]
64extend-ignore = E722  # Prefer pylint's bare-except checks to flake8's
65exclude = __pycache__,
66
67[mypy]
68strict = True
69python_version = 3.6
70warn_unused_configs = True
71namespace_packages = True
72
73[mypy-qemu.qmp.qom_fuse]
74# fusepy has no type stubs:
75allow_subclassing_any = True
76
77[mypy-fuse]
78# fusepy has no type stubs:
79ignore_missing_imports = True
80
81[pylint.messages control]
82# Disable the message, report, category or checker with the given id(s). You
83# can either give multiple identifiers separated by comma (,) or put this
84# option multiple times (only on the command line, not in the configuration
85# file where it should appear only once). You can also use "--disable=all" to
86# disable everything first and then reenable specific checks. For example, if
87# you want to run only the similarities checker, you can use "--disable=all
88# --enable=similarities". If you want to run only the classes checker, but have
89# no Warning level messages displayed, use "--disable=all --enable=classes
90# --disable=W".
91disable=consider-using-f-string,
92
93[pylint.basic]
94# Good variable names which should always be accepted, separated by a comma.
95good-names=i,
96           j,
97           k,
98           ex,
99           Run,
100           _,   # By convention: Unused variable
101           fh,  # fh = open(...)
102           fd,  # fd = os.open(...)
103           c,   # for c in string: ...
104           T,   # for TypeVars. See pylint#3401
105
106[pylint.similarities]
107# Ignore imports when computing similarities.
108ignore-imports=yes
109ignore-signatures=yes
110
111# Minimum lines number of a similarity.
112# TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
113min-similarity-lines=6
114
115
116[isort]
117force_grid_wrap=4
118force_sort_within_sections=True
119include_trailing_comma=True
120line_length=72
121lines_after_imports=2
122multi_line_output=3
123
124# tox (https://tox.readthedocs.io/) is a tool for running tests in
125# multiple virtualenvs. This configuration file will run the test suite
126# on all supported python versions. To use it, "pip install tox" and
127# then run "tox" from this directory. You will need all of these versions
128# of python available on your system to run this test.
129
130[tox:tox]
131envlist = py36, py37, py38, py39, py310
132skip_missing_interpreters = true
133
134[testenv]
135allowlist_externals = make
136deps =
137    .[devel]
138    .[fuse]  # Workaround to trigger tox venv rebuild
139commands =
140    make check
141