Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

sage --package, sage-get-system-packages: Support PURLs pkg:pypi/DISTRO-NAME, obtain dependencies of wheels from PyPI #37500

Merged
merged 22 commits into from
May 12, 2024

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Feb 28, 2024

We make it possible to refer to Python packages via their PURL (see draft PEP 725) instead of their SPKG name.

For now a string of the form pkg:pypi/DISTRO-NAME is simply a nickname for the (unique) SPKG that has DISTRO-NAME in their version_requirements.txt or requirements.txt. The scheme can also be omitted: pypi/DISTRO-NAME also works. And we also map pkg:generic/PACKAGE-NAME to PACKAGE_NAME.

Based on code by @culler, sage --package create --pypi now also fills dependencies from the PyPI metadata of wheel packages. When some of the Python dependencies obtained in this way do not have SPKGs yet, they are also automatically created.

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@mkoeppe mkoeppe self-assigned this Feb 28, 2024
@mkoeppe mkoeppe force-pushed the sage_package_purl branch 3 times, most recently from 7f2157c to 74a3708 Compare March 7, 2024 07:15
@mkoeppe mkoeppe requested a review from culler March 7, 2024 07:50
@mkoeppe mkoeppe changed the title sage --package, sage-get-system-packages: Support PURLs pkg:pypi/DISTRO-NAME sage --package, sage-get-system-packages: Support PURLs pkg:pypi/DISTRO-NAME, obtain dependencies of wheels from PyPI Mar 7, 2024
Copy link
Contributor

@culler culler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not really qualified to review most of this PR, but I do see some vestigial trace of the code that I provided, and it looks like the overall scheme makes sense. More automation of the process of maintaining the boilerplate in the file-based spkg database seems like a very useful and important contribution.

Copy link

github-actions bot commented Apr 9, 2024

Documentation preview for this PR (built with commit 06c3f90; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@kwankyu
Copy link
Collaborator

kwankyu commented Apr 24, 2024

Otherwise, lgtm. It works well.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Apr 25, 2024

Thanks for the review!

vbraun pushed a commit to vbraun/sage that referenced this pull request Apr 28, 2024
…rt PURLs `pkg:pypi/DISTRO-NAME`, obtain dependencies of wheels from PyPI

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

We make it possible to refer to Python packages via their PURL (see
[draft PEP 725](https://peps.python.org/pep-0725/#concrete-package-
specification-through-purl)) instead of their SPKG name.

For now a string of the form `pkg:pypi/DISTRO-NAME` is simply a nickname
for the (unique) SPKG that has DISTRO-NAME in their `install-
requires.txt` or `requirements.txt`. The scheme can also be omitted:
`pypi/DISTRO-NAME` also works. And we also map `pkg:generic/PACKAGE-
NAME` to `PACKAGE_NAME`.

Based on code by @culler, `sage --package create --pypi` now also fills
`dependencies` from the PyPI metadata of wheel packages. When some of
the Python dependencies obtained in this way do not have SPKGs yet, they
are also automatically created.

- Preparation for sagemath#31136.
- Split out from sagemath#37250.


### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#37500
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Marc Culler, Matthias Köppe
@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 8, 2024

Tentative resolve of merge conflict caused by #36982.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented May 12, 2024

Setting back to positive review

@vbraun vbraun merged commit b2df018 into sagemath:develop May 12, 2024
18 checks passed
@mkoeppe mkoeppe added this to the sage-10.4 milestone May 12, 2024
@mkoeppe mkoeppe deleted the sage_package_purl branch May 12, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants