Handle additional path-based version specifiers #25
Conversation
This file contains 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
4 tasks
taylormadore
force-pushed
the
add-alternate-file-dep-style
branch
from
1ab2b2e
to
057cbc7
Compare
pyarn/lockfile.py
Outdated
| @@ -46,7 +46,7 @@ def __init__( | |||
| self.version = version | |||
| self.url = url | |||
| self.checksum = checksum | |||
| self.relpath = relpath | |||
| self.path = path | |||
There was a problem hiding this comment.
Would it make sense to keep relpath as an alias to path for backward compatibility?
taylormadore
force-pushed
the
add-alternate-file-dep-style
branch
from
057cbc7
to
b982dd7
Compare
|
Apart from existing comments LGTM. |
| self.dependencies = dependencies or {} | ||
| self.alias = alias | ||
|
|
||
| @property | ||
| def relpath(self) -> Optional[str]: |
There was a problem hiding this comment.
Please add a note stating that this is deprecated and is left for backward compatibility only.
| elif version_path.is_absolute() or version.startswith(("./", "../")): | ||
| return str(version_path) | ||
| else: | ||
| return None |
There was a problem hiding this comment.
A minor, non-blocking suggestion: could you please add a short comment or a link to a doc about when this branch could be reached?
It is possible to have an absolute path as the version specifier in Yarn-generated package.json and yarn.lock files. This makes the Package.relpath field name slightly misleading. Add Package.path instead and retain Package.relpath only for backwards compatibility. This will make the naming more accurate for future commits. Signed-off-by: Taylor Madore <[email protected]>
These are all valid version specifiers for path-style packages in package.json/yarn.lock: ./some/relative/path ../some/relative/path file:some/relative/path file:../some/relative/path link:some/relative/path link:../some/relative/path\ /some/absolute/path Ensure that the Package class provides a path in each of these cases. Signed-off-by: Taylor Madore <[email protected]>
Signed-off-by: Taylor Madore <[email protected]>
taylormadore
force-pushed
the
add-alternate-file-dep-style
branch
from
b982dd7
to
deec552
Compare
slimreaper35
approved these changes
Oct 25, 2024
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.
Add handling for more path-based version specifiers
These are all valid version specifiers for path-style packages in package.json/yarn.lock:
./some/relative/path
../some/relative/path
file:some/relative/path
file:../some/relative/path
link:some/relative/path
link:../some/relative/path
/some/absolute/path
Ensure that the Package class provides a path in each of these cases.