Command "sage -tox"

[mkoeppe]

This will run tox using src/tox.ini.

Entry point for doctesting and linting: See ./sage -tox -l -v or (cd src && tox -l -v).

Depends on #30408

CC: @tobiasdiez @dimpase @jhpalmieri @fchapoton

Component: doctest framework

Author: Matthias Koeppe

Branch: eba708b

Reviewer: Dima Pasechnik

Issue created by migration from https://trac.sagemath.org/ticket/30410

[mkoeppe]

Branch: u/mkoeppe/command__sage__tox_

[mkoeppe]

New commits:

5ccccbb

sage --tox

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

Commit: 5ccccbb

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,4 @@
 This will run tox using `src/tox.ini`.
 
 Entry point for doctesting and linting.
-
+(#30408 adds more functionality.)

[tobiasdiez]

comment:3

Instead of putting more into the bin/sage script, wouldn't it make sense to actually extract all building and testing related code to tox? So instead of sage -b (sage -t) you run tox build (tox test respectively). This would leave the sage script only with the functionality that a user needs to run sage.

(also I don't see any advantages of sage -tox pycodestyle over tox pycodestyle)

[tobiasdiez]

comment:4

Whatever the final interface looks like, the documentation needs to be changed as well to reflect this. In particular, this ticket depends on #30361.

[tobiasdiez]

Dependencies: 30361

[mkoeppe]

comment:5

Replying to @tobiasdiez:

Instead of putting more into the bin/sage script, wouldn't it make sense to actually extract all building and testing related code to tox? So instead of sage -b (sage -t) you run tox build (tox test respectively). This would leave the sage script only with the functionality that a user needs to run sage.

Some projects are indeed using tox also for building, but I think I would like to keep it for testing only. At least for now - we can't make too many changes at the same time so that our developer community is not overwhelmed.

sage -coverage and sage -startuptime, however, should definitely become tox environments.

(also I don't see any advantages of sage -tox pycodestyle over tox pycodestyle)

The difference is that sage -tox would also work with src/tox.ini when called from SAGE_ROOT. (There's another tox.ini in SAGE_ROOT for a different purpose - testing of the sage distribution.)

And it can give a hint to install tox when it is not available.

[mkoeppe]

Changed dependencies from 30361 to #30408, #30361

[sagetrac-git]

Changed commit from 5ccccbb to 8574448

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

1cedc00	Add configuration of pycodestyle via tox
dde3b4f	src/tox.ini: Add testenv:pycodestyle
939e9e0	src/tox.ini: Better default arg testenv:pycodestyle
583bde5	Merge branch 't/30408/public/build/pycodestyleConfig' into t/30410/command__sage__tox_
8574448	src/tox.ini: Add coverage, startuptime; refactor, add descriptions

[mkoeppe]

Changed dependencies from #30408, #30361 to #30408

[mkoeppe]

Description changed:

--- 
+++ 
@@ -1,4 +1,8 @@
 This will run tox using `src/tox.ini`.
 
-Entry point for doctesting and linting.
-(#30408 adds more functionality.)
+Entry point for doctesting and linting: See `./sage -tox -l -v` or `(cd src && tox -l -v)`.
+
+
+
+
+

[mkoeppe]

comment:8

I don't think #30361 needs to be a dependency.