Fix error on inline comments in Python dependencies #708
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It appears that the distlib parsing function we're using here can't handle inline comments and raises a syntax error. After digging into the setuptools sources, it appears that these comments are dropped between parsing the file and parsing the individual dependencies, so we can do the same.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #708 +/- ##
=======================================
Coverage 87.08% 87.08%
=======================================
Files 69 69
Lines 4081 4082 +1
Branches 704 704
=======================================
+ Hits 3554 3555 +1
Misses 417 417
Partials 110 110 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It appears that the distlib parsing function we're using here can't handle inline comments and raises a syntax error. After digging into the setuptools sources, it appears that these comments are dropped between parsing the file and parsing the individual dependencies, so we can do the same.
Needed to support syntax like this:
https://github.com/ros-infrastructure/rosdoc2/blob/d65d85509289d053a75bf69b1cfd4a9cca355cbc/setup.cfg#L56-L57
Hints for similar investigations:
https://github.com/pypa/setuptools/blob/9c4d383631d3951fcae0afd73b5d08ff5a262976/setuptools/dist.py#L399-L405
https://github.com/pypa/setuptools/blob/9c4d383631d3951fcae0afd73b5d08ff5a262976/setuptools/_reqs.py#L29
https://github.com/jaraco/jaraco.text/blob/10d49b85f8060bdfd64fa594bfd73a1356aab7e3/jaraco/text/__init__.py#L569-L581