Quy tắc
py_binary
Xem nguồn quy tắcpy_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, imports, legacy_create_init, licenses, main, output_licenses, python_version, restricted_to, srcs_version, stamp, tags, target_compatible_with, testonly, toolchains, visibility)
py_binary là một chương trình Python có thể thực thi, bao gồm một tập hợp các tệp nguồn .py (có thể thuộc về các quy tắc py_library khác), một cây thư mục *.runfiles chứa tất cả mã và dữ liệu mà chương trình cần trong thời gian chạy, cũng như một tập lệnh giả lập khởi động chương trình bằng môi trường và dữ liệu ban đầu chính xác.
Ví dụ
py_binary(
name = "foo",
srcs = ["foo.py"],
data = [":transform"], # a cc_binary which we invoke at run time
deps = [
":foolib", # a py_library
],
)
Nếu bạn muốn chạy py_binary từ trong một tệp nhị phân hoặc kiểm thử khác (ví dụ: chạy tệp nhị phân python để thiết lập một số tài nguyên mô phỏng từ trong java_test), thì phương pháp chính xác là làm cho tệp nhị phân hoặc kiểm thử khác phụ thuộc vào py_binary trong phần dữ liệu của tệp đó. Sau đó, tệp nhị phân khác có thể định vị py_binary so với thư mục nguồn.
py_binary(
name = "test_main",
srcs = ["test_main.py"],
deps = [":testing"],
)
java_library(
name = "testing",
srcs = glob(["*.java"]),
data = [":test_main"]
)
Đối số
| Thuộc tính | |
|---|---|
name |
Tên; bắt buộc Tên duy nhất cho mục tiêu này. Nếu không chỉ định main, thì tên này phải giống với tên của tệp nguồn là điểm truy cập chính của ứng dụng, trừ đuôi tệp. Ví dụ: nếu điểm truy cập của bạn có tên là main.py, thì tên của bạn phải là main.
|
deps
|
Danh sách nhãn; mặc định là deps tại
Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
Đây thường là các quy tắc py_library.
|
srcs
|
Danh sách nhãn; bắt buộc Danh sách các tệp nguồn (.py) được xử lý để tạo mục tiêu.
Gói này bao gồm tất cả mã đã kiểm tra và mọi tệp nguồn được tạo. Mục tiêu thư viện thuộc về deps, trong khi các tệp nhị phân khác cần thiết trong thời gian chạy thuộc về data.
|
imports
|
Danh sách chuỗi; mặc định là PYTHONPATH.
Chịu sự thay thế của "Tạo biến". Các thư mục nhập này sẽ được thêm vào quy tắc này và tất cả các quy tắc phụ thuộc vào quy tắc này (lưu ý: không phải là các quy tắc mà quy tắc này phụ thuộc vào). Mỗi thư mục sẽ được thêm vào
Đường dẫn tuyệt đối (đường dẫn bắt đầu bằng |
legacy_create_init
|
Số nguyên; mặc định là --incompatible_default_to_explicit_init_py. Nếu giá trị là false, người dùng sẽ chịu trách nhiệm tạo các tệp __init__.py (có thể trống) và thêm các tệp đó vào srcs của các mục tiêu Python nếu cần.
|
main
|
Nhãn; mặc định là srcs. Nếu bạn không chỉ định, hệ thống sẽ sử dụng name (xem ở trên). Nếu name không khớp với tên tệp nào trong srcs, thì bạn phải chỉ định main.
|
python_version
|
Chuỗi; không thể định cấu hình; mặc định là deps bắc cầu của mục tiêu) cho Python 2 hay Python 3 hay không. Các giá trị hợp lệ là "PY2" và "PY3" (mặc định).
Phiên bản Python luôn được đặt lại (có thể theo mặc định) thành bất kỳ phiên bản nào được thuộc tính này chỉ định, bất kể phiên bản được chỉ định trên dòng lệnh hay bởi các mục tiêu cao hơn khác phụ thuộc vào phiên bản này. Nếu muốn Cảnh báo lỗi: Thuộc tính này đặt phiên bản mà Bazel xây dựng mục tiêu của bạn, nhưng do #4815, tập lệnh giả lập thu được vẫn có thể gọi sai phiên bản trình thông dịch trong thời gian chạy. Hãy xem giải pháp này, trong đó bao gồm việc xác định mục tiêu |
srcs_version
|
Chuỗi; mặc định là srcs của mục tiêu tương thích với Python 2, Python 3 hoặc cả hai. Để thực sự đặt phiên bản thời gian chạy Python, hãy sử dụng thuộc tính python_version của quy tắc Python có thể thực thi (py_binary hoặc py_test).
Các giá trị được phép là: Xin lưu ý rằng chỉ các quy tắc có thể thực thi ( Để nhận thông tin chẩn đoán về những phần phụ thuộc đưa ra yêu cầu về phiên bản, bạn có thể chạy phương diện
bazel build <your target> \
--aspects=@rules_python//python:defs.bzl%find_requirements \
--output_groups=pyversioninfo
-pyversioninfo.txt cung cấp thông tin
về lý do mục tiêu của bạn yêu cầu một phiên bản Python hay một phiên bản khác. Xin lưu ý rằng tính năng này hoạt động ngay cả khi mục tiêu đã cho không tạo được do xung đột phiên bản.
|
stamp
|
Số nguyên; mặc định là
Tệp nhị phân được đóng dấu không được tạo lại trừ khi các phần phụ thuộc của tệp đó thay đổi. |
py_library
Xem nguồn quy tắcpy_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, imports, licenses, restricted_to, srcs_version, tags, target_compatible_with, testonly, visibility)
Đối số
| Thuộc tính | |
|---|---|
name |
Tên; bắt buộc Tên duy nhất cho mục tiêu này. |
deps
|
Danh sách nhãn; mặc định là deps tại
Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
Đây thường là các quy tắc py_library.
|
srcs
|
Danh sách nhãn; mặc định là .py) được xử lý để tạo mục tiêu.
Gói này bao gồm tất cả mã đã kiểm tra và mọi tệp nguồn được tạo.
|
imports
|
Danh sách chuỗi; mặc định là PYTHONPATH.
Chịu sự thay thế của "Tạo biến". Các thư mục nhập này sẽ được thêm vào quy tắc này và tất cả các quy tắc phụ thuộc vào quy tắc này (lưu ý: không phải là các quy tắc mà quy tắc này phụ thuộc vào). Mỗi thư mục sẽ được thêm vào
Đường dẫn tuyệt đối (đường dẫn bắt đầu bằng |
srcs_version
|
Chuỗi; mặc định là srcs của mục tiêu tương thích với Python 2, Python 3 hoặc cả hai. Để thực sự đặt phiên bản thời gian chạy Python, hãy sử dụng thuộc tính python_version của quy tắc Python có thể thực thi (py_binary hoặc py_test).
Các giá trị được phép là: Xin lưu ý rằng chỉ các quy tắc có thể thực thi ( Để nhận thông tin chẩn đoán về những phần phụ thuộc đưa ra yêu cầu về phiên bản, bạn có thể chạy phương diện
bazel build <your target> \
--aspects=@rules_python//python:defs.bzl%find_requirements \
--output_groups=pyversioninfo
-pyversioninfo.txt cung cấp thông tin
về lý do mục tiêu của bạn yêu cầu một phiên bản Python hay một phiên bản khác. Xin lưu ý rằng tính năng này hoạt động ngay cả khi mục tiêu đã cho không tạo được do xung đột phiên bản.
|
py_test
Xem nguồn quy tắcpy_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, imports, legacy_create_init, licenses, local, main, python_version, restricted_to, shard_count, size, srcs_version, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility)
Quy tắc py_test() biên dịch một chương trình kiểm thử. Kiểm thử là một trình bao bọc tệp nhị phân
xung quanh một số mã kiểm thử.
Ví dụ
py_test(
name = "runtest_test",
srcs = ["runtest_test.py"],
deps = [
"//path/to/a/py/library",
],
)
Bạn cũng có thể chỉ định một mô-đun chính:
py_test(
name = "runtest_test",
srcs = [
"runtest_main.py",
"runtest_lib.py",
],
main = "runtest_main.py",
)
Đối số
| Thuộc tính | |
|---|---|
name |
Tên; bắt buộc Tên duy nhất cho mục tiêu này. |
deps
|
Danh sách nhãn; mặc định là deps tại
Các thuộc tính thông thường do hầu hết các quy tắc bản dựng xác định.
Đây thường là các quy tắc py_library.
|
srcs
|
Danh sách nhãn; bắt buộc Danh sách các tệp nguồn (.py) được xử lý để tạo mục tiêu.
Gói này bao gồm tất cả mã đã kiểm tra và mọi tệp nguồn được tạo. Mục tiêu thư viện thuộc về deps, trong khi các tệp nhị phân khác cần thiết trong thời gian chạy thuộc về data.
|
imports
|
Danh sách chuỗi; mặc định là PYTHONPATH.
Chịu sự thay thế của "Tạo biến". Các thư mục nhập này sẽ được thêm vào quy tắc này và tất cả các quy tắc phụ thuộc vào quy tắc này (lưu ý: không phải là các quy tắc mà quy tắc này phụ thuộc vào). Mỗi thư mục sẽ được thêm vào
Đường dẫn tuyệt đối (đường dẫn bắt đầu bằng |
legacy_create_init
|
Số nguyên; mặc định là --incompatible_default_to_explicit_init_py. Nếu giá trị là false, người dùng sẽ chịu trách nhiệm tạo các tệp __init__.py (có thể trống) và thêm các tệp đó vào srcs của các mục tiêu Python nếu cần.
|
main
|
Nhãn; mặc định là srcs. Nếu bạn không chỉ định, hệ thống sẽ sử dụng name (xem ở trên). Nếu name không khớp với tên tệp nào trong srcs, thì bạn phải chỉ định main.
|
python_version
|
Chuỗi; không thể định cấu hình; mặc định là deps bắc cầu của mục tiêu) cho Python 2 hay Python 3 hay không. Các giá trị hợp lệ là "PY2" và "PY3" (mặc định).
Phiên bản Python luôn được đặt lại (có thể theo mặc định) thành bất kỳ phiên bản nào được thuộc tính này chỉ định, bất kể phiên bản được chỉ định trên dòng lệnh hay bởi các mục tiêu cao hơn khác phụ thuộc vào phiên bản này. Nếu muốn Cảnh báo lỗi: Thuộc tính này đặt phiên bản mà Bazel xây dựng mục tiêu của bạn, nhưng do #4815, tập lệnh giả lập thu được vẫn có thể gọi sai phiên bản trình thông dịch trong thời gian chạy. Hãy xem giải pháp này, trong đó bao gồm việc xác định mục tiêu |
srcs_version
|
Chuỗi; mặc định là srcs của mục tiêu tương thích với Python 2, Python 3 hoặc cả hai. Để thực sự đặt phiên bản thời gian chạy Python, hãy sử dụng thuộc tính python_version của quy tắc Python có thể thực thi (py_binary hoặc py_test).
Các giá trị được phép là: Xin lưu ý rằng chỉ các quy tắc có thể thực thi ( Để nhận thông tin chẩn đoán về những phần phụ thuộc đưa ra yêu cầu về phiên bản, bạn có thể chạy phương diện
bazel build <your target> \
--aspects=@rules_python//python:defs.bzl%find_requirements \
--output_groups=pyversioninfo
-pyversioninfo.txt cung cấp thông tin
về lý do mục tiêu của bạn yêu cầu một phiên bản Python hay một phiên bản khác. Xin lưu ý rằng tính năng này hoạt động ngay cả khi mục tiêu đã cho không tạo được do xung đột phiên bản.
|
stamp
|
Số nguyên; mặc định là |
py_runtime
Xem nguồn quy tắcpy_runtime(name, bootstrap_template, compatible_with, coverage_tool, deprecation, distribs, features, files, interpreter, interpreter_path, licenses, python_version, restricted_to, stub_shebang, tags, target_compatible_with, testonly, visibility)
Biểu thị môi trường thời gian chạy Python dùng để thực thi mã Python.
Mục tiêu py_runtime có thể đại diện cho thời gian chạy nền tảng hoặc thời gian chạy tích hợp. Môi trường thời gian chạy nền tảng truy cập vào trình thông dịch do hệ thống cài đặt tại một đường dẫn đã biết, trong khi môi trường thời gian chạy tích hợp sẵn trỏ đến một mục tiêu thực thi đóng vai trò là trình thông dịch. Trong cả hai trường hợp, "trình thông dịch" có nghĩa là bất kỳ tập lệnh bao bọc hoặc tệp nhị phân có thể thực thi nào có khả năng chạy tập lệnh Python được truyền trên dòng lệnh, tuân theo các quy ước giống như trình thông dịch CPython tiêu chuẩn.
Thời gian chạy nền tảng theo bản chất là không kín. Trình biên dịch này áp đặt một yêu cầu đối với nền tảng mục tiêu là phải có trình thông dịch nằm ở một đường dẫn cụ thể. Thời gian chạy tích hợp có thể kín hoặc không kín, tuỳ thuộc vào việc thời gian chạy đó trỏ đến trình thông dịch đã kiểm tra hay tập lệnh trình bao bọc truy cập vào trình thông dịch hệ thống.
Ví dụ:
py_runtime(
name = "python-2.7.12",
files = glob(["python-2.7.12/**"]),
interpreter = "python-2.7.12/bin/python",
)
py_runtime(
name = "python-3.6.0",
interpreter_path = "/opt/pyenv/versions/3.6.0/bin/python",
)
Đối số
| Thuộc tính | |
|---|---|
name |
Tên; bắt buộc Tên duy nhất cho mục tiêu này. |
bootstrap_template
|
Nhãn; mặc định là |
coverage_tool
|
Nhãn; mặc định là py_binary và py_test.
Nếu được đặt, mục tiêu phải tạo một tệp duy nhất hoặc là mục tiêu có thể thực thi. Đường dẫn đến một tệp hoặc tệp thực thi nếu mục tiêu là tệp thực thi, xác định điểm truy cập cho công cụ đo lường mức độ sử dụng python. Mục tiêu và các tệp chạy của mục tiêu đó sẽ được thêm vào tệp chạy khi bạn bật tính năng mức độ sử dụng. Điểm truy cập của công cụ phải có thể tải được bằng trình thông dịch python (ví dụ: tệp |
files
|
Danh sách nhãn; mặc định là |
interpreter
|
Nhãn; mặc định là |
interpreter_path
|
Chuỗi; mặc định là |
python_version
|
Chuỗi; mặc định là "PY2" và "PY3".
Giá trị mặc định được kiểm soát bằng cờ |
stub_shebang
|
Chuỗi; mặc định là py_binary.
Hãy xem vấn đề 8685 để biết lý do. Không áp dụng cho Windows. |