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     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'.
  39 devel =
  40     avocado-framework >= 90.0
  41     flake8 >= 3.6.0
  42     fusepy >= 2.0.4
  43     isort >= 5.1.2
  44     mypy >= 0.780
  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
  52 fuse =
  53     fusepy >= 2.0.4
  54
  55 # AQMP TUI dependencies
  56 tui =
  57     urwid >= 2.1.2
  58     urwid-readline >= 0.13
  59     Pygments >= 2.9.0
  60
  61 [options.entry_points]
  62 console_scripts =
  63     qom = qemu.utils.qom:main
  64     qom-set = qemu.utils.qom:QOMSet.entry_point
  65     qom-get = qemu.utils.qom:QOMGet.entry_point
  66     qom-list = qemu.utils.qom:QOMList.entry_point
  67     qom-tree = qemu.utils.qom:QOMTree.entry_point
  68     qom-fuse = qemu.utils.qom_fuse:QOMFuse.entry_point [fuse]
  69     qemu-ga-client = qemu.utils.qemu_ga_client:main
  70     qmp-shell = qemu.aqmp.qmp_shell:main
  71     qmp-shell-wrap = qemu.aqmp.qmp_shell:main_wrap
  72     aqmp-tui = qemu.aqmp.aqmp_tui:main [tui]
  73
  74 [flake8]
  75 extend-ignore = E722  # Prefer pylint's bare-except checks to flake8's
  76 exclude = __pycache__,
  77
  78 [mypy]
  79 strict = True
  80 python_version = 3.6
  81 warn_unused_configs = True
  82 namespace_packages = True
  83
  84 [mypy-qemu.utils.qom_fuse]
  85 # fusepy has no type stubs:
  86 allow_subclassing_any = True
  87
  88 [mypy-qemu.aqmp.aqmp_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-urwid]
  98 ignore_missing_imports = True
  99
 100 [mypy-urwid_readline]
 101 ignore_missing_imports = True
 102
 103 [mypy-pygments]
 104 ignore_missing_imports = True
 105
 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".
 116 disable=consider-using-f-string,
 117         consider-using-with,
 118         too-many-arguments,
 119         too-many-function-args,  # mypy handles this with less false positives.
 120         too-many-instance-attributes,
 121         no-member,  # mypy also handles this better.
 122
 123 [pylint.basic]
 124 # Good variable names which should always be accepted, separated by a comma.
 125 good-names=i,
 126            j,
 127            k,
 128            ex,
 129            Run,
 130            _,   # By convention: Unused variable
 131            fh,  # fh = open(...)
 132            fd,  # fd = os.open(...)
 133            c,   # for c in string: ...
 134            T,   # for TypeVars. See pylint#3401
 135
 136 [pylint.similarities]
 137 # Ignore imports when computing similarities.
 138 ignore-imports=yes
 139 ignore-signatures=yes
 140
 141 # Minimum lines number of a similarity.
 142 # TODO: Remove after we opt in to Pylint 2.8.3. See commit msg.
 143 min-similarity-lines=6
 144
 145
 146 [isort]
 147 force_grid_wrap=4
 148 force_sort_within_sections=True
 149 include_trailing_comma=True
 150 line_length=72
 151 lines_after_imports=2
 152 multi_line_output=3
 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]
 161 envlist = py36, py37, py38, py39, py310
 162 skip_missing_interpreters = true
 163
 164 [testenv]
 165 allowlist_externals = make
 166 deps =
 167     .[devel]
 168     .[fuse]  # Workaround to trigger tox venv rebuild
 169     .[tui]   # Workaround to trigger tox venv rebuild
 170 commands =
 171     make check
 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]
 179 concurrency = multiprocessing
 180 source = qemu/
 181 parallel = true