AcademySoftwareFoundation / AcademySoftwareFoundation/rez

[Feature] Support for correct pre-release version sorting

Ouverte
#653 8 commentaires 6 réactions 0 personnes assignées Voir sur GitHub
enhancement rez-pip
Langage dominant
Python
Étoiles
1.1k
Forks
374
Merge moyen
9 j 12 h
PR mergées (30 j)
5

Description

Both PEP 440 versions and SemVar 2.0 versions may contain pre-release (and other) version information besides just maj/min/patch.

- https://www.python.org/dev/peps/pep-0440/
- https://semver.org/

Both PEP 440 and SemVar 2.0 utilize different sorting behavior for pre-releases than the default alphanumeric sort used by rez. For example, this is the expected sort order under PEP 440:

- `1.0.0-a1`
- `1.0.0b1`
- `1.0.0.rc1`
- `1.0.0`

The default rez sort will sort them like this, with the base version *before* the pre-releases, and also doesn't support the pre-release separator being optional:

- `1.0.0`
- `1.0.0-a1`
- `1.0.0.rc1`
- `1.0.0b1`

To maintain backwards compatibility, a config option could be added to enable support for this sorting behavior -- maybe `use_pep440_versioning`? With the expectation that if the package version isn't a valid PEP 440 version, it simply falls back to the normal alphanumeric sorting behavior.

This also raises another question of whether the `version` module should be vendored or not and instead be moved into rez proper, since it's already a pretty significant fork from the original and if we want it to be config aware, it should probably be moved into rez.

It may make sense to separate this ticket (and the config option) into two different options -- one for PEP 440 and one for SemVar 2.0, since they are different enough that someone may want one behavior and not the other. For this ticket, I'm mainly concerned with PEP 440 style versioning. I included SemVar 2.0 just to show it's not an issue unique to python packaging.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par examiner le module de versions vendored existant ainsi que les chemins actuels de Rez pour le tri des versions et la configuration. Comparez le comportement actuel avec les exemples de PEP 440, puis définissez la portée de la configuration et vérifiez que les versions PEP 440 valides sont correctement triées, tandis que les versions invalides conservent le fallback alphanumérique existant.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
30/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.