template_ctx

Nightly · 9.1 · 9.0 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1
Đối tượng ngữ cảnh được truyền đến hàm mở rộng mẫu hành động.

Hội viên

đối số

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.

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

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

declare_subdirectory

File template_ctx.declare_subdirectory(subdirectory, *, directory)

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

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

Tham số

Tham số Mô tả
subdirectory chuỗi; bắt buộc
Đường dẫn tương đối của thư mục con trong thư mục.
directory Tệp; bắt buộc
Thư mục mà thư mục con 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 một tệp thực thi.

Tham số

Tham số Mô tả
outputs chuỗi của Tệps; bắt buộc
Danh sách các tệp đầu ra của hành động.
inputs chuỗi các 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 mà hành động sẽ 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 và được tự động cung cấp cho hành động.

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

  • Files
  • các thực thể FilesToRunProvider
  • depset của Files
Files từ ctx.executable và FilesToRunProviders nằm trực tiếp trong danh sách sẽ tự động thêm runfile. Tất cả cá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 để hiển thị cho người dùng trong quá trình xây dựng.