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