.bzl 파일

문제 신고

모든 .bzl 파일에서 사용할 수 있는 전역 메서드입니다.

구성원

analysis_test_transition

transition analysis_test_transition(settings)

분석-테스트 규칙의 종속 항목에 적용할 구성 전환을 만듭니다. 이 전환은 analysis_test = True이 있는 규칙의 속성에만 적용될 수 있습니다. 이러한 규칙은 기능이 제한되므로 (예: 종속 항목 트리 크기 제한됨) 이 함수를 사용하여 만든 전환은 transition()를 사용하여 만든 전환보다 범위가 제한적입니다.

이 함수는 주로 분석 테스트 프레임워크 핵심 라이브러리를 용이하게 하기 위해 설계되었습니다. 권장사항은 해당 문서 (또는 구현)를 참조하세요.

매개변수

매개변수 설명
settings 필수
이 구성 전환으로 설정해야 하는 구성 설정에 대한 정보가 포함된 사전입니다. 키는 빌드 설정 라벨이며 값은 전환 후 새로운 값입니다. 다른 모든 설정은 변경되지 않습니다. 이 메서드를 사용하여 분석 테스트를 통과하기 위해 설정해야 하는 특정 구성 설정을 선언합니다.

관점

Aspect aspect(implementation, attr_aspects=[], attrs={}, required_providers=[], required_aspect_providers=[], provides=[], requires=[], fragments=[], host_fragments=[], toolchains=[], incompatible_use_toolchain_transition=False, doc=None, *, apply_to_generating_rules=False, exec_compatible_with=[], exec_groups=None, subrules=[])

새 측면을 만듭니다. 이 함수의 결과는 전역 값에 저장해야 합니다. 자세한 내용은 평가 항목 소개를 참고하세요.

매개변수

매개변수 설명
implementation 필수
이 측면을 구현하는 Starlark 함수로, 정확히 두 개의 매개변수, 즉 Target (평면이 적용되는 타겟)과 ctx (타겟이 생성되는 규칙 컨텍스트)가 있습니다. 타겟의 속성은 ctx.rule 필드를 통해 사용할 수 있습니다. 이 함수는 분석을 대상에 적용할 때마다 분석 단계에서 평가됩니다.
attr_aspects 문자열의 시퀀스. 기본값은 []
속성 이름 목록입니다. 관점은 이러한 이름을 가진 타겟의 속성에 지정된 종속 항목을 따라 전파됩니다. 여기서 일반적인 값에는 deps 및 exports가 포함됩니다. 이 목록에는 단일 문자열 "*"를 포함하여 타겟의 모든 종속 항목을 전파할 수도 있습니다.
attrs dict. 기본값은 {}입니다.
관점의 모든 속성을 선언하는 사전입니다. 속성 이름에서 `attr.label` 또는 `attr.string`과 같은 속성 객체에 매핑됩니다 (attr 모듈 참고). 관점 속성은 구현 함수에서 ctx 매개변수의 필드로 사용할 수 있습니다.

_로 시작하는 암시적 속성에는 기본값이 있어야 하며 유형이 label 또는 label_list여야 합니다.

명시적 속성은 string 유형이어야 하며 values 제한을 사용해야 합니다. 명시적 속성은 제한사항에 따라 동일한 이름, 유형, 유효한 값의 속성을 가진 규칙에서만 사용되도록 측면을 제한합니다.

required_providers 기본값은 []입니다.
이 속성을 사용하면 관점이 필수 제공업체를 광고하는 규칙이 있는 타겟으로만 전파를 제한할 수 있습니다. 값은 개별 제공자 또는 제공업체 목록을 포함하는 목록이어야 하며 둘 다 포함할 수는 없습니다. 예를 들어 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]]는 유효한 값이지만 [FooInfo, BarInfo, [BazInfo, QuxInfo]]는 유효하지 않습니다.

중첩되지 않은 제공자 목록은 제공자 목록 하나가 포함된 목록으로 자동 변환됩니다. 즉, [FooInfo, BarInfo]가 [[FooInfo, BarInfo]]로 자동 변환됩니다.

일부 규칙 (예: some_rule) 타겟이 특정 요소에 표시되도록 하려면 some_rule가 하나 이상의 필수 제공업체 목록에 있는 모든 제공업체를 알려야 합니다. 예를 들어 측면의 required_providers가 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]]인 경우 some_rule가 FooInfo, 또는 BarInfo를 또는 BazInfo 및 QuxInfo을 모두 제공하는 경우에만 some_rule 타겟을 볼 수 있습니다.

required_aspect_providers 기본값은 []입니다.
이 속성을 사용하면 이 관점이 다른 측면을 검사할 수 있습니다. 값은 개별 제공자 또는 제공업체 목록을 포함하는 목록이어야 하며 둘 다 포함할 수는 없습니다. 예를 들어 [[FooInfo], [BarInfo], [BazInfo, QuxInfo]]는 유효한 값이지만 [FooInfo, BarInfo, [BazInfo, QuxInfo]]는 유효하지 않습니다.

중첩되지 않은 제공자 목록은 제공자 목록 하나가 포함된 목록으로 자동 변환됩니다. 즉, [FooInfo, BarInfo]가 [[FooInfo, BarInfo]]로 자동 변환됩니다.

이 측면에 다른 측면 (예: other_aspect)을 표시하려면 other_aspect에서 하나 이상의 목록에 있는 모든 제공자를 제공해야 합니다. [[FooInfo], [BarInfo], [BazInfo, QuxInfo]]의 예에서 이 측면은 other_aspect가 FooInfo, 또는 BarInfo 또는 BazInfo 및 QuxInfo를 모두 제공하는 경우에만 other_aspect를 볼 수 있습니다.

provides 기본값은 []입니다.
구현 함수에서 반환해야 하는 제공업체 목록입니다.

구현 함수가 반환 값에서 여기에 나열된 제공자 유형을 생략하면 오류가 발생합니다. 그러나 구현 함수는 여기에 나열되지 않은 추가 제공자를 반환할 수도 있습니다.

목록의 각 요소는 provider()에서 반환된 *Info 객체입니다. 단, 기존 제공자는 문자열 이름으로 대신 표시됩니다. 규칙의 대상이 필수 제공자를 선언하는 대상의 종속 항목으로 사용되는 경우 여기서 해당 제공자를 지정할 필요가 없습니다. 구현 함수가 반환하는 것만으로 충분합니다. 하지만 필수 사항은 아니지만 지정하는 것이 좋습니다. 그러나 가로세로의 required_providers 필드를 사용하려면 여기에 공급업체를 지정해야 합니다.

requires Aspect의 sequence이며 기본값은 []입니다.
이 관점 이전에 전파되어야 하는 관점 목록입니다.
fragments 문자열의 sequence이며 기본값은 []입니다.
타겟 구성에서 측면에 필요한 구성 프래그먼트의 이름 목록입니다.
host_fragments 문자열의 sequence이며 기본값은 []입니다.
호스트 구성에서 측면에 필요한 구성 프래그먼트의 이름 목록입니다.
toolchains sequence이며 기본값은 []입니다.
설정하는 경우 이 규칙에 필요한 도구 모음 집합입니다. 목록에는 String, Label, StarlarkToolchainTypeApi 객체를 조합하여 사용할 수 있습니다. 도구 모음은 현재 플랫폼을 확인하여 찾을 수 있으며 ctx.toolchain를 통해 규칙 구현에 제공됩니다.
incompatible_use_toolchain_transition 기본값은 False입니다.
지원 중단되었습니다. 더 이상 사용하지 않으므로 삭제해야 합니다.
doc string 또는 None. 기본값은 None입니다.
문서 생성 도구로 추출할 수 있는 측면에 대한 설명입니다.
apply_to_generating_rules 기본값은 False입니다.
true인 경우 가로세로 비율이 출력 파일에 적용될 때 출력 파일의 생성 규칙에 대신 적용됩니다.

예를 들어 어떤 특성이 `deps` 속성을 통해 전이적으로 전파되고 `alpha`를 타겟팅하기 위해 적용된다고 가정해 보겠습니다. `alpha`에 `deps = [':beta_output']`이 있고 여기서 `beta_output`은 타겟 `beta`의 선언된 출력입니다. `beta`에는 타겟 `charlie`가 `deps` 중 하나로 있으며 `alpha_to_generating_rules`가 `alpha`인 경우 `alpha`가 관점만 전파되고 `alpha`가 관점=false인 경우 `alpha`가 관점=false인 경우 `alpha`가 관점=false인 경우 'alpha'는 관점을 전파합니다.

기본적으로 false입니다.
exec_compatible_with 문자열의 시퀀스. 기본값은 []
이 측면의 모든 인스턴스에 적용되는 실행 플랫폼의 제약 조건 목록입니다.
exec_groups dict 또는 None. 기본값은 None입니다.
실행 그룹 이름 (문자열)의 디렉터리는 exec_groups입니다. 설정된 경우 관점이 단일 인스턴스 내의 여러 실행 플랫폼에서 작업을 실행하도록 허용합니다. 자세한 내용은 실행 그룹 문서를 참고하세요.
subrules 하위 규칙의 시퀀스. 기본값은 []
실험용: 이 측면에서 사용하는 하위 규칙 목록입니다.

configuration_field

LateBoundDefault configuration_field(fragment, name)

label 유형 속성의 지연된 기본값을 참조합니다. 값을 결정하기 전에 구성을 빌드해야 하는 경우 값은 '지연 제한'입니다. 이 값을 값으로 사용하는 모든 속성은 비공개여야 합니다.

사용 예:

규칙 속성 정의: 

'_foo': attr.label(default=configuration_field(fragment='java', name='toolchain'))

규칙 구현에서 액세스 중: 

  def _rule_impl(ctx):
    foo_info = ctx.attr._foo
    ...

매개변수

매개변수 설명
fragment 필수
지연된 값이 포함된 구성 프래그먼트의 이름입니다.
name 필수
구성 프래그먼트에서 가져올 값의 이름입니다.

depset

depset depset(direct=None, order="default", *, transitive=None)

depset을 만듭니다. direct 매개변수는 depset의 직접 요소 목록이며 transitive 매개변수는 해당 요소가 생성된 depset의 간접 요소가 되는 depset 목록입니다. depset이 목록으로 변환될 때 요소가 반환되는 순서는 order 매개변수로 지정됩니다. 자세한 내용은 디셋 개요를 참고하세요.

depset의 모든 요소 (직접 및 간접)는 type(x) 표현식을 통해 얻는 것과 동일한 유형이어야 합니다.

해시 기반 세트는 반복 중에 중복을 제거하는 데 사용되므로 depset의 모든 요소는 해시가 가능해야 합니다. 그러나 이 불변량은 현재 모든 생성자에서 일관되게 검사되는 것은 아닙니다. --incompatible_always_check_depset_elements 플래그를 사용하여 일관된 검사를 사용 설정합니다. 이는 향후 출시에서 기본 동작이 될 것입니다. 문제 10313을 참조하세요.

또한 요소는 현재 변경할 수 없어야 하지만 이 제한사항은 향후 완화될 예정입니다.

생성된 종속 항목의 순서는 transitive 종속 항목의 순서와 호환되어야 합니다. "default" 주문은 다른 모든 주문과 호환되며 다른 모든 주문은 해당 주문하고만 호환됩니다.

매개변수

매개변수 설명
direct sequence 또는 None이며 기본값은 None입니다.
depset의 direct 요소 목록입니다.
order 기본값은 "default"입니다.
새 종속 항목의 순회 전략입니다. 가능한 값은 여기를 참고하세요.
transitive depset의 시퀀스 또는 None. 기본값은 None
요소가 종속 항목의 간접 요소가 되는 종속 항목의 목록입니다.

exec_group

exec_group exec_group(toolchains=[], exec_compatible_with=[])

규칙 구현 중에 특정 실행 플랫폼에 대한 작업을 만드는 데 사용할 수 있는 실행 그룹을 만듭니다.

매개변수

매개변수 설명
toolchains sequence이며 기본값은 []입니다.
이 실행 그룹에 필요한 도구 모음 집합입니다. 목록에는 String, Label, StarlarkToolchainTypeApi 객체를 조합하여 사용할 수 있습니다.
exec_compatible_with 문자열의 시퀀스. 기본값은 []
실행 플랫폼의 제약 조건 목록입니다.

module_extension

unknown module_extension(implementation, *, tag_classes={}, doc=None, environ=[], os_dependent=False, arch_dependent=False)

새 모듈 확장 프로그램을 만듭니다. MODULE.bazel 파일로 내보내고 사용할 수 있도록 전역 값에 저장합니다.

매개변수

매개변수 설명
implementation 필수
이 모듈 확장 프로그램을 구현하는 함수입니다. 단일 매개변수 module_ctx를 사용해야 합니다. 이 함수는 빌드 시작 시 한 번 호출되어 사용 가능한 저장소 집합을 결정합니다.
tag_classes 기본값은 {}입니다.
확장 프로그램에서 사용하는 모든 태그 클래스를 선언하는 사전입니다. 이 클래스는 태그 클래스의 이름에서 tag_class 객체에 매핑됩니다.
doc string 또는 None. 기본값은 None입니다.
문서 생성 도구로 추출할 수 있는 모듈 확장 프로그램에 대한 설명입니다.
environ 문자열의 시퀀스. 기본값은 []
입니다. 이 모듈 확장 프로그램이 종속된 환경 변수 목록을 제공합니다. 이 목록의 환경 변수가 변경되면 확장 프로그램이 다시 평가됩니다.
os_dependent 기본값은 False입니다.
이 확장 프로그램이 OS 종속적인지 여부를 나타냅니다.
arch_dependent 기본값은 False입니다.
이 확장 프로그램이 아키텍처에 종속되는지 여부를 나타냅니다.

제공업체

unknown provider(doc=None, *, fields=None, init=None)

제공업체 기호를 정의합니다. 제공자를 호출하여 인스턴스화하거나 대상에서 해당 제공자의 인스턴스를 검색하기 위한 키로 직접 사용할 수 있습니다. 예:
MyInfo = provider()
...
def _my_library_impl(ctx):
    ...
    my_info = MyInfo(x = 2, y = 3)
    # my_info.x == 2
    # my_info.y == 3
    ...

제공업체를 사용하는 방법에 관한 전체 가이드는 규칙 (제공업체)을 참고하세요.

init가 지정되지 않은 경우 Provider 호출 가능 값을 반환합니다.

init가 지정된 경우 Provider 호출 가능 값과 원시 생성자 호출 가능 값 등 두 요소의 튜플을 반환합니다. 자세한 내용은 규칙 (맞춤 제공자의 맞춤 초기화) 및 아래의 init 매개변수에 관한 설명을 참고하세요.

매개변수

매개변수 설명
doc string 또는 None. 기본값은 None입니다.
문서 생성 도구로 추출할 수 있는 제공자에 관한 설명입니다.
fields 문자열, dict 또는 None의 시퀀스입니다. 기본값은 None입니다.
지정된 경우 허용되는 필드 집합을 제한합니다.
가능한 값은 다음과 같습니다.
  • 필드 목록:
    provider(fields = ['a', 'b'])

  • 사전 필드 이름 -> 문서:
    provider(
       fields = { 'a' : 'Documentation for a', 'b' : 'Documentation for b' })
모든 입력란은 선택사항입니다.
init 호출 가능 또는 None. 기본값은 None입니다.
인스턴스화하는 동안 제공자의 필드 값을 사전 처리하고 검증하기 위한 선택적 콜백입니다. init가 지정되면 provider()는 두 요소(일반 제공자 기호와 원시 생성자)로 구성된 튜플을 반환합니다.

정확한 설명이 이어집니다. 직관적인 설명 및 사용 사례는 규칙 (제공업체 맞춤 초기화)을 참고하세요.

P를 provider()를 호출하여 만든 제공자 기호로 설정합니다. 개념적으로 P 인스턴스는 다음을 실행하는 기본 생성자 함수 c(*args, **kwargs)를 호출하여 생성됩니다.

  • args가 비어 있지 않으면 오류가 발생합니다.
  • provider()가 호출될 때 fields 매개변수가 지정되었고, kwargs에 fields에 나열되지 않은 키가 포함되어 있으면 오류가 발생합니다.
  • 그렇지 않으면 c는 kwargs의 각 k: v 항목에 대해 값이 v인 k라는 필드가 있는 새 인스턴스를 반환합니다.
init 콜백이 지정되지 않은 경우, P 기호 자체에 대한 호출은 기본 생성자 함수 c를 호출하는 역할을 합니다. 즉, P(*args, **kwargs)는 c(*args, **kwargs)를 반환합니다. 예를 들어
MyInfo = provider()
m = MyInfo(foo = 1)
는 m가 m.foo == 1가 있는 MyInfo 인스턴스가 되도록 간단히 만듭니다.

하지만 init가 지정된 경우 P(*args, **kwargs) 호출은 대신 다음 단계를 실행합니다.

  1. 콜백은 init(*args, **kwargs)로 호출됩니다. 즉, P에 전달된 것과 정확히 동일한 위치 및 키워드 인수를 사용합니다.
  2. init의 반환 값은 키가 필드 이름 문자열인 사전 d여야 합니다. 그렇지 않은 경우 오류가 발생합니다.
  3. c(**d)에서와 같이 d의 항목을 키워드 인수로 사용하여 기본 생성자를 호출하는 것처럼 P의 새 인스턴스가 생성됩니다.

NB: 위 단계는 *args 또는 **kwargs가 init의 서명과 일치하지 않거나 init의 본문 평가에 실패하거나 (아마 의도적으로 fail() 호출을 통해) init의 반환 값이 예상 스키마가 포함된 사전이 아닌 경우 오류가 발생한다는 것을 의미합니다.

이러한 방식으로 init 콜백은 전처리와 유효성 검사를 위한 위치 인수와 임의의 로직을 허용하여 일반적인 제공자 구성을 일반화합니다. 허용된 fields 목록을 우회할 수 없습니다.

init가 지정되면 provider()의 반환 값은 (P, r) 튜플이 되며, 여기서 r는 원시 생성자입니다. 실제로 r의 동작은 위에서 설명한 기본 생성자 함수 c의 동작과 정확히 일치합니다. 일반적으로 r는 이름에 밑줄이 접두사로 붙은 변수에 바인딩되므로 현재 .bzl 파일만 직접 액세스할 수 있습니다.

MyInfo, _new_myinfo = provider(init = ...)

repository_rule

callable repository_rule(implementation, *, attrs=None, local=False, environ=[], configure=False, remotable=False, doc=None)

새 저장소 규칙을 만듭니다. WORKSPACE 파일에서 로드하고 호출할 수 있도록 전역 값에 저장합니다.

매개변수

매개변수 설명
implementation 필수
이 규칙을 구현하는 함수입니다. 단일 매개변수 repository_ctx가 있어야 합니다. 이 함수는 규칙의 각 인스턴스에 대해 로드 단계에서 호출됩니다.
attrs dict 또는 None. 기본값은 None
사전으로 규칙의 모든 속성을 선언합니다. 속성 이름에서 속성 객체로 매핑됩니다 (attr 모듈 참조). _로 시작하는 속성은 비공개이며 라벨에 관한 암시적 종속 항목을 파일에 추가하는 데 사용할 수 있습니다 (저장소 규칙은 생성된 아티팩트에 종속될 수 없음). name 속성은 암시적으로 추가되므로 지정해서는 안 됩니다.
local 기본값은 False입니다.
이 규칙이 로컬 시스템에서 모든 항목을 가져오므로 가져올 때마다 재평가되어야 함을 나타냅니다.
environ 문자열의 순서. 기본값은 []
입니다. 이 저장소 규칙이 종속된 환경 변수 목록을 제공합니다. 이 목록의 환경 변수가 변경되면 저장소를 다시 가져옵니다.
configure 기본값은 False입니다.
저장소가 구성 목적으로 시스템을 검사한다고 나타냅니다.
remotable 기본값은 False
실험용입니다. 이 매개변수는 시험용이며 언제든지 변경될 수 있습니다. 의존하지 마세요. ---experimental_repo_remote_exec을 설정하여 실험적으로 사용 설정할 수 있습니다.
원격 실행과 호환됨
doc string 또는 None. 기본값은 None입니다.
문서 생성 도구로 추출할 수 있는 저장소 규칙의 설명입니다.

규칙

callable rule(implementation, *, test=unbound, attrs={}, outputs=None, executable=unbound, output_to_genfiles=False, fragments=[], host_fragments=[], _skylark_testable=False, toolchains=[], incompatible_use_toolchain_transition=False, doc=None, provides=[], exec_compatible_with=[], analysis_test=False, build_setting=None, cfg=None, exec_groups=None, initializer=None, parent=None, extendable=None, subrules=[])

새 규칙을 만듭니다. 이 규칙은 BUILD 파일 또는 매크로에서 호출하여 대상을 만들 수 있습니다.

규칙은 .bzl 파일의 전역 변수에 할당되어야 합니다. 전역 변수의 이름은 규칙의 이름입니다.

테스트 규칙에는 _test으로 끝나는 이름이 있어야 하지만 다른 모든 규칙에는 이 접미사가 없어야 합니다. (이 제한은 규칙에만 적용되며 대상에는 적용되지 않습니다.)

매개변수

매개변수 설명
implementation 필수
이 규칙을 구현하는 Starlark 함수는 정확히 하나의 매개변수(ctx)를 가져야 합니다. 이 함수는 규칙의 각 인스턴스에 대한 분석 단계에서 호출됩니다. 사용자가 제공한 속성에 액세스할 수 있습니다. 선언된 모든 출력을 생성하는 작업을 만들어야 합니다.
test bool. 기본값은 unbound입니다.
이 규칙이 테스트 규칙인지 여부, 즉 blaze test 명령어의 대상이 될 수 있는지 여부입니다. 모든 테스트 규칙은 자동으로 실행 가능한 것으로 간주되므로 테스트 규칙에 executable = True를 명시적으로 설정하지 않아도 됩니다. 따라서 권장되지 않습니다. 기본값은 False입니다. 자세한 내용은 규칙 페이지를 참조하세요.
attrs dict입니다. 기본값은 규칙의 모든 속성을 선언하는 {}
사전입니다. 속성 이름에서 속성 객체로 매핑됩니다 (attr 모듈 참조). _로 시작하는 속성은 비공개이며 라벨에 암시적 종속 항목을 추가하는 데 사용할 수 있습니다. name 속성은 암시적으로 추가되므로 지정해서는 안 됩니다. 속성 visibility, deprecation, tags, testonly, features는 암시적으로 추가되며 재정의할 수 없습니다. 대부분의 규칙에는 몇 가지 속성만 필요합니다. 메모리 사용량을 제한하기 위해 규칙 함수는 attrs 크기에 한도를 적용합니다.
outputs dict, None, function, 기본값은 None
지원 중단됨. 이 매개변수는 지원 중단되었으며 곧 삭제됩니다. 의존하지 마세요. ---incompatible_no_rule_outputs_param를 통해 사용 중지됩니다. 이 플래그를 사용하여 코드가 임박한 삭제와 호환되는지 확인합니다.
이 매개변수는 지원 중단되었습니다. 대신 OutputGroupInfo 또는 attr.output를 사용하도록 규칙을 이전하세요.

사전 선언된 출력을 정의하기 위한 스키마입니다. output 및 output_list 속성과 달리 사용자는 이러한 파일에 라벨을 지정하지 않습니다. 사전 선언된 출력에 대한 자세한 내용은 규칙 페이지를 참조하세요.

이 인수의 값은 사전을 생성하는 사전 또는 콜백 함수입니다. 콜백은 계산된 종속 항목 속성과 유사하게 작동합니다. 함수의 매개변수 이름은 규칙의 속성과 일치하는지 확인합니다. 예를 들어 def _my_func(srcs, deps): ... 정의와 함께 outputs = _my_func을 전달하면 함수는 srcs 및 deps 속성에 액세스할 수 있습니다. 사전이 직접 지정되었는지 또는 함수를 통해 지정되었는지에 따라 다음과 같이 해석됩니다.

사전의 각 항목은 키가 식별자이고 값은 출력의 라벨을 결정하는 문자열 템플릿인 사전 선언된 출력을 생성합니다. 규칙의 구현 함수에서 식별자는 ctx.outputs에서 출력의 File에 액세스하는 데 사용되는 필드 이름이 됩니다. 출력 라벨에는 규칙과 동일한 패키지가 있으며 패키지 뒤 부분은 "%{ATTR}" 형식의 각 자리표시자를 ATTR 속성 값으로 구성된 문자열로 대체하여 생성됩니다.

  • 문자열 유형 속성은 그대로 대체됩니다.
  • 라벨 유형이 지정된 속성은 패키지 뒤에서 파일 확장자를 제외한 라벨의 일부가 됩니다. 예를 들어 "//pkg:a/b.c" 라벨은 "a/b"가 됩니다.
  • 출력 유형 속성은 파일 확장자를 포함하여 패키지 다음에 라벨의 일부가 됩니다 (위의 예에서는 "a/b.c").
  • 자리표시자에 사용되는 모든 목록 유형 속성 (예: attr.label_list)에는 정확히 하나의 요소가 있어야 합니다. 전환은 목록에 없는 버전 (attr.label)과 동일합니다.
  • 다른 속성 유형은 자리표시자에 표시되지 않을 수 있습니다.
  • 특수 비속성 자리표시자 %{dirname} 및 %{basename}는 패키지를 제외한 규칙 라벨의 해당 부분으로 확장됩니다. 예를 들어 "//pkg:a/b.c"에서 dirname은 a이고 기본 이름은 b.c입니다.

실제로 가장 일반적인 대체 자리표시자는 "%{name}"입니다. 예를 들어 'foo'라는 타겟의 경우 출력 사전 선언 {"bin": "%{name}.exe"}은 구현 함수에서 ctx.outputs.bin로 액세스할 수 있는 foo.exe라는 출력을 미리 선언합니다.

executable bool. 기본값은 unbound입니다.
이 규칙을 실행 가능한 것으로 간주할지 여부, 즉 blaze run 명령어의 대상인지 여부입니다. 기본값은 False입니다. 자세한 내용은 규칙 페이지를 참조하세요.
output_to_genfiles 기본값은 False입니다.
true인 경우 파일이 bin 디렉터리가 아닌 genfiles 디렉터리에 생성됩니다. 기존 규칙과의 호환성을 위해 필요한 경우가 아니라면 (예: C++용 헤더 파일 생성 시) 이 플래그를 설정하지 마세요.
fragments 문자열의 sequence이며 기본값은 []입니다.
규칙이 타겟 구성에서 요구하는 구성 프래그먼트의 이름 목록입니다.
host_fragments 문자열의 sequence이며 기본값은 []입니다.
규칙이 호스트 구성에서 요구하는 구성 프래그먼트의 이름 목록입니다.
_skylark_testable 기본값은 False입니다.
(실험용)

true인 경우 이 규칙은 Actions 제공자를 통해 이 규칙에 종속된 규칙에 따라 검사할 작업을 노출합니다. 제공자는 ctx.created_actions()를 호출하여 규칙 자체에 사용할 수도 있습니다.

이는 Starlark 규칙의 분석 시간 동작을 테스트하는 데만 사용해야 합니다. 이 플래그는 향후 삭제될 수 있습니다.
toolchains sequence이며 기본값은 []입니다.
설정하는 경우 이 규칙에 필요한 도구 모음 집합입니다. 목록에는 String, Label, StarlarkToolchainTypeApi 객체를 조합하여 사용할 수 있습니다. 도구 모음은 현재 플랫폼을 확인하여 찾을 수 있으며 ctx.toolchain를 통해 규칙 구현에 제공됩니다.
incompatible_use_toolchain_transition 기본값은 False입니다.
지원 중단되었습니다. 더 이상 사용하지 않으므로 삭제해야 합니다.
doc string 또는 None. 기본값은 None입니다.
문서 생성 도구로 추출할 수 있는 규칙에 대한 설명입니다.
provides 기본값은 []입니다.
구현 함수에서 반환해야 하는 제공업체 목록입니다.

구현 함수가 반환 값에서 여기에 나열된 제공자 유형을 생략하면 오류가 발생합니다. 그러나 구현 함수는 여기에 나열되지 않은 추가 제공자를 반환할 수도 있습니다.

목록의 각 요소는 provider()에서 반환된 *Info 객체입니다. 단, 기존 제공자는 문자열 이름으로 대신 표시됩니다. 규칙의 대상이 필수 제공자를 선언하는 대상의 종속 항목으로 사용되는 경우 여기서 해당 제공자를 지정할 필요가 없습니다. 구현 함수가 반환하는 것만으로 충분합니다. 하지만 필수 사항은 아니지만 지정하는 것이 좋습니다. 그러나 가로세로의 required_providers 필드를 사용하려면 여기에 공급업체를 지정해야 합니다.

exec_compatible_with 문자열의 시퀀스. 기본값은 []
이 규칙 유형의 모든 대상에 적용되는 실행 플랫폼의 제약 조건 목록입니다.
analysis_test 기본값은 False입니다.
true인 경우 이 규칙은 분석 테스트로 처리됩니다.

참고: 분석 테스트 규칙은 주로 핵심 Starlark 라이브러리에 제공되는 인프라를 사용하여 정의됩니다. 자세한 내용은 테스트를 참고하세요.

분석 테스트 규칙으로 규칙을 정의한 경우 속성에서 analysis_test_transition을 사용하여 정의된 구성 전환을 사용할 수 있지만 다음과 같은 몇 가지 제한사항이 있습니다.

  • 이 규칙의 대상은 포함할 수 있는 전이 종속 항목의 수가 제한됩니다.
  • 규칙은 테스트 규칙으로 간주됩니다 (마치 test=True가 설정된 경우). 이 값은 test 값을 대체합니다.
  • 규칙 구현 함수에서 작업을 등록하지 못할 수 있습니다. 대신 AnalysisTestResultInfo를 제공하여 성공/실패 결과를 등록해야 합니다.
build_setting BuildSetting 또는 None로, 기본값은 None입니다.
설정하는 경우 이 규칙의 build setting 종류를 설명합니다. config 모듈을 참조하세요. 이 속성을 설정하면 'build_setting_default'라는 필수 속성이 이 규칙에 자동으로 추가되며, 여기에 전달된 값에 해당하는 유형이 사용됩니다.
cfg 기본값은 None입니다.
설정된 경우 구성 전환을 가리킵니다. 분석 전에 규칙이 자체 구성에 적용됩니다.
exec_groups dict 또는 None. 기본값은 None입니다.
실행 그룹 이름 (문자열)의 디렉터리는 exec_groups입니다. 설정된 경우 규칙이 단일 타겟 내의 여러 실행 플랫폼에서 작업을 실행하도록 허용합니다. 자세한 내용은 실행 그룹 문서를 참고하세요.
initializer 기본값은 None입니다.
실험용: 규칙의 속성을 초기화하는 Stalark 함수입니다.

이 함수는 규칙의 각 인스턴스에 대해 로드 시 호출됩니다. 이 메서드는 일반 속성 (예: name 또는 tags)이 아닌 규칙에서 정의한 공개 속성 값으로 호출됩니다.

속성 이름에서 원하는 값으로 사전을 반환해야 합니다. 반환되지 않은 속성은 영향을 받지 않습니다. None을 값으로 반환하면 속성 정의에 지정된 기본값이 사용됩니다.

이니셜라이저는 속성 정의에 지정된 기본값보다 먼저 평가됩니다. 따라서 이니셜라이저 서명의 매개변수에 기본값이 포함되어 있으면 속성 정의에서 기본값을 덮어씁니다 (None를 반환하는 경우 제외).

마찬가지로 이니셜라이저 서명의 매개변수에 기본값이 없으면 매개변수가 필수가 됩니다. 이러한 경우 속성 정의에서 기본/필수 설정을 생략하는 것이 좋습니다.

처리되지 않는 속성에는 **kwargs를 사용하는 것이 좋습니다.

확장 규칙의 경우 모든 이니셜라이저를 하위 요소에서 상위 요소로 진행한다고 합니다. 각 이니셜라이저에는 알고 있는 공개 속성만 전달됩니다.

parent 기본값은 None입니다.
실험용: 확장된 Stalark 규칙입니다. 설정하면 공개 속성뿐 아니라 공지된 제공업체도 병합됩니다. 규칙은 상위 요소의 executable 및 test와 일치합니다. fragments, toolchains, exec_compatible_with, exec_groups 값이 병합됩니다. 기존 매개변수 또는 지원 중단된 매개변수는 설정되지 않을 수 있습니다.
extendable bool, Label, string, None, 기본값은 None입니다.
실험용: 이 규칙을 확장할 수 있는 규칙을 정의하는 허용 목록 라벨입니다. True/False로 설정하여 확장을 항상 허용하거나 허용하지 않을 수도 있습니다. Bazel은 기본적으로 항상 확장 프로그램을 허용합니다.
subrules 하위 규칙의 시퀀스. 기본값은 []
실험용: 이 규칙에서 사용하는 하위 규칙 목록입니다.

select

unknown select(x, no_match_error='')

select()는 규칙 속성을 구성 가능하도록 하는 도우미 함수입니다. 자세한 내용은 빌드 백과사전을 참고하세요.

매개변수

매개변수 설명
x 필수
구성 조건을 값에 매핑하는 사전입니다. 각 키는 config_setting 또는 constraint_value 인스턴스를 식별하는 라벨 또는 라벨 문자열입니다. 문자열 대신 라벨을 사용하는 경우에 대해서는 매크로 문서를 참조하세요.
no_match_error 기본값은 ''입니다.
일치하는 조건이 없는 경우 보고할 커스텀 오류입니다(선택사항).

하위 규칙

Subrule subrule(implementation, attrs={}, toolchains=[], fragments=[], subrules=[])

하위 규칙의 새 인스턴스를 생성합니다. 이 함수의 결과를 사용하려면 먼저 전역 변수에 저장해야 합니다.

매개변수

매개변수 설명
implementation function; 필수
이 하위 규칙을 구현하는 Starlark 함수
attrs dict. 기본값은 {}입니다.
하위 규칙의 모든 (비공개) 속성을 선언하기 위한 사전입니다.

하위 규칙은 라벨 유형이 지정된 비공개 속성 (예: label 또는 label-list)만 포함할 수 있습니다. 이러한 라벨에 상응하는 결정된 값은 Bazel에 의해 하위 규칙의 구현 함수에 이름이 지정된 인수로 자동 전달됩니다. 따라서 구현 함수는 속성 이름과 일치하는 이름이 지정된 매개변수를 허용해야 합니다. 이러한 값의 유형은 다음과 같습니다.

  • executable=True이 있는 라벨 속성의 경우 FilesToRunProvider
  • allow_single_file=True이 있는 라벨 속성의 경우 File
  • 기타 모든 라벨 속성의 경우 Target
  • 모든 라벨 목록 속성의 경우 [Target]
toolchains sequence이며 기본값은 []입니다.
설정하는 경우 이 하위 규칙에 필요한 도구 모음 집합입니다. 목록에는 String, Label, StarlarkToolchainTypeApi 객체를 조합하여 사용할 수 있습니다. 도구 모음은 현재 플랫폼을 확인하여 찾을 수 있으며 ctx.toolchains를 통해 하위 규칙 구현에 제공됩니다.
fragments 문자열의 시퀀스. 기본값은 []
대상 구성에서 하위 규칙이 요구하는 구성 프래그먼트의 이름 목록입니다.
subrules 하위 규칙의 시퀀스. 기본값은 []
이 하위 규칙에 필요한 다른 하위 규칙의 목록입니다.

tag_class

tag_class tag_class(attrs={}, *, doc=None)

모듈 확장 프로그램에서 사용할 수 있는 데이터 객체인 태그 클래스에 대한 속성 스키마를 정의하는 새 tag_class 객체를 만듭니다.

매개변수

매개변수 설명
attrs 기본값은 {}입니다.
이 태그 클래스의 모든 속성을 선언하는 사전입니다. 속성 이름에서 속성 객체로 매핑됩니다 (attr 모듈 참조).
doc string 또는 None. 기본값은 None입니다.
문서 생성 도구로 추출할 수 있는 태그 클래스에 대한 설명입니다.

공개 상태

None visibility(value)

현재 초기화 중인 .bzl 모듈의 로드 공개 상태를 설정합니다.

모듈의 로드 가시성은 다른 BUILD 및 .bzl 파일에서 모듈을 로드할 수 있는지 여부를 제어합니다. (파일이 다른 타겟의 종속 항목으로 표시될 수 있는지 여부를 제어하는 기본 .bzl 소스 파일의 타겟 공개 상태와는 다릅니다.) 로드 가시성은 패키지 수준에서 작동합니다. 모듈을 로드하려면 로드하는 파일이 모듈에 대한 가시성이 부여된 패키지에 있어야 합니다. 모듈은 공개 상태와 상관없이 항상 자체 패키지 내에 로드할 수 있습니다.

visibility()는 함수 내부가 아닌 최상위 수준에서만 .bzl 파일당 한 번만 호출할 수 있습니다. 선호되는 스타일은 이 호출을 load() 문 바로 아래에 배치하는 것과 인수를 결정하는 데 필요한 간단한 로직입니다.

--check_bzl_visibility 플래그를 false로 설정하면 부하 공개 상태 위반이 경고를 내보내지만 빌드에 실패하지는 않습니다.

매개변수

매개변수 설명
value 필수
패키지 사양 문자열의 목록 또는 단일 패키지 사양 문자열.

패키지 사양은 음수 패키지 사양이 허용되지 않는다는 점을 제외하고 package_group와 동일한 형식을 따릅니다. 즉, 사양은 다음과 같은 형식일 수 있습니다.

  • "//foo": //foo 패키지입니다.
  • "//foo/...": 패키지 //foo 및 모든 하위 패키지입니다.
  • "public" 또는 "private": 각각 모든 패키지 또는 패키지 없음

'@' 구문은 허용되지 않습니다. 모든 사양은 현재 모듈의 저장소를 기준으로 해석됩니다.

value가 문자열 목록인 경우 이 모듈에 대한 가시성이 부여되는 패키지 집합은 각 사양으로 표현되는 패키지의 합집합입니다. 빈 목록은 private와 효과가 같습니다. value가 단일 문자열인 경우 싱글톤 목록 [value]인 것처럼 처리됩니다.

--incompatible_package_group_has_public_syntax 및 --incompatible_fix_package_group_reporoot_syntax 플래그는 이 인수에 영향을 주지 않습니다. "public" 및 "private" 값은 항상 사용할 수 있으며 "//..."는 항상 '현재 저장소의 모든 패키지'로 해석됩니다.