Read python version from pyproject.toml (fix #542) #669

dariocurr · 2023-05-22T19:38:14Z

Hi, I'm Dario, a tech PO at hiop.

Description:
This PR enables the action to read the Python version from the pyproject.toml file (or another TOML file if specified) both for standard python (PEP 621, PEP 508) and poetry (https://python-poetry.org/docs/basic-usage/).

More in detail, it deserializes the TOML files using the toml package and then navigates it to extract the Python versions.

Related issue:

Automatic Python version determination from pyproject.toml #542

Check list:

Mark if documentation changes are required.
Mark if tests were added or updated to cover the changes.

Notes:

Is there a specific reason not to test the src/setup-python.ts? I didn't find any test related to those functions
>=3.9,<=3.10 bounds are transformed in semver-like bounds
In addition to the tests for this new feature, I added some missing tests. For example.

.python-version file used if no parameters are provided .github/workflows/test-python.yml
python version provided with bounds .github/workflows/e2e-tests.yml

dariocurr · 2023-06-02T09:51:27Z

Is anyone maintaining this action?

dmitry-shibanov · 2023-06-06T12:05:25Z

Hello @dariocurr. Sorry for the late response. Could you please fix the code because it looks like you have the recursive calling of some function.

dariocurr · 2023-06-06T12:32:10Z

Sorry, I fixed it, it was a silly error.
I thought the workflows were failing because I was overshooting the API calls

dariocurr · 2023-06-07T17:39:57Z

I guess we are ready to give it another run

dariocurr · 2023-06-08T10:06:27Z

Can I have more info about the failing test?

dmitry-shibanov · 2023-06-08T11:47:36Z

Hello @dariocurr. If I understood correctly you changed that python-version input could accept values from toml files ? If it's so could you please change to python-version-file input only. Besides, I'm not sure about toml library because the last update was 4 years ago. Can we achieve required behaviour without extra library ?

dariocurr · 2023-06-08T11:56:24Z

I didn't understand your first request, can you please explain it better?
About the TOML package, sure I can look for a newer and maintained package, but parsing a TOML manually seems silly to me

dariocurr · 2023-06-10T09:39:57Z

I replaced toml with @iarna/toml which as you can see here should not have any vulnerabilities and it's probably the best option.
I don't want to implement a custom TOML parser. It sounds like reinventing the wheel to me.
Many packages are old and not maintained anymore because there is nothing new and there is no need to update them

dist/setup/index.js

+  }).join('\n')
+  if (escaped.slice(-1) === '"') escaped += '\\\n'
+  return '"""\n' + escaped + '"""'
+}


dariocurr · 2023-06-19T16:18:12Z

I don't have a clue about the failing checks and CodeQL issue

dmitry-shibanov · 2023-06-19T16:57:06Z

.github/workflows/e2e-tests.yml

+      - name: Run with setup-python ==3.8
+        uses: ./
+        with:
+          python-version: '==3.8'


Could you please keep syntax specific for toml files for python-version-file

Can you explain better the expected behaviour you desire?

It's quite difficult for me to keep up with this PR with feedbacks once a week

Previously such type of syntax was not supported by setup-python. If I understood correctly it comes from the toml file log. I'd like to keep this logic in the scope of python-version-file input.

You already supported it because you parse versions using semver. I did not change the parsing behavior.

You were already supporting it, but you were not testing it.

Thank you for your response @dariocurr. It is right that '==3.8' is supported by SemVer but as I suppose that >=3.8,<3.10 is not supported. If it is so could you please keep logic regarding to toml to python-version-file parsing.

That's why I added this line to convert >=3.8,<3.10 to >=3.8 <3.10:
https://github.com/dariocurr/setup-python/blob/6f8266d242a075e81d1967d6165cd0af7e56d049/src/setup-python.ts#L73

It is right that we need to change it to SemVer syntax but I'd like to keep it this syntax for in scope of python-version-file input so when you get it from the toml file it get parsed but it should not be allowed to pass it through python-version input.

Done with 39c1ae5

dmitry-shibanov · 2023-06-27T08:41:08Z

src/setup-python.ts

-  if (versions.length && versionFile) {
-    core.warning(
-      'Both python-version and python-version-file inputs are specified, only python-version will be used.'
+function resolveVersionInputFromDefaultFile(): string[] {


Could you please remove pyproject.toml. We'd like to keep only .python-version file as a default option.

IMHO it would be a nice option since is the python standard (PEP 621) and this action is called setup-python.
But as you wish. I edited it in the latest commit

dariocurr · 2023-06-28T12:34:22Z

I fixed the test that was failing

dariocurr · 2023-06-28T13:24:27Z

I fixed also the prettier issue

dariocurr · 2023-06-28T16:15:44Z

Ready to go?

dmitry-shibanov · 2023-06-28T20:02:54Z

Hello @dariocurr. Thank you for your pull request. I'll test the action additionally this week. After that we'll prepare a new release next week.

BrandonLWhite · 2023-06-28T21:14:59Z

Wow! Thanks @dariocurr for implementing this and sticking with it! Little improvements to the Python ecosystem like this that simplify and unify project config are huge benefits.

dariocurr · 2023-06-29T08:37:02Z

Thank you for accepting the PR.
It is a pleasure to contribute to such an impactful project.
Feel free to contact me if you have any problems during testing or need help with future new features!

dariocurr · 2023-07-10T16:31:05Z

When will it be released?

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/setup-python](https://togithub.com/actions/setup-python) | action | major | `v2.2.2` -> `v4.7.0` | | [canonical/data-platform-workflows](https://togithub.com/canonical/data-platform-workflows) | action | major | `v2` -> `v4` | --- ### Release Notes <details> <summary>actions/setup-python (actions/setup-python)</summary> ### [`v4.7.0`](https://togithub.com/actions/setup-python/releases/tag/v4.7.0) [Compare Source](https://togithub.com/actions/setup-python/compare/v4.6.1...v4.7.0) In scope of this release, the support for reading python version from pyproject.toml was added ([https://github.com/actions/setup-python/pull/669](https://togithub.com/actions/setup-python/pull/669)). ```yaml - name: Setup Python uses: actions/setup-python@v4 with: python-version-file: pyproject.toml ``` ##### Besides, it includes such changes as: - Bump tough-cookie and [@azure/ms-rest-js](https://togithub.com/azure/ms-rest-js) by [@dependabot](https://togithub.com/dependabot) in [https://github.com/actions/setup-python/pull/697](https://togithub.com/actions/setup-python/pull/697) - Bump semver from 7.3.8 to 7.5.2 by [@dependabot](https://togithub.com/dependabot) in [https://github.com/actions/setup-python/pull/692](https://togithub.com/actions/setup-python/pull/692) - Fix typos found by codespell by [@DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) in [https://github.com/actions/setup-python/pull/650](https://togithub.com/actions/setup-python/pull/650) #### New Contributors - [@dariocurr](https://togithub.com/dariocurr) made their first contribution in [https://github.com/actions/setup-python/pull/669](https://togithub.com/actions/setup-python/pull/669) - [@DimitriPapadopoulos](https://togithub.com/DimitriPapadopoulos) made their first contribution in [https://github.com/actions/setup-python/pull/650](https://togithub.com/actions/setup-python/pull/650) **Full Changelog**: actions/setup-python@v4...v4.7.0 ### [`v4.6.1`](https://togithub.com/actions/setup-python/releases/tag/v4.6.1) [Compare Source](https://togithub.com/actions/setup-python/compare/v4.6.0...v4.6.1) #### What's Changed - Fix `allow-prereleases` sample configuration by [@mayeut](https://togithub.com/mayeut) in [https://github.com/actions/setup-python/pull/615](https://togithub.com/actions/setup-python/pull/615) - Fix a incorrect link advanced-usage.md by [@siyuan0322](https://togithub.com/siyuan0322) in [https://github.com/actions/setup-python/pull/657](https://togithub.com/actions/setup-python/pull/657) - Remove implicit dependency by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-python/pull/668](https://togithub.com/actions/setup-python/pull/668) - Automatic update of configuration files from 05/23/2023 by [@github-actions](https://togithub.com/github-actions) in [https://github.com/actions/setup-python/pull/671](https://togithub.com/actions/setup-python/pull/671) - Add warning for python 2.7 on release/v4 by [@dmitry-shibanov](https://togithub.com/dmitry-shibanov) in [https://github.com/actions/setup-python/pull/673](https://togithub.com/actions/setup-python/pull/673) #### New Contributors - [@siyuan0322](https://togithub.com/siyuan0322) made their first contribution in [https://github.com/actions/setup-python/pull/657](https://togithub.com/actions/setup-python/pull/657) - [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) made their first contribution in [https://github.com/actions/setup-python/pull/668](https://togithub.com/actions/setup-python/pull/668) **Full Changelog**: actions/setup-python@v4...v4.6.1 ### [`v4.6.0`](https://togithub.com/actions/setup-python/releases/tag/v4.6.0): Add allow-prereleases input [Compare Source](https://togithub.com/actions/setup-python/compare/v4.5.0...v4.6.0) In scope of this release we added a new input (`allow-prereleases`) to allow [falling back to pre-release versions of Python when a matching GA version of Python is not available](https://togithub.com/actions/setup-python/pull/414) ```yaml steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 with: python-version: 3.12 allow-prereleases: true ``` Besides, we added such changes as: - Fix bug to trim new line for PyPy version: [https://github.com/actions/setup-python/pull/610](https://togithub.com/actions/setup-python/pull/610) - Added pip dependency file to generate hash from it: [https://github.com/actions/setup-python/pull/604](https://togithub.com/actions/setup-python/pull/604) - Improved error handling for saving and restoring cache: [https://github.com/actions/setup-python/pull/618](https://togithub.com/actions/setup-python/pull/618) - Add warning if cache paths are empty: [https://github.com/actions/setup-python/pull/642](https://togithub.com/actions/setup-python/pull/642) ### [`v4.5.0`](https://togithub.com/actions/setup-python/releases/tag/v4.5.0): Fix cache issue for Poetry projects located in subfolders [Compare Source](https://togithub.com/actions/setup-python/compare/v4.4.0...v4.5.0) In scope of this release we fixed cache issue for Poetry projects located in subfolders ([https://github.com/actions/setup-python/issues/446](https://togithub.com/actions/setup-python/issues/446)). Besides that we updated json5 version from 2.2.0 to 2.2.3 ([https://github.com/actions/setup-python/pull/579](https://togithub.com/actions/setup-python/pull/579)). ### [`v4.4.0`](https://togithub.com/actions/setup-python/releases/tag/v4.4.0): Add support to install multiple python versions [Compare Source](https://togithub.com/actions/setup-python/compare/v4.3.1...v4.4.0) In scope of this release we added support to [install multiple python versions](https://togithub.com/actions/setup-python/pull/567). For this you can try to use this snippet: ```yaml - uses: actions/setup-python@v4 with: python-version: | 3.8 3.9 3.10 ``` Besides, we changed logic with throwing the error for GHES if cache is unavailable to warn ([https://github.com/actions/setup-python/pull/566](https://togithub.com/actions/setup-python/pull/566)). ### [`v4.3.1`](https://togithub.com/actions/setup-python/releases/tag/v4.3.1): Improve error handling and messages [Compare Source](https://togithub.com/actions/setup-python/compare/v4.3.0...v4.3.1) In scope of this release we added improved error message to put operating system and its version in the logs ([https://github.com/actions/setup-python/pull/559](https://togithub.com/actions/setup-python/pull/559)). Besides, the release - fixes issue about [specifying architecture for pypy-nightly on Windows](https://togithub.com/actions/setup-python/issues/518) with related [pull request](https://togithub.com/actions/setup-python/pull/520). - improves error handling for Http Errors ([https://github.com/actions/setup-python/pull/511](https://togithub.com/actions/setup-python/pull/511)). - updates minimatch ([https://github.com/actions/setup-python/pull/558](https://togithub.com/actions/setup-python/pull/558)). ### [`v4.3.0`](https://togithub.com/actions/setup-python/releases/tag/v4.3.0) [Compare Source](https://togithub.com/actions/setup-python/compare/v4.2.0...v4.3.0) - Update [@actions/core](https://togithub.com/actions/core) to 1.10.0 version [#517](https://togithub.com/actions/setup-python/issues/517) - Update [@actions/cache](https://togithub.com/actions/cache) to 3.0.4 version [#499](https://togithub.com/actions/setup-python/issues/499) - Only use github.token on github.com [#443](https://togithub.com/actions/setup-python/issues/443) - Improvement of documentation [#477](https://togithub.com/actions/setup-python/issues/477) [#479](https://togithub.com/actions/setup-python/issues/479) [#491](https://togithub.com/actions/setup-python/issues/491) [#492](https://togithub.com/actions/setup-python/issues/492) ### [`v4.2.0`](https://togithub.com/actions/setup-python/releases/tag/v4.2.0): Add check-latest input and bug fixes [Compare Source](https://togithub.com/actions/setup-python/compare/v4.1.0...v4.2.0) In scope of this release we add the [check-latest](https://togithub.com/actions/setup-python/pull/406) input. If check-latest is set to true, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, the version will then be downloaded from [python-versions](https://togithub.com/actions/python-versions) repository. By default check-latest is set to false. For PyPy it will to try to reach https://downloads.python.org/pypy/versions.json ##### Example of usage: ```yaml steps: - uses: actions/checkout@v3 - uses: actions/setup-python@v4 with: python-version: '3.9' check-latest: true - run: python --version ``` Besides, it includes such changes as - Resolved logs for python-version and file inputs: [https://github.com/actions/setup-python/pull/465](https://togithub.com/actions/setup-python/pull/465) - Added linux os release info to primary key: [https://github.com/actions/setup-python/pull/467](https://togithub.com/actions/setup-python/pull/467) - Added fix to change Python versions for poetry: [https://github.com/actions/setup-python/pull/445](https://togithub.com/actions/setup-python/pull/445) - Fix Tool Path handling for self-hosted runners: [https://github.com/actions/setup-python/pull/466](https://togithub.com/actions/setup-python/pull/466) ### [`v4.1.0`](https://togithub.com/actions/setup-python/releases/tag/v4.1.0) [Compare Source](https://togithub.com/actions/setup-python/compare/v4.0.0...v4.1.0) In scope of this pull request we updated `actions/cache` package as the new version contains fixes for [caching error handling](https://togithub.com/actions/setup-python/pull/448). Moreover, we added a new input [update-environment](https://togithub.com/actions/setup-python/pull/411). This option allows to specify if the action shall update environment variables (default) or not. ##### Update-environment input ```yaml - name: setup-python 3.9 uses: actions/setup-python@v4 with: python-version: 3.9 update-environment: false ``` **Besides, we added such changes as:** - Allow python-version-file to be a relative path: [https://github.com/actions/setup-python/pull/431](https://togithub.com/actions/setup-python/pull/431) - Added new environment variables for `Cmake`: [https://github.com/actions/setup-python/pull/440](https://togithub.com/actions/setup-python/pull/440) - Updated error message for resolveVersion: [https://github.com/actions/setup-python/pull/450](https://togithub.com/actions/setup-python/pull/450) - Assign default value of `AGENT_TOOLSDIRECTORY` if not set: [https://github.com/actions/setup-python/pull/394](https://togithub.com/actions/setup-python/pull/394) ### [`v4.0.0`](https://togithub.com/actions/setup-python/releases/tag/v4.0.0) [Compare Source](https://togithub.com/actions/setup-python/compare/v3.1.4...v4.0.0) ##### What's Changed - Support for `python-version-file` input: [#336](https://togithub.com/actions/setup-python/issues/336) Example of usage: ```yaml - uses: actions/setup-python@v4 with: python-version-file: '.python-version' # Read python version from a file - run: python my_script.py ``` There is no default python version for this `setup-python` major version, the action requires to specify either `python-version` input or `python-version-file` input. If the `python-version` input is not specified the action will try to read required version from file from `python-version-file` input. - Use pypyX.Y for PyPy `python-version` input: [#349](https://togithub.com/actions/setup-python/issues/349) Example of usage: ```yaml - uses: actions/setup-python@v4 with: python-version: 'pypy3.9' # pypy-X.Y kept for backward compatibility - run: python my_script.py ``` - `RUNNER_TOOL_CACHE` environment variable is equal `AGENT_TOOLSDIRECTORY`: [#338](https://togithub.com/actions/setup-python/issues/338) - Bugfix: create missing `pypyX.Y` symlinks: [#347](https://togithub.com/actions/setup-python/issues/347) - `PKG_CONFIG_PATH` environment variable: [#400](https://togithub.com/actions/setup-python/issues/400) - Added `python-path` output: [#405](https://togithub.com/actions/setup-python/issues/405) `python-path` output contains Python executable path. - Updated `zeit/ncc` to `vercel/ncc` package: [#393](https://togithub.com/actions/setup-python/issues/393) - Bugfix: fixed output for prerelease version of poetry: [#409](https://togithub.com/actions/setup-python/issues/409) - Made `pythonLocation` environment variable consistent for Python and PyPy: [#418](https://togithub.com/actions/setup-python/issues/418) - Bugfix for `3.x-dev` syntax: [#417](https://togithub.com/actions/setup-python/issues/417) - Other improvements: [#318](https://togithub.com/actions/setup-python/issues/318) [#396](https://togithub.com/actions/setup-python/issues/396) [#384](https://togithub.com/actions/setup-python/issues/384) [#387](https://togithub.com/actions/setup-python/issues/387) [#388](https://togithub.com/actions/setup-python/issues/388) ### [`v3.1.4`](https://togithub.com/actions/setup-python/releases/tag/v3.1.4) [Compare Source](https://togithub.com/actions/setup-python/compare/v3.1.3...v3.1.4) #### What's Changed In the scope of this patch release, the warning for deprecating Python 2.x was added in [https://github.com/actions/setup-python/pull/674](https://togithub.com/actions/setup-python/pull/674) by [@dmitry-shibanov](https://togithub.com/dmitry-shibanov) For more information, check out [https://github.com/actions/setup-python/issues/672](https://togithub.com/actions/setup-python/issues/672) **Full Changelog**: actions/setup-python@v3...v3.1.4 ### [`v3.1.3`](https://togithub.com/actions/setup-python/releases/tag/v3.1.3): Update actions/core to 1.10.0 for v3 [Compare Source](https://togithub.com/actions/setup-python/compare/v3.1.2...v3.1.3) In scope of this release we update actions/core to 1.10.0 for v3 major tag: [https://github.com/actions/setup-python/pull/624](https://togithub.com/actions/setup-python/pull/624) ### [`v3.1.2`](https://togithub.com/actions/setup-python/releases/tag/v3.1.2): Update actions/cache version to 2.0.2 [Compare Source](https://togithub.com/actions/setup-python/compare/v3.1.1...v3.1.2) In scope of this release we updated `actions/cache` package as the new version contains fixes related to GHES 3.5 ([https://github.com/actions/setup-python/pull/382](https://togithub.com/actions/setup-python/pull/382)) ### [`v3.1.1`](https://togithub.com/actions/setup-python/releases/tag/v3.1.1): Add "cache-hit" output and fix "python-version" output for PyPy [Compare Source](https://togithub.com/actions/setup-python/compare/v3.1.0...v3.1.1) This release introduces new output cache-hit ([https://github.com/actions/setup-python/pull/373](https://togithub.com/actions/setup-python/pull/373)) and fix python-version output for PyPy ([https://github.com/actions/setup-python/pull/365](https://togithub.com/actions/setup-python/pull/365)) The cache-hit output contains boolean value indicating that an exact match was found for the key. It shows that the action uses already existing cache or not. The output is available only if cache is enabled. The python-version contains version of Python or PyPy. ### [`v3.1.0`](https://togithub.com/actions/setup-python/releases/tag/v3.1.0): Support caching poetry dependencies and caching on GHES 3.5 [Compare Source](https://togithub.com/actions/setup-python/compare/v3.0.0...v3.1.0) - In the scope of this release, we added [support for caching from GHES 3.5](https://togithub.com/actions/setup-python/issues/362) and fixed the download issue for files > 2GB during restore. - Caching poetry dependencies ```yaml steps: - uses: actions/checkout@v3 - name: Install poetry run: pipx install poetry - uses: actions/setup-python@v3 with: python-version: '3.9' cache: 'poetry' - run: poetry install - run: poetry run pytest ``` ### [`v3.0.0`](https://togithub.com/actions/setup-python/releases/tag/v3.0.0) [Compare Source](https://togithub.com/actions/setup-python/compare/v2.3.4...v3.0.0) #### What's Changed - Update default runtime to node16 ([https://github.com/actions/setup-python/pull/340](https://togithub.com/actions/setup-python/pull/340)) - Update `package-lock.json` file version to 2, `@types/node` to 16.11.25 and `typescript` to 4.2.3 ([https://github.com/actions/setup-python/pull/341](https://togithub.com/actions/setup-python/pull/341)) - Remove legacy `pypy2` and `pypy3` keywords ([https://github.com/actions/setup-python/pull/342](https://togithub.com/actions/setup-python/pull/342)) ##### Breaking Changes With the update to Node 16, all scripts will now be run with Node 16 rather than Node 12. This new major release removes support of legacy `pypy2` and `pypy3` keywords. Please use more specific and flexible syntax to specify a PyPy version: ```yaml jobs: build: runs-on: ubuntu-latest strategy: matrix: python-version: - 'pypy-2.7' # the latest available version of PyPy that supports Python 2.7 - 'pypy-3.8' # the latest available version of PyPy that supports Python 3.8 - 'pypy-3.8-v7.3.8' # Python 3.8 and PyPy 7.3.8 steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v3 with: python-version: ${{ matrix.python-version }} ``` See more usage examples in the [documentation](https://togithub.com/actions/setup-python#specifying-a-pypy-version) ### [`v2.3.4`](https://togithub.com/actions/setup-python/releases/tag/v2.3.4) [Compare Source](https://togithub.com/actions/setup-python/compare/v2.3.3...v2.3.4) #### What's Changed In the scope of this patch release, the warning for deprecating Python 2.x was added in [https://github.com/actions/setup-python/pull/675](https://togithub.com/actions/setup-python/pull/675) by [@dmitry-shibanov](https://togithub.com/dmitry-shibanov) For more information, check out [https://github.com/actions/setup-python/issues/672](https://togithub.com/actions/setup-python/issues/672) **Full Changelog**: actions/setup-python@v2...v2.3.4 ### [`v2.3.3`](https://togithub.com/actions/setup-python/releases/tag/v2.3.3): Update actions/core to 1.10.0 for v2 [Compare Source](https://togithub.com/actions/setup-python/compare/v2.3.2...v2.3.3) In scope of this release we update actions/core to 1.10.0 for v2 major tag: [https://github.com/actions/setup-python/pull/533](https://togithub.com/actions/setup-python/pull/533). ### [`v2.3.2`](https://togithub.com/actions/setup-python/releases/tag/v2.3.2): Update primary and restore keys for pip [Compare Source](https://togithub.com/actions/setup-python/compare/v2.3.1...v2.3.2) In scope of this release we [include a version of python in restore and primary cache keys for pip](https://togithub.com/actions/setup-python/pull/303). Besides, we add temporary fix for Windows caching [issue](https://togithub.com/actions/setup-python/pull/332), that the `pip cache dir` command returns non zero exit code or writes to stderr. Moreover we updated [node-fetch dependency](https://togithub.com/actions/setup-python/pull/327). ### [`v2.3.1`](https://togithub.com/actions/setup-python/releases/tag/v2.3.1): Update actions/cache version to 1.0.8 [Compare Source](https://togithub.com/actions/setup-python/compare/v2.3.0...v2.3.1) We have updated [actions/cache](https://togithub.com/actions/toolkit/blob/main/packages/cache/RELEASES.md#108) dependency version to 1.0.8 to support 10GB cache upload ### [`v2.3.0`](https://togithub.com/actions/setup-python/releases/tag/v2.3.0): Support caching dependencies [Compare Source](https://togithub.com/actions/setup-python/compare/v2.2.2...v2.3.0) This release introduces dependency caching support ([https://github.com/actions/setup-python/pull/266](https://togithub.com/actions/setup-python/pull/266)) #### Caching dependencies. The action has a built-in functionality for caching and restoring pip/pipenv dependencies. The `cache` input is optional, and caching is turned off by default. Besides, this release introduces dependency caching support for mono repos and repositories with complex structure. By default, the action searches for the dependency file (requirements.txt for pip or Pipfile.lock for pipenv) in the whole repository. Use the `cache-dependency-path` input for cases when you want to override current behaviour and use different file for hash generation (for example requirements-dev.txt). This input supports wildcards or a list of file names for caching multiple dependencies. ##### Caching pip dependencies: steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 with: python-version: '3.9' cache: 'pip' - run: pip install -r requirements.txt - run: pip test ##### Caching pipenv dependencies: steps: - uses: actions/checkout@v2 - name: Install pipenv run: pipx install pipenv - uses: actions/setup-python@v2 with: python-version: '3.9' cache: 'pipenv' - run: pipenv install - run: pipenv test ##### Change dependency file: steps: - uses: actions/checkout@v2 - uses: actions/setup-python@v2 with: python-version: '3.9' cache: 'pip' cache-dependency-path: '**/requirements-dev.txt' - run: pip install -r subdirectory/requirements-dev.txt - run: pip test </details> <details> <summary>canonical/data-platform-workflows (canonical/data-platform-workflows)</summary> ### [`v4`](https://togithub.com/canonical/data-platform-workflows/compare/v3...v4) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v3...v4) ### [`v3`](https://togithub.com/canonical/data-platform-workflows/compare/v2...v3) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v2...v3) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 1am and before 2am on saturday" in timezone Etc/UTC, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/canonical/spark-k8s-toolkit-py).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

zoj613 · 2023-08-26T03:30:28Z

This seems like a great addition and should eliminate the need to specify

matrix:
  python-version: [ ... ]

Usually I use python-version to help name a workflow step like so: Python version - ${{ matrix.python-version }} - ${{ matrix.os }}. Is there a way to get this supported using information from pyproject.toml without having to keep the above snippet in the workflow file?

dariocurr · 2023-08-28T07:41:13Z

We could add an output value to use in the following steps

dariocurr requested a review from a team as a code owner May 22, 2023 19:38

dariocurr changed the title ~~Reading python version from pyproject.toml (fix #542)~~ Read python version from pyproject.toml (fix #542) May 22, 2023

dariocurr added 5 commits June 6, 2023 16:50

Add TOML dependency

0422415

Add examples for version ranges and pyproject.toml

c242fc9

Add tests for python version files

e1bb6df

Add tests for python version files

3e4f089

Add utils to extract python version from files

5fe4cfd

Replace toml with @iarna/toml

6f8266d

github-advanced-security bot found potential problems Jun 19, 2023

View reviewed changes

dist/setup/index.js

}).join('\n')

if (escaped.slice(-1) === '"') escaped += '\\\n'

return '"""\n' + escaped + '"""'

}

Check failure

Code scanning / CodeQL

Incomplete string escaping or encoding

This does not escape backslash characters in the input.

dmitry-shibanov reviewed Jun 21, 2023

View reviewed changes

dmitry-shibanov reviewed Jun 27, 2023

View reviewed changes

Remove pyproject.toml from default values

556ac3e

Allow python version bounds just with TOMLs

c4ab19b

dmitry-shibanov approved these changes Jun 28, 2023

View reviewed changes

dmitry-shibanov merged commit 0d5da6a into actions:main Jun 28, 2023

bmritz mentioned this pull request Jul 18, 2023

Bump actions/setup-python from 4.6.1 to 4.7.0 bmritz/ai-ghostfunctions#95

Merged

cclauss mentioned this pull request Aug 25, 2023

pyproject.toml: project.requires-python = ">=3.11.1,<3.11.2" internetarchive/openlibrary#8229

Merged

peterschutt mentioned this pull request Oct 20, 2023

build: configure type checkers to run on min supported version litestar-org/litestar#2474

Merged

5 tasks

ITProKyle mentioned this pull request Dec 6, 2023

[REQUEST] ensure python version can be provided from pyproject.toml finleyfamily/action-setup-python#164

Closed

LoicGrobol mentioned this pull request Dec 6, 2023

build(deps): bump actions/setup-python from 4 to 5 hopsparser/hopsparser#99

Closed

nx10 mentioned this pull request Dec 7, 2023

Grab workflow python version from pyproject.toml childmindresearch/template-python-repository#74

Closed

jasonjoh mentioned this pull request Dec 11, 2023

Bump actions/setup-python from 4 to 5 microsoftgraph/msgraph-sample-pythondjangoapp#126

Merged

hongbo-miao mentioned this pull request Dec 31, 2023

ci(python): read python version from pyproject.toml hongbo-miao/hongbomiao.com#13529

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Read python version from pyproject.toml (fix #542) #669

Read python version from pyproject.toml (fix #542) #669

dariocurr commented May 22, 2023 •

edited

Loading

dariocurr commented Jun 2, 2023

dmitry-shibanov commented Jun 6, 2023

dariocurr commented Jun 6, 2023 •

edited

Loading

dariocurr commented Jun 7, 2023

dariocurr commented Jun 8, 2023

dmitry-shibanov commented Jun 8, 2023

dariocurr commented Jun 8, 2023

dariocurr commented Jun 10, 2023

dariocurr commented Jun 19, 2023

dmitry-shibanov Jun 19, 2023

dariocurr Jun 21, 2023

dariocurr Jun 23, 2023 •

edited

Loading

dmitry-shibanov Jun 23, 2023

dariocurr Jun 23, 2023 •

edited

Loading

dmitry-shibanov Jun 27, 2023

dariocurr Jun 27, 2023

dmitry-shibanov Jun 27, 2023

dariocurr Jun 28, 2023

dmitry-shibanov Jun 27, 2023

dariocurr Jun 27, 2023

dariocurr commented Jun 28, 2023

dariocurr commented Jun 28, 2023

dariocurr commented Jun 28, 2023

dmitry-shibanov commented Jun 28, 2023

BrandonLWhite commented Jun 28, 2023

dariocurr commented Jun 29, 2023

dariocurr commented Jul 10, 2023

zoj613 commented Aug 26, 2023

dariocurr commented Aug 28, 2023

Read python version from pyproject.toml (fix #542) #669

Read python version from pyproject.toml (fix #542) #669

Conversation

dariocurr commented May 22, 2023 • edited Loading

dariocurr commented Jun 2, 2023

dmitry-shibanov commented Jun 6, 2023

dariocurr commented Jun 6, 2023 • edited Loading

dariocurr commented Jun 7, 2023

dariocurr commented Jun 8, 2023

dmitry-shibanov commented Jun 8, 2023

dariocurr commented Jun 8, 2023

dariocurr commented Jun 10, 2023

dariocurr commented Jun 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dariocurr Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dariocurr Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dariocurr commented Jun 28, 2023

dariocurr commented Jun 28, 2023

dariocurr commented Jun 28, 2023

dmitry-shibanov commented Jun 28, 2023

BrandonLWhite commented Jun 28, 2023

dariocurr commented Jun 29, 2023

dariocurr commented Jul 10, 2023

zoj613 commented Aug 26, 2023

dariocurr commented Aug 28, 2023

dariocurr commented May 22, 2023 •

edited

Loading

dariocurr commented Jun 6, 2023 •

edited

Loading

dariocurr Jun 23, 2023 •

edited

Loading

dariocurr Jun 23, 2023 •

edited

Loading