________ việc sử dụng dữ liệu

Báo cáo vấn đề Xem nguồn Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Ngữ cảnh của quy tắc kho lưu trữ chứa các hàm trợ giúp và thông tin về các thuộc tính. Bạn sẽ nhận được đối tượng repository_ctx làm đối số cho hàm implementation khi tạo quy tắc kho lưu trữ.

Hội viên

attr

struct repository_ctx.attr

Một cấu trúc để truy cập vào các giá trị của thuộc tính. Các giá trị do người dùng cung cấp (nếu không, giá trị mặc định sẽ được sử dụng).

xóa

bool repository_ctx.delete(path)

Xoá một tệp hoặc thư mục. Trả về một bool, cho biết liệu lệnh gọi này có thực sự xoá tệp hoặc thư mục hay không.

Thông số

Thông số Mô tả
path chuỗi; hoặc đường dẫn; bắt buộc
Đường dẫn của tệp cần xoá, tương ứng với thư mục kho lưu trữ hoặc tuyệt đối. Có thể là một đường dẫn hoặc một chuỗi.

tải xuống

unknown repository_ctx.download(url, output='', sha256='', executable=False, allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', block=True)

Tải một tệp xuống đường dẫn đầu ra cho URL được cung cấp và trả về một cấu trúc chứa success, một cờ là true nếu quá trình tải xuống hoàn tất thành công và nếu thành công, một hàm băm của tệp có các trường sha256 và integrity.

Thông số

Thông số Mô tả
url string; hoặc Có thể lặp lại của chuỗi; bắt buộc
Danh sách URL phản chiếu tham chiếu đến cùng một tệp.
output string; hoặc Label; hoặc đường dẫn; giá trị mặc định là ''
đường dẫn đến tệp đầu ra, so với thư mục kho lưu trữ.
sha256 mặc định là ''
hàm băm SHA-256 dự kiến của tệp đã tải xuống. Hàm băm này phải khớp với hàm băm SHA-256 của tệp đã tải xuống. Việc bỏ qua SHA-256 sẽ gây rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là bạn không nên bỏ qua trường này vì sẽ khiến bản dựng của bạn không kín. Bạn không bắt buộc phải thiết lập để phát triển ứng dụng dễ dàng hơn, nhưng nên thiết lập trước khi vận chuyển.
executable giá trị mặc định là False
đặt cờ thực thi trên tệp được tạo, mặc định là false.
allow_fail giá trị mặc định là False
Nếu được đặt, hãy chỉ ra lỗi trong giá trị trả về thay vì đưa ra lỗi cho các lượt tải xuống không thành công
canonical_id mặc định là ''
Nếu được đặt, hãy hạn chế số lượt truy cập vào bộ nhớ đệm ở những trường hợp tệp được thêm vào bộ nhớ đệm có cùng mã chuẩn
auth giá trị mặc định là {}
Một lệnh chính xác không bắt buộc chỉ định thông tin xác thực cho một số URL.
headers giá trị mặc định là {}
Nhập chính tả tuỳ chọn chỉ định tiêu đề http cho tất cả URL.
integrity mặc định là ''
Giá trị tổng kiểm dự kiến của tệp đã tải xuống, ở định dạng Tính toàn vẹn của tài nguyên phụ. Giá trị này phải khớp với tổng kiểm của tệp đã tải xuống. Việc bỏ qua tổng kiểm tra là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là bạn nên bỏ qua trường này để bản dựng của bạn không bị ngắt quãng. Bạn không bắt buộc phải thiết lập để phát triển ứng dụng dễ dàng hơn, nhưng nên thiết lập trước khi vận chuyển.
block giá trị mặc định là True
Nếu bạn đặt thành false, lệnh gọi sẽ trả về ngay lập tức và thay vì giá trị trả về thông thường, lệnh gọi này sẽ trả về một mã thông báo với một phương thức duy nhất là Wait(). Lệnh gọi này sẽ chặn cho đến khi quá trình tải xuống hoàn tất và trả về giá trị trả về thông thường hoặc gửi đi như bình thường.

download_and_extract

struct repository_ctx.download_and_extract(url, output='', sha256='', type='', stripPrefix='', allow_fail=False, canonical_id='', auth={}, headers={}, *, integrity='', rename_files={})

Tải tệp xuống đường dẫn đầu ra cho URL đã cung cấp, trích xuất tệp đó và trả về một cấu trúc chứa success, một cờ là true nếu quá trình tải xuống hoàn tất thành công và nếu thành công, một hàm băm của tệp có các trường sha256 và integrity.

Thông số

Thông số Mô tả
url string; hoặc Có thể lặp lại của chuỗi; bắt buộc
Danh sách URL phản chiếu tham chiếu đến cùng một tệp.
output string; hoặc Label; hoặc đường dẫn; giá trị mặc định là ''
đường dẫn đến thư mục nơi tệp lưu trữ sẽ được giải nén, tương ứng với thư mục kho lưu trữ.
sha256 mặc định là ''
hàm băm SHA-256 dự kiến của tệp đã tải xuống. Giá trị này phải khớp với hàm băm SHA-256 của tệp được tải xuống. Việc bỏ qua SHA-256 là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là bạn nên bỏ qua trường này để bản dựng của bạn không bị ngắt quãng. Bạn không bắt buộc phải thiết lập để phát triển ứng dụng dễ dàng hơn, nhưng nên thiết lập trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ đệm của kho lưu trữ sẽ được kiểm tra để tìm tệp có hàm băm đã cho; chỉ cố gắng tải xuống nếu không tìm thấy tệp trong bộ nhớ đệm. Sau khi tải xuống thành công, tệp sẽ được thêm vào bộ nhớ đệm.
type mặc định là ''
loại tệp lưu trữ của tệp đã tải xuống. Theo mặc định, loại tệp lưu trữ được xác định từ đuôi tệp của URL. Nếu tệp không có đuôi thì bạn có thể chỉ định rõ ràng là "zip", "jar", "war", "aar", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" hoặc ".deb" vào đây.
stripPrefix mặc định là ''
tiền tố thư mục để loại bỏ khỏi các tệp đã trích xuất. Nhiều tệp lưu trữ chứa một thư mục cấp cao nhất chứa tất cả các tệp trong tệp lưu trữ. Thay vì cần chỉ định nhiều lần tiền tố này trong build_file, bạn có thể dùng trường này để loại bỏ tiền tố khỏi các tệp đã trích xuất.
allow_fail giá trị mặc định là False
Nếu được đặt, hãy chỉ ra lỗi trong giá trị trả về thay vì đưa ra lỗi cho các lượt tải xuống không thành công
canonical_id mặc định là ''
Nếu được đặt, hãy hạn chế số lượt truy cập vào bộ nhớ đệm ở những trường hợp tệp được thêm vào bộ nhớ đệm có cùng mã chuẩn
auth giá trị mặc định là {}
Một lệnh chính xác không bắt buộc chỉ định thông tin xác thực cho một số URL.
headers giá trị mặc định là {}
Nhập chính tả tuỳ chọn chỉ định tiêu đề http cho tất cả URL.
integrity giá trị mặc định là ''
Giá trị tổng kiểm dự kiến của tệp đã tải xuống, ở định dạng Tính toàn vẹn của tài nguyên phụ. Giá trị này phải khớp với giá trị tổng kiểm của tệp đã tải xuống. Việc bỏ qua tổng kiểm tra là một rủi ro bảo mật vì các tệp từ xa có thể thay đổi. Tốt nhất là bạn không nên bỏ qua trường này vì sẽ khiến bản dựng của bạn không kín. Bạn không bắt buộc phải thiết lập để phát triển ứng dụng dễ dàng hơn, nhưng nên thiết lập trước khi vận chuyển.
rename_files giá trị mặc định là {}
Một lệnh chính xác không bắt buộc chỉ định các tệp cần đổi tên trong quá trình trích xuất. Các mục nhập lưu trữ có tên khớp chính xác với khoá sẽ được đổi tên thành giá trị, trước khi điều chỉnh tiền tố thư mục. Bạn có thể sử dụng công cụ này để trích xuất các tệp lưu trữ chứa tên tệp không phải Unicode hoặc có tệp sẽ trích xuất sang cùng một đường dẫn trong hệ thống tệp không phân biệt chữ hoa chữ thường.

thực hiện

exec_result repository_ctx.execute(arguments, timeout=600, environment={}, quiet=True, working_directory="")

Thực thi lệnh do danh sách đối số cung cấp. Thời gian thực thi của lệnh bị giới hạn bởi timeout (tính bằng giây, mặc định là 600 giây). Phương thức này trả về một cấu trúc exec_result chứa kết quả của lệnh. Bạn có thể dùng bản đồ environment để ghi đè một số biến môi trường sẽ được truyền vào quy trình.

Thông số

Thông số Mô tả
arguments bắt buộc
Danh sách đối số, phần tử đầu tiên phải là đường dẫn đến chương trình cần thực thi.
timeout giá trị mặc định là 600
thời lượng tối đa của lệnh tính bằng giây (mặc định là 600 giây).
environment giá trị mặc định là {}
buộc truyền một số biến môi trường vào quy trình.
quiet giá trị mặc định là True
Nếu phải in stdout và stderr vào thiết bị đầu cuối.
working_directory giá trị mặc định là ""
Thư mục đang làm việc để thực thi lệnh. Có thể tương đối so với gốc hoặc tuyệt đối của kho lưu trữ.

trích xuất

None repository_ctx.extract(archive, output='', stripPrefix='', *, rename_files={}, watch_archive='auto')

Trích xuất một tệp lưu trữ vào thư mục kho lưu trữ.

Thông số

Thông số Mô tả
archive chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
đường dẫn đến tệp lưu trữ sẽ được giải nén, tương ứng với thư mục kho lưu trữ.
output chuỗi; hoặc Nhãn; hoặc đường dẫn; giá trị mặc định là ''
đường dẫn đến thư mục nơi giải nén tệp lưu trữ, tương ứng với thư mục kho lưu trữ.
stripPrefix giá trị mặc định là ''
một tiền tố thư mục để xoá khỏi các tệp đã trích xuất. Nhiều tệp lưu trữ chứa một thư mục cấp cao nhất chứa tất cả các tệp trong tệp lưu trữ. Thay vì cần chỉ định tiền tố này nhiều lần trong build_file, bạn có thể dùng trường này để xoá tiền tố đó khỏi các tệp đã trích xuất.
rename_files mặc định là {}
Một dict không bắt buộc chỉ định các tệp cần đổi tên trong quá trình trích xuất. Các mục lưu trữ có tên khớp chính xác với một khoá sẽ được đổi tên thành giá trị đó, trước khi điều chỉnh tiền tố thư mục. Bạn có thể dùng tính năng này để trích xuất các tệp lưu trữ chứa tên tệp không phải Unicode hoặc có các tệp sẽ trích xuất vào cùng một đường dẫn trên các hệ thống tệp không phân biệt chữ hoa chữ thường.
watch_archive giá trị mặc định là 'auto'
có xem tệp lưu trữ hay không. Có thể là chuỗi "yes", "no" hoặc "auto". Việc truyền "yes" tương đương với việc gọi ngay phương thức watch(); việc truyền "no" sẽ không cố gắng theo dõi tệp; việc truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được phép (xem tài liệu về watch() để biết thêm thông tin.

tệp

None repository_ctx.file(path, content='', executable=True, legacy_utf8=True)

Tạo một tệp trong thư mục kho lưu trữ có nội dung được cung cấp.

Thông số

Thông số Mô tả
path chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
đường dẫn của tệp cần tạo, tương ứng với thư mục kho lưu trữ.
content mặc định là ''
nội dung của tệp cần tạo, trống theo mặc định.
executable mặc định là True
đặt cờ thực thi trên tệp đã tạo, đúng theo mặc định.
legacy_utf8 mặc định là True
mã hoá nội dung tệp thành UTF-8, đúng theo mặc định. Các phiên bản trong tương lai sẽ thay đổi giá trị mặc định và xoá thông số này.

getenv

string repository_ctx.getenv(name, default=None)

Trả về giá trị của biến môi trường name dưới dạng chuỗi nếu có hoặc default nếu không có.

Khi tạo theo cách tăng dần, mọi thay đổi đối với giá trị của biến do name đặt tên sẽ khiến kho lưu trữ này được tìm nạp lại.

Thông số

Thông số Mô tả
name string; bắt buộc
tên của biến môi trường mong muốn
default string; hoặc None; giá trị mặc định là None
Giá trị mặc định để trả về nếu không tìm thấy "name"
Có thể trả về None.

tên

string repository_ctx.name

Tên của kho lưu trữ bên ngoài do quy tắc này tạo.

os

repository_os repository_ctx.os

Một cấu trúc để truy cập vào thông tin từ hệ thống.

bản vá

None repository_ctx.patch(patch_file, strip=0, *, watch_patch='auto')

Áp dụng tệp bản vá cho thư mục gốc của kho lưu trữ bên ngoài. Tệp bản vá phải là tệp định dạng diff hợp nhất tiêu chuẩn. Quy trình triển khai bản vá gốc Bazel không hỗ trợ tính năng so khớp mờ và bản vá nhị phân như công cụ dòng lệnh của bản vá.

Thông số

Thông số Mô tả
patch_file chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
Tệp bản vá cần áp dụng, có thể là nhãn, đường dẫn tương đối hoặc đường dẫn tuyệt đối. Nếu là đường dẫn tương đối, đường dẫn này sẽ phân giải đến thư mục kho lưu trữ.
strip mặc định là 0
xoá số thành phần đầu tiên được chỉ định khỏi tên tệp.
watch_patch mặc định là 'auto'
liệu có xem tệp bản vá hay không. Có thể là chuỗi "yes", "no" hoặc "auto". Việc truyền "yes" tương đương với việc gọi ngay phương thức watch(); việc truyền "no" sẽ không cố gắng theo dõi tệp; việc truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được phép (xem tài liệu về watch() để biết thêm thông tin.

đường dẫn

path repository_ctx.path(path)

Trả về một đường dẫn từ một chuỗi, nhãn hoặc đường dẫn. Nếu đường dẫn là tương đối, thì đường dẫn sẽ phân giải tương ứng với thư mục kho lưu trữ. Nếu đường dẫn là một nhãn, thì đường dẫn này sẽ phân giải thành đường dẫn của tệp tương ứng. Xin lưu ý rằng các kho lưu trữ từ xa được thực thi trong giai đoạn phân tích và do đó không thể phụ thuộc vào kết quả mục tiêu (nhãn phải trỏ đến một tệp không được tạo). Nếu đường dẫn là một đường dẫn, thì đường dẫn đó sẽ trả về nguyên trạng đường dẫn đó.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc đường dẫn; bắt buộc
chuỗi, nhãn hoặc đường dẫn mà từ đó tạo đường dẫn

đọc

string repository_ctx.read(path, *, watch='auto')

Đọc nội dung của một tệp trên hệ thống tệp.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc đường dẫn; bắt buộc
đường dẫn của tệp cần đọc.
watch mặc định là 'auto'
liệu có theo dõi tệp hay không. Có thể là chuỗi "yes" (có), "no" (không) hoặc "auto" (tự động). Việc truyền "yes" tương đương với việc gọi ngay phương thức watch(); việc truyền "no" sẽ không cố gắng theo dõi tệp; việc truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được phép (xem tài liệu về watch() để biết thêm thông tin.

report_progress

None repository_ctx.report_progress(status='')

Cập nhật trạng thái tiến trình của quá trình tìm nạp tiện ích mô-đun hoặc kho lưu trữ này

Thông số

Thông số Mô tả
status string; giá trị mặc định là ''
chuỗi mô tả trạng thái hiện tại của tiến trình tìm nạp 

None repository_ctx.symlink(target, link_name)

Tạo một đường liên kết tượng trưng trên hệ thống tệp.

Thông số

Thông số Mô tả
target string; hoặc Label; hoặc đường dẫn; bắt buộc
Đường dẫn mà đường liên kết tượng trưng phải trỏ đến.
string; hoặc Label; hoặc path; bắt buộc
Đường dẫn của đường liên kết tượng trưng cần tạo.

ManualContentEmbargoesScheduleTemplate.xlsx

None repository_ctx.template(path, template, substitutions={}, executable=True, *, watch_template='auto')

Tạo tệp mới bằng template. Mọi lần xuất hiện trong template của khoá của substitutions sẽ được thay thế bằng giá trị tương ứng. Kết quả được viết bằng path. Bạn có thể đặt đối số executable không bắt buộc (mặc định là true) để bật hoặc tắt bit thực thi.

Thông số

Thông số Mô tả
path chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
đường dẫn của tệp cần tạo, tương ứng với thư mục kho lưu trữ.
template chuỗi; hoặc Nhãn; hoặc đường dẫn; bắt buộc
đường dẫn đến tệp mẫu.
substitutions giá trị mặc định là {}
thay thế để thực hiện khi mở rộng mẫu.
executable giá trị mặc định là True
đặt cờ thực thi trên tệp đã tạo thành true theo mặc định.
watch_template mặc định là 'auto'
liệu có xem tệp mẫu hay không. Có thể là chuỗi "yes" (có), "no" (không) hoặc "auto" (tự động). Chuyển giá trị "yes" tương đương với việc gọi ngay phương thức watch(); đang truyền "no" không cố xem tệp; truyền "auto" sẽ chỉ cố gắng xem tệp khi việc đó là hợp pháp (xem tài liệu watch() để biết thêm thông tin.

đồng hồ

None repository_ctx.watch(path)

Yêu cầu Bazel theo dõi các thay đổi đối với đường dẫn đã cho, cho dù đường dẫn đó có tồn tại hay không, hoặc cho dù đó là tệp hay thư mục. Mọi thay đổi đối với tệp hoặc thư mục sẽ làm vô hiệu hoá kho lưu trữ hoặc tiện ích mô-đun này, đồng thời khiến kho lưu trữ hoặc tiện ích mô-đun này được tìm nạp lại hoặc đánh giá lại vào lần tiếp theo.

"Thay đổi" bao gồm các thay đổi đối với nội dung của tệp (nếu đường dẫn là tệp); nếu đường dẫn là tệp nhưng hiện là thư mục hoặc ngược lại; và nếu đường dẫn bắt đầu hoặc ngừng tồn tại. Đáng chú ý là việc này không bao gồm các thay đổi đối với bất kỳ tệp nào trong thư mục đó nếu đường dẫn là một thư mục. Thay vào đó, hãy sử dụng path.readdir().

Xin lưu ý rằng việc cố gắng xem các đường dẫn bên trong kho lưu trữ hiện đang được tìm nạp hoặc bên trong thư mục đang hoạt động của tiện ích mô-đun hiện tại sẽ dẫn đến lỗi. Tiện ích mô-đun cố gắng theo dõi đường dẫn bên ngoài không gian làm việc Bazel hiện tại cũng sẽ gây ra lỗi.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc đường dẫn; bắt buộc
đường dẫn của tệp cần xem.

watch_tree

None repository_ctx.watch_tree(path)

Yêu cầu Bazel theo dõi các thay đổi đối với bất kỳ tệp hoặc thư mục nào theo cách bắc cầu theo đường dẫn nhất định. Mọi thay đổi đối với nội dung của tệp, sự tồn tại của tệp hoặc thư mục, tên tệp hoặc tên thư mục sẽ khiến kho lưu trữ này được tìm nạp lại.

Xin lưu ý rằng việc cố gắng theo dõi các đường dẫn bên trong kho lưu trữ đang được tìm nạp sẽ dẫn đến lỗi.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc đường dẫn; bắt buộc
đường dẫn của cây thư mục cần theo dõi.

thiết bị nào

path repository_ctx.which(program)

Trả về đường dẫn của chương trình tương ứng hoặc Không có nếu không có chương trình nào như vậy trong đường dẫn.

Thông số

Thông số Mô tả
program bắt buộc
Chương trình để tìm trong đường dẫn.
Có thể trả về None.

workspace_root

path repository_ctx.workspace_root

Đường dẫn đến không gian làm việc gốc của lệnh gọi bazel.