Args

명령줄의 일부 또는 전체를 빌드하는 데 필요한 데이터를 메모리 효율적인 방식으로 캡슐화하는 객체입니다.

작업에 전이 종속 항목에서 누적된 값이 포함된 큰 명령줄이 필요한 경우가 많습니다. 예를 들어 링커 명령줄에는 연결되는 모든 라이브러리에 필요한 모든 객체 파일이 나열될 수 있습니다. 이러한 전이적 데이터는 여러 타겟에서 공유할 수 있도록 depset에 저장하는 것이 좋습니다. 하지만 규칙 작성자가 작업 명령줄을 구성하기 위해 이러한 depsets를 문자열 목록으로 변환해야 한다면 이 메모리 공유 최적화는 무용지물이 됩니다.

이러한 이유로 작업 생성 함수는 문자열 외에도 Args 객체를 허용합니다. 각 Args 객체는 문자열과 depsets의 연결을 나타내며, 데이터를 조작하기 위한 변환은 선택사항입니다. Args 객체는 명령줄을 계산할 때인 실행 단계까지 캡슐화된 depsets를 처리하지 않습니다. 이렇게 하면 분석 단계가 완료될 때까지 비용이 많이 드는 복사를 연기할 수 있습니다. 자세한 내용은 성능 최적화 페이지를 참고하세요.

Args는 ctx.actions.args()를 호출하여 구성됩니다. ctx.actions.run() 또는 ctx.actions.run_shell()의 arguments 매개변수로 전달할 수 있습니다. Args 객체의 각 변형은 최종 명령줄에 값을 추가합니다.

map_each 기능을 사용하면 항목이 문자열로 변환되는 방식을 맞춤설정할 수 있습니다. map_each 함수를 제공하지 않으면 표준 변환은 다음과 같습니다.

• 이미 문자열인 값은 그대로 유지됩니다.
• File 객체는 File.path 값으로 변환됩니다.
• Label 객체는 기본 저장소의 컨텍스트에서 해결될 때 동일한 객체로 다시 해결되는 문자열 표현으로 변환됩니다. 가능한 경우 문자열 표현은 저장소의 표준 이름 대신 저장소의 명시적 이름을 사용하므로 이 표현은 BUILD 파일에서 사용하기에 적합합니다. 표현의 정확한 형태는 보장되지 않지만 일반적인 예는 //foo:bar, @repo//foo:bar, @@canonical_name+//foo:bar.bzl입니다.
• 다른 모든 유형은 지정되지 않은 방식으로 문자열로 변환됩니다. 이러한 이유로 문자열 또는 File 유형이 아닌 값을 add()에 전달해서는 안 되며, add_all() 또는 add_joined()에 전달하는 경우 map_each 함수를 제공해야 합니다.

문자열 형식 지정 (add*() 메서드의 format, format_each, format_joined 매개변수)을 사용하는 경우 형식 템플릿은 문자열의 % 대체와 동일한 방식으로 해석됩니다. 단, 템플릿에는 대체 자리표시자가 정확히 하나 있어야 하며 %s여야 합니다. 리터럴 퍼센트는 %%로 이스케이프 처리할 수 있습니다. 서식은 위와 같이 값이 문자열로 변환된 후에 적용됩니다.

각 add*() 메서드에는 나머지 인수 앞에 삽입할 'arg name' 문자열인 추가 위치 매개변수를 허용하는 대체 형식이 있습니다. add_all 및 add_joined의 경우 시퀀스가 비어 있으면 추가 문자열이 추가되지 않습니다. 예를 들어 지정된 시퀀스에 val1..val3가 포함되어 있는지 아니면 비어 있는지에 따라 동일한 사용으로 명령줄에 --foo val1 val2 val3 --bar 또는 --bar만 추가할 수 있습니다.

명령줄의 크기가 시스템에서 허용하는 최대 크기보다 커질 수 있는 경우 인수가 매개변수 파일로 유출될 수 있습니다. use_param_file() 및 set_param_file_format()을 참고하세요.

예: 다음 명령줄을 생성한다고 가정해 보겠습니다.

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz

# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

회원

• 추가
• add_all
• add_joined
• set_param_file_format
• use_param_file

추가

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

매개변수

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

대부분의 처리는 다음 단계에 따라 추가할 인수 목록에서 발생합니다.

1. 각 디렉터리 File 항목은 해당 디렉터리에 재귀적으로 포함된 모든 File로 대체됩니다.
2. map_each가 제공되면 각 항목에 적용되고 결과 문자열 목록이 연결되어 초기 인수 목록을 형성합니다. 그렇지 않으면 초기 인수 목록은 각 항목에 표준 변환을 적용한 결과입니다.
3. 목록의 각 인수는 있는 경우 format_each로 형식이 지정됩니다.
4. uniquify가 true이면 중복 인수가 삭제됩니다. 첫 번째 발생이 유지됩니다.
5. before_each 문자열이 제공되면 목록의 각 기존 인수 앞에 새 인수로 삽입됩니다. 이렇게 하면 이 시점까지 추가되는 인수의 수가 효과적으로 두 배가 됩니다.
6. 목록이 비어 있고 omit_if_empty이 true (기본값)인 경우를 제외하고, arg 이름과 terminate_with은 제공된 경우 각각 첫 번째 인수와 마지막 인수로 삽입됩니다.

매개변수

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

처리는 add_all()와 유사하지만 values에서 파생된 인수 목록은 join_with.join(...)에 의해 단일 인수로 결합된 다음 지정된 format_joined 문자열 템플릿을 사용하여 형식이 지정됩니다. add_all()와 달리 항목이 단일 인수로 결합될 때는 일반적으로 유용하지 않으므로 before_each 또는 terminate_with 매개변수가 없습니다.

필터링 후 인수로 조인할 문자열이 없고 omit_if_empty이 true (기본값)인 경우 처리가 실행되지 않습니다. 그렇지 않고 결합할 문자열이 없지만 omit_if_empty가 false인 경우 결합된 문자열은 빈 문자열이 됩니다.

매개변수

set_param_file_format

Args Args.set_param_file_format(format)

매개변수

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

Bazel은 효율성을 위해 실행 중에 출력 트리에 매개변수 파일을 쓰는 것을 생략할 수 있습니다. 작업을 디버깅하고 매개변수 파일을 검사하려면 빌드에 --materialize_param_files를 전달하세요.

매개변수