BUILD 파일

문제 신고 Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

BUILD 파일에서 사용할 수 있는 메서드입니다. BUILD 파일에서도 사용할 수 있는 추가 함수 및 빌드 규칙에 관한 내용은 빌드 백과사전을 참고하세요.

회원

depset

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

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

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

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

또한 현재 요소는 변경 불가해야 하지만 향후 이 제한이 완화될 예정입니다.

생성된 depset의 순서는 transitive depset의 순서와 호환되어야 합니다. "default" 순서는 다른 순서와 호환되며 다른 모든 순서는 자체적으로만 호환됩니다.

매개변수

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

existing_rule

unknown existing_rule(name)

이 스레드의 패키지에 인스턴스화된 규칙의 속성을 설명하는 변경 불가능한 사전과 유사한 객체를 반환하거나, 해당 이름의 규칙 인스턴스가 없는 경우 None을 반환합니다.

여기에서 변경 불가능한 dict 같은 객체는 dict와 같은 반복(len(x), name in x, x[name], x.get(name), x.items(), x.keys(), x.values())을 지원하는 완전히 변경할 수 없는 객체 x를 의미합니다.

결과에는 비공개 속성(이름이 문자로 시작하지 않음)과 표현할 수 없는 일부 기존 속성 유형을 제외한 각 속성에 대한 항목이 포함됩니다. 또한 사전에는 규칙 인스턴스의 name 및 kind 항목(예: 'cc_binary')이 포함됩니다.

결과의 값은 다음과 같이 속성 값을 나타냅니다.

  • str, int 및 bool 유형의 속성은 있는 그대로 표시됩니다.
  • 라벨은 같은 패키지의 타겟인 경우 ':foo' 형식의 문자열로 변환됩니다. 다른 패키지에 있는 타겟의 경우 '//pkg:name' 형식의 문자열로 변환됩니다.
  • 목록은 튜플로 표시되고 사전은 변경 가능한 새 사전으로 변환됩니다. 요소의 요소는 동일한 방식으로 재귀적으로 변환됩니다.
  • select 값은 위에서 설명한 대로 변환된 콘텐츠와 함께 반환됩니다.
  • 규칙 인스턴스화 중에 값이 지정되지 않았고 기본값이 계산된 속성은 결과에서 제외됩니다. 계산된 기본값은 분석 단계까지 계산할 수 없습니다.

가능하면 이 함수를 규칙 최종 처리기 기호 매크로의 구현 함수에서만 사용하세요. 다른 컨텍스트에서는 이 함수를 사용하는 것이 권장되지 않으며 향후 Bazel 출시에서 사용 중지될 예정입니다. BUILD 파일이 불안정하고 순서에 종속됩니다. 또한 내부 형식에서 Starlark로의 규칙 속성 값 변환의 다른 두 가지 방법(계산된 기본값에서 사용되는 방법과 ctx.attr.foo에서 사용되는 방법)과는 미묘하게 다릅니다.

매개변수

매개변수 설명
name string; required
대상의 이름입니다.

existing_rules

unknown existing_rules()

지금까지 이 스레드의 패키지에 인스턴스화된 규칙을 설명하는 변경 불가능한 사전과 유사한 객체를 반환합니다. 사전과 유사한 객체의 각 항목은 규칙 인스턴스의 이름을 existing_rule(name)에서 반환할 결과에 매핑합니다.

여기서 변경 불가능한 사전과 유사한 객체는 사전과 유사한 반복, len(x), name in x, x[name], x.get(name), x.items(), x.keys(), x.values()을 지원하는 깊이 변경 불가능한 객체 x를 의미합니다.

가능한 경우 이 함수는 규칙 파이널라이저 심볼릭 매크로의 구현 함수에서만 사용하세요. 다른 컨텍스트에서 이 함수를 사용하는 것은 권장되지 않으며 향후 Bazel 출시에서 사용 중지됩니다. 이 함수를 사용하면 BUILD 파일이 취약해지고 순서에 종속됩니다.

exports_files

None exports_files(srcs, visibility=None, licenses=None)

이 패키지에 속하며 다른 패키지로 내보낸 파일 목록을 지정합니다.

매개변수

매개변수 설명
srcs 문자열 시퀀스입니다. 필수
내보낼 파일 목록입니다.
visibility sequence 또는 None. 기본값은 None입니다.
공개 상태 선언을 지정할 수 있습니다. 파일은 지정된 대상에 표시됩니다. 가시성을 지정하지 않으면 파일이 모든 패키지에 표시됩니다.
licenses 문자열의 시퀀스 또는 None입니다. 기본값은 None입니다.
지정할 라이선스입니다.

glob

sequence glob(include=[], exclude=[], exclude_directories=1, allow_empty=unbound)

Glob는 다음과 같은 현재 패키지의 모든 파일의 새롭고 변경 가능한 정렬된 목록을 반환합니다.
  • include의 패턴과 하나 이상 일치합니다.
  • exclude(기본값 [])의 패턴과 일치하지 않습니다.
exclude_directories 인수가 사용 설정된 경우(1로 설정) 디렉터리 유형의 파일이 결과에서 생략됩니다(기본값 1).

매개변수

매개변수 설명
include 문자열의 시퀀스입니다. 기본값은 []입니다.
포함할 glob 패턴 목록입니다.
exclude 문자열의 시퀀스입니다. 기본값은 []입니다.
제외할 glob 패턴 목록입니다.
exclude_directories int; 기본값은 1
디렉터리를 제외할지 여부를 나타내는 플래그입니다.
allow_empty 기본값은 unbound
glob 패턴이 아무것도 일치하지 않도록 허용할지 여부입니다. `allow_empty` 가 False인 경우 각 개별 포함 패턴이 항목과 일치해야 하며, `제외` 패턴의 일치 항목이 제외된 후 최종 결과는 비어 있지 않아야 합니다.

module_name

string module_name()

이 패키지가 있는 저장소와 연결된 Bazel 모듈의 이름입니다. 이 패키지가 MODULE.bazel이 아닌 WORKSPACE에 정의된 저장소의 경우 이 필드는 비어 있습니다. 모듈 확장 프로그램에서 생성된 저장소의 경우 확장 프로그램을 호스팅하는 모듈의 이름입니다. module_ctx.modules에 표시된 module.name 필드와 동일합니다. None을 반환할 수 있습니다.

module_version

string module_version()

이 패키지가 있는 저장소와 연결된 Bazel 모듈의 버전입니다. 이 패키지가 MODULE.bazel이 아닌 WORKSPACE에 정의된 저장소의 경우 이 필드는 비어 있습니다. 모듈 확장 프로그램에서 생성된 저장소의 경우 확장 프로그램을 호스팅하는 모듈의 버전입니다. module_ctx.modules에 표시된 module.version 필드와 동일합니다. None을 반환할 수 있습니다.

package_group

None package_group(name, packages=[], includes=[])

이 함수는 패키지 집합을 정의하고 그룹에 라벨을 할당합니다. 라벨은 visibility 속성에서 참조할 수 있습니다.

매개변수

매개변수 설명
name string; required
이 규칙의 고유한 이름입니다.
packages 문자열의 순서로, 기본값은 []입니다.
이 그룹에 포함된 패키지의 전체 열거형입니다.
includes string의 sequence로, 기본값은 []
입니다. 이 그룹에 포함된 다른 패키지 그룹입니다.

package_name

string package_name()

저장소 이름을 제외하고 평가 중인 패키지의 이름입니다. 예를 들어 BUILD 파일 some/package/BUILD의 값은 some/package입니다. BUILD 파일이 .bzl 파일에 정의된 함수를 호출하면 package_name()는 호출자 BUILD 파일 패키지와 일치합니다.

package_relative_label

Label package_relative_label(input)

현재 초기화되고 있는 패키지(즉, 현재 매크로가 실행 중인 BUILD 파일)의 컨텍스트에서 입력 문자열을 라벨 객체로 변환합니다. 입력이 이미 Label이면 변경되지 않은 상태로 반환됩니다.

이 함수는 BUILD 파일과 이 파일이 직접 또는 간접적으로 호출하는 매크로를 평가하는 동안에만 호출될 수 있습니다. 예를 들어 규칙 구현 함수에서는 호출되지 않을 수 있습니다.

이 함수의 결과는 지정된 문자열을 BUILD 파일에 선언된 타겟의 라벨 값 속성에 전달하여 생성되는 것과 동일한 Label 값입니다.

사용 메모: 이 함수와 Label()의 차이점은 Label()가 BUILD 파일의 패키지가 아닌 호출한 .bzl 파일의 패키지 컨텍스트를 사용한다는 점입니다. 컴파일러와 같이 매크로에 하드코딩된 고정 타겟을 참조해야 하는 경우 Label()를 사용하세요. BUILD 파일에서 제공된 라벨 문자열을 Label 객체로 정규화해야 하는 경우 package_relative_label()를 사용합니다. (BUILD 파일 또는 호출 .bzl 파일 외의 패키지 컨텍스트에서 문자열을 Label로 변환할 방법은 없습니다. 따라서 외부 매크로는 항상 라벨 문자열이 아닌 라벨 객체를 내부 매크로에 전달하는 것이 좋습니다.)

매개변수

매개변수 설명
input string 또는 Label; 필수
입력 라벨 문자열 또는 Label 객체입니다. Label 객체가 전달되면 있는 그대로 반환됩니다.

repo_name

string repo_name()

현재 평가 중인 패키지가 포함된 저장소의 표준 이름이며, 선행 @ 기호가 없습니다.

repository_name

string repository_name()

실험용 이 API는 실험용이며 언제든지 변경될 수 있습니다. 이 방법을 사용하지 마세요. --+incompatible_enable_deprecated_label_apis
를 설정하여 실험적으로 사용 설정할 수 있습니다.지원 중단됨 대신 repo_name를 사용하는 것이 좋습니다. 이 경우 가짜 선행 at 부호가 포함되지 않지만 그 외에는 동일하게 작동합니다.

현재 평가 중인 패키지가 포함된 저장소의 표준 이름으로, 접두사로 단일 @ 기호(@)가 추가됩니다. 예를 들어 WORKSPACE 스탠자 local_repository(name='local', path=...)에 의해 호출되어 생성된 패키지에서는 @local로 설정됩니다. 기본 저장소의 패키지에서는 @로 설정됩니다.

select

unknown select(x, no_match_error='')

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

매개변수

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

하위 패키지

sequence subpackages(include, exclude=[], allow_empty=False)

파일 시스템 디렉터리 깊이에 관계없이 현재 패키지의 모든 직접 하위 패키지로 구성된 변경 가능한 새 목록을 반환합니다. 반환된 목록은 정렬되며 현재 패키지와 관련된 하위 패키지의 이름을 포함합니다. 이 함수를 직접 호출하는 대신 bazel_skylib.subpackages 모듈의 메서드를 사용하는 것이 좋습니다.

매개변수

매개변수 설명
include string의 sequence, 필수
하위 패키지 스캔에 포함할 glob 패턴의 목록입니다.
exclude string의 sequence로, 기본값은 []
하위 패키지 스캔에서 제외할 glob 패턴 목록입니다.
allow_empty bool; 기본값은 False
호출이 빈 목록을 반환하면 실패하는지 여부입니다. 기본적으로 빈 목록은 subpackages() 호출이 불필요한 BUILD 파일의 잠재적 오류를 나타냅니다. true로 설정하면 이 경우 이 함수가 성공적으로 실행됩니다.