template_ctx

Một đối tượng ngữ cảnh được truyền đến hàm mở rộng mẫu thao tác.

Hội viên

args

Args template_ctx.args()

Trả về một đối tượng Args có thể dùng để tạo dòng lệnh tiết kiệm bộ nhớ.

declare_file

File template_ctx.declare_file(filename, *, directory)

Khai báo rằng quá trình triển khai sẽ tạo một tệp có tên tệp đã cho trong thư mục được chỉ định.

Xin lưu ý rằng ngoài việc khai báo một tệp, bạn phải tạo riêng một thao tác phát tệp đó. Để tạo thao tác đó, bạn sẽ cần truyền đối tượng File được trả về vào hàm tạo của thao tác.

Tham số

Tham số Mô tả
filename chuỗi; bắt buộc
Đường dẫn tương đối của tệp trong thư mục.
directory File; bắt buộc
Thư mục mà bạn nên tạo tệp.

chạy

None template_ctx.run(*, outputs, inputs=[], executable, tools=None, arguments=[], progress_message=None)

Tạo một thao tác chạy một tệp thực thi.

Tham số

Tham số Mô tả
outputs trình tự của các Tệp; bắt buộc
Danh sách các tệp đầu ra của thao tác.
inputs sequence của File; hoặc depset; mặc định là []
Danh sách hoặc depset của các tệp đầu vào của thao tác.
executable Tệp; hoặc chuỗi; hoặc FilesToRunProvider; bắt buộc
Tệp thực thi mà thao tác sẽ gọi.
tools sequence; hoặc depset; hoặc None; mặc định là None
Danh sách hoặc depset của mọi công cụ cần thiết cho thao tác. Công cụ là các đầu vào có thể thực thi và có thể có các tệp chạy riêng, được tự động cung cấp cho thao tác.

Khi được cung cấp, danh sách có thể là một tập hợp không đồng nhất gồm:

  • File giây
  • FilesToRunProvider trường hợp
  • depset giây của File giây
File từ ctx.executable và FilesToRunProvider nằm ngay trong danh sách sẽ tự động được thêm runfile. Tất cả các công cụ đều được thêm ngầm dưới dạng dữ liệu đầu vào.

arguments trình tự; mặc định là []
. Đối số dòng lệnh của thao tác. Phải là danh sách các chuỗi hoặc đối tượng actions.args().
progress_message string; hoặc None; mặc định là None
Thông báo tiến trình hiển thị cho người dùng trong quá trình tạo bản dựng.