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

Báo cáo vấn đề Xem nguồn Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Bối 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 một đối tượng repository_ctx làm đối số cho hàm implementation khi tạo một 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. Người dùng cung cấp các giá trị này (nếu không, hệ thống sẽ sử dụng giá trị mặc định).

xóa

bool repository_ctx.delete(path)

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

Thông số

Thông số Mô tả
path string; hoặc path; required
Đường dẫn của tệp cần xoá, tương ứng với thư mục kho lưu trữ hoặc đường dẫn 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 đã 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, thì đó là một hàm băm của tệp có các trường sha256 và integrity. Khi sha256 hoặc integrity do người dùng chỉ định, bạn nên đặt một canonical_id rõ ràng. ví dụ: get_default_canonical_id

Thông số

Thông số Mô tả
url string; hoặc Iterable của strings; bắt buộc
Danh sách các URL phản chiếu tham chiếu đến cùng một tệp.
output string; hoặc Label; hoặc path; mặc định là ''
đường dẫn đến tệp đầu ra, 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 đã 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à việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ đệm kho lưu trữ sẽ được kiểm tra để tìm một tệp có hàm băm đã cho; quá trình tải xuống sẽ chỉ được thực hiện 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.
executable mặc định là False
Đặt cờ thực thi trên tệp đã tạo, mặc định là false.
allow_fail mặc định là False
Nếu được đặt, hãy cho biết lỗi trong giá trị trả về thay vì tăng 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ế các lượt truy cập vào bộ nhớ đệm đối với những trường hợp mà tệp được thêm vào bộ nhớ đệm có cùng mã nhận dạng chuẩn. Theo mặc định, tính năng lưu vào bộ nhớ đệm sẽ sử dụng tổng kiểm (sha256 hoặc integrity).
auth mặc định là {}
Một từ điển không bắt buộc chỉ định thông tin xác thực cho một số URL.
headers mặc định là {}
Một từ điển không bắt buộc chỉ định tiêu đề http cho tất cả các URL.
integrity mặc định là ''
Tổng kiểm tra 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à việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ đệm kho lưu trữ sẽ được kiểm tra để tìm một tệp có tổng kiểm tra đã cho; quá trình tải xuống sẽ chỉ được thực hiện 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.
block mặc định là True
Nếu được đặ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 sẽ trả về một mã thông báo có một phương thức duy nhất, wait(). Phương thức 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 truyền 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 một 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, thì một hàm băm của tệp có các trường sha256 và integrity. Khi sha256 hoặc integrity do người dùng chỉ định, bạn nên đặt một canonical_id rõ ràng. ví dụ: get_default_canonical_id

Thông số

Thông số Mô tả
url string; hoặc Iterable của strings; bắt buộc
Danh sách các URL phản chiếu tham chiếu đến cùng một tệp.
output string; hoặc Label; hoặc path; mặc định là ''
Đường dẫn đến thư mục nơi kho 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 đã 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à việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ đệm kho lưu trữ sẽ được kiểm tra để tìm một tệp có hàm băm đã cho; quá trình tải xuống sẽ chỉ được thực hiện 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, bạn có thể chỉ định rõ "zip", "jar", "war", "aar", "nupkg", "tar", "tar.gz", "tgz", "tar.xz", "txz", ".tar.zst", ".tzst", "tar.bz2", ".tbz", ".ar" hoặc ".deb" tại đây.
stripPrefix mặc định là ''
Tiền tố thư mục cần 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ì phải chỉ định tiền tố này nhiều lần 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 mặc định là False
Nếu được đặt, hãy cho biết lỗi trong giá trị trả về thay vì tăng 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ế các lượt truy cập vào bộ nhớ đệm đối với những trường hợp mà tệp được thêm vào bộ nhớ đệm có cùng mã nhận dạng chuẩn. Theo mặc định, hoạt động lưu vào bộ nhớ đệm sẽ sử dụng tổng kiểm tra ("sha256" hoặc "integrity").
auth mặc định là {}
Một từ điển không bắt buộc chỉ định thông tin xác thực cho một số URL.
headers mặc định là {}
Một từ điển không bắt buộc chỉ định tiêu đề http cho tất cả các URL.
integrity mặc định là ''
Tổng kiểm tra 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à việc bỏ qua trường này sẽ khiến bản dựng của bạn không khép kín. Bạn không bắt buộc phải đặt để phát triển dễ dàng hơn, nhưng bạn nên đặt trước khi vận chuyển. Nếu được cung cấp, trước tiên, bộ nhớ đệm kho lưu trữ sẽ được kiểm tra để tìm một tệp có tổng kiểm tra đã cho; quá trình tải xuống sẽ chỉ được thực hiện 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.
rename_files mặc định là {}
Một từ điển 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 có bất kỳ điều chỉnh nào về tiền tố thư mục. Bạn có thể dùng tuỳ chọn này để trích xuất những tệp lưu trữ có tên tệp không phải là Unicode hoặc có các tệp sẽ được 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.

thực thi

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

Thực thi lệnh do danh sách đối số đưa ra. 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 đầu ra 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 đến quy trình.

Thông số

Thông số Mô tả
arguments required
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 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 mặc định là {}
Buộc một số biến môi trường phải được đặt để truyền đến quy trình.
quiet mặc định là True
Nếu stdout và stderr sẽ được in ra thiết bị đầu cuối.
working_directory mặc định là ""
Thư mục đang hoạt động để thực thi lệnh. Có thể tương đối với thư mục gốc của kho lưu trữ hoặc tuyệt đối. Giá trị mặc định là thư mục gốc của kho lưu trữ.

trích xuất

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

Giải nén 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 string; hoặc Label; hoặc path; bắt buộc
đường dẫn đến kho lưu trữ sẽ được giải nén, tương ứng với thư mục kho lưu trữ.
output string; hoặc Label; hoặc path; mặc định là ''
đường dẫn đến thư mục nơi kho lưu trữ sẽ được giải nén, tương ứng với thư mục kho lưu trữ.
stripPrefix mặc định là ''
, một tiền tố thư mục cần 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ì phải chỉ định tiền tố này nhiều lần 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.
rename_files mặc định là {}
Một từ điển 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 có bất kỳ điều chỉnh nào về tiền tố thư mục. Bạn có thể dùng tuỳ chọn này để trích xuất những tệp lưu trữ có tên tệp không phải là Unicode hoặc có các tệp sẽ được 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 mặc định là 'auto'
cho dù có theo dõi tệp lưu trữ hay không. Có thể là chuỗi "yes", "no" hoặc "auto". Truyền "yes" tương đương với việc gọi ngay phương thức watch(); truyền "no" sẽ không cố gắng theo dõi tệp; truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được phép (xem tài liệu 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ữ với nội dung được cung cấp.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc path; required
Đườ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, theo mặc định là trống.
executable mặc định là True
Đặt cờ thực thi trên tệp đã tạo, mặc định là true.
legacy_utf8 mặc định là True
Mã hoá nội dung tệp thành UTF-8, theo mặc định là true. Các phiên bản trong tương lai sẽ thay đổi giá trị mặc định và xoá tham số này.

getenv

string repository_ctx.getenv(name, default=None)

Trả về giá trị của một 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 bạn tạo 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; required
Name of desired environment variable.
default string; hoặc None; mặc định là None
Giá trị mặc định cần 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.

hệ điều hành

repository_os repository_ctx.os

Một cấu trúc để truy cập 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 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 chênh lệch hợp nhất tiêu chuẩn. Việc triển khai bản vá gốc của Bazel không hỗ trợ so khớp mờ và bản vá nhị phân như công cụ dòng lệnh vá.

Thông số

Thông số Mô tả
patch_file string; hoặc Label; hoặc path; bắt buộc
Tệp vá để á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 thành thư mục kho lưu trữ.
strip mặc định là 0
Xoá số lượng thành phần đầu tiên được chỉ định khỏi tên tệp.
watch_patch mặc định là 'auto'
Có theo dõi tệp bản vá hay không. Có thể là chuỗi "yes", "no" hoặc "auto". Truyền "yes" tương đương với việc gọi ngay phương thức watch(); truyền "no" sẽ không cố gắng theo dõi tệp; truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được phép (xem tài liệu 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ẽ được 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 đó 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ẽ được trả về nguyên trạng.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc path; required
string, Label hoặc path mà từ đó tạo ra một đườ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 path; required
Đường dẫn của tệp cần đọc.
watch mặc định là 'auto'
Có theo dõi tệp hay không. Có thể là chuỗi "yes", "no" hoặc "auto". Truyền "yes" tương đương với việc gọi ngay phương thức watch(); truyền "no" sẽ không cố gắng theo dõi tệp; truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được phép (xem tài liệu 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 để 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; mặc định là ''
string 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 path; required
Đường dẫn mà symlink sẽ trỏ đến.
string; hoặc Label; hoặc path; required
Đường dẫn của symlink cần tạo.

ManualContentEmbargoesScheduleTemplate.xlsx

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

Tạo một tệp mới bằng cách sử dụng template. Mọi lần xuất hiện trong template của một khoá 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 mộ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 string; hoặc Label; hoặc path; required
Đường dẫn của tệp cần tạo, tương ứng với thư mục kho lưu trữ.
template string; hoặc Label; hoặc path; required
Đường dẫn đến tệp mẫu.
substitutions mặc định là {}
Các giá trị thay thế cần thực hiện khi mở rộng mẫu.
executable mặc định là True
Đặt cờ thực thi trên tệp đã tạo, mặc định là true.
watch_template mặc định là 'auto'
Có theo dõi tệp mẫu hay không. Có thể là chuỗi "yes", "no" hoặc "auto". Truyền "yes" tương đương với việc gọi ngay phương thức watch(); truyền "no" sẽ không cố gắng theo dõi tệp; truyền "auto" sẽ chỉ cố gắng theo dõi tệp khi được 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 mất hiệu lực 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 đó đượ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 những thay đổi đối với nội dung của tệp (nếu đường dẫn là một tệp); nếu đường dẫn là một tệp nhưng hiện là một 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. Đặc biệt, lệnh 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. Để làm việc đó, hãy sử dụng path.readdir().

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 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 một đường dẫn bên ngoài không gian làm việc Bazel hiện tại cũng sẽ dẫn đến lỗi.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc path; required
Đường dẫn của tệp cần theo dõi.

watch_tree

None repository_ctx.watch_tree(path)

Yêu cầu Bazel theo dõi các thay đổi đối với mọi tệp hoặc thư mục một cách gián tiếp trong đường dẫn đã cho. 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 nếu bạn cố gắng theo dõi các đường dẫn bên trong kho lưu trữ đang được tìm nạp, thì sẽ xảy ra lỗi.

Thông số

Thông số Mô tả
path string; hoặc Label; hoặc path; required
Đườ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ề path của chương trình tương ứng hoặc None 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 required
Chương trình cần 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.