template_ctx

Nightly · 9.2 · 9.1 · 9.0 · 8.7 · 8.6
Đối tượng ngữ cảnh được chuyển đến hàm mở rộng mẫu hành động.

Hội viên

đối số

Args template_ctx.args()

Trả về đố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.

Hãy nhớ rằng ngoài việc khai báo tệp, bạn phải tạo riêng một hành động phát ra tệp đó. Để tạo hành động đó, bạn cần chuyển đối tượng File đã trả về đến hàm tạo của hành động.

Thông 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 Tệp; bắt buộc
Thư mục mà tệp sẽ được tạo.

chạy

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

Tạo một hành động chạy tệp thực thi.

Thông số

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

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

  • File
  • Các thực thể FilesToRunProvider
  • depset của File
File từ ctx.executable và FilesToRunProvider trực tiếp trong danh sách sẽ tự động thêm runfile. Tất cả công cụ đều được ngầm thêm dưới dạng đầu vào.

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