Now using virtualenv as nox backend. Added python 3.11 and 3.12. Fixed gitignore. Fixed #100

Author: Sylvain MARIE

.github/workflows/base.yml

@@ -12,24 +12,32 @@ on:
   pull_request:
     branches:
       - main
+
+defaults:
+  run:
+    shell: bash -l {0}
+
 jobs:
   # pre-job to read nox tests matrix - see https://stackoverflow.com/q/66747359/7262247
   list_nox_test_sessions:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+
+      - name: Install python 3.9
+        uses: actions/setup-python@v5.0.0
         with:
-          python-version: 3.7
+          python-version: 3.9
           architecture: x64
 
       - name: Install noxfile requirements
-        shell: bash -l {0}
         run: pip install -r noxfile-requirements.txt
 
-      - name: List 'tests' nox sessions
+      - name: List 'tests' nox sessions and required python versions
         id: set-matrix
-        run: echo "::set-output name=matrix::$(nox -s gha_list -- tests)"
+        run: echo "::set-output name=matrix::$(nox -s gha_list -- -s tests -v)"
+
     outputs:
       matrix: ${{ steps.set-matrix.outputs.matrix }}  # save nox sessions list to outputs
 
@@ -38,45 +46,72 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        # see https://github.com/actions/setup-python/issues/544
+        # os: [ ubuntu-20.04 ]
         os: [ ubuntu-latest ]  # , macos-latest, windows-latest]
         # all nox sessions: manually > dynamically from previous job
         # nox_session: ["tests-2.7", "tests-3.7"]
         nox_session: ${{ fromJson(needs.list_nox_test_sessions.outputs.matrix) }}
 
-    name: ${{ matrix.os }} ${{ matrix.nox_session }} # ${{ matrix.name_suffix }}
+    name: ${{ matrix.os }} ${{ matrix.nox_session.python }} ${{ matrix.nox_session.session }} # ${{ matrix.name_suffix }}
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+
+      - name: Install python ${{ matrix.nox_session.python }} for tests
+        uses: MatteoH2O1999/setup-python@v3.0.0  # actions/setup-python@v5.0.0
+        id: set-py
+        with:
+          python-version: ${{ matrix.nox_session.python }}
+          architecture: x64
+          allow-build: info
+          cache-build: true
 
-      # Conda install
-      - name: Install conda v3.7
-        uses: conda-incubator/setup-miniconda@v2
+      - name: Install python 3.12 for nox
+        uses: actions/setup-python@v5.0.0
         with:
-          # auto-update-conda: true
-          python-version: 3.7
-          activate-environment: noxenv
-      - run: conda info
-        shell: bash -l {0}  # so that conda works
-      - run: conda list
-        shell: bash -l {0}  # so that conda works
-
-      # Nox install + run
+          python-version: 3.12
+          architecture: x64
+
+      - name: pin virtualenv==20.15.1 in old python versions
+        # pinned to keep compatibility with old versions, see https://github.com/MatteoH2O1999/setup-python/issues/28#issuecomment-1745613621
+        if: contains(fromJson('["2.7", "3.5", "3.6"]'), matrix.nox_session.python )
+        run: sed -i "s/virtualenv/virtualenv==20.15.1/g" noxfile-requirements.txt
+
       - name: Install noxfile requirements
-        shell: bash -l {0}  # so that conda works
         run: pip install -r noxfile-requirements.txt
-      - run: conda list
-        shell: bash -l {0}  # so that conda works
-      - run: nox -s "${{ matrix.nox_session }}"
-        shell: bash -l {0}  # so that conda works
+
+      - name: Run nox session ${{ matrix.nox_session.session }}
+        run: nox -s "${{ matrix.nox_session.session }}" -v
 
       # Share ./docs/reports so that they can be deployed with doc in next job
       - name: Share reports with other jobs
-        # if: matrix.nox_session == '...': not needed, if empty wont be shared
-        uses: actions/upload-artifact@master
+        # if: matrix.nox_session == '...': not needed, if empty won't be shared
+        uses: actions/upload-artifact@v4.3.0
         with:
           name: reports_dir
           path: ./docs/reports
 
+  build_doc:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.1.1
+
+      - name: Install python 3.9 for nox
+        uses: actions/setup-python@v5.0.0
+        with:
+          python-version: 3.9
+          architecture: x64
+
+      - name: Install noxfile requirements
+        run: pip install -r noxfile-requirements.txt
+
+      - name: Build the doc including example gallery
+        run: nox -s docs -- build
+
   publish_release:
     needs: run_all_tests
     runs-on: ubuntu-latest
@@ -87,47 +122,37 @@ jobs:
           GITHUB_CONTEXT: ${{ toJSON(github) }}
         run: echo "$GITHUB_CONTEXT"
 
-      - uses: actions/checkout@v2
+      - name: Checkout with no depth
+        uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0  # so that gh-deploy works
 
+      - name: Install python 3.9 for nox
+        uses: actions/setup-python@v5.0.0
+        with:
+          python-version: 3.9
+          architecture: x64
+
       # 1) retrieve the reports generated previously
       - name: Retrieve reports
-        uses: actions/download-artifact@master
+        uses: actions/download-artifact@v4.1.1
         with:
           name: reports_dir
           path: ./docs/reports
 
-      # Conda install
-      - name: Install conda v3.7
-        uses: conda-incubator/setup-miniconda@v2
-        with:
-          # auto-update-conda: true
-          python-version: 3.7
-          activate-environment: noxenv
-      - run: conda info
-        shell: bash -l {0}  # so that conda works
-      - run: conda list
-        shell: bash -l {0}  # so that conda works
-
       # Nox install
       - name: Install noxfile requirements
-        shell: bash -l {0}  # so that conda works
         run: pip install -r noxfile-requirements.txt
-      - run: conda list
-        shell: bash -l {0}  # so that conda works
 
       # 5) Run the flake8 report and badge
       - name: Run flake8 analysis and generate corresponding badge
-        shell: bash -l {0}  # so that conda works
         run: nox -s flake8
 
       # -------------- only on Ubuntu + MAIN PUSH (no pull request, no tag) -----------
 
       # 5) Publish the doc and test reports
       - name: \[not on TAG\] Publish documentation, tests and coverage reports
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/heads')  # startsWith(matrix.os,'ubuntu')
-        shell: bash -l {0}  # so that conda works
         run: nox -s publish
 
       # 6) Publish coverage report
@@ -142,7 +167,7 @@ jobs:
           EOF
       - name: \[not on TAG\] Publish coverage report
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/heads')
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v4.0.1
         with:
           files: ./docs/reports/coverage/coverage.xml
 
@@ -151,13 +176,12 @@ jobs:
       # 7) Create github release and build the wheel
       - name: \[TAG only\] Build wheel and create github release
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-        shell: bash -l {0}  # so that conda works
         run: nox -s release -- ${{ secrets.GITHUB_TOKEN }}
 
       # 8) Publish the wheel on PyPi
       - name: \[TAG only\] Deploy on PyPi
         if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@v1.8.11
         with:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -50,7 +50,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
-makefun/_version.py
+src/makefun/_version.py
 
 # Translations
 *.mo

ci_tools/nox_utils.py

@@ -633,7 +633,8 @@ def _f_wrapper(**kwargs):
             except KeyError:
                 # Skip this session, it is a dummy one
                 nox_logger.warning(
-                    "Skipping configuration, this is not supported in python version %r" % session.python
+                    "Skipping configuration, %r is not meant to be executed in this session for python version %r" %
+                    (grid_param if has_parameter else "this", session.python)
                 )
                 return
 

noxfile-requirements.txt

@@ -1,3 +1,4 @@
+virtualenv
 nox
 toml
 makefun

noxfile.py

@@ -1,3 +1,4 @@
+import argparse
 from itertools import product
 from json import dumps
 import logging
@@ -9,16 +10,17 @@
 # add parent folder to python path so that we can import noxfile_utils.py
 # note that you need to "pip install -r noxfile-requiterements.txt" for this file to work.
 sys.path.append(str(Path(__file__).parent / "ci_tools"))
-from nox_utils import PY27, PY37, PY36, PY35, PY38, PY39, PY310, power_session, rm_folder, rm_file, PowerSession  # noqa
+from nox_utils import PY27, PY37, PY36, PY35, PY38, PY39, PY310, PY311, PY312, power_session, rm_folder, rm_file, PowerSession, DONT_INSTALL  # noqa
 
 
 pkg_name = "makefun"
 gh_org = "smarie"
 gh_repo = "python-makefun"
 
 ENVS = {
-    # python 3.10 is not available on conda yet
-    # PY310: {"coverage": False, "pkg_specs": {"pip": ">19"}},
+    PY312: {"coverage": False, "pkg_specs": {"pip": ">19"}},
+    PY311: {"coverage": False, "pkg_specs": {"pip": ">19"}},
+    PY310: {"coverage": False, "pkg_specs": {"pip": ">19"}},
     PY39: {"coverage": False, "pkg_specs": {"pip": ">19"}},
     PY38: {"coverage": False, "pkg_specs": {"pip": ">19"}},
     PY27: {"coverage": False, "pkg_specs": {"pip": ">10"}},
@@ -30,10 +32,11 @@
 
 
 # set the default activated sessions, minimal for CI
-nox.options.sessions = ["tests", "flake8"]  # , "docs", "gh_pages"
+nox.options.sessions = ["tests", "flake8", "docs"]  # , "docs", "gh_pages"
+nox.options.error_on_missing_interpreters = True
 nox.options.reuse_existing_virtualenvs = True  # this can be done using -r
 # if platform.system() == "Windows":  >> always use this for better control
-nox.options.default_venv_backend = "conda"
+nox.options.default_venv_backend = "virtualenv"
 # os.environ["NO_COLOR"] = "True"  # nox.options.nocolor = True does not work
 # nox.options.verbose = True
 
@@ -95,10 +98,10 @@ def tests(session: PowerSession, coverage, pkg_specs):
 
     # list all (conda list alone does not work correctly on github actions)
     # session.run2("conda list")
-    conda_prefix = Path(session.bin)
-    if conda_prefix.name == "bin":
-        conda_prefix = conda_prefix.parent
-    session.run2("conda list", env={"CONDA_PREFIX": str(conda_prefix), "CONDA_DEFAULT_ENV": session.get_session_id()})
+    # conda_prefix = Path(session.bin)
+    # if conda_prefix.name == "bin":
+    #     conda_prefix = conda_prefix.parent
+    # session.run2("conda list", env={"CONDA_PREFIX": str(conda_prefix), "CONDA_DEFAULT_ENV": session.get_session_id()})
 
     # Fail if the assumed python version is not the actual one
     session.run2("python ci_tools/check_python_version.py %s" % session.python)
@@ -111,7 +114,6 @@ def tests(session: PowerSession, coverage, pkg_specs):
     if not coverage:
         # install self so that it is recognized by pytest
         session.run2("pip install . --no-deps")
-        # session.install(".", "--no-deps")
 
         # simple: pytest only
         session.run2("python -m pytest --cache-clear -v tests/")
@@ -141,7 +143,7 @@ def tests(session: PowerSession, coverage, pkg_specs):
         session.run2("genbadge coverage -i %s -o %s" % (Folders.coverage_xml, Folders.coverage_badge))
 
 
-@power_session(python=PY38, logsdir=Folders.runlogs)
+@power_session(python=PY39, logsdir=Folders.runlogs)
 def flake8(session: PowerSession):
     """Launch flake8 qualimetry."""
 
@@ -162,7 +164,7 @@ def flake8(session: PowerSession):
     rm_file(Folders.flake8_intermediate_file)
 
 
-@power_session(python=[PY37])
+@power_session(python=[PY39])
 def docs(session: PowerSession):
     """Generates the doc and serves it on a local http server. Pass '-- build' to build statically instead."""
 
@@ -175,11 +177,11 @@ def docs(session: PowerSession):
         session.run2("mkdocs serve")
 
 
-@power_session(python=[PY37])
+@power_session(python=[PY39])
 def publish(session: PowerSession):
     """Deploy the docs+reports on github pages. Note: this rebuilds the docs"""
 
-    session.install_reqs(phase="mkdocs", phase_reqs=["mkdocs-material", "mkdocs", "pymdown-extensions", "pygments"])
+    session.install_reqs(phase="publish", phase_reqs=["mkdocs-material", "mkdocs", "pymdown-extensions", "pygments"])
 
     # possibly rebuild the docs in a static way (mkdocs serve does not build locally)
     session.run2("mkdocs build")
@@ -200,7 +202,7 @@ def publish(session: PowerSession):
     # session.run2('codecov -t %s -f %s' % (codecov_token, Folders.coverage_xml))
 
 
-@power_session(python=[PY37])
+@power_session(python=[PY39])
 def release(session: PowerSession):
     """Create a release on github corresponding to the latest tag"""
 
@@ -261,19 +263,36 @@ def gha_list(session):
 
     # see https://stackoverflow.com/q/66747359/7262247
 
+    # The options
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-s", "--session", help="The nox base session name")
+    parser.add_argument(
+        "-v",
+        "--with_version",
+        action="store_true",
+        default=False,
+        help="Return a list of lists where the first element is the python version and the second the nox session.",
+    )
+    additional_args = parser.parse_args(session.posargs)
+
     # get the desired base session to generate the list for
-    if len(session.posargs) != 1:
-        raise ValueError("This session has a mandatory argument: <base_session_name>")
-    session_func = globals()[session.posargs[0]]
+    session_func = globals()[additional_args.session]
 
     # list all sessions for this base session
     try:
         session_func.parametrize
     except AttributeError:
-        sessions_list = ["%s-%s" % (session_func.__name__, py) for py in session_func.python]
+        if additional_args.with_version:
+            sessions_list = [{"python": py, "session": "%s-%s" % (session_func.__name__, py)} for py in session_func.python]
+        else:
+            sessions_list = ["%s-%s" % (session_func.__name__, py) for py in session_func.python]
     else:
-        sessions_list = ["%s-%s(%s)" % (session_func.__name__, py, param)
-                         for py, param in product(session_func.python, session_func.parametrize)]
+        if additional_args.with_version:
+            sessions_list = [{"python": py, "session": "%s-%s(%s)" % (session_func.__name__, py, param)}
+                             for py, param in product(session_func.python, session_func.parametrize)]
+        else:
+            sessions_list = ["%s-%s(%s)" % (session_func.__name__, py, param)
+                             for py, param in product(session_func.python, session_func.parametrize)]
 
     # print the list so that it can be caught by GHA.
     # Note that json.dumps is optional since this is a list of string.