Skip to content

fix(pypi): return yank reason from SimpleAPI HTML#3656

Open
aignas wants to merge 1 commit intobazel-contrib:mainfrom
aignas:aignas.fix.parse-simpleapi-yanked
Open

fix(pypi): return yank reason from SimpleAPI HTML#3656
aignas wants to merge 1 commit intobazel-contrib:mainfrom
aignas:aignas.fix.parse-simpleapi-yanked

Conversation

@aignas
Copy link
Collaborator

@aignas aignas commented Mar 9, 2026

This makes the logic in the parser a little bit more sophisticated, but
we also start handling the yank reason. With this the yank reason will
be present in the logs, which should be a usability improvement.

The yanked attribute will be None if the package is not yanked and a
string value if it is yanked. An empty string value should be treated
as "yanked with no reason provided".

This implementation assumes that we have HTML escaped sequences as tag
values. It also un-escapes them when returning the strings.

The possibilities that it gives us are, but out of scope for this PR:

  • Use the data-requires-python to potentially discard any Python
    packages that are unsupported in the select_whl function.
  • Also retrieve the provenance attributes if they are supported.

Work towards #260.
Work towards #2731.

@aignas aignas requested review from groodt and rickeylev as code owners March 9, 2026 09:01
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the PyPI Simple API HTML parser to accurately process package metadata, particularly addressing the data-yanked attribute. By correctly extracting and unescaping the yank reason, it resolves a previous misinterpretation of yanked packages and provides a more robust foundation for package management. This also paves the way for leveraging other HTML attributes, such as data-requires-python, for advanced package selection.

Highlights

  • Enhanced HTML Parsing: Implemented sophisticated parsing logic for PyPI Simple API HTML <a> tags to accurately extract attributes and their values.
  • Corrected Yank Reason Handling: Correctly extracts and returns the data-yanked reason, resolving an issue where its mere presence was misinterpreted as a yanked package.
  • New Utility Functions: Introduced _parse_attrs and _unescape_pypi_html helper functions for robust attribute extraction and HTML entity decoding.
  • Data Structure Update: Modified the yanked field in the returned package struct to store the string reason instead of a boolean flag.
  • Future Capabilities: Enabled future functionality to utilize data-requires-python for advanced package filtering.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • python/private/pypi/parse_simpleapi_html.bzl
    • Refactored HTML parsing logic to correctly extract attributes from <a> tags.
    • Introduced _parse_attrs function to parse HTML attributes.
    • Introduced _unescape_pypi_html function to decode HTML entities in attribute values.
    • Updated yanked field to store the yank reason string instead of a boolean.
  • tests/pypi/parse_simpleapi_html/parse_simpleapi_html_tests.bzl
    • Updated test cases to reflect the change in yanked field from boolean to string.
    • Added new test cases for data-yanked with and without a reason, including HTML escaped characters.
    • Updated data-requires-python values to use HTML escaped characters in tests.
Activity
  • No specific activity (comments, reviews, progress) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the Simple API HTML parser to correctly handle yanked packages and their reasons. However, a critical security vulnerability has been identified: the new custom HTML attribute parser fails to detect the data-yanked attribute when it is present without an explicit value. This flaw leads to a security regression, as yanked packages (often due to critical bugs or security vulnerabilities) are not recognized, potentially allowing Bazel to download and use compromised versions. Additionally, the _parse_attrs function has significant issues with its loop construct and general handling of valueless attributes, which could lead to incorrect behavior. The attribute parser must be updated to correctly handle boolean attributes and ensure data-yanked always signals a yanked status.

@aignas aignas force-pushed the aignas.fix.parse-simpleapi-yanked branch from 9ad8c68 to 76f521a Compare March 10, 2026 10:06
This makes the logic in the parser a little bit more sophisticated, but
we also start handling the yank reason. This fixes the issue where the
`data-yank` presence but no value would be interpreted as a yanked
package. With this it should start working.

This implementation assumes that we have HTML escaped sequences as tag
values. It also unescapes them when returning the strings.

The posibilities that it gives us are:
- Use the `data-requires-python` to potentially discard any Python
  packages that are unsupported in the `select_whl` function.

Work towards bazel-contrib#260.
Work towards bazel-contrib#2731.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant