Remove requirements_git comments in output file

[AlanCoding]

SUMMARY

I was reminded of this looking at #15314

Elevator pitch:

We consider requirements_git.txt in resolution of dependencies (so that we get dependencies of git requirements) but we remove the direct git requirements from the resultant requirements.txt file... but that was implemented before pip-tools changed their format. At the time it was implemented, it was fully correct because the lines it operated on looked like:

git+foo.invalid  # via -r requirements_git.txt

But then pip-tools changed format to be like

git+foo
    # via -r requirements_git.txt

So the prior logic would remove the git+ lines. After the format change, it started leaving around the comment lines.

I believe people have been leaving these comments lines around, mis-interpreting them as the source for the requirement above git+foo, which it is not.

ISSUE TYPE

• Bug, Docs Fix or other nominal change

COMPONENT NAME

• API

[AlanCoding]

I have discovered this is not correct for:

certifi @ git+https://github.com/ansible/system-certifi.git@devel
    # via
    #   -r /awx_devel/requirements/requirements_git.txt
    #   kubernetes
    #   msrest
    #   requests

[AlanCoding]

My solution is that I'm taking the certifi case out of scope of this. By matching on a longer string (including "via") we avoid removing any comments related to that requirement. We still have incorrect comments from that, and I'm just going to leave those.

[AlanCoding]

Tossing out an alternative proposal:

Instead of removing the git+ lines, we turn them into comments, so that we can track dependencies.

[AlanCoding]

Thanks for looking at this, but I've become really strongly convinced that #15317 is a vastly better solution. This wouldn't really fix anything.