use arguments fill, fill_platforms, fill_factors

Author: zacharyburnett

.github/workflows/test_tox.yml

@@ -82,7 +82,11 @@ jobs:
   test_supported_pythons:
     uses: ./.github/workflows/tox.yml
     with:
-      envs: ''
+      envs: |
+        - linux: py3
+      fill: true
+      fill_platforms: linux
+      fill_factors: xdist
       pytest: false
 
   test_libraries:

.github/workflows/tox.yml

@@ -7,6 +7,21 @@ on:
         description: Array of tox environments to test
         required: true
         type: string
+      fill:
+        description: Add an extra toxenv to the matrix for each current version of Python supported by the package
+        required: false
+        default: false
+        type: boolean
+      fill_platforms:
+        description: Platforms to iterate with fill
+        required: false
+        default: ''
+        type: string
+      fill_factors:
+        description: Tox factors to add to toxenvs added with `fill`
+        required: false
+        default: ''
+        type: string
       libraries:
         description: Additional packages to install
         required: false
@@ -123,20 +138,17 @@ jobs:
       - uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
         with:
           python-version: '3.12'
-      - if: inputs.envs == ''
+      - if: inputs.fill
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
         with:
-          fetch-depth: 0
-          lfs: true
-          submodules: ${{ inputs.submodules }}
           ref: ${{ inputs.checkout_ref }}
-      - if: inputs.envs == ''
+      - if: inputs.fill
         run: echo $SUPPORTED_PYTHONS_SCRIPT | base64 --decode > supported_pythons.py
         env:
-          SUPPORTED_PYTHONS_SCRIPT: IyAvLy8gc2NyaXB0CiMgcmVxdWlyZXMtcHl0aG9uID0gIj49My4xMiIKIyBkZXBlbmRlbmNpZXMgPSBbCiMgICAgICJjbGljaz09OC4yLjEiLAojICAgICAicGVwcHlwcm9qZWN0PT0xLjAuMiIsCiMgICAgICJyZXF1ZXN0cz09Mi4zMi41IiwKIyAgICAgInBhY2thZ2luZz09MjUuMCIsCiMgXQojIC8vLwppbXBvcnQgb3MKaW1wb3J0IHdhcm5pbmdzCmZyb20gcGF0aGxpYiBpbXBvcnQgUGF0aAoKaW1wb3J0IGNsaWNrCmltcG9ydCByZXF1ZXN0cwpmcm9tIHBhY2thZ2luZy5zcGVjaWZpZXJzIGltcG9ydCBTcGVjaWZpZXJTZXQKZnJvbSBwYWNrYWdpbmcudmVyc2lvbiBpbXBvcnQgVmVyc2lvbgpmcm9tIHBlcHB5cHJvamVjdCBpbXBvcnQgUHlQcm9qZWN0Q29uZmlndXJhdGlvbgoKCkBjbGljay5jb21tYW5kKCkKQGNsaWNrLm9wdGlvbigiLS1zb3VyY2UiLCBkZWZhdWx0PU5vbmUpCkBjbGljay5vcHRpb24oIi0tZmxhZ3MiLCBkZWZhdWx0PU5vbmUpCkBjbGljay5vcHRpb24oIi0tbm8tZW9hcyIsIGlzX2ZsYWc9VHJ1ZSwgZGVmYXVsdD1GYWxzZSkKQGNsaWNrLm9wdGlvbigiLS1wbGF0Zm9ybXMiLCBkZWZhdWx0PU5vbmUpCmRlZiBzdXBwb3J0ZWRfcHl0aG9uX2VudnNfYmxvY2soCiAgICBzb3VyY2U6IFBhdGggPSBOb25lLAogICAgZmxhZ3M6IGxpc3Rbc3RyXSA9IE5vbmUsCiAgICBub19lb2FzOiBib29sID0gRmFsc2UsCiAgICBwbGF0Zm9ybXM6IGxpc3Rbc3RyXSA9IE5vbmUsCik6CiAgICAiIiJlbnVtZXJhdGUgdG94ZW52cyBQeXRob24gZnJvbSBhIHBhY2thZ2Ugc291cmNlIiIiCgogICAgaWYgcGxhdGZvcm1zIGlzIE5vbmU6CiAgICAgICAgcGxhdGZvcm1zID0gWyJsaW51eCJdCiAgICBlbGlmIGlzaW5zdGFuY2UocGxhdGZvcm1zLCBzdHIpOgogICAgICAgIHBsYXRmb3JtcyA9IHBsYXRmb3Jtcy5zcGxpdCgiLCIpCgogICAgdG94ZW52cyA9IHN1cHBvcnRlZF9weXRob25fdG94ZW52cyhzb3VyY2UsIGZsYWdzLCBub19lb2FzKQogICAgZW52c19ibG9jayA9ICJcXG4iLmpvaW4oCiAgICAgICAgZiItIHtwbGF0Zm9ybX06IHt0b3hlbnZ9IiBmb3IgcGxhdGZvcm0gaW4gcGxhdGZvcm1zIGZvciB0b3hlbnYgaW4gdG94ZW52cwogICAgKQoKICAgIHByaW50KGVudnNfYmxvY2spCiAgICB3aXRoIG9wZW4ob3MuZW52aXJvblsiR0lUSFVCX09VVFBVVCJdLCAiYSIpIGFzIGY6CiAgICAgICAgZi53cml0ZShmImVudnM9e2VudnNfYmxvY2t9XG4iKQoKCmRlZiBzdXBwb3J0ZWRfcHl0aG9uX3RveGVudnMoCiAgICBzb3VyY2U6IFBhdGggPSBOb25lLAogICAgZmxhZ3M6IGxpc3Rbc3RyXSA9IE5vbmUsCiAgICBub19lb2FzOiBib29sID0gRmFsc2UsCikgLT4gbGlzdFtzdHJdOgogICAgY3VycmVudF9weXRob25zID0gY3VycmVudF9weXRob25fdmVyc2lvbnMobm9fZW9hcz1ub19lb2FzKQoKICAgIGlmIHNvdXJjZSBpcyBOb25lIG9yIHNvdXJjZSA9PSAiIjoKICAgICAgICBzdXBwb3J0ZWRfcHl0aG9ucyA9IGN1cnJlbnRfcHl0aG9ucwogICAgZWxzZToKICAgICAgICBjb25maWd1cmF0aW9uID0gUHlQcm9qZWN0Q29uZmlndXJhdGlvbi5mcm9tX2RpcmVjdG9yeShzb3VyY2UpCiAgICAgICAgdHJ5OgogICAgICAgICAgICBweXRob25fcmVxdWlyZW1lbnRzID0gU3BlY2lmaWVyU2V0KGNvbmZpZ3VyYXRpb25bInByb2plY3QiXVsicmVxdWlyZXMtcHl0aG9uIl0pCgogICAgICAgICAgICBzdXBwb3J0ZWRfcHl0aG9ucyA9IFsKICAgICAgICAgICAgICAgIHB5dGhvbiBmb3IgcHl0aG9uIGluIGN1cnJlbnRfcHl0aG9ucyBpZiBweXRob24gaW4gcHl0aG9uX3JlcXVpcmVtZW50cwogICAgICAgICAgICBdCiAgICAgICAgZXhjZXB0IChLZXlFcnJvciwgVHlwZUVycm9yKToKICAgICAgICAgICAgd2FybmluZ3Mud2FybigKICAgICAgICAgICAgICAgICJjb3VsZCBub3QgZmluZCBgcmVxdWlyZXMtcHl0aG9uYCBpbiBtZXRhZGF0YTsgZmFsbGluZyBiYWNrIHRvIGN1cnJlbnQgUHl0aG9uIHZlcnNpb25zLi4uIgogICAgICAgICAgICApCiAgICAgICAgICAgIHN1cHBvcnRlZF9weXRob25zID0gY3VycmVudF9weXRob25zCgogICAgcmV0dXJuIFsKICAgICAgICBmInB5e3N0cihweXRob24pLnJlcGxhY2UoJy4nLCAnJyl9eyctJyArICctJy5qb2luKGZsYWdzKSBpZiBmbGFncyBpcyBub3QgTm9uZSBhbmQgbGVuKGZsYWdzKSA+IDAgZWxzZSAnJ30iCiAgICAgICAgZm9yIHB5dGhvbiBpbiBzdXBwb3J0ZWRfcHl0aG9ucwogICAgXQoKCmRlZiBjdXJyZW50X3B5dGhvbl92ZXJzaW9ucyhub19lb2FzOiBib29sID0gRmFsc2UpIC0+IGxpc3RbVmVyc2lvbl06CiAgICB1cmwgPSAiaHR0cHM6Ly9lbmRvZmxpZmUuZGF0ZS9hcGkvdjEvcHJvZHVjdHMvcHl0aG9uIgogICAgcmVzcG9uc2UgPSByZXF1ZXN0cy5nZXQoImh0dHBzOi8vZW5kb2ZsaWZlLmRhdGUvYXBpL3YxL3Byb2R1Y3RzL3B5dGhvbiIpCiAgICBpZiByZXNwb25zZS5zdGF0dXNfY29kZSA9PSAyMDA6CiAgICAgICAgcmV0dXJuIFsKICAgICAgICAgICAgVmVyc2lvbihweXRob25bIm5hbWUiXSkKICAgICAgICAgICAgZm9yIHB5dGhvbiBpbiByZXNwb25zZS5qc29uKClbInJlc3VsdCJdWyJyZWxlYXNlcyJdCiAgICAgICAgICAgIGlmIG5vdCBweXRob25bImlzRW9hcyIgaWYgbm9fZW9hcyBlbHNlICJpc0VvbCJdCiAgICAgICAgXQogICAgZWxzZToKICAgICAgICByYWlzZSBWYWx1ZUVycm9yKGYicmVxdWVzdCByZXR1cm5lZCBzdGF0dXMgY29kZSB7cmVzcG9uc2Uuc3RhdHVzX2NvZGV9IFt7dXJsfV0iKQoKCmlmIF9fbmFtZV9fID09ICJfX21haW5fXyI6CiAgICBzdXBwb3J0ZWRfcHl0aG9uX2VudnNfYmxvY2soKQo=
-      - if: inputs.envs == ''
-        id: get-envs
-        run: pipx run supported_pythons.py --platforms linux --source .
+          SUPPORTED_PYTHONS_SCRIPT: IyAvLy8gc2NyaXB0CiMgcmVxdWlyZXMtcHl0aG9uID0gIj49My4xMiIKIyBkZXBlbmRlbmNpZXMgPSBbCiMgICAgICJjbGljaz09OC4yLjEiLAojICAgICAicGVwcHlwcm9qZWN0PT0xLjAuMiIsCiMgICAgICJyZXF1ZXN0cz09Mi4zMi41IiwKIyAgICAgInBhY2thZ2luZz09MjUuMCIsCiMgXQojIC8vLwppbXBvcnQgb3MKaW1wb3J0IHdhcm5pbmdzCmZyb20gcGF0aGxpYiBpbXBvcnQgUGF0aAoKaW1wb3J0IGNsaWNrCmltcG9ydCByZXF1ZXN0cwpmcm9tIHBhY2thZ2luZy5zcGVjaWZpZXJzIGltcG9ydCBTcGVjaWZpZXJTZXQKZnJvbSBwYWNrYWdpbmcudmVyc2lvbiBpbXBvcnQgVmVyc2lvbgpmcm9tIHBlcHB5cHJvamVjdCBpbXBvcnQgUHlQcm9qZWN0Q29uZmlndXJhdGlvbgoKCkBjbGljay5jb21tYW5kKCkKQGNsaWNrLm9wdGlvbigiLS1zb3VyY2UiLCBkZWZhdWx0PU5vbmUpCkBjbGljay5vcHRpb24oIi0tZmFjdG9ycyIsIGRlZmF1bHQ9Tm9uZSkKQGNsaWNrLm9wdGlvbigiLS1uby1lb2FzIiwgaXNfZmxhZz1UcnVlLCBkZWZhdWx0PUZhbHNlKQpAY2xpY2sub3B0aW9uKCItLXBsYXRmb3JtcyIsIGRlZmF1bHQ9Tm9uZSkKZGVmIHN1cHBvcnRlZF9weXRob25fZW52c19ibG9jaygKICAgIHNvdXJjZTogUGF0aCA9IE5vbmUsCiAgICBmYWN0b3JzOiBsaXN0W3N0cl0gPSBOb25lLAogICAgbm9fZW9hczogYm9vbCA9IEZhbHNlLAogICAgcGxhdGZvcm1zOiBsaXN0W3N0cl0gPSBOb25lLAopOgogICAgIiIiZW51bWVyYXRlIHRveGVudnMgUHl0aG9uIGZyb20gYSBwYWNrYWdlIHNvdXJjZSIiIgoKICAgIGlmIHBsYXRmb3JtcyBpcyBOb25lOgogICAgICAgIHBsYXRmb3JtcyA9IFsibGludXgiXQogICAgZWxpZiBpc2luc3RhbmNlKHBsYXRmb3Jtcywgc3RyKToKICAgICAgICBwbGF0Zm9ybXMgPSBwbGF0Zm9ybXMuc3BsaXQoIiwiKQoKICAgIHRveGVudnMgPSBzdXBwb3J0ZWRfcHl0aG9uX3RveGVudnMoc291cmNlLCBmYWN0b3JzLCBub19lb2FzKQogICAgZW52c19ibG9jayA9ICJcXG4iLmpvaW4oCiAgICAgICAgZiItIHtwbGF0Zm9ybX06IHt0b3hlbnZ9IiBmb3IgcGxhdGZvcm0gaW4gcGxhdGZvcm1zIGZvciB0b3hlbnYgaW4gdG94ZW52cwogICAgKQoKICAgIHByaW50KGVudnNfYmxvY2spCiAgICB3aXRoIG9wZW4ob3MuZW52aXJvblsiR0lUSFVCX09VVFBVVCJdLCAiYSIpIGFzIGY6CiAgICAgICAgZi53cml0ZShmImVudnM9e2VudnNfYmxvY2t9XG4iKQoKCmRlZiBzdXBwb3J0ZWRfcHl0aG9uX3RveGVudnMoCiAgICBzb3VyY2U6IFBhdGggPSBOb25lLAogICAgZmFjdG9yczogbGlzdFtzdHJdID0gTm9uZSwKICAgIG5vX2VvYXM6IGJvb2wgPSBGYWxzZSwKKSAtPiBsaXN0W3N0cl06CiAgICBpZiBpc2luc3RhbmNlKGZhY3RvcnMsIHN0cik6CiAgICAgICAgZmFjdG9ycyA9IGZhY3RvcnMuc3BsaXQoIiwiKQoKICAgIGN1cnJlbnRfcHl0aG9ucyA9IGN1cnJlbnRfcHl0aG9uX3ZlcnNpb25zKG5vX2VvYXM9bm9fZW9hcykKCiAgICBpZiBzb3VyY2UgaXMgTm9uZSBvciBzb3VyY2UgPT0gIiI6CiAgICAgICAgc3VwcG9ydGVkX3B5dGhvbnMgPSBjdXJyZW50X3B5dGhvbnMKICAgIGVsc2U6CiAgICAgICAgY29uZmlndXJhdGlvbiA9IFB5UHJvamVjdENvbmZpZ3VyYXRpb24uZnJvbV9kaXJlY3Rvcnkoc291cmNlKQogICAgICAgIHRyeToKICAgICAgICAgICAgcHl0aG9uX3JlcXVpcmVtZW50cyA9IFNwZWNpZmllclNldChjb25maWd1cmF0aW9uWyJwcm9qZWN0Il1bInJlcXVpcmVzLXB5dGhvbiJdKQoKICAgICAgICAgICAgc3VwcG9ydGVkX3B5dGhvbnMgPSBbCiAgICAgICAgICAgICAgICBweXRob24gZm9yIHB5dGhvbiBpbiBjdXJyZW50X3B5dGhvbnMgaWYgcHl0aG9uIGluIHB5dGhvbl9yZXF1aXJlbWVudHMKICAgICAgICAgICAgXQogICAgICAgIGV4Y2VwdCAoS2V5RXJyb3IsIFR5cGVFcnJvcik6CiAgICAgICAgICAgIHdhcm5pbmdzLndhcm4oCiAgICAgICAgICAgICAgICAiY291bGQgbm90IGZpbmQgYHJlcXVpcmVzLXB5dGhvbmAgaW4gbWV0YWRhdGE7IGZhbGxpbmcgYmFjayB0byBjdXJyZW50IFB5dGhvbiB2ZXJzaW9ucy4uLiIKICAgICAgICAgICAgKQogICAgICAgICAgICBzdXBwb3J0ZWRfcHl0aG9ucyA9IGN1cnJlbnRfcHl0aG9ucwoKICAgIHJldHVybiBbCiAgICAgICAgZiJweXtzdHIocHl0aG9uKS5yZXBsYWNlKCcuJywgJycpfXsnLScgKyAnLScuam9pbihmYWN0b3JzKSBpZiBmYWN0b3JzIGlzIG5vdCBOb25lIGFuZCBsZW4oZmFjdG9ycykgPiAwIGVsc2UgJyd9IgogICAgICAgIGZvciBweXRob24gaW4gc3VwcG9ydGVkX3B5dGhvbnMKICAgIF0KCgpkZWYgY3VycmVudF9weXRob25fdmVyc2lvbnMobm9fZW9hczogYm9vbCA9IEZhbHNlKSAtPiBsaXN0W1ZlcnNpb25dOgogICAgdXJsID0gImh0dHBzOi8vZW5kb2ZsaWZlLmRhdGUvYXBpL3YxL3Byb2R1Y3RzL3B5dGhvbiIKICAgIHJlc3BvbnNlID0gcmVxdWVzdHMuZ2V0KCJodHRwczovL2VuZG9mbGlmZS5kYXRlL2FwaS92MS9wcm9kdWN0cy9weXRob24iKQogICAgaWYgcmVzcG9uc2Uuc3RhdHVzX2NvZGUgPT0gMjAwOgogICAgICAgIHJldHVybiBbCiAgICAgICAgICAgIFZlcnNpb24ocHl0aG9uWyJuYW1lIl0pCiAgICAgICAgICAgIGZvciBweXRob24gaW4gcmVzcG9uc2UuanNvbigpWyJyZXN1bHQiXVsicmVsZWFzZXMiXQogICAgICAgICAgICBpZiBub3QgcHl0aG9uWyJpc0VvYXMiIGlmIG5vX2VvYXMgZWxzZSAiaXNFb2wiXQogICAgICAgIF0KICAgIGVsc2U6CiAgICAgICAgcmFpc2UgVmFsdWVFcnJvcihmInJlcXVlc3QgcmV0dXJuZWQgc3RhdHVzIGNvZGUge3Jlc3BvbnNlLnN0YXR1c19jb2RlfSBbe3VybH1dIikKCgppZiBfX25hbWVfXyA9PSAiX19tYWluX18iOgogICAgc3VwcG9ydGVkX3B5dGhvbl9lbnZzX2Jsb2NrKCkK
+      - if: inputs.fill
+        id: supported-pythons
+        run: pipx run supported_pythons.py --source . ${{ inputs.fill_platforms != '' && format('--platforms {}', inputs.fill_platforms) || '' }} ${{ inputs.fill_factors != '' && format('--factors {}', inputs.fill_factors) || '' }}
         shell: sh
       - run: echo $TOX_MATRIX_SCRIPT | base64 --decode > tox_matrix.py
         env:
@@ -145,7 +157,7 @@ jobs:
       - id: set-outputs
         run: |
           pipx run tox_matrix.py \
-          --envs "${{ inputs.envs != '' && inputs.envs || steps.get-envs.outputs.envs }}" \
+          --envs "${{ !inputs.fill && inputs.envs || format("{}\n{}", inputs.envs, steps.supported-pythons.outputs.envs) }}" \
           --libraries "${{ inputs.libraries }}" \
           --posargs "${{ inputs.posargs }}" --toxdeps "${{ inputs.toxdeps }}" \
           --toxargs "${{ inputs.toxargs }}" --pytest "${{ inputs.pytest }}" \

tools/supported_pythons.py

@@ -20,12 +20,12 @@
 
 @click.command()
 @click.option("--source", default=None)
-@click.option("--flags", default=None)
+@click.option("--factors", default=None)
 @click.option("--no-eoas", is_flag=True, default=False)
 @click.option("--platforms", default=None)
 def supported_python_envs_block(
     source: Path = None,
-    flags: list[str] = None,
+    factors: list[str] = None,
     no_eoas: bool = False,
     platforms: list[str] = None,
 ):
@@ -36,7 +36,7 @@ def supported_python_envs_block(
     elif isinstance(platforms, str):
         platforms = platforms.split(",")
 
-    toxenvs = supported_python_toxenvs(source, flags, no_eoas)
+    toxenvs = supported_python_toxenvs(source, factors, no_eoas)
     envs_block = "\\n".join(
         f"- {platform}: {toxenv}" for platform in platforms for toxenv in toxenvs
     )
@@ -48,9 +48,12 @@ def supported_python_envs_block(
 
 def supported_python_toxenvs(
     source: Path = None,
-    flags: list[str] = None,
+    factors: list[str] = None,
     no_eoas: bool = False,
 ) -> list[str]:
+    if isinstance(factors, str):
+        factors = factors.split(",")
+
     current_pythons = current_python_versions(no_eoas=no_eoas)
 
     if source is None or source == "":
@@ -70,7 +73,7 @@ def supported_python_toxenvs(
             supported_pythons = current_pythons
 
     return [
-        f"py{str(python).replace('.', '')}{'-' + '-'.join(flags) if flags is not None and len(flags) > 0 else ''}"
+        f"py{str(python).replace('.', '')}{'-' + '-'.join(factors) if factors is not None and len(factors) > 0 else ''}"
         for python in supported_pythons
     ]