feat: Package pyi files in wheel#2609

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
aignas merged 7 commits into from
Mar 6, 2025
Merged

feat: Package pyi files in wheel #2609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dc0d260
feat: Package pyi files in wheel
Synss Feb 6, 2025
70a5a65
feat: Package pyi files in `py_package`
Synss Feb 26, 2025
dbaa314
fix: Address review nits
Synss Feb 27, 2025
13f4b98
Merge branch 'main' into package-pyi-in-py_wheel
aignas Feb 27, 2025
56b96fe
Merge branch 'main' into package-pyi-in-py_wheel
aignas Mar 3, 2025
65c4f9d
Merge branch 'main' into package-pyi-in-py_wheel
Synss Mar 4, 2025
f3ce381
fix: wheel_test, extract_wheel_files_test, test_publish
Synss Mar 5, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down
4 changes: 4 additions & 0 deletions examples/wheel/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
deps = [
"//examples/wheel/lib:simple_module",
"//examples/wheel/lib:module_with_data",
"//examples/wheel/lib:module_with_type_annotations",
# Example dependency which is not packaged in the wheel
# due to "packages" filter on py_package rule.
"//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
version = "0.0.1",
deps = [
"//examples/wheel/lib:module_with_data",
"//examples/wheel/lib:module_with_type_annotations",
"//examples/wheel/lib:simple_module",
],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
version = "$(VERSION)",
deps = [
"//examples/wheel/lib:module_with_data",
"//examples/wheel/lib:module_with_type_annotations",
"//examples/wheel/lib:simple_module",
],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
version = "0.1.{BUILD_TIMESTAMP}",
deps = [
"//examples/wheel/lib:module_with_data",
"//examples/wheel/lib:module_with_type_annotations",
"//examples/wheel/lib:simple_module",
],
)
Expand Down
6 changes: 6 additions & 0 deletions examples/wheel/lib/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
srcs = ["simple_module.py"],
)

py_library(
name = "module_with_type_annotations",
srcs = ["module_with_type_annotations.py"],
pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
name = "module_with_data",
srcs = ["module_with_data.py"],
Expand Down
16 changes: 16 additions & 0 deletions examples/wheel/lib/module_with_type_annotations.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
return "qux"
15 changes: 15 additions & 0 deletions examples/wheel/lib/module_with_type_annotations.pyi
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...
2 changes: 2 additions & 0 deletions examples/wheel/main.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
print(function())
print(module_with_data.function())
print(module_with_type_annotations.function())
print(simple_module.function())


Expand Down
2 changes: 1 addition & 1 deletion examples/wheel/test_publish.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
</head>
<body>
<h1>Links for example-minimal-library</h1>
<a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
<a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
</body>
</html>"""
self.assertEqual(
Expand Down
34 changes: 25 additions & 9 deletions examples/wheel/wheel_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
zf.namelist(),
[
"examples/wheel/lib/module_with_data.py",
"examples/wheel/lib/module_with_type_annotations.py",
"examples/wheel/lib/module_with_type_annotations.pyi",
"examples/wheel/lib/simple_module.py",
"example_minimal_library-0.0.1.dist-info/WHEEL",
"example_minimal_library-0.0.1.dist-info/METADATA",
"example_minimal_library-0.0.1.dist-info/RECORD",
],
)
self.assertFileSha256Equal(
filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
)

def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
"examples/wheel/lib/data,with,commas.txt",
"examples/wheel/lib/data.txt",
"examples/wheel/lib/module_with_data.py",
"examples/wheel/lib/module_with_type_annotations.py",
"examples/wheel/lib/module_with_type_annotations.pyi",
"examples/wheel/lib/simple_module.py",
"examples/wheel/main.py",
"example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
],
)
self.assertFileSha256Equal(
filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
)

def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",
"examples/wheel/lib/data.txt",
"examples/wheel/lib/module_with_data.py",
"examples/wheel/lib/module_with_type_annotations.py",
"examples/wheel/lib/module_with_type_annotations.pyi",
"examples/wheel/lib/simple_module.py",
"examples/wheel/main.py",
"example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
)
self.assertFileSha256Equal(
filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
)

def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
"examples/wheel/lib/data,with,commas.txt",
"examples/wheel/lib/data.txt",
"examples/wheel/lib/module_with_data.py",
"examples/wheel/lib/module_with_type_annotations.py",
"examples/wheel/lib/module_with_type_annotations.pyi",
"examples/wheel/lib/simple_module.py",
"examples/wheel/main.py",
# PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
"wheel/lib/data,with,commas.txt",
"wheel/lib/data.txt",
"wheel/lib/module_with_data.py",
"wheel/lib/module_with_type_annotations.py",
"wheel/lib/module_with_type_annotations.pyi",
"wheel/lib/simple_module.py",
"wheel/main.py",
"examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
for line in record_contents.splitlines():
self.assertFalse(line.startswith("/"))
self.assertFileSha256Equal(
filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
)

def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
"data,with,commas.txt",
"data.txt",
"module_with_data.py",
"module_with_type_annotations.py",
"module_with_type_annotations.pyi",
"simple_module.py",
"main.py",
"example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
for line in record_contents.splitlines():
self.assertFalse(line.startswith("/"))
self.assertFileSha256Equal(
filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
)

def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
"lib/data,with,commas.txt",
"lib/data.txt",
"lib/module_with_data.py",
"lib/module_with_type_annotations.py",
"lib/module_with_type_annotations.pyi",
"lib/simple_module.py",
"main.py",
"example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
for line in record_contents.splitlines():
self.assertFalse(line.startswith("/"))
self.assertFileSha256Equal(
filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
)

def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
)
self.assertFileSha256Equal(
filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
)

def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
],
)
self.assertFileSha256Equal(
filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
)

def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down
3 changes: 3 additions & 0 deletions python/private/py_package.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
if hasattr(py_info, "transitive_pyc_files"):
inputs.add(py_info.transitive_pyc_files)

if hasattr(py_info, "transitive_pyi_files"):
inputs.add(py_info.transitive_pyi_files)

inputs = inputs.build()

# TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down
8 changes: 7 additions & 1 deletion python/private/py_wheel.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

name_file = ctx.actions.declare_file(ctx.label.name + ".name")

direct_pyi_files = []
for dep in ctx.attr.deps:
if PyInfo in dep:
direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

inputs_to_package = depset(
direct = ctx.files.deps,
direct = ctx.files.deps + direct_pyi_files,
)

# Inputs to this rule which are not to be packaged.
Expand Down
2 changes: 2 additions & 0 deletions tests/whl_filegroup/extract_wheel_files_test.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
"examples/wheel/lib/data,with,commas.txt",
"examples/wheel/lib/data.txt",
"examples/wheel/lib/module_with_data.py",
"examples/wheel/lib/module_with_type_annotations.py",
"examples/wheel/lib/module_with_type_annotations.pyi",
"examples/wheel/lib/simple_module.py",
"examples/wheel/main.py",
"example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down

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

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down

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

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down

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

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down

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

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down

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

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down

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

Skip to content
feat: Package pyi files in wheel#2609

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

aignas
merged 7 commits into

from

Mar 6, 2025
 Merged


feat: Package pyi files in wheel
#2609
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
dc0d260

feat: Package pyi files in wheel


Synss Feb 6, 2025
70a5a65

feat: Package pyi files in `py_package`


Synss Feb 26, 2025
dbaa314

fix: Address review nits


Synss Feb 27, 2025
13f4b98

Merge branch 'main' into package-pyi-in-py_wheel


aignas Feb 27, 2025
56b96fe

Merge branch 'main' into package-pyi-in-py_wheel


aignas Mar 3, 2025
65c4f9d

Merge branch 'main' into package-pyi-in-py_wheel


Synss Mar 4, 2025
f3ce381

fix: wheel_test, extract_wheel_files_test, test_publish


Synss Mar 5, 2025

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


2 changes: 2 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ Unreleased changes template.
{#v0-0-0-changed}
### Changed
* (deps) platforms 0.0.4 -> 0.0.11
* (py_wheel) Package `py_library.pyi_srcs` (`.pyi` files) in the wheel.
* (py_package) Package `py_library.pyi_srcs` (`.pyi` files) in `py_package`.

{#v0-0-0-fixed}
### Fixed
Expand Down

4 changes: 4 additions & 0 deletions
examples/wheel/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,7 @@ py_library(
 deps = [
 "//examples/wheel/lib:simple_module",
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 # Example dependency which is not packaged in the wheel
 # due to "packages" filter on py_package rule.
 "//tests/load_from_macro:foo",
Expand DownExpand Up@@ -67,6 +68,7 @@ py_wheel(
 version = "0.0.1",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -90,6 +92,7 @@ py_wheel(
 version = "$(VERSION)",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand All@@ -109,6 +112,7 @@ py_wheel(
 version = "0.1.{BUILD_TIMESTAMP}",
 deps = [
 "//examples/wheel/lib:module_with_data",
 "//examples/wheel/lib:module_with_type_annotations",
 "//examples/wheel/lib:simple_module",
 ],
)
Expand Down

6 changes: 6 additions & 0 deletions
examples/wheel/lib/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,12 @@ py_library(
 srcs = ["simple_module.py"],
)

py_library(
 name = "module_with_type_annotations",
 srcs = ["module_with_type_annotations.py"],
 pyi_srcs = ["module_with_type_annotations.pyi"],
)

py_library(
 name = "module_with_data",
 srcs = ["module_with_data.py"],
Expand Down

16 changes: 16 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function():
 return "qux"

15 changes: 15 additions & 0 deletions
examples/wheel/lib/module_with_type_annotations.pyi

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def function() -> str: ...

2 changes: 2 additions & 0 deletions
examples/wheel/main.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# limitations under the License.

import examples.wheel.lib.module_with_data as module_with_data
import examples.wheel.lib.module_with_type_annotations as module_with_type_annotations
import examples.wheel.lib.simple_module as simple_module


Expand All@@ -23,6 +24,7 @@ def function():
def main():
 print(function())
 print(module_with_data.function())
 print(module_with_type_annotations.function())
 print(simple_module.function())


Expand Down

2 changes: 1 addition & 1 deletion
examples/wheel/test_publish.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -104,7 +104,7 @@ def test_upload_and_query_simple_api(self):
 </head>
 <body>
 <h1>Links for example-minimal-library</h1>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 <a href="/packages/example_minimal_library-0.0.1-py3-none-any.whl#sha256=0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5">example_minimal_library-0.0.1-py3-none-any.whl</a><br>
 </body>
</html>"""
 self.assertEqual(
Expand Down

34 changes: 25 additions & 9 deletions
examples/wheel/wheel_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,14 +76,16 @@ def test_py_library_wheel(self):
 zf.namelist(),
 [
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "example_minimal_library-0.0.1.dist-info/WHEEL",
 "example_minimal_library-0.0.1.dist-info/METADATA",
 "example_minimal_library-0.0.1.dist-info/RECORD",
 ],
 )
 self.assertFileSha256Equal(
 filename, "79a4e9c1838c0631d5d8fa49a26efd6e9a364f6b38d9597c0f6df112271a0e28"
 filename, "0cbf4ec574676015af595f570caf4ae2812f994f6338e247b002b4e496b6fbd5"
 )

 def test_py_package_wheel(self):
Expand All@@ -98,6 +100,8 @@ def test_py_package_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand All@@ -106,7 +110,7 @@ def test_py_package_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "82370bf61310e2d3c7b1218368457dc7e161bf5dc1a280d7d45102b5e56acf43"
 filename, "22aff90dd3c8c30c3ce2b729bb793cab0bd2668a6810de232677a0354ce79cae"
 )

 def test_customized_wheel(self):
Expand All@@ -121,6 +125,8 @@ def test_customized_wheel(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_customized-0.0.1.dist-info/WHEEL",
Expand All@@ -145,8 +151,10 @@ def test_customized_wheel(self):
"examples/wheel/lib/data,with,commas.txt",sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/data.txt,sha256=9vJKEdfLu8bZRArKLroPZJh1XKkK3qFMXiM79MBL2Sg,12
examples/wheel/lib/module_with_data.py,sha256=8s0Khhcqz3yVsBKv2IB5u4l4TMKh7-c_V6p65WVHPms,637
examples/wheel/lib/module_with_type_annotations.py,sha256=MM2cFQsCBaUnzGiEGT5r07jhKSaCVRh5Paw_YLyrS-w,636
examples/wheel/lib/module_with_type_annotations.pyi,sha256=fja3ql_WRJ1qO8jyZjWWrTTMcg1J7EpOQivOHY_8vI4,630
examples/wheel/lib/simple_module.py,sha256=z2hwciab_XPNIBNH8B1Q5fYgnJvQTeYf0ZQJpY8yLLY,637
examples/wheel/main.py,sha256=sgg5iWN_9inYBjm6_Zw27hYdmo-l24fA-2rfphT-IlY,909
examples/wheel/main.py,sha256=mFiRfzQEDwCHr-WVNQhOH26M42bw1UMF6IoqvtuDTrw,1047
example_customized-0.0.1.dist-info/WHEEL,sha256=sobxWSyDDkdg_rinUth-jxhXHqoNqlmNMJY3aTZn2Us,91
example_customized-0.0.1.dist-info/METADATA,sha256=QYQcDJFQSIqan8eiXqL67bqsUfgEAwf2hoK_Lgi1S-0,559
example_customized-0.0.1.dist-info/entry_points.txt,sha256=pqzpbQ8MMorrJ3Jp0ntmpZcuvfByyqzMXXi2UujuXD0,137
Expand DownExpand Up@@ -197,7 +205,7 @@ def test_customized_wheel(self):
second = second.main:s""",
 )
 self.assertFileSha256Equal(
 filename, "706e8dd45884d8cb26e92869f7d29ab7ed9f683b4e2d08f06c03dbdaa12191b8"
 filename, "657a938a6fdd6f38bf73d1d91016ffff85d68cf29ca390692a3e9d923dd0e39e"
 )

 def test_filename_escaping(self):
Expand All@@ -211,6 +219,8 @@ def test_filename_escaping(self):
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 # PEP calls for replacing only in the archive filename.
Expand DownExpand Up@@ -248,6 +258,8 @@ def test_custom_package_root_wheel(self):
 "wheel/lib/data,with,commas.txt",
 "wheel/lib/data.txt",
 "wheel/lib/module_with_data.py",
 "wheel/lib/module_with_type_annotations.py",
 "wheel/lib/module_with_type_annotations.pyi",
 "wheel/lib/simple_module.py",
 "wheel/main.py",
 "examples_custom_package_root-0.0.1.dist-info/WHEEL",
Expand All@@ -265,7 +277,7 @@ def test_custom_package_root_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "568922541703f6edf4b090a8413991f9fa625df2844e644dd30bdbe9deb660be"
 filename, "d415edbf8f326161674c1fa260e364dd44f2a0311e2f596284320ea52d2a8bdb"
 )

 def test_custom_package_root_multi_prefix_wheel(self):
Expand All@@ -281,6 +293,8 @@ def test_custom_package_root_multi_prefix_wheel(self):
 "data,with,commas.txt",
 "data.txt",
 "module_with_data.py",
 "module_with_type_annotations.py",
 "module_with_type_annotations.pyi",
 "simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix-0.0.1.dist-info/WHEEL",
Expand All@@ -297,7 +311,7 @@ def test_custom_package_root_multi_prefix_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "a8b91ce9d6f570e97b40a357a292a6f595d3470f07c479cb08550257cc9c8306"
 filename, "6b76a1178c90996feaf3f9417f350c4a67f90f4247647fd4fd552858dc372d4b"
 )

 def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
Expand All@@ -313,6 +327,8 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 "lib/data,with,commas.txt",
 "lib/data.txt",
 "lib/module_with_data.py",
 "lib/module_with_type_annotations.py",
 "lib/module_with_type_annotations.pyi",
 "lib/simple_module.py",
 "main.py",
 "example_custom_package_root_multi_prefix_reverse_order-0.0.1.dist-info/WHEEL",
Expand All@@ -329,7 +345,7 @@ def test_custom_package_root_multi_prefix_reverse_order_wheel(self):
 for line in record_contents.splitlines():
 self.assertFalse(line.startswith("/"))
 self.assertFileSha256Equal(
 filename, "8f44e940731757c186079a42cfe7ea3d43cd96b526e3fb2ca2a3ea3048a9d489"
 filename, "f976f0bb1c7d753e8c41629d6b79fb09908c6ecd2fec006816879fc86b664f3f"
 )

 def test_python_requires_wheel(self):
Expand All@@ -354,7 +370,7 @@ def test_python_requires_wheel(self):
""",
 )
 self.assertFileSha256Equal(
 filename, "ba32493f5e43e481346384aaab9e8fa09c23884276ad057c5f432096a0350101"
 filename, "f3b74ce429c3324b87f8d1cc7dc33be1493f54bb88d546a7d53be7587b82c1a7"
 )

 def test_python_abi3_binary_wheel(self):
Expand DownExpand Up@@ -419,7 +435,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self):
 ],
 )
 self.assertFileSha256Equal(
 filename, "ac9216bd54dcae1a6270c35fccf8a73b0be87c1b026c28e963b7c76b2f9b722b"
 filename, "d8e874b807e5574bd11a9312c58ce7fe7055afb80412d0d0e7ed21fc9223cd53"
 )

 def test_rule_expands_workspace_status_keys_in_wheel_metadata(self):
Expand Down

3 changes: 3 additions & 0 deletions
python/private/py_package.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,9 @@ def _py_package_impl(ctx):
 if hasattr(py_info, "transitive_pyc_files"):
 inputs.add(py_info.transitive_pyc_files)

 if hasattr(py_info, "transitive_pyi_files"):
 inputs.add(py_info.transitive_pyi_files)

 inputs = inputs.build()

 # TODO: '/' is wrong on windows, but the path separator is not available in starlark.
Expand Down

8 changes: 7 additions & 1 deletion
python/private/py_wheel.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@

"Implementation of py_wheel rule"

load(":py_info.bzl", "PyInfo")
load(":py_package.bzl", "py_package_lib")
load(":py_wheel_normalize_pep440.bzl", "normalize_pep440")
load(":stamp.bzl", "is_stamping_enabled")
Expand DownExpand Up@@ -319,8 +320,13 @@ def _py_wheel_impl(ctx):

 name_file = ctx.actions.declare_file(ctx.label.name + ".name")

 direct_pyi_files = []
 for dep in ctx.attr.deps:
 if PyInfo in dep:
 direct_pyi_files.extend(dep[PyInfo].direct_pyi_files.to_list())

 inputs_to_package = depset(
 direct = ctx.files.deps,
 direct = ctx.files.deps + direct_pyi_files,
 )

 # Inputs to this rule which are not to be packaged.
Expand Down

2 changes: 2 additions & 0 deletions
tests/whl_filegroup/extract_wheel_files_test.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ def test_get_wheel_record(self) -> None:
 "examples/wheel/lib/data,with,commas.txt",
 "examples/wheel/lib/data.txt",
 "examples/wheel/lib/module_with_data.py",
 "examples/wheel/lib/module_with_type_annotations.py",
 "examples/wheel/lib/module_with_type_annotations.pyi",
 "examples/wheel/lib/simple_module.py",
 "examples/wheel/main.py",
 "example_minimal_package-0.0.1.dist-info/WHEEL",
Expand Down