thuộc tính

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Đây là mô-đun cấp cao nhất dùng để xác định giản đồ thuộc tính của một quy tắc hoặc khía cạnh. Mỗi hàm trả về một đối tượng đại diện cho giản đồ của một thuộc tính. Các đối tượng này được dùng làm giá trị của đối số trong từ điển attrs của rule() và aspect().

Xem trang Quy tắc để tìm hiểu thêm về cách xác định và sử dụng thuộc tính.

Hội viên

bool

Attribute attr.bool(default=False, doc=None, mandatory=False)

Tạo giản đồ cho một thuộc tính boolean. Thuộc tính ctx.attr tương ứng sẽ thuộc loại bool.

Thông số

Thông số Mô tả
default mặc định là False
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao của quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).

int

Attribute attr.int(default=0, doc=None, mandatory=False, values=[])

Tạo giản đồ cho một thuộc tính số nguyên. Giá trị phải nằm trong phạm vi 32 bit đã ký. Thuộc tính ctx.attr tương ứng sẽ thuộc loại int.

Thông số

Thông số Mô tả
default mặc định là 0
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo thực thể quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
values trình tự của int; giá trị mặc định là []
Danh sách các giá trị được phép cho thuộc tính. Lỗi sẽ xảy ra nếu bạn cung cấp bất kỳ giá trị nào khác.

int_list

Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)

Tạo giản đồ cho thuộc tính danh sách số nguyên. Mỗi phần tử phải nằm trong phạm vi 32 bit đã ký.

Thông số

Thông số Mô tả
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
allow_empty mặc định là True
Đúng nếu thuộc tính có thể để trống.
default trình tự của int; giá trị mặc định là []
. Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao của quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.

nhãn

Attribute attr.label(default=None, doc=None, executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[])

Tạo giản đồ cho thuộc tính nhãn. Đây là thuộc tính phần phụ thuộc.

Thuộc tính này chứa các giá trị Label riêng biệt. Nếu một chuỗi được cung cấp thay cho Label, thì chuỗi đó sẽ được chuyển đổi bằng hàm khởi tạo nhãn. Các phần tương đối của đường dẫn nhãn, bao gồm cả kho lưu trữ (có thể được đổi tên), được phân giải liên quan đến gói của mục tiêu được tạo bản sao.

Tại thời điểm phân tích (trong hàm triển khai của quy tắc), khi truy xuất giá trị thuộc tính từ ctx.attr, các nhãn sẽ được thay thế bằng Target tương ứng. Điều này cho phép bạn truy cập vào các nhà cung cấp của phần phụ thuộc của mục tiêu hiện tại.

Ngoài các tệp nguồn thông thường, loại thuộc tính này thường được dùng để tham chiếu đến một công cụ, chẳng hạn như trình biên dịch. Các công cụ như vậy được coi là phần phụ thuộc, giống như tệp nguồn. Để tránh yêu cầu người dùng chỉ định nhãn của công cụ mỗi khi họ sử dụng quy tắc trong tệp BUILD, bạn có thể mã hoá cứng nhãn của một công cụ chuẩn hoá dưới dạng giá trị default của thuộc tính này. Nếu cũng muốn ngăn người dùng ghi đè giá trị mặc định này, bạn có thể đặt thuộc tính ở chế độ riêng tư bằng cách đặt tên bắt đầu bằng dấu gạch dưới. Hãy xem trang Quy tắc để biết thêm thông tin.

Thông số

Thông số Mô tả
default Label; hoặc string; hoặc LateBoundDefault; hoặc NativeComputedDefault; hoặc function; hoặc None; mặc định là None
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao của quy tắc.Sử dụng một chuỗi hoặc hàm Label để chỉ định giá trị mặc định, ví dụ: attr.label(default = "//a:b").
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
executable mặc định là False
Đúng nếu phần phụ thuộc phải có thể thực thi. Điều này có nghĩa là nhãn phải tham chiếu đến một tệp thực thi hoặc một quy tắc xuất ra một tệp thực thi. Truy cập vào nhãn bằng ctx.executable.<attribute_name>.
allow_files bool; hoặc trình tự của chuỗi; hoặc None; mặc định là None
Liệu có cho phép mục tiêu File hay không. Có thể là True, False (mặc định) hoặc danh sách các đuôi tệp được phép (ví dụ: [".cc", ".cpp"]).
allow_single_file giá trị mặc định là None
Điều này tương tự như allow_files, nhưng có quy định hạn chế là nhãn phải tương ứng với một Tệp. Truy cập vào thông tin này thông qua ctx.file.<attribute_name>.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
providers mặc định là []
Các trình cung cấp phải được cung cấp qua bất kỳ phần phụ thuộc nào xuất hiện trong thuộc tính này.

Định dạng của đối số này là danh sách các danh sách nhà cung cấp – đối tượng *Info do provider() trả về (hoặc trong trường hợp của nhà cung cấp cũ, tên chuỗi của nhà cung cấp đó). Phần phụ thuộc phải trả về TẤT CẢ các nhà cung cấp được đề cập trong ít nhất MỘT danh sách bên trong. Để thuận tiện, đối số này cũng có thể là danh sách một cấp của các nhà cung cấp, trong trường hợp này, đối số này được gói trong một danh sách bên ngoài có một phần tử. Không bắt buộc quy tắc của phần phụ thuộc phải quảng cáo các nhà cung cấp đó trong tham số provides, tuy nhiên, đây được coi là phương pháp hay nhất.

allow_rules trình tự của chuỗi; hoặc None; mặc định là None
Các mục tiêu quy tắc (tên của các lớp) được cho phép. Phương thức này không còn được dùng nữa (chỉ giữ lại để đảm bảo khả năng tương thích), hãy sử dụng trình cung cấp.
cfg mặc định là None
Cấu hình của thuộc tính. Giá trị này có thể là "exec", cho biết phần phụ thuộc được tạo cho execution platform hoặc "target", cho biết phần phụ thuộc được tạo cho target platform. Một ví dụ điển hình về sự khác biệt là khi tạo ứng dụng di động, trong đó target platform là Android hoặc iOS trong khi execution platform là Linux, macOS hoặc Windows. Tham số này là bắt buộc nếu executable là True để tránh vô tình tạo các công cụ lưu trữ trong cấu hình đích. "target" không có hiệu lực ngữ nghĩa, vì vậy, đừng đặt thuộc tính này khi executable là False, trừ phi thuộc tính này thực sự giúp làm rõ ý định của bạn.
aspects trình tự của Aspect; giá trị mặc định là []
. Các khía cạnh cần được áp dụng cho phần phụ thuộc hoặc các phần phụ thuộc do thuộc tính này chỉ định.

label_keyed_string_dict

Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

Tạo giản đồ cho một thuộc tính chứa từ điển, trong đó khoá là nhãn và giá trị là chuỗi. Đây là thuộc tính phần phụ thuộc.

Thuộc tính này chứa các giá trị Label duy nhất. Nếu bạn cung cấp một chuỗi thay vì Label, chuỗi đó sẽ được chuyển đổi bằng hàm khởi tạo nhãn. Các phần tương đối của đường dẫn nhãn, bao gồm cả kho lưu trữ (có thể được đổi tên), được phân giải liên quan đến gói của mục tiêu được tạo bản sao.

Tại thời điểm phân tích (trong hàm triển khai của quy tắc), khi truy xuất giá trị thuộc tính từ ctx.attr, nhãn sẽ được thay thế bằng các Target tương ứng. Nhờ vậy, bạn có thể truy cập vào các trình cung cấp phần phụ thuộc của mục tiêu hiện tại.

Thông số

Thông số Mô tả
allow_empty mặc định là True
Đúng nếu thuộc tính có thể để trống.
default dict; hoặc function; mặc định là {}
Một giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo thực thể cho quy tắc.Sử dụng chuỗi hoặc hàm Label để chỉ định giá trị mặc định, chẳng hạn như attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}).
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
allow_files bool; hoặc trình tự của chuỗi; hoặc None; mặc định là None
Liệu các mục tiêu File có được cho phép hay không. Có thể là True, False (mặc định) hoặc danh sách các đuôi tệp được phép (ví dụ: [".cc", ".cpp"]).
allow_rules trình tự của chuỗi; hoặc None; mặc định là None
Những mục tiêu quy tắc nào (tên lớp) được cho phép. Phương thức này không còn được dùng nữa (chỉ giữ lại để đảm bảo khả năng tương thích), hãy sử dụng trình cung cấp.
providers mặc định là []
Các trình cung cấp phải được cung cấp qua bất kỳ phần phụ thuộc nào xuất hiện trong thuộc tính này.

Định dạng của đối số này là danh sách các danh sách nhà cung cấp – đối tượng *Info do provider() trả về (hoặc trong trường hợp của nhà cung cấp cũ, tên chuỗi của nhà cung cấp đó). Phần phụ thuộc phải trả về TẤT CẢ các nhà cung cấp được đề cập trong ít nhất MỘT danh sách bên trong. Để thuận tiện, đối số này cũng có thể là danh sách một cấp của các nhà cung cấp, trong trường hợp này, đối số này được gói trong một danh sách bên ngoài có một phần tử. Không bắt buộc quy tắc của phần phụ thuộc phải quảng cáo các nhà cung cấp đó trong tham số provides, tuy nhiên, đây được coi là phương pháp hay nhất.

flags trình tự của chuỗi; mặc định là []
Không dùng nữa, sẽ bị xoá.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
cfg mặc định là None
Cấu hình của thuộc tính. Giá trị này có thể là "exec", cho biết phần phụ thuộc được tạo cho execution platform hoặc "target", cho biết phần phụ thuộc được tạo cho target platform. Một ví dụ điển hình về sự khác biệt là khi tạo ứng dụng di động, trong đó target platform là Android hoặc iOS trong khi execution platform là Linux, macOS hoặc Windows.
aspects trình tự của Aspect; giá trị mặc định là []
. Các khía cạnh cần được áp dụng cho phần phụ thuộc hoặc các phần phụ thuộc do thuộc tính này chỉ định.

label_list

Attribute attr.label_list(allow_empty=True, *, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])

Tạo giản đồ cho thuộc tính danh sách nhãn. Đây là thuộc tính phần phụ thuộc. Thuộc tính ctx.attr tương ứng sẽ thuộc loại danh sách của Target.

Thuộc tính này chứa các giá trị Label duy nhất. Nếu một chuỗi được cung cấp thay cho Label, thì chuỗi đó sẽ được chuyển đổi bằng hàm khởi tạo nhãn. Các phần tương đối của đường dẫn nhãn, bao gồm cả kho lưu trữ (có thể được đổi tên), được phân giải liên quan đến gói của mục tiêu được tạo bản sao.

Tại thời điểm phân tích (trong hàm triển khai của quy tắc), khi truy xuất giá trị thuộc tính từ ctx.attr, các nhãn sẽ được thay thế bằng Target tương ứng. Điều này cho phép bạn truy cập vào các nhà cung cấp của phần phụ thuộc của mục tiêu hiện tại.

Thông số

Thông số Mô tả
allow_empty mặc định là True
Đúng nếu thuộc tính có thể để trống.
default trình tự của Nhãn; hoặc hàm; giá trị mặc định là []
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao quy tắc. Sử dụng chuỗi hoặc hàm Label để chỉ định giá trị mặc định, ví dụ: attr.label_list(default = ["//a:b", "//a:c"]).
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
allow_files bool; hoặc trình tự của chuỗi; hoặc None; mặc định là None
Liệu có cho phép mục tiêu File hay không. Có thể là True, False (mặc định) hoặc một danh sách đuôi tệp được phép (ví dụ: [".cc", ".cpp"]).
allow_rules trình tự của chuỗi; hoặc None; mặc định là None
Các mục tiêu quy tắc (tên của các lớp) được cho phép. Phương thức này không còn được dùng nữa (chỉ giữ lại để đảm bảo khả năng tương thích), hãy sử dụng trình cung cấp.
providers mặc định là []
Các trình cung cấp phải được cung cấp qua bất kỳ phần phụ thuộc nào xuất hiện trong thuộc tính này.

Định dạng của đối số này là danh sách các danh sách nhà cung cấp – đối tượng *Info do provider() trả về (hoặc trong trường hợp của nhà cung cấp cũ, tên chuỗi của nhà cung cấp đó). Phần phụ thuộc phải trả về TẤT CẢ các nhà cung cấp được đề cập trong ít nhất MỘT danh sách bên trong. Để thuận tiện, đối số này cũng có thể là danh sách một cấp của các nhà cung cấp, trong trường hợp này, đối số này được gói trong một danh sách bên ngoài có một phần tử. Không bắt buộc quy tắc của phần phụ thuộc phải quảng cáo các nhà cung cấp đó trong tham số provides, tuy nhiên, đây được coi là phương pháp hay nhất.

flags trình tự của chuỗi; mặc định là []
Không dùng nữa, sẽ bị xoá.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
cfg mặc định là None
Cấu hình của thuộc tính. Giá trị này có thể là "exec", cho biết phần phụ thuộc được tạo cho execution platform hoặc "target", cho biết phần phụ thuộc được tạo cho target platform. Một ví dụ điển hình về sự khác biệt này là khi tạo ứng dụng di động, trong đó target platform là Android hoặc iOS trong khi execution platform là Linux, macOS hoặc Windows.
aspects trình tự của Aspect; giá trị mặc định là []
. Các khía cạnh cần được áp dụng cho phần phụ thuộc hoặc các phần phụ thuộc do thuộc tính này chỉ định.

output

Attribute attr.output(doc=None, mandatory=False)

Tạo giản đồ cho thuộc tính đầu ra (nhãn).

Thuộc tính này chứa các giá trị Label duy nhất. Nếu bạn cung cấp một chuỗi thay vì Label, chuỗi đó sẽ được chuyển đổi bằng hàm khởi tạo nhãn. Các phần tương đối của đường dẫn nhãn, bao gồm cả kho lưu trữ (có thể được đổi tên), được phân giải liên quan đến gói của mục tiêu được tạo bản sao.

Tại thời điểm phân tích, bạn có thể truy xuất File tương ứng bằng cách sử dụng ctx.outputs.

Thông số

Thông số Mô tả
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).

output_list

Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)

Tạo giản đồ cho thuộc tính danh sách đầu ra.

Thuộc tính này chứa các giá trị Label riêng biệt. Nếu bạn cung cấp một chuỗi thay vì Label, chuỗi đó sẽ được chuyển đổi bằng hàm khởi tạo nhãn. Các phần tương đối của đường dẫn nhãn, bao gồm cả kho lưu trữ (có thể được đổi tên), được phân giải liên quan đến gói của mục tiêu được tạo bản sao.

Tại thời điểm phân tích, bạn có thể truy xuất File tương ứng bằng cách sử dụng ctx.outputs.

Thông số

Thông số Mô tả
allow_empty mặc định là True
Đúng nếu thuộc tính có thể để trống.
doc string; hoặc None; mặc định là None
Nội dung mô tả về thuộc tính có thể trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).

chuỗi

Attribute attr.string(default='', doc=None, mandatory=False, values=[])

Tạo giản đồ cho thuộc tính chuỗi.

Thông số

Thông số Mô tả
default string; hoặc NativeComputedDefault; giá trị mặc định là ''
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
values trình tự của chuỗi; giá trị mặc định là []
Danh sách các giá trị được phép cho thuộc tính. Lỗi sẽ xảy ra nếu bạn cung cấp bất kỳ giá trị nào khác.

string_dict

Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

Tạo giản đồ cho một thuộc tính chứa từ điển, trong đó khoá và giá trị là chuỗi.

Thông số

Thông số Mô tả
allow_empty mặc định là True
Đúng nếu thuộc tính có thể để trống.
default mặc định là {}
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao của quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả thuộc tính có thể được trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).

string_list

Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)

Tạo giản đồ cho thuộc tính danh sách chuỗi.

Thông số

Thông số Mô tả
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).
allow_empty giá trị mặc định là True
Đúng nếu thuộc tính có thể để trống.
default trình tự của chuỗi; hoặc NativeComputedDefault; giá trị mặc định là []
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo bản sao của quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả về thuộc tính có thể trích xuất bằng các công cụ tạo tài liệu.

string_list_dict

Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)

Tạo giản đồ cho một thuộc tính chứa từ điển, trong đó khoá là chuỗi và giá trị là danh sách chuỗi.

Thông số

Thông số Mô tả
allow_empty mặc định là True
Đúng nếu thuộc tính có thể để trống.
default mặc định là {}
Giá trị mặc định để sử dụng nếu không có giá trị nào cho thuộc tính này được cung cấp khi tạo thực thể quy tắc.
doc string; hoặc None; mặc định là None
Nội dung mô tả về thuộc tính có thể trích xuất bằng các công cụ tạo tài liệu.
mandatory mặc định là False
Nếu đúng, bạn phải chỉ định giá trị một cách rõ ràng (ngay cả khi giá trị đó có default).