diff mbox series

[v2,07/12] python: update help text for check-tox

Message ID 20210629164253.1272763-8-jsnow@redhat.com
State New
Headers show
Series Python: packaging cleanups | expand

Commit Message

John Snow June 29, 2021, 4:42 p.m. UTC
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(-)

Comments

Wainer dos Santos Moschetta June 29, 2021, 8:23 p.m. UTC | #1
Hi John,

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(-)
>
> 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 ""

Somewhat related... in my system I don't have all supported python 
versions installed, thus check-tox fails.

Instead, maybe, you could configure tox (as below) to test to whatever 
supported versions the developer have installed in the system; and on 
absence of some versions it won't fail the tests entirely.

diff --git a/python/setup.cfg b/python/setup.cfg
index e730f208d3..1db8aaf340 100644
--- a/python/setup.cfg
+++ b/python/setup.cfg
@@ -123,6 +123,7 @@ multi_line_output=3

  [tox:tox]
  envlist = py36, py37, py38, py39, py310
+skip_missing_interpreters=true

  [testenv]
  allowlist_externals = make

>   	@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 ""
John Snow June 29, 2021, 9:27 p.m. UTC | #2
On Tue, Jun 29, 2021 at 4:25 PM Wainer dos Santos Moschetta <
wainersm@redhat.com> wrote:

> Hi John,
>
> 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(-)
> >
> > 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 ""
>
> Somewhat related... in my system I don't have all supported python
> versions installed, thus check-tox fails.
>
> Instead, maybe, you could configure tox (as below) to test to whatever
> supported versions the developer have installed in the system; and on
> absence of some versions it won't fail the tests entirely.
>
> diff --git a/python/setup.cfg b/python/setup.cfg
> index e730f208d3..1db8aaf340 100644
> --- a/python/setup.cfg
> +++ b/python/setup.cfg
> @@ -123,6 +123,7 @@ multi_line_output=3
>
>   [tox:tox]
>   envlist = py36, py37, py38, py39, py310
> +skip_missing_interpreters=true
>

Didn't know this was an option, to be honest ... I wonder if it can be
toggled on/off easily? I like the idea that it will fail if we don't set up
the CI environment correctly instead of succeeding quietly.

Though, you're right, some is better than none. Send a patch if you want?

--js
Wainer dos Santos Moschetta June 30, 2021, 6:55 p.m. UTC | #3
On 6/29/21 6:27 PM, John Snow wrote:
>
>
> On Tue, Jun 29, 2021 at 4:25 PM Wainer dos Santos Moschetta 
> <wainersm@redhat.com <mailto:wainersm@redhat.com>> wrote:
>
>     Hi John,
>
>     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
>     <mailto:jsnow@redhat.com>>
>     > Reviewed-by: Willian Rampazzo <willianr@redhat.com
>     <mailto:willianr@redhat.com>>
>     > ---
>     >   python/Makefile | 8 ++++++--
>     >   1 file changed, 6 insertions(+), 2 deletions(-)
>     >
>     > 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 ""
>
>     Somewhat related... in my system I don't have all supported python
>     versions installed, thus check-tox fails.
>
>     Instead, maybe, you could configure tox (as below) to test to
>     whatever
>     supported versions the developer have installed in the system; and on
>     absence of some versions it won't fail the tests entirely.
>
>     diff --git a/python/setup.cfg b/python/setup.cfg
>     index e730f208d3..1db8aaf340 100644
>     --- a/python/setup.cfg
>     +++ b/python/setup.cfg
>     @@ -123,6 +123,7 @@ multi_line_output=3
>
>       [tox:tox]
>       envlist = py36, py37, py38, py39, py310
>     +skip_missing_interpreters=true
>
>
> Didn't know this was an option, to be honest ... I wonder if it can be 
> toggled on/off easily? I like the idea that it will fail if we don't 
> set up the CI environment correctly instead of succeeding quietly.
>
> Though, you're right, some is better than none. Send a patch if you want?


I just sent a patch. Message-Id: 
<20210630184546.456582-1-wainersm@redhat.com>

- Wainer

>
> --js
diff mbox series

Patch

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 ""