작업

문제 신고 소스 보기

작업을 만드는 함수를 제공하는 모듈입니다. ctx.actions를 사용하여 이 모듈에 액세스합니다.

구성원

args

Args actions.args()

메모리 효율적인 명령줄을 빌드하는 데 사용할 수 있는 Args 객체를 반환합니다.

declare_directory

File actions.declare_directory(filename, *, sibling=None)

규칙 또는 관점이 현재 패키지에서 지정된 이름으로 디렉터리를 생성한다고 선언합니다. 디렉터리를 생성하는 작업을 만들어야 합니다. 디렉터리의 콘텐츠는 Starlark에서 직접 액세스할 수 없지만 Args.add_all()를 사용하여 작업 명령어로 확장할 수 있습니다. manifest_directory의 확장된 콘텐츠에는 일반 파일과 디렉터리만 포함될 수 있습니다.

매개변수

매개변수 설명
filename 필수
'sibling'이 제공되지 않은 경우 현재 패키지를 기준으로 한 새 디렉터리의 경로입니다. 그렇지 않으면 파일의 기본 이름이 됩니다 ('sibling'은 디렉터리를 정의함).
sibling File 또는 None. 기본값은 None입니다.
새로 선언된 디렉터리와 동일한 디렉터리에 있는 파일입니다. 파일이 현재 패키지에 있어야 합니다.

declare_file

File actions.declare_file(filename, *, sibling=None)

규칙 또는 관점이 지정된 파일 이름으로 파일을 생성한다고 선언합니다. sibling이 지정되지 않은 경우 파일 이름은 패키지 디렉터리를 기준으로 하며, 지정되지 않은 경우 파일은 sibling와 같은 디렉터리에 있습니다. 현재 패키지 외부에는 파일을 만들 수 없습니다.

파일을 선언하는 것 외에도 파일을 내보내는 작업을 별도로 만들어야 합니다. 이 작업을 만들려면 반환된 File 객체를 작업의 생성 함수에 전달해야 합니다.

사전 선언된 출력 파일은 이 함수를 사용하여 선언할 필요가 없으며 선언할 수도 없습니다. 대신 ctx.outputs에서 File 객체를 가져올 수 있습니다. 사용 예 보기

매개변수

매개변수 설명
filename 필수
'동위 요소'가 제공되지 않은 경우 현재 패키지를 기준으로 한 새 파일의 경로입니다. 그렇지 않으면 파일의 기본 이름이 'sibling'이 디렉터리를 결정합니다.
sibling File 또는 None. 기본값은 None입니다.
새로 만든 파일과 동일한 디렉터리에 있는 파일입니다. 파일이 현재 패키지에 있어야 합니다. 

File actions.declare_symlink(filename, *, sibling=None)

규칙 또는 관점이 현재 패키지에 지정된 이름을 사용하여 심볼릭 링크를 생성한다고 선언합니다. 이 심볼릭 링크를 생성하는 작업을 만들어야 합니다. Bazel은 이 심볼릭 링크를 역참조하지 않으며 샌드박스 또는 원격 실행자에게 그대로 전송합니다. 트리 아티팩트 내의 심볼릭 링크는 현재 지원되지 않습니다.

매개변수

매개변수 설명
filename 필수
'sibling'이 제공되지 않은 경우 현재 패키지를 기준으로 한 새 심볼릭 링크의 경로입니다. 그렇지 않으면 파일의 기본 이름이 됩니다 ('sibling'은 디렉터리를 정의함).
sibling File, None, 기본값은 None
새로 선언된 심볼릭 링크와 동일한 디렉터리에 있는 파일입니다.

do_nothing

None actions.do_nothing(mnemonic, inputs=[])

명령어를 실행하거나 출력을 생성하지 않는 빈 작업을 생성합니다. 하지만 '추가 작업'을 삽입하는 데 유용합니다.

매개변수

매개변수 설명
mnemonic 필수
작업에 대한 한 단어 설명(예: CppCompile 또는 GoLink)
inputs File의 sequence이거나 depset입니다. 기본값은 []입니다.
작업의 입력 파일 목록입니다.

expand_template

None actions.expand_template(template, output, substitutions={}, is_executable=False, computed_substitutions=unbound)

템플릿 확장 작업을 만듭니다. 작업이 실행되면 템플릿을 기반으로 파일이 생성됩니다. 템플릿의 일부는 대체 항목이 지정된 순서대로 substitutions 사전을 사용하여 대체됩니다. 사전의 키가 템플릿에 표시되거나 이전에 대체한 결과가 나타날 때마다 관련 값으로 대체됩니다. 키에 대한 특수 구문은 없습니다. 예를 들어 중괄호를 사용하여 충돌을 방지할 수 있습니다 (예: {KEY}). 사용 예 보기

매개변수

매개변수 설명
template 필수
템플릿 파일은 UTF-8로 인코딩된 텍스트 파일입니다.
output 필수
출력 파일로, UTF-8로 인코딩된 텍스트 파일입니다.
substitutions 기본값은 {}입니다.
템플릿을 확장할 때 사용할 대체 항목입니다.
is_executable 기본값은 False입니다.
출력 파일이 실행 가능해야 하는지 여부입니다.
computed_substitutions TemplateDict. 기본값은 unbound입니다.
템플릿을 확장할 때 사용할 대체 항목입니다.

run

None actions.run(outputs, inputs=[], unused_inputs_list=None, executable, tools=unbound, arguments=[], mnemonic=None, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=unbound)

실행 파일을 실행하는 작업을 만듭니다. 사용 예 보기

매개변수

매개변수 설명
outputs File의 sequence, 필수
작업의 출력 파일 목록입니다.
inputs File의 sequence이거나 depset입니다. 기본값은 []입니다.
작업의 입력 파일 목록 또는 depset입니다.
unused_inputs_list File 또는 None. 기본값은 None입니다.
작업에서 사용하지 않는 입력 목록이 포함된 파일입니다.

이 파일의 콘텐츠 (일반적으로 작업의 출력 중 하나)는 전체 작업 실행 중에 사용되지 않은 입력 파일의 목록에 해당합니다. 이러한 파일의 변경 사항은 어떤 방식으로든 작업의 출력에 영향을 미치면 안 됩니다.

executable File, string, FilesToRunProvider, required
작업에서 호출할 실행 파일입니다.
tools sequence 또는 depset입니다. 기본값은 unbound입니다.
작업에 필요한 도구의 목록 또는 depset입니다. 도구는 자동으로 작업에 사용할 수 있는 추가 실행 파일이 포함된 입력입니다. 목록이 제공되는 경우 이 목록은 Files, FilesToRunProvider 인스턴스 또는 Files의 종속 세트로 구성된 이종 컬렉션일 수 있습니다. 목록에 직접 있고 ctx.executable에서 가져온 파일에는 실행 파일이 자동으로 추가됩니다. depset이 제공되는 경우 파일만 포함해야 합니다. 두 경우 모두 depset 내의 파일은 실행 파일에 대해 ctx.executable과 상호 참조되지 않습니다.
arguments sequence입니다. 기본값은 []입니다.
작업의 명령줄 인수입니다. 문자열 또는 actions.args() 객체의 목록이어야 합니다.
mnemonic string 또는 None. 기본값은 None입니다.
작업에 관한 한 단어 설명입니다(예: CppCompile 또는 GoLink).
progress_message string 또는 None. 기본값은 None입니다.
빌드 중에 사용자에게 표시할 진행률 메시지입니다(예: 'Compiling foo.cc to create foo.o'). 메시지에는 %{label}, %{input} 또는 %{output} 패턴이 포함될 수 있으며 이 패턴은 각각 라벨 문자열, 첫 번째 입력 또는 출력 경로로 대체됩니다. 정적 문자열이 아닌 패턴을 사용하는 것이 좋습니다. 전자가 더 효율적이기 때문입니다.
use_default_shell_env 기본값은 False입니다.
작업에서 기본 셸 환경을 사용할지 여부입니다. 이 기본 셸 환경은 몇 가지 OS 종속 변수와 --action_env를 통해 설정된 변수로 구성됩니다.

use_default_shell_env 및 env가 모두 True로 설정된 경우 --incompatible_merge_fixed_and_default_shell_env가 사용 설정 (기본값)되면 env에 설정된 값이 기본 셸 환경을 덮어씁니다. 플래그가 사용 설정되지 않으면 env가 무시됩니다.

env dict 또는 None. 기본값은 None입니다.
환경 변수의 사전을 설정합니다.

use_default_shell_env 및 env가 모두 True로 설정된 경우 --incompatible_merge_fixed_and_default_shell_env가 사용 설정 (기본값)되면 env에 설정된 값이 기본 셸 환경을 덮어씁니다. 플래그가 사용 설정되지 않으면 env가 무시됩니다.

execution_requirements dict 또는 None. 기본값은 None입니다.
작업 예약을 위한 정보입니다. 유용한 키는 태그를 참고하세요.
input_manifests sequence 또는 None. 기본값은 None입니다.
(실험용)은 입력 실행 파일 메타데이터를 설정합니다. 일반적으로resolve_command에 의해 생성됩니다.
exec_group string 또는 None. 기본값은 None입니다.
지정된 실행 그룹의 실행 플랫폼에서 작업을 실행합니다. 없는 경우 대상의 기본 실행 플랫폼을 사용합니다.
shadowed_action 작업. 기본값은 None입니다.
우선 적용된 작업의 입력과 작업의 입력 목록 및 환경에 추가된 환경을 사용하여 작업을 실행합니다. 작업 환경은 섀도 처리된 작업의 환경 변수를 덮어쓸 수 있습니다. 없는 경우 작업의 입력과 지정된 환경만 사용합니다.
resource_set callable 또는 None. 기본값은 None입니다.
이 작업이 로컬에서 실행되는 경우 실행 시 리소스 사용량을 예측하는 데 사용되는 리소스 세트 사전을 반환하는 콜백 함수입니다.

이 함수는 두 개의 위치 인수를 허용합니다. OS 이름 (예: 'osx')을 나타내는 문자열과 작업에 대한 입력 수를 나타내는 정수입니다. 반환된 사전에는 다음 항목이 포함될 수 있으며, 각 항목은 float 또는 int일 수 있습니다.

  • 'cpu': CPU 수. 기본값은 1입니다.
  • 'memory': MB 단위, 기본값 250
  • 'local_test': 로컬 테스트 수, 기본값은 1입니다.

이 매개변수가 None로 설정되거나 --experimental_action_resource_set가 false이면 기본값이 사용됩니다.

콜백은 최상위 수준이어야 합니다 (람다 및 중첩 함수는 허용되지 않음).

toolchain 라벨, 문자열, None(기본값: unbound
)

이 작업에 사용되는 실행 파일 또는 도구의 툴체인 유형입니다. 작업이 올바른 실행 플랫폼에서 실행되도록 매개변수를 설정해야 합니다.

현재는 작동하지 않지만 도구 모음이 사용될 때 설정하는 것이 좋습니다. 향후 Bazel 릴리스에 필요할 것이기 때문입니다.

이 작업을 만드는 규칙은 'rule()' 함수 내에 이 도구 모음을 정의해야 합니다.

`toolchain` 과 `exec_group` 매개변수가 모두 설정된 경우 `exec_group` 이 사용됩니다. `exec_group` 이 동일하게 지정하지 않으면 오류가 발생합니다.

run_shell

None actions.run_shell(outputs, inputs=[], tools=unbound, arguments=[], mnemonic=None, command, progress_message=None, use_default_shell_env=False, env=None, execution_requirements=None, input_manifests=None, exec_group=None, shadowed_action=None, resource_set=None, toolchain=unbound)

셸 명령어를 실행하는 작업을 생성합니다. 사용 예 보기

매개변수

매개변수 설명
outputs File의 sequence, 필수
작업의 출력 파일 목록입니다.
inputs File의 sequence이거나 depset입니다. 기본값은 []입니다.
작업의 입력 파일 목록 또는 depset입니다.
tools 파일의 시퀀스 또는 depset. 기본값은 unbound입니다.
작업에 필요한 도구의 목록 또는 배포판입니다. 도구는 자동으로 작업에 사용할 수 있는 추가 실행 파일이 포함된 입력입니다. 목록에는 Files 또는 FilesToRunProvider 인스턴스가 포함될 수 있습니다.
arguments sequence입니다. 기본값은 []입니다.
작업의 명령줄 인수입니다. 문자열 또는 actions.args() 객체의 목록이어야 합니다.

Bazel은 이 속성의 요소를 명령어에 인수로 전달합니다.명령어는 $1, $2 등의 셸 변수 대체를 사용하여 이러한 인수에 액세스할 수 있습니다. Args 객체는 색인 생성 전에 평면화되므로 크기가 알 수 없는 Args 객체가 있으면 모든 후속 문자열이 예측할 수 없는 색인으로 지정됩니다. $@ (모든 인수를 검색)를 알 수 없는 크기의 Args 객체와 함께 사용하는 것이 유용할 수 있습니다.

command가 문자열 목록인 경우 이 매개변수를 사용할 수 없습니다.

mnemonic string 또는 None. 기본값은 None입니다.
작업에 관한 한 단어 설명입니다(예: CppCompile 또는 GoLink).
command 문자열 또는 문자열의 순서로, 필수
실행할 셸 명령어입니다. 문자열 (권장) 또는 문자열 시퀀스(지원 중단됨)일 수 있습니다.

command가 문자열인 경우 sh -c <command> "" <arguments>에 의해 실행되는 것처럼 실행됩니다. 즉, arguments의 요소를 명령어에서 $1, $2 (또는 Windows 배치를 사용하는 경우 %1, %2) 등으로 사용할 수 있습니다. arguments에 actions.args() 객체가 포함되어 있으면 콘텐츠가 명령줄에 하나씩 추가되므로 $i가 Args 객체 내의 개별 문자열을 참조할 수 있습니다. 크기를 알 수 없는 Args 객체가 arguments의 일부로 전달되는 경우 문자열은 알 수 없는 색인에 있습니다. 이 경우 $@ 셸 대체 (모든 인수 가져오기)가 유용할 수 있습니다.

(지원 중단됨) command가 문자열 시퀀스인 경우 실행할 첫 항목은 실행 파일이고 나머지 항목은 인수입니다. 이 형식을 사용하는 경우 arguments 매개변수를 제공하지 않아야 합니다. 이 양식은 지원 중단되었으며 곧 삭제될 예정입니다. `--incompatible_run_shell_command_string`으로 사용 중지됩니다. 이 플래그를 사용하여 코드가 호환되는지 확인하세요.

Bazel은 genrule에서와 같이 동일한 셸을 사용하여 명령어를 실행합니다.

progress_message string 또는 None. 기본값은 None입니다.
빌드 중에 사용자에게 표시할 진행률 메시지입니다(예: 'Compiling foo.cc to create foo.o'). 메시지에는 %{label}, %{input} 또는 %{output} 패턴이 포함될 수 있으며 이 패턴은 각각 라벨 문자열, 첫 번째 입력 또는 출력 경로로 대체됩니다. 정적 문자열이 아닌 패턴을 사용하는 것이 좋습니다. 전자가 더 효율적이기 때문입니다.
use_default_shell_env 기본값은 False입니다.
작업에서 기본 셸 환경을 사용할지 여부입니다. 이 기본 셸 환경은 몇 가지 OS 종속 변수와 --action_env를 통해 설정된 변수로 구성됩니다.

use_default_shell_env 및 env가 모두 True로 설정된 경우 --incompatible_merge_fixed_and_default_shell_env가 사용 설정 (기본값)되면 env에 설정된 값이 기본 셸 환경을 덮어씁니다. 플래그가 사용 설정되지 않으면 env가 무시됩니다.

env dict 또는 None. 기본값은 None입니다.
환경 변수의 사전을 설정합니다.

use_default_shell_env 및 env가 모두 True로 설정된 경우 --incompatible_merge_fixed_and_default_shell_env가 사용 설정 (기본값)되면 env에 설정된 값이 기본 셸 환경을 덮어씁니다. 플래그가 사용 설정되지 않으면 env가 무시됩니다.

execution_requirements dict 또는 None. 기본값은 None입니다.
작업 예약을 위한 정보입니다. 유용한 키는 태그를 참고하세요.
input_manifests sequence 또는 None. 기본값은 None입니다.
(실험용)은 입력 실행 파일 메타데이터를 설정합니다. 일반적으로resolve_command에 의해 생성됩니다.
exec_group string 또는 None. 기본값은 None입니다.
지정된 실행 그룹의 실행 플랫폼에서 작업을 실행합니다. 없는 경우 대상의 기본 실행 플랫폼을 사용합니다.
shadowed_action 작업. 기본값은 None입니다.
작업의 입력 목록에 추가된 특정 섀도 처리된 작업의 발견된 입력을 사용하여 작업을 실행합니다. 없으면 작업의 입력만 사용합니다.
resource_set callable 또는 None. 기본값은 None입니다.
로컬에서 실행되는 경우 리소스 사용량을 추정하는 콜백 함수입니다. ctx.actions.run()를 참고하세요.
toolchain 라벨, 문자열, None(기본값: unbound
)

이 작업에 사용되는 실행 파일 또는 도구의 툴체인 유형입니다. 작업이 올바른 실행 플랫폼에서 실행되도록 매개변수를 설정해야 합니다.

현재는 작동하지 않지만 도구 모음이 사용될 때 설정하는 것이 좋습니다. 향후 Bazel 릴리스에 필요할 것이기 때문입니다.

이 작업을 만드는 규칙은 'rule()' 함수 내에 이 도구 모음을 정의해야 합니다.

`toolchain` 과 `exec_group` 매개변수가 모두 설정된 경우 `exec_group` 이 사용됩니다. `exec_group` 이 동일한 도구 모음을 지정하지 않으면 오류가 발생합니다.

 

None actions.symlink(output, target_file=None, target_path=None, is_executable=False, progress_message=None)

파일 시스템에 심볼릭 링크를 작성하는 작업을 만듭니다.

이 함수는 정확히 target_file 또는 target_path 중 하나를 지정하여 호출해야 합니다.

target_file를 사용하는 경우 declare_file() 또는 declare_directory()로 output를 선언하고 target_file 유형과 일치시킵니다. 이렇게 하면 심볼릭 링크가 target_file를 가리킵니다. Bazel은 심볼릭 링크의 타겟이나 그 콘텐츠가 변경될 때마다 이 작업의 출력을 무효화합니다.

그러지 않고 target_path를 사용할 때 declare_symlink()로 output를 선언합니다. 이 경우 심볼릭 링크는 target_path를 가리킵니다. Bazel은 심볼릭 링크를 결정하지 않으며 심볼릭 링크의 텍스트 콘텐츠 (즉, readlink() 값)가 변경될 때만 이 작업의 출력이 무효화됩니다. 특히 댕글링 심볼릭 링크를 만드는 데 사용할 수 있습니다.

매개변수

매개변수 설명
output 필수
이 작업의 출력입니다.
target_file File, None, 기본값은 None입니다.
출력 심볼릭 링크가 가리키는 파일입니다.
target_path string 또는 None. 기본값은 None입니다.
출력 심볼릭 링크가 가리키는 정확한 경로입니다. 정규화나 다른 처리가 적용되지 않습니다.
is_executable 기본값은 False입니다.
target_path가 아닌 target_file에서만 사용할 수 있습니다. true인 경우 작업이 실행될 때 target_file의 경로를 확인하여 실행 가능한지 확인하고 그렇지 않은 경우 오류가 보고됩니다. is_executable를 False로 설정해도 타겟을 실행할 수 없는 것은 아니며, 검증이 이루어지지 않을 뿐입니다.

댕글링 심볼릭 링크는 빌드 시간에 존재하지 않을 수 있으므로 이 기능은 target_path에 적합하지 않습니다.
progress_message string 또는 None. 기본값은 None입니다.
빌드 중에 사용자에게 표시할 진행률 메시지입니다.

template_dict

TemplateDict actions.template_dict()

메모리 효율적인 템플릿 확장을 위해 TemplateDict 객체를 반환합니다.

write

None actions.write(output, content, is_executable=False)

파일 쓰기 작업을 만듭니다. 작업이 실행되면 지정된 콘텐츠를 파일에 씁니다. 분석 단계에서 제공되는 정보를 사용하여 파일을 생성하는 데 사용됩니다. 파일이 크고 정적 콘텐츠가 많은 경우 expand_template를 사용하는 것이 좋습니다.

매개변수

매개변수 설명
output 필수
출력 파일입니다.
content string, Args, 필수
파일 콘텐츠 문자열 또는 actions.args() 객체일 수 있습니다.
is_executable 기본값은 False입니다.
출력 파일이 실행 가능해야 하는지 여부입니다.