Add [PythonVersionFromToml] shield #9516
Conversation
Added new shield per issue badges#9410 The shield display required python versions for packages based on pyproject.toml
calebcartwright
added
the
service-badge
|
|
||
| static examples = [ | ||
| { | ||
| title: 'Python Required Version TOML', |
There was a problem hiding this comment.
Can we clarify in the title and description that this is for PEP 621-compliant pyproject.toml
Python packaging is..fun 😬 and lots of projects have a pyproject.toml that doesn't use this format e.g: https://github.com/chris48s/arcgis2geojson/blob/master/pyproject.toml#L12
| base: '', | ||
| pattern: 'python/required-version-toml', | ||
| queryParamSchema, |
There was a problem hiding this comment.
I don't have an answer for this at the moment, but I'm wondering where this should live.
Python isn't really a "service". Neither is "pyproject.toml".
We've got a bunch of other badges knocking about under /github that just read a file on GitHub. We've talked before about converting them to work like this so you can just pass a URL in as a query param. Then they could work for files hosted elsewhere. I wonder if it makes sense to lump them together as a "service".
I need to have a think about this one. Any other maintainers got a view on what a sensible route would be for this?
There was a problem hiding this comment.
I was not sure myself, i used SecurityHeaders as reference and saw it used an empty base route.
What should we do with that?
There was a problem hiding this comment.
So it isn't really about the empty base. It is more that our URL schema assumes the first part of the route is a service, but there's no service here.
Given nobody else has chimed in on this, I think I'm going to merge this but note this as a consideration in #5343
| const isCommaSeparatedPythonVersions = Joi.string().regex( | ||
| // This should test for PEP440 | ||
| // Accepted values are one or more Version specifiers as defined at https://peps.python.org/pep-0440/#version-specifiers | ||
| // Some strings might include spaces, those are valid, values are comma seperated | ||
| // Versions should fit the version scheme https://peps.python.org/pep-0440/#version-scheme | ||
| // This is based on the example in PEP440 at https://peps.python.org/pep-0440/#appendix-b-parsing-version-strings-with-regular-expressions | ||
| /^\s*(?:(?:===|!=|<=|>=|<|>)\s*)?((?:(?:\d+!)?(?:\d+(?:\.\d+)*))(?:(?:[abc]|rc)\d+)?(?:\.post\d+)?(?:\.dev\d+)?)(?:\s*,\s*(?:(?:===|!=|<=|>=|<|>)\s*)?((?:(?:\d+!)?(?:\d+(?:\.\d+)*))(?:(?:[abc]|rc)\d+)?(?:\.post\d+)?(?:\.dev\d+)?))*\s*$/, | ||
| ) |
There was a problem hiding this comment.
Rather than copy/pasing this monster regex (I hope you didn't write this from scratch! 😄 ), I'd suggest we use Joi.custom() https://joi.dev/api/#anycustommethod-description here to make a validator using the validRange() function from @renovate/pep440 (which is a package we already use).
import pep440 from '@renovate/pep440'
pep440.validRange(">=3.6, <4.0") // trueThere was a problem hiding this comment.
Should be fixed with b3de30f
I still have issue testing so i feel like mountain climbing where i try to get it first try, lets see the CI results.
Rename and updated description to bring into focus that only PEP 621 complaint pyproject.toml files are supported. Solves review badges#9516 (comment)
|
🚀 Updated review app: https://pr-9516-badges-shields.fly.dev |
Added new shield PythonVersionFromToml
The shield display required python versions for packages based on pyproject.toml
Example:
For URL
https://raw.githubusercontent.com/numpy/numpy/main/pyproject.tomlShield URL is:
http://localhost:8080/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fnumpy%2Fnumpy%2Fmain%2Fpyproject.tomlAnd the result:
Tester is also added in this PR.
Fixes #9410