mbox series

[v2,00/12] Python: packaging cleanups

Message ID 20210629164253.1272763-1-jsnow@redhat.com (mailing list archive)
Headers show
Series Python: packaging cleanups | expand

Message

John Snow June 29, 2021, 4:42 p.m. UTC
This series is a collection of touchups and small fixes to the Python
packaging series that was initiated with commit ea1213b7.

It fixes a small handful of annoyances and adjusts some readme files,
help text, and so on.

I'd like to make sure this is included prior to the 6.1 RC testing
period.

V2:
  007/12:[0002] [FC] 'python: update help text for check-tox'
  008/12:[down] 'python: Fix .PHONY Make specifiers'
  009/12:[down] 'python: add 'make check-dev' invocation'

 - 07: Changed '3.6-3.10' to '3.6 - 3.10'.
       (Kept Willian's RB)
 - 08: New, based on Wainer's observation I had missed 'check-tox'.
 - 09: Renamed targets based on Wainer's review.

Status:
  [01] python-expose-typing         # [RB] WR,WdSM [SOB] JS
  [02] python-remove-global-pylint  # [RB] WR,WdSM [SOB] JS
  [03] python-re-lock-pipenv-at     # [RB] WR,WdSM [SOB] JS
  [04] python-readme.rst-touchups   # [RB] WR,WdSM [SOB] JS
  [05] python-add-no-install-usage  # [RB] WR,WdSM [SOB] JS
  [06] python-rename-venv-check     # [RB] WR,WdSM [SOB] JS
  [07] python-update-help-text-for  # [RB] WR      [SOB] JS
  [08] python-fix-.phony-make       #              [SOB] JS
  [09] python-add-make-check-venv   #              [SOB] JS
  [10] python-update-help-text-on   # [RB] WR,WdSM [SOB] JS
  [11] python-update-help-text-on-1 # [RB] WR,WdSM [SOB] JS
  [12] python-remove-auto-generated # [RB] WR,WdSM [SOB] JS

John Snow (12):
  python: expose typing information via PEP 561
  python: Remove global pylint suppressions
  python: Re-lock pipenv at *oldest* supported versions
  python: README.rst touchups
  python: Add no-install usage instructions
  python: rename 'venv-check' target to 'check-pipenv'
  python: update help text for check-tox
  python: Fix .PHONY Make specifiers
  python: add 'make check-dev' invocation
  python: Update help text on 'make check', 'make develop'
  python: Update help text on 'make clean', 'make distclean'
  python: remove auto-generated pyproject.toml file

 python/README.rst              |  47 +++++++++++---
 .gitlab-ci.d/static_checks.yml |   2 +-
 python/Makefile                |  89 ++++++++++++++++++++------
 python/Pipfile.lock            | 113 ++++++++++++++++-----------------
 python/qemu/machine/machine.py |   3 +
 python/qemu/machine/py.typed   |   0
 python/qemu/machine/qtest.py   |   2 +
 python/qemu/qmp/py.typed       |   0
 python/qemu/utils/py.typed     |   0
 python/setup.cfg               |  12 ++--
 10 files changed, 175 insertions(+), 93 deletions(-)
 create mode 100644 python/qemu/machine/py.typed
 create mode 100644 python/qemu/qmp/py.typed
 create mode 100644 python/qemu/utils/py.typed

Comments

Wainer dos Santos Moschetta June 29, 2021, 4:51 p.m. UTC | #1
On 6/29/21 1:42 PM, John Snow wrote:
> Move it up near the check-pipenv help text, and update it to suggest parity.
>
> (At the time I first added it, I wasn't sure if I would be keeping it,
> but I've come to appreciate it as it has actually helped uncover bugs I
> would not have noticed without it. It should stay.)
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> Reviewed-by: Willian Rampazzo <willianr@redhat.com>
> ---
>   python/Makefile | 8 ++++++--
>   1 file changed, 6 insertions(+), 2 deletions(-)

Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>

>
> diff --git a/python/Makefile b/python/Makefile
> index 07ad73ccd0..d2cfa6ad8f 100644
> --- a/python/Makefile
> +++ b/python/Makefile
> @@ -9,13 +9,17 @@ help:
>   	@echo "    Requires: Python 3.6 and pipenv."
>   	@echo "    Hint (Fedora): 'sudo dnf install python3.6 pipenv'"
>   	@echo ""
> +	@echo "make check-tox:"
> +	@echo "    Run tests against multiple python versions."
> +	@echo "    These tests use the newest dependencies."
> +	@echo "    Requires: Python 3.6 - 3.10, and tox."
> +	@echo "    Hint (Fedora): 'sudo dnf install python3-tox python3.10'"
> +	@echo ""
>   	@echo "make develop:    Install deps for 'make check', and"
>   	@echo "                 the qemu libs in editable/development mode."
>   	@echo ""
>   	@echo "make check:      run linters using the current environment."
>   	@echo ""
> -	@echo "make check-tox:  run linters using multiple python versions."
> -	@echo ""
>   	@echo "make pipenv"
>   	@echo "    Creates pipenv's virtual environment (.venv)"
>   	@echo ""