Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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" + '
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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('^' + ".*" + '
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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('^' + ".*" + '
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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" + '
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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('^' + ".*" + '
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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('^' + ".*" + '
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer
, '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); } })(); })();
Skip to content

Exclude static libraries and tests to reduce zipped Python executables - #758

Merged
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables
Jul 28, 2022
Merged

Exclude static libraries and tests to reduce zipped Python executables#758
f0rmiga merged 4 commits into
bazel-contrib:mainfrom
tetsuok:exclude-static-libs-and-tests-from-py-executables

Conversation

@tetsuok

@tetsuoktetsuok commented Jul 16, 2022

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

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

PR Type

What kind of change does this PR introduce?

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

What is the current behavior?

Issue Number: N/A

Build artifacts by bazel build with the --build_python_zip option are unnecessary big. The size of the artifacts is at least 90MB (e.g., a zipped python binary which just prints "hello, world"). This is not great when build artifacts are included to docker images. The cause of this size issue is that the hermetic Python toolchain include the static libraries of the Python toolchain and tests for the standard libraries even though majority of users of rules_python don't need them. These files occupy 47MB (52% of an artifact of size 90MB).

Repro steps

WORKSPACE:

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name="rules_python",
sha256="a3a6e99f497be089f81ec082882e40246bfd435f52f4e82f37e89449b04573f6",
strip_prefix="rules_python-0.10.2",
url="https://github.com/bazelbuild/rules_python/archive/refs/tags/0.10.2.tar.gz",
)
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
python_register_toolchains(
name="python3_10",
python_version="3.10.4",
)

BUILD:

load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name="hello",
srcs= ["hello.py"],
)

hello.py:

print("hello, world!")
$ bazel build --build_python_zip //:hello
$ ls -lh bazel-bin/hello.zip
-r-xr-xr-x 1 t docker 91M Jul 17 11:55 bazel-bin/hello.zip

You can see some static libraries are included in the zip file (we have duplicated libpython3.10.a. The file size (uncompressed) of the static library is 38MB):

$ unzip -l bazel-bin/hello.zip | sort -n | grep ".a$"
2356 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitclstub4.2.2.a
149348 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/thread2.8.7/libthread2.8.7.a
496010 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/itcl4.2.2/libitcl4.2.2.a
526406 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/Tix8.4.3/libTix8.4.3.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.a
39633662 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/config-3.10-x86_64-linux-gnu/libpython3.10.a

What is the new behavior?

The static libraries and tests for the standard libraries in the Python toolchain are excluded from Python runfiles built by Python rules. Build artifacts by bazel build with the --build_python_zip get smaller. The size of the artifacts is at least 43MB, saving 47MB.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@thundergolferthundergolfer left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This change looks safe to me. As far as I can tell, these .a files are only being included in distributions to be re-consumed by other build processes and can't be useful in a Bazel Python runtime.


There's also a bunch of .tcl files that may be useless...

Comment threadpython/repositories.bzl Outdated
Co-authored-by: Jonathon Belotti <jonathon@canva.com>
@tetsuok

tetsuok commented Jul 19, 2022

Copy link
Copy Markdown
ContributorAuthor

There's also a bunch of .tcl files that may be useless...

Yes, that can be removed, but removing modules seems arguable to me. We might want to consider removing libpython{python_version}.so (libpython3.10.so for Python 3.10) first because the --build_python_zip option includes the two identical shared libraries, libpython{python_version}.so and libpython{python_version}.so.1.0 into zip files and because the shared libraries dominate the total size of zip files:

$ unzip -l bazel-bin/hello.zip | sort -n | tail -n 6
745004 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/pydoc_data/topics.py
816725 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/setuptools-58.1.0-py3-none-any.whl
2123599 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/python3.10/ensurepip/_bundled/pip-22.0.4-py3-none-any.whl
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so
38861696 2010-01-01 00:00 runfiles/python3_10_x86_64-unknown-linux-gnu/lib/libpython3.10.so.1.0
110513272 2381 files

The zip file should include either shared library. libpython{python_version}.so.1.0 is enough since it is referred in //python:libpython. Removing one of the shared libraries saves another 16 MB (43 MB → 27 MB).

Comment threadpython/repositories.bzl
@f0rmiga
f0rmiga merged commit 9cdb4f3 into bazel-contrib:mainJul 28, 2022
@tetsuok
tetsuok deleted the exclude-static-libs-and-tests-from-py-executables branch July 29, 2022 00:26
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.

3 participants

@tetsuok@f0rmiga@thundergolfer