posit-dev / posit-dev/go-python-packaging
Add a PEP 503-named entry point for project-name normalization
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 0
- Forks
- 0
- Merge moyen
- 2 h 49 min
- PR mergées (30 j)
- 8
Description
Describe the feature
Add a PEP 503-named entry point for project-name normalization, so callers normalizing a package name don't have to reach for extras.Normalize.
Why
PEP 503 project-name normalization and PEP 685 extra-name normalization are the same transformation — lowercase, then collapse any run of -, _, . into a single -. extras.Normalize already implements it, and its own doc comment says it mirrors pypa/packaging's canonicalize_name for PEP 503/685 both.
So the behavior is right and there is no duplication to remove. The problem is purely discoverability and call-site legibility: go-pyresolver's index.NewPackageName currently calls extras.Normalize to normalize a project name, which reads like a bug at the call site even though it is correct. The alternative — a second copy of the algorithm in go-pyresolver — would be worse, since two copies can drift.
Suggested shape
Either is fine; the second is probably cleaner:
- A
packagenamepackage withNormalize(string) string, andextras.Normalizedelegating to it (or vice versa) so there is exactly one implementation. - Keep one implementation in an internal package, with
extras.Normalizeandpackagename.Normalizeas thin named wrappers, each documenting its PEP.
Whichever way, one implementation. The current function is on a per-dependency, per-extra hot path during resolution and is deliberately regex-free, so keep that property.
Testing notes
The existing extras tests cover the transformation. A new entry point needs only enough to prove delegation, plus the PEP 503 examples from pypa/packaging's own test suite for the project-name framing.
Additional notes
- Once this lands, update
go-pyresolver'sindex/name.goto call the new entry point and drop the apologetic comment pointing here. - Not urgent and not blocking: today's arrangement is correct, just awkward to read.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Lisez d’abord l’implémentation existante de extras.Normalize et ses tests, puis examinez index/name.go de go-pyresolver ainsi que les exemples de PEP 503 référencés dans l’issue. Ajoutez le point d’entrée project-name indiqué avec une seule implémentation partagée sans regex, mettez à jour le site d’appel du resolver et vérifiez que les tests existants de extras ainsi que les nouveaux cas de project-name passent.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- go
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 72/100