feat: add requires_file attr for py_wheel #644

weixiao-huang · 2022-03-08T20:38:15Z

PR Checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix
Feature (please, look at the "Scope of the project" section in the README.md file)
Code style update (formatting, local variables)
Refactoring (no functional changes, no api changes)
Build related changes
CI related changes
Documentation content changes
Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

google-cla · 2022-03-08T20:38:20Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

For more information, open the CLA check for this pull request.

pstradomski · 2022-03-13T11:38:21Z

Any background for why this is needed? Maybe the documentation should be updated to reflect that and what's the interaction with "requires" attribute?

weixiao-huang · 2022-03-13T12:00:57Z

Because sometimes we may write codes like this in setup.py

#!/usr/bin/env python

from setuptools import setup, find_packages

with open("requirements.txt") as fp:
    install_requires = fp.read()


setup(
    # get requires from file
    install_requires=install_requires,
)

However, in py_wheel, it only provides requires from bazel string. It seems we cannot get requires from files. So I add requires_file in py_wheel.

If requires specified, requires_file will not work

github-actions · 2022-09-09T22:52:50Z

This Pull Request has been automatically marked as stale because it has not had any activity for 180 days. It will be closed if no further activity occurs in 30 days.
Collaborators can add an assignee to keep this open indefinitely. Thanks for your contributions to rules_python!

weixiao-huang · 2022-09-10T02:26:22Z

Is there any update of this PR?

UebelAndre · 2022-10-10T17:13:11Z

@weixiao-huang would you be able to rebase this and address conflicts?

UebelAndre

I'm no maintainer but did have some requests 😅

python/packaging.bzl

tools/wheelmaker.py

pstradomski · 2022-10-13T18:37:25Z

tools/wheelmaker.py

+        if arguments.requires_file:
+            with open(arguments.requires_file) as fp:
+                additive_requires_list = ["Requires-Dist: {}".format(line) for line in fp.read().strip().split("\n")]
+                metadata += "\n" + "\n".join(additive_requires_list)


Won't that leave you with two \n in a row, so everything below will be interpreted as a description?

Can we have a test?

pstradomski · 2022-10-13T18:37:45Z

tools/wheelmaker.py

@@ -398,6 +403,10 @@ def main() -> None:
                      encoding="utf-8") as metadata_file:
                metadata = metadata_file.read()

+        if arguments.requires_file:
+            with open(arguments.requires_file) as fp:
+                additive_requires_list = ["Requires-Dist: {}".format(line) for line in fp.read().strip().split("\n")]


why read().strip().split() and not readlines()?

github-actions · 2023-04-11T22:50:33Z

This Pull Request has been automatically marked as stale because it has not had any activity for 180 days. It will be closed if no further activity occurs in 30 days.
Collaborators can add an assignee to keep this open indefinitely. Thanks for your contributions to rules_python!

chrislovecnm · 2023-04-24T16:16:22Z

@weixiao-huang knudge

weixiao-huang · 2023-04-25T09:33:52Z

Sorry, I'll check it recently

github-actions · 2023-10-22T22:50:28Z

This Pull Request has been automatically marked as stale because it has not had any activity for 180 days. It will be closed if no further activity occurs in 30 days.
Collaborators can add an assignee to keep this open indefinitely. Thanks for your contributions to rules_python!

github-actions · 2023-11-21T22:50:28Z

This PR was automatically closed because it went 30 days without a reply since it was labeled "Can Close?"

weixiao-huang requested review from brandjon, lberki, thundergolfer and andyscott as code owners March 8, 2022 20:38

weixiao-huang force-pushed the feat/add-requires-file branch 3 times, most recently from 0f95f75 to 28e48e7 Compare March 9, 2022 02:59

github-actions bot added the Can Close? Will close in 30 days if there is no new activity label Sep 9, 2022

github-actions bot removed the Can Close? Will close in 30 days if there is no new activity label Sep 10, 2022

weixiao-huang force-pushed the feat/add-requires-file branch 2 times, most recently from 35abc61 to feba774 Compare October 11, 2022 09:27

feat: add requires_file for py_wheel and update docs

458d28c

weixiao-huang force-pushed the feat/add-requires-file branch from feba774 to 458d28c Compare October 11, 2022 09:28

fix doc err

f197f76

UebelAndre suggested changes Oct 11, 2022

View reviewed changes

python/packaging.bzl Outdated Show resolved Hide resolved

tools/wheelmaker.py Outdated Show resolved Hide resolved

tools/wheelmaker.py Show resolved Hide resolved

fix: make requires_file additive and fix Requires-Dist bug

aa3beac

weixiao-huang force-pushed the feat/add-requires-file branch from cd7edd7 to aa3beac Compare October 12, 2022 15:03

pstradomski reviewed Oct 13, 2022

View reviewed changes

github-actions bot added the Can Close? Will close in 30 days if there is no new activity label Apr 11, 2023

github-actions bot removed the Can Close? Will close in 30 days if there is no new activity label Apr 24, 2023

github-actions bot added the Can Close? Will close in 30 days if there is no new activity label Oct 22, 2023

github-actions bot closed this Nov 21, 2023

UebelAndre mentioned this pull request Jan 20, 2024

feat(py_wheel): Added requires_file and extra_requires_files attrs #1710

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add requires_file attr for py_wheel #644

feat: add requires_file attr for py_wheel #644

weixiao-huang commented Mar 8, 2022 •

edited

Loading

google-cla bot commented Mar 8, 2022

pstradomski commented Mar 13, 2022

weixiao-huang commented Mar 13, 2022

github-actions bot commented Sep 9, 2022

weixiao-huang commented Sep 10, 2022

UebelAndre commented Oct 10, 2022

UebelAndre left a comment

pstradomski Oct 13, 2022 •

edited

Loading

pstradomski Oct 13, 2022

github-actions bot commented Apr 11, 2023

chrislovecnm commented Apr 24, 2023

weixiao-huang commented Apr 25, 2023

github-actions bot commented Oct 22, 2023

github-actions bot commented Nov 21, 2023

feat: add requires_file attr for py_wheel #644

feat: add requires_file attr for py_wheel #644

Conversation

weixiao-huang commented Mar 8, 2022 • edited Loading

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

google-cla bot commented Mar 8, 2022

pstradomski commented Mar 13, 2022

weixiao-huang commented Mar 13, 2022

github-actions bot commented Sep 9, 2022

weixiao-huang commented Sep 10, 2022

UebelAndre commented Oct 10, 2022

UebelAndre left a comment

Choose a reason for hiding this comment

pstradomski Oct 13, 2022 • edited Loading

Choose a reason for hiding this comment

pstradomski Oct 13, 2022

Choose a reason for hiding this comment

github-actions bot commented Apr 11, 2023

chrislovecnm commented Apr 24, 2023

weixiao-huang commented Apr 25, 2023

github-actions bot commented Oct 22, 2023

github-actions bot commented Nov 21, 2023

weixiao-huang commented Mar 8, 2022 •

edited

Loading

pstradomski Oct 13, 2022 •

edited

Loading