pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

pip_compile: remove external/workspace_name prefix from generated requirements.txt - #690

Merged
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689
Jun 21, 2022
Merged

pip_compile: remove external/workspace_name prefix from generated requirements.txt#690
alexeagle merged 5 commits into
bazel-contrib:mainfrom
BoleynSu:fix689

Conversation

@BoleynSu

@BoleynSuBoleynSu commented Apr 16, 2022

Copy link
Copy Markdown
Contributor

Fixes#689

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: #689

What is the new behavior?

In the generated file via -r filename will be replaced with via -r -.

Does this PR introduce a breaking change?

  • Yes
  • No

The existing generated tests will fail and a regeneration is required.

Other information

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

The test is not added yet and I am expecting to break some existing ones.
I will fix them and add a new one once the PR is SGTMed.

@BoleynSu
BoleynSu marked this pull request as draft April 20, 2022 15:08
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Friendly ping.

@alexeagle

Copy link
Copy Markdown
Contributor

I don't think this is really an improvement - these from lines are useful documentation to say where a requirement came from, and the user doesn't understand what stdin is in this case, it's hidden by Bazel.

Can we just fixup the external pathing before writing the file instead?

@alexeaglealexeagle self-assigned this Apr 22, 2022
@BoleynSu

BoleynSu commented Apr 23, 2022 via email

Copy link
Copy Markdown
ContributorAuthor

@BoleynSu
BoleynSuforce-pushed the fix689 branch 2 times, most recently from 7d86772 to 34fb449CompareApril 23, 2022 08:41
@BoleynSuBoleynSu changed the title pip_compile: use stdin instead of a filenamepip_compile: remove external/workspace_name prefix from generated requirements.txtApr 23, 2022
@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

As a byproduct, this also allows |compile_pip_requirements| to comsume a generated requirements.in.
@alexeagle PTAL. I can add some tests after you think the PR is OK.

@BoleynSu
BoleynSu marked this pull request as ready for review April 24, 2022 16:55
@f0rmiga

Copy link
Copy Markdown
Member

@alexeagle Seems valid to me with proper tests. Anything else you want @BoleynSu to change?

@alexeagle

Copy link
Copy Markdown
Contributor

Yup, seems like a targeted fix. Even a simple test by checking in a requirements file that currently has an external/ segment would help.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Cool. I will add some tests later. I have implemented something simliar to @unpinned_maven//:pin which depend on this fix. Maybe I can use that as a test here.

@BoleynSu

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle and @f0rmiga, I have added the tests PTAL. Also I implemented something simliar to @unpinned_maven//:pin in the test. Would you mind also check if that can be part of the contributed repository rules?

@BoleynSu
BoleynSuforce-pushed the fix689 branch 3 times, most recently from e1549e9 to fc806a9CompareMay 4, 2022 20:07

PIP_PACKAGES = {"sphinx": "4.5.0"}

pip_deps(

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

this was the intent of the pip_parse_vendored example introduced in 12662b6

The major issue with pip_parse_vendored and the approach used for golang is that the meta data is unknown to Bazel. With pip_deps, one can save all the metadata in a .bzl file so that the downstream can consume it, e.g., use it to resolve diamond dependency.

I did something similar with golang dependencies at https://github.com/BoleynSu-Org/monorepo/blob/main/configs/deps/go_deps.bzl.

could you just update that example instead of introducing another e2e test? They are kinda slow so it would be better not to accumulate more.

Sure, I think I can merge it into another e2e test.

Also this doc 12662b6#diff-b92f94a67df862cde9714ff224afa676e39fe02da4fd4c6993daf684fbbc7cbdR182-R186 should maybe be updated?

- "-//gazelle/..."
# The dependencies needed for this test are not cross-platform: https://github.com/bazelbuild/rules_python/issues/260
- "-//tests:pip_repository_entry_points_example"
- "-//tests:pip_deps_example"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

why doesn't it work on Windows?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure. I guessed it was because bazel_integration_test did not work well on Windows, which is likely wrong.

The error is caused by os.chdir("external\\unpinned_pip") reporting no such directory. I do not have a Windows machine to debug it at the moment. Would you mind take a look if possible?

Comment threadpython/pip_install/pip_compile.py
python_interpreter_target = None,
**kwargs):
_requirements_in(
name = "unpinned_" + name,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think the term "unpinned" may be inaccurate here. I'm not sure how it compares with rules_jvm_external, but here, the existing locked requirements file is still an input to pip-compile, so any already-pinned transitive dependencies will remain pinned to the same version. Only versions which no longer satisfy the constraints in requirements.in will actually change.

The input to _requirements_in is packages and output is a requirements.in file. None of them have anything to do with the locked requirements file.

If the behavior is different from rules_jvm_external, then maybe another name would be better?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There's a requirements_lock attribute here that gets passed to pip_compile. Am I missing something?

@BoleynSuBoleynSuMay 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I see. Yes, the locked requirements file is also part of the input.

It seems that [1] we can pass --upgrade to achive this. It only read the locked file when there is no --upgrade. I am also wondering why --upgrade is not passed already? I think people are expecting this. We would better document it somewhere.

Also, in my usecase the requirements.txt is always generated so I did not ever notice it.

[1] https://github.com/jazzband/pip-tools/blob/master/piptools/scripts/compile.py#L352

Comment threadtests/pip_deps/pip_deps.bzl
@BoleynSu

BoleynSu commented May 5, 2022

Copy link
Copy Markdown
ContributorAuthor

Hi @alexeagle, I will remove pip_deps for now and add the test to existing an e2e test. I will propose another PR regarding pip_deps if you think it is worth the effort. If so, maybe we can first decide a better name for it.

@BoleynSu

BoleynSu commented May 8, 2022

Copy link
Copy Markdown
ContributorAuthor

@alexeaglealexeagle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks! sorry this got stalled for so long.

@alexeagle

Copy link
Copy Markdown
Contributor

I'll get this in so that #689 can be fixed.

@alexeagle
alexeagle merged commit aef17ad into bazel-contrib:mainJun 21, 2022
mattem pushed a commit to mattem/rules_python that referenced this pull request Jul 7, 2022
…uirements.txt (bazel-contrib#690)
* pip_compile: remove external/workspace_name prefix from generated requirements.txt
* add some tests and a demo impl of pip_deps
* update pinned requirement
Co-authored-by: Alex Eagle <alex@aspect.dev>
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 17, 2022
alexeagle added a commit that referenced this pull request Aug 18, 2022
Sign up for freeto 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.

the test created by compile_pip_requirements will fail when run as an external dependency

3 participants

@BoleynSu@alexeagle@f0rmiga