Fix git req sanitization due to underscore

[AlanCoding]

SUMMARY

This is what @TheRealHaoLiu was asking about.

I'd suggest a followup change to the awx-plugins.interfaces library to also use -. Ping @webknjaz

https://github.com/ansible/awx_plugins.interfaces

I believe this is the right thing to do, because:

python-poetry/poetry#8848

that is the correctly normalized package name, not a bug

referencing its own source

https://peps.python.org/pep-0503/#normalized-names

This PEP references the concept of a “normalized” project name. As per PEP 426 the only valid characters in a name are the ASCII alphabet, ASCII numbers, ., -, and _. The name should be lowercased with all runs of the characters ., -, or _ replaced with a single - character. This can be implemented in Python with the re module:

And it writes code, in case that wasn't clear enough what normalization means.

import re

def normalize(name):
    return re.sub(r"[-_.]+", "-", name).lower()

ISSUE TYPE

• Bug, Docs Fix or other nominal change

COMPONENT NAME

• API

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[webknjaz]

@AlanCoding FTR, additionally wheel and sdist filenames are getting normalized slightly differently. Plus, that changed slightly earlier this year, so some downstreams had fun with https://warehouse.pypa.io/api-reference/integration-guide.html#predictable-urls. The way PyPI normalizes the project names is closer to sdists IIRC. I think this is what it uses: https://github.com/pypa/packaging/blob/029f415/src/packaging/utils.py#L46-L51.

I'd suggest a followup change to the awx-plugins.interfaces library to also use -.

We wouldn't want that. The reason it's underscored was that I wanted consistency with the importable namespace. So people would be less confused seeing that a PyPI project looks like awx_plugins.type.thing and what they reference in code is also awx_plugins.type.thing.
We are about to have 49 plugins namespaced as awx_plugins.credential.x / awx_plugins.managed_credential_type.y / awx_plugins.inventory.z and I wanted consistency in how what we control is shaped.

Though, if you still feel like this should be different, let's talk about it sooner rather than later. The plugin split is close and once I unblock it, it's going to be infinitely harder to change this.

[AlanCoding]

Then that would suggest this be solved by a special case in the updater script. That's fine, I just wanted to put up these specifics.