LXR qemu/python/setup.cfg

   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 >= 90.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    urwid >= 2.1.2
  48    urwid-readline >= 0.13
  49    Pygments >= 2.9.0
  50
  51# Provides qom-fuse functionality
  52fuse =
  53    fusepy >= 2.0.4
  54
  55# AQMP TUI dependencies
  56tui =
  57    urwid >= 2.1.2
  58    urwid-readline >= 0.13
  59    Pygments >= 2.9.0
  60
  61[options.entry_points]
  62console_scripts =
  63    qom = qemu.qmp.qom:main
  64    qom-set = qemu.qmp.qom:QOMSet.entry_point
  65    qom-get = qemu.qmp.qom:QOMGet.entry_point
  66    qom-list = qemu.qmp.qom:QOMList.entry_point
  67    qom-tree = qemu.qmp.qom:QOMTree.entry_point
  68    qom-fuse = qemu.qmp.qom_fuse:QOMFuse.entry_point [fuse]
  69    qemu-ga-client = qemu.qmp.qemu_ga_client:main
  70    qmp-shell = qemu.qmp.qmp_shell:main
  71    aqmp-tui = qemu.aqmp.aqmp_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.qmp.qom_fuse]
  84# fusepy has no type stubs:
  85allow_subclassing_any = True
  86
  87[mypy-qemu.aqmp.aqmp_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        too-many-function-args,  # mypy handles this with less false positives.
 117        no-member,  # mypy also handles this better.
 118
 119[pylint.basic]
 120# Good variable names which should always be accepted, separated by a comma.
 121good-names=i,
 122           j,
 123           k,
 124           ex,
 125           Run,
 126           _,   # By convention: Unused variable
 127           fh,  # fh = open(...)
 128           fd,  # fd = os.open(...)
 129           c,   # for c in string: ...
 130           T,   # for TypeVars. See pylint#3401
 131
 132[pylint.similarities]
 133# Ignore imports when computing similarities.
 134ignore-imports=yes
 135ignore-signatures=yes
 136
 137# Minimum lines number of a similarity.
 138# TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
 139min-similarity-lines=6
 140
 141
 142[isort]
 143force_grid_wrap=4
 144force_sort_within_sections=True
 145include_trailing_comma=True
 146line_length=72
 147lines_after_imports=2
 148multi_line_output=3
 149
 150# tox (https://tox.readthedocs.io/) is a tool for running tests in
 151# multiple virtualenvs. This configuration file will run the test suite
 152# on all supported python versions. To use it, "pip install tox" and
 153# then run "tox" from this directory. You will need all of these versions
 154# of python available on your system to run this test.
 155
 156[tox:tox]
 157envlist = py36, py37, py38, py39, py310
 158skip_missing_interpreters = true
 159
 160[testenv]
 161allowlist_externals = make
 162deps =
 163    .[devel]
 164    .[fuse]  # Workaround to trigger tox venv rebuild
 165    .[tui]   # Workaround to trigger tox venv rebuild
 166commands =
 167    make check
 168
 169# Coverage.py [https://coverage.readthedocs.io/en/latest/] is a tool for
 170# measuring code coverage of Python programs. It monitors your program,
 171# noting which parts of the code have been executed, then analyzes the
 172# source to identify code that could have been executed but was not.
 173
 174[coverage:run]
 175concurrency = multiprocessing
 176source = qemu/
 177parallel = true
 178