python/setup.cfg

   1 [metadata]
   2 name = qemu
   3 version = file:VERSION
   4 maintainer = QEMU Developer Team
   5 maintainer_email = qemu-devel@nongnu.org
   6 url = https://www.qemu.org/
   7 download_url = https://www.qemu.org/download/
   8 description = QEMU Python Build, Debug and SDK tooling.
   9 long_description = file:PACKAGE.rst
  10 long_description_content_type = text/x-rst
  11 classifiers =
  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.8
  18     Programming Language :: Python :: 3.9
  19     Programming Language :: Python :: 3.10
  20     Programming Language :: Python :: 3.11
  21     Programming Language :: Python :: 3.12
  22     Typing :: Typed
  23
  24 [options]
  25 python_requires = >= 3.8
  26 packages =
  27     qemu.qmp
  28     qemu.machine
  29     qemu.utils
  30
  31 [options.package_data]
  32 * = py.typed
  33
  34 [options.extras_require]
  35 # Remember to update tests/minreqs.txt if changing anything below:
  36 devel =
  37     avocado-framework >= 90.0
  38     distlib >= 0.3.6
  39     flake8 >= 5.0.4
  40     fusepy >= 2.0.4
  41     isort >= 5.1.2
  42     mypy >= 1.4.0
  43     pylint >= 2.17.3
  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
  50 fuse =
  51     fusepy >= 2.0.4
  52
  53 # QMP TUI dependencies
  54 tui =
  55     urwid >= 2.1.2
  56     urwid-readline >= 0.13
  57     Pygments >= 2.9.0
  58
  59 [options.entry_points]
  60 console_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
  74 extend-ignore = E722
  75 exclude = __pycache__,
  76
  77 [mypy]
  78 strict = True
  79 python_version = 3.8
  80 warn_unused_configs = True
  81 namespace_packages = True
  82 warn_unused_ignores = False
  83
  84 [mypy-qemu.utils.qom_fuse]
  85 # fusepy has no type stubs:
  86 allow_subclassing_any = True
  87
  88 [mypy-qemu.qmp.qmp_tui]
  89 # urwid and urwid_readline have no type stubs:
  90 allow_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]
  95 ignore_missing_imports = True
  96
  97 [mypy-tomli]
  98 ignore_missing_imports = True
  99
 100 [mypy-tomllib]
 101 ignore_missing_imports = True
 102
 103 [mypy-urwid]
 104 ignore_missing_imports = True
 105
 106 [mypy-urwid_readline]
 107 ignore_missing_imports = True
 108
 109 [mypy-pygments]
 110 ignore_missing_imports = True
 111
 112 [mypy-distlib]
 113 ignore_missing_imports = True
 114
 115 [mypy-distlib.scripts]
 116 ignore_missing_imports = True
 117
 118 [mypy-distlib.version]
 119 ignore_missing_imports = True
 120
 121 [mypy-pip._vendor.distlib]
 122 ignore_missing_imports = True
 123
 124 [mypy-pip._vendor.distlib.scripts]
 125 ignore_missing_imports = True
 126
 127 [mypy-pip._vendor.distlib.version]
 128 ignore_missing_imports = True
 129
 130 [pylint.messages control]
 131 # Disable the message, report, category or checker with the given id(s). You
 132 # can either give multiple identifiers separated by comma (,) or put this
 133 # option multiple times (only on the command line, not in the configuration
 134 # file where it should appear only once). You can also use "--disable=all" to
 135 # disable everything first and then reenable specific checks. For example, if
 136 # you want to run only the similarities checker, you can use "--disable=all
 137 # --enable=similarities". If you want to run only the classes checker, but have
 138 # no Warning level messages displayed, use "--disable=all --enable=classes
 139 # --disable=W".
 140 disable=consider-using-f-string,
 141         consider-using-with,
 142         too-many-arguments,
 143         too-many-function-args,  # mypy handles this with less false positives.
 144         too-many-instance-attributes,
 145         no-member,  # mypy also handles this better.
 146
 147 [pylint.basic]
 148 # Good variable names which should always be accepted, separated by a comma.
 149 good-names=i,
 150            j,
 151            k,
 152            ex,
 153            Run,
 154            _,   # By convention: Unused variable
 155            fh,  # fh = open(...)
 156            fd,  # fd = os.open(...)
 157            c,   # for c in string: ...
 158            T,   # for TypeVars. See pylint#3401
 159            SocketAddrT,  # Not sure why this is invalid.
 160
 161 [pylint.similarities]
 162 # Ignore imports when computing similarities.
 163 ignore-imports=yes
 164 ignore-signatures=yes
 165
 166 # Minimum lines number of a similarity.
 167 # TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
 168 min-similarity-lines=6
 169
 170
 171 [isort]
 172 force_grid_wrap=4
 173 force_sort_within_sections=True
 174 include_trailing_comma=True
 175 line_length=72
 176 lines_after_imports=2
 177 multi_line_output=3
 178
 179 # tox (https://tox.readthedocs.io/) is a tool for running tests in
 180 # multiple virtualenvs. This configuration file will run the test suite
 181 # on all supported python versions. To use it, "pip install tox" and
 182 # then run "tox" from this directory. You will need all of these versions
 183 # of python available on your system to run this test.
 184
 185 [tox:tox]
 186 envlist = py38, py39, py310, py311, py312
 187 skip_missing_interpreters = true
 188
 189 [testenv]
 190 allowlist_externals = make
 191 deps =
 192     .[devel]
 193     .[fuse]  # Workaround to trigger tox venv rebuild
 194     .[tui]   # Workaround to trigger tox venv rebuild
 195 commands =
 196     make check
 197
 198 # Coverage.py [https://coverage.readthedocs.io/en/latest/] is a tool for
 199 # measuring code coverage of Python programs. It monitors your program,
 200 # noting which parts of the code have been executed, then analyzes the
 201 # source to identify code that could have been executed but was not.
 202
 203 [coverage:run]
 204 concurrency = multiprocessing
 205 source = qemu/
 206 parallel = true