Skip to content

fix(bzlmod): correctly template repository macros for requirements, etc#1190

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
rickeylev merged 2 commits into from
May 1, 2023
Merged

fix(bzlmod): correctly template repository macros for requirements, etc #1190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e485f75
fix(bzlmod): correctly template repository macros for requirements, etc
aignas Apr 30, 2023
915b1ec
comment: improve code layout
aignas May 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion python/pip_install/pip_repository.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
else:
build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

# NOTE: we are using the canonical name with the double '@' in order to
# always uniquely identify a repository, as the labels are being passed as
# a string and the resolution of the label happens at the call-site of the
# `requirement`, et al. macros.
Comment on lines +370 to +373

@rickeylevrickeylevMay 1, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.

Since we're dealing with canonical names, that re-evaluation shouldn't matter much.

resolution happens at the call site of the macro

Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.

if rctx.attr.incompatible_generate_aliases:
macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
else:
macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

rctx.file("BUILD.bazel", build_contents)
rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
"%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
"@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
for p in bzl_packages
]),
"%%NAME%%": rctx.attr.name,
"%%MACRO_TMPL%%": macro_tmpl,
"%%REQUIREMENTS_LOCK%%": str(requirements_txt),
})

Expand Down
8 changes: 4 additions & 4 deletions python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
return "@@%%NAME%%//:" + _clean_name(name) + "_data"
return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(bzlmod): correctly template repository macros for requirements, etc by aignas · Pull Request #1190 · bazel-contrib/rules_python · GitHub
Skip to content
fix(bzlmod): correctly template repository macros for requirements, etc#1190

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(bzlmod): correctly template repository macros for requirements, etc by aignas · Pull Request #1190 · bazel-contrib/rules_python · GitHub
Skip to content
fix(bzlmod): correctly template repository macros for requirements, etc#1190

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(bzlmod): correctly template repository macros for requirements, etc by aignas · Pull Request #1190 · bazel-contrib/rules_python · GitHub
Skip to content
fix(bzlmod): correctly template repository macros for requirements, etc#1190

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(bzlmod): correctly template repository macros for requirements, etc by aignas · Pull Request #1190 · bazel-contrib/rules_python · GitHub
Skip to content
fix(bzlmod): correctly template repository macros for requirements, etc#1190

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")

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

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

rickeylev
merged 2 commits into

from

May 1, 2023
 Merged


fix(bzlmod): correctly template repository macros for requirements, etc
#1190
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
e485f75

fix(bzlmod): correctly template repository macros for requirements, etc


aignas Apr 30, 2023
915b1ec

comment: improve code layout


aignas May 1, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 10 additions & 1 deletion
python/pip_install/pip_repository.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,6 +367,15 @@ def _pip_repository_bzlmod_impl(rctx):
 else:
 build_contents += _bzlmod_pkg_aliases(repo_name, bzl_packages)

 # NOTE: we are using the canonical name with the double '@' in order to
 # always uniquely identify a repository, as the labels are being passed as
 # a string and the resolution of the label happens at the call-site of the
 # `requirement`, et al. macros.

Comment on lines

+370
 to 
+373

@rickeylevrickeylevMay 1, 2023

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

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

Thanks for the doc. Yeah, this is kind of confusing. We pass the canonical name, but it later gets "reparsed" into a slightly different string by the generated requirements.bzl, so it'll get re-evaluated in (potentially) another context.
Since we're dealing with canonical names, that re-evaluation shouldn't matter much.
resolution happens at the call site of the macro
Well, sort of. IIUC, resolution happens when Label() is called. This occurs when Label() is called manually or when a string is passed to a label attribute (i.e. rule invocation). When it occurs, it'll use the context of the current repo to resolve it. e.g. when repo A calls a macro in repo B, and passes a string label, then the string gets resolved with repo B's mappings. If repo A calls Label() before passing to repo B, then it'll use A's mappings.
 if rctx.attr.incompatible_generate_aliases:
 macro_tmpl = "@@{name}//{{}}:{{}}".format(name = rctx.attr.name)
 else:
 macro_tmpl = "@@{name}//:{{}}_{{}}".format(name = rctx.attr.name)

 rctx.file("BUILD.bazel", build_contents)
 rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
 "%%ALL_REQUIREMENTS%%": _format_repr_list([
Expand All@@ -377,7 +386,7 @@ def _pip_repository_bzlmod_impl(rctx):
 "@{}//{}:whl".format(repo_name, p) if rctx.attr.incompatible_generate_aliases else "@{}_{}//:whl".format(rctx.attr.name, p)
 for p in bzl_packages
 ]),
 "%%NAME%%": rctx.attr.name,
 "%%MACRO_TMPL%%": macro_tmpl,
 "%%REQUIREMENTS_LOCK%%": str(requirements_txt),
 })

Expand Down

8 changes: 4 additions & 4 deletions
python/pip_install/pip_repository_requirements_bzlmod.bzl.tmpl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,13 +12,13 @@ def _clean_name(name):
 return name.replace("-", "_").replace(".", "_").lower()

def requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_pkg"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "pkg")

def whl_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_whl"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "whl")

def data_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_data"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "data")

def dist_info_requirement(name):
 return "@@%%NAME%%//:" + _clean_name(name) + "_dist_info"
 return "%%MACRO_TMPL%%".format(_clean_name(name), "dist_info")