규칙은 Bazel이 입력에서 실행하여 일련의 출력을 생성하는 일련의 작업을 정의합니다. 이러한 출력은 규칙의 구현 함수에서 반환된 제공자에서 참조됩니다. 예를 들어 C++ 바이너리 규칙은 다음을 실행할 수 있습니다.
.cpp
소스 파일 (입력) 집합을 가져옵니다.- 소스 파일에서
g++
를 실행합니다 (작업). - 실행 가능한 출력 및 기타 파일과 함께
DefaultInfo
제공자를 반환합니다. 런타임 시 사용할 수 있게 해야 합니다 - 타겟 및 종속 항목에서 수집된 C++ 관련 정보가 포함된
CcInfo
제공자를 반환합니다.
Bazel의 관점에서 볼 때 g++
및 표준 C++ 라이브러리도 입력입니다.
추가할 수 있습니다. 규칙 작성자는 규칙에 사용자 제공 입력뿐만 아니라 작업 실행에 필요한 모든 도구와 라이브러리도 고려해야 합니다.
규칙을 만들거나 수정하기 전에 Bazel의 빌드 단계를 숙지하세요. 이 세 가지 개념을 각 단계 (로드, 분석, 실행)의 한 단계를 거칩니다. 규칙과 매크로의 차이를 이해하려면 매크로에 관해 알아보는 것도 유용합니다. 시작하려면 먼저 규칙 튜토리얼을 검토하세요. 그런 다음 이 페이지를 참고하세요.
Bazel 자체에 몇 가지 규칙이 내장되어 있습니다. 이러한 기본 규칙의 예시는 다음과 같습니다.
cc_library
및 java_binary
는 특정 언어에 대한 핵심 지원을 제공합니다.
자체 규칙을 정의하여 언어 및 도구에 대한 유사한 지원을 추가할 수 있습니다.
Bazel이 기본적으로 지원하지 않는 것입니다
Bazel은 Python용 확장 모델을 사용하여
Starlark 언어 이러한 규칙은 .bzl
파일로 작성되며
BUILD
파일에서 직접 로드할 수 있습니다.
자체 규칙을 정의할 때는 규칙이 지원하는 속성과 출력을 생성하는 방법을 배우게 됩니다.
규칙의 implementation
함수는
분석 단계입니다. 이 함수는
사용할 수 있습니다 대신 나중에 실행 단계에서 규칙의 출력을 빌드하는 데 필요한 경우 사용할 작업을 등록합니다.
규칙 생성
.bzl
파일에서 rule 함수를 사용하여 새 규칙
결과를 전역 변수에 저장합니다. rule
호출은 속성 및 구현 함수를 지정합니다.
example_library = rule(
implementation = _example_library_impl,
attrs = {
"deps": attr.label_list(),
...
},
)
이는 example_library
이라는 규칙의 종류를 정의합니다.
rule
호출은 규칙이 실행 파일 출력(executable=True
사용)을 생성하는지 아니면 특히 테스트 실행 파일(test=True
사용)을 생성하는지 여부도 지정해야 합니다. 후자인 경우 규칙은 테스트 규칙이며 규칙의 이름은 _test
로 끝나야 합니다.
타겟 인스턴스화
규칙은 BUILD
파일에서 로드되고 호출될 수 있습니다.
load('//some/pkg:rules.bzl', 'example_library')
example_library(
name = "example_target",
deps = [":another_target"],
...
)
빌드 규칙을 호출할 때마다 값을 반환하지는 않지만 정의를 정의하는 부작용이 있습니다. 있습니다. 이를 규칙 인스턴스화라고 합니다. 이렇게 하면 새 타겟의 이름과 타겟의 속성 값이 지정됩니다.
규칙은 Starlark 함수에서 호출하여 .bzl
파일에 로드할 수도 있습니다.
규칙을 호출하는 Starlark 함수를 Starlark 매크로라고 합니다.
Starlark 매크로는 궁극적으로 BUILD
파일에서 호출되어야 하며
BUILD
인 경우 로드 단계 중에 호출됩니다.
파일이 대상을 인스턴스화하도록 평가됩니다.
속성
속성은 규칙 인수입니다. 속성은 타겟의 구현에 특정 값을 제공하거나 다른 타겟을 참조하여 종속 항목 그래프를 만들 수 있습니다.
규칙별 속성(예: srcs
또는 deps
)은 지도를 전달하여 정의됩니다.
속성 이름에서 스키마로 변경(attr
을(를) 사용하여 생성)
모듈)을 rule
의 attrs
매개변수에 추가합니다.
name
및 visibility
와 같은 공통 속성은 모든 규칙에 암시적으로 추가됩니다. 추가
속성은 암시적으로
실행 규칙 및 테스트 규칙을
구체적으로 살펴보겠습니다 속성
전달된 사전에 포함될 수 없는 규칙에 암시적으로 추가된 경우
attrs
종속 항목 속성
소스 코드를 처리하는 규칙은 일반적으로 다음 속성을 정의하여 다양한 종속 항목 유형:
srcs
는 대상의 작업으로 처리되는 소스 파일을 지정합니다. 속성 스키마는 규칙이 처리하는 소스 파일의 종류에 예상되는 파일 확장자를 지정하는 경우가 많습니다. 헤더 파일이 있는 언어 규칙 일반적으로hdrs
알게 되었습니다.deps
는 타겟의 코드 종속 항목을 지정합니다. 속성 스키마는 이러한 종속 항목을 제공해야 하는 제공업체를 지정해야 합니다. 예를 들어cc_library
는CcInfo
를 제공합니다.data
는 런타임에 모든 실행 파일이 사용할 수 있도록 할 파일을 지정합니다. 타겟에 따라 다릅니다 그러면 임의의 파일을 지정할 수 있습니다.
example_library = rule(
implementation = _example_library_impl,
attrs = {
"srcs": attr.label_list(allow_files = [".example"]),
"hdrs": attr.label_list(allow_files = [".header"]),
"deps": attr.label_list(providers = [ExampleInfo]),
"data": attr.label_list(allow_files = True),
...
},
)
다음은 종속 항목 속성의 예입니다. 입력 라벨을 지정하는 속성(attr.label_list
, attr.label
또는 attr.label_keyed_string_dict
로 정의된 속성)은 대상이 정의될 때 해당 속성에 라벨(또는 상응하는 Label
객체)이 나열된 대상과 대상 간의 특정 유형의 종속 항목을 지정합니다. 이러한 라벨의 저장소와 경로는 정의된 타겟을 기준으로 확인됩니다.
example_library(
name = "my_target",
deps = [":other_target"],
)
example_library(
name = "other_target",
...
)
이 예에서 other_target
는 my_target
의 종속 항목이므로
other_target
가 먼저 분석됩니다. 타겟의 종속 항목 그래프에 순환이 있으면 오류입니다.
비공개 속성 및 암시적 종속 항목
기본값이 있는 종속 항목 속성은 암시적 종속 항목을 만듭니다. 이는 사용자가 BUILD
파일에서 지정하지 않는 타겟 그래프의 일부이므로 암시적입니다. 암시적 종속 항목은 규칙과 도구(컴파일러와 같은 빌드 시간 종속 항목) 간의 관계를 하드코딩하는 데 유용합니다. 대부분의 경우 사용자는 규칙에서 사용하는 도구를 지정하는 데 관심이 없기 때문입니다. 규칙의 구현 함수 내에서는 다른 종속 항목과 동일하게 취급됩니다.
사용자가 다음 작업을 하도록 허용하지 않고 암시적 종속 항목을 제공하려는 경우
재정의하려면 이름을 지정하여 속성을 private으로 만들 수 있습니다.
밑줄 (_
)로 시작하는 단어입니다. 비공개 속성에는 기본값이 있어야 합니다.
값으로 사용됩니다. 일반적으로 암시적 전달을 위해 비공개 속성을 사용하는 것은
종속 항목이 포함됩니다
example_library = rule(
implementation = _example_library_impl,
attrs = {
...
"_compiler": attr.label(
default = Label("//tools:example_compiler"),
allow_single_file = True,
executable = True,
cfg = "exec",
),
},
)
이 예에서 example_library
유형의 모든 타겟은 컴파일러 //tools:example_compiler
에 암시적 종속 항목이 있습니다. 이렇게 하면
example_library
의 구현 함수:
사용자가 라벨을 입력으로 전달하지 않았더라도 마찬가지입니다. 이후
_compiler
는 비공개 속성으로, ctx.attr._compiler
뒤에 옵니다.
이 규칙의 모든 대상에서 항상 //tools:example_compiler
을(를) 가리킵니다.
있습니다. 또는 다음과 같이 속성 이름을 compiler
로 지정할 수 있습니다.
기본값을 유지합니다. 이렇게 하면 사용자가
필요한 경우 다른 컴파일러를 제공하지만 컴파일러의
라벨을 지정합니다.
암시적 종속 항목은 일반적으로 규칙 구현과 동일한 저장소에 있는 도구에 사용됩니다. 도구의 출처가 실행 플랫폼 또는 다른 저장소인 경우 도구 모음에서 해당 도구를 가져와야 합니다.
출력 속성
출력 속성(예: attr.output
및
attr.output_list
인 경우
생성합니다. 이는 종속 항목 속성과 다음 두 가지 측면에서 다릅니다.
- 다른 곳에서 정의된 타겟을 참조하는 대신 출력 파일 타겟을 정의합니다.
- 출력 파일 타겟은 인스턴스화된 규칙 타겟에 종속되며 그 반대는 아닙니다.
일반적으로 출력 속성은 규칙에서 대상 이름을 기반으로 할 수 없는 사용자 정의 이름으로 출력을 만들어야 하는 경우에만 사용됩니다. 규칙에
출력 속성 하나는 일반적으로 out
또는 outs
로 명명됩니다.
출력 속성은 사전 선언된 출력을 만드는 데 권장되는 방법으로, 이러한 출력은 구체적으로 종속되거나 명령줄에서 요청할 수 있습니다.
구현 함수
모든 규칙에는 implementation
함수가 필요합니다. 이러한 함수는 분석 단계에서 엄격하게 실행되며 로드 단계에서 생성된 타겟 그래프를 실행 단계에서 실행할 작업 그래프로 변환합니다. 따라서 구현 함수는 실제로 파일을 읽거나 쓸 수 없습니다.
규칙 구현 함수는 일반적으로 비공개이며(앞에 밑줄이 표시됨) 일반적으로 규칙과 동일한 이름을 사용하지만 _impl
접미사를 추가합니다.
구현 함수는 일반적으로 ctx
라는 이름의 규칙 컨텍스트라는 하나의 매개변수를 사용합니다. 이 함수는
제공업체와는 다릅니다.
대상
종속 항목은 분석 시간에 Target
로 표시됩니다.
객체입니다. 이러한 객체에는 타겟의 구현 함수가 실행될 때 생성된 제공자가 포함되어 있습니다.
ctx.attr
에는 각
종속 항목 속성: 각 직접 객체를 나타내는 Target
객체를 포함합니다.
종속 항목을 호출합니다. label_list
속성의 경우 Targets
목록입니다. label
속성의 경우 단일 Target
또는 None
입니다.
제공자 객체의 목록은 타겟의 구현 함수에 의해 반환됩니다.
return [ExampleInfo(headers = depset(...))]
이러한 항목은 색인 표기법 ([]
)을 사용하여 액세스할 수 있으며 제공자 유형은 다음과 같습니다.
생성합니다. 이는 Starlark에서 정의된 커스텀 제공자일 수 있습니다.
Starlark로 제공되는 네이티브 규칙용 제공업체
전역 변수입니다
예를 들어 규칙이 hdrs
속성을 통해 헤더 파일을 가져와 타겟 및 소비자의 컴파일 작업에 제공하는 경우 다음과 같이 수집할 수 있습니다.
def _example_library_impl(ctx):
...
transitive_headers = [hdr[ExampleInfo].headers for hdr in ctx.attr.hdrs]
제공업체 객체 목록 대신 타겟의 구현 함수에서 struct
가 반환되는 기존 스타일의 경우:
return struct(example_info = struct(headers = depset(...)))
제공업체는 Target
객체의 해당 필드에서 가져올 수 있습니다.
transitive_headers = [hdr.example_info.headers for hdr in ctx.attr.hdrs]
이 스타일은 권장되지 않으며 규칙을 이 스타일에서 이전해야 합니다.
파일
파일은 File
객체로 표현됩니다. Bazel은 분석 단계에서 파일 I/O를 실행하지 않으므로 이러한 객체는 파일 콘텐츠를 직접 읽거나 쓰는 데 사용할 수 없습니다. 대신 작업을 내보내는
함수 (ctx.actions
참고)를 사용하여
액션 그래프입니다.
File
은 소스 파일 또는 생성된 파일일 수 있습니다. 생성된 각 파일은
정확히 한 작업의 출력이어야 합니다. 소스 파일은
실행할 수 있습니다
종속 항목 속성마다 ctx.files
의 해당 필드에는 해당 속성을 통한 모든 종속 항목의 기본 출력 목록이 포함됩니다.
def _example_library_impl(ctx):
...
headers = depset(ctx.files.hdrs, transitive=transitive_headers)
srcs = ctx.files.srcs
...
ctx.file
에는 다음 표현식에 대한 단일 File
또는 None
가 포함됩니다.
사양에서 allow_single_file=True
를 설정한 종속 항목 속성입니다.
ctx.executable
는 ctx.file
와 동일하게 동작하지만
사양이 executable=True
로 설정된 종속 항목 속성의 필드가 포함됩니다.
출력 선언
분석 단계에서는 규칙의 구현 함수가 출력을 생성할 수 있습니다.
로드 단계에서 모든 라벨을 알아야 하므로
출력에 라벨이 없습니다. 출력용 File
객체는 ctx.actions.declare_file
및 ctx.actions.declare_directory
를 사용하여 만들 수 있습니다. 출력 이름은 타겟 이름인 ctx.label.name
을 기반으로 하는 경우가 많습니다.
def _example_library_impl(ctx):
...
output_file = ctx.actions.declare_file(ctx.label.name + ".output")
...
출력 속성용으로 만든 것과 같은 사전 선언된 출력의 경우 File
객체는 대신 ctx.outputs
의 해당 필드에서 가져올 수 있습니다.
작업
작업은 입력 집합에서 출력 집합을 생성하는 방법을 설명합니다(예: 'hello.c에서 gcc를 실행하고 hello.o 가져오기'). 작업이 생성되면 Bazel은 명령어를 즉시 실행하지는 않습니다 작업은 다른 작업의 출력에 종속될 수 있으므로 종속 항목 그래프에 등록됩니다. 예를 들어 C에서는 컴파일러 후에 링커를 호출해야 합니다.
작업을 만드는 범용 함수는 ctx.actions
에 정의되어 있습니다.
ctx.actions.run
: 실행 파일을 실행합니다.ctx.actions.run_shell
: 셸을 실행합니다. 명령어와 함께 사용하면 됩니다ctx.actions.write
: 파일에 문자열을 작성합니다.ctx.actions.expand_template
~ 템플릿을 사용하여 파일을 생성합니다.
ctx.actions.args
는 작업의 인수를 효율적으로 누적하는 데 사용할 수 있습니다. 실행 시간까지 depset을 평탄화하지 않습니다.
def _example_library_impl(ctx):
...
transitive_headers = [dep[ExampleInfo].headers for dep in ctx.attr.deps]
headers = depset(ctx.files.hdrs, transitive=transitive_headers)
srcs = ctx.files.srcs
inputs = depset(srcs, transitive=[headers])
output_file = ctx.actions.declare_file(ctx.label.name + ".output")
args = ctx.actions.args()
args.add_joined("-h", headers, join_with=",")
args.add_joined("-s", srcs, join_with=",")
args.add("-o", output_file)
ctx.actions.run(
mnemonic = "ExampleCompile",
executable = ctx.executable._compiler,
arguments = [args],
inputs = inputs,
outputs = [output_file],
)
...
작업은 입력 파일의 목록 또는 depset를 취하여 출력 파일도 포함됩니다. 입력 및 출력 파일 세트는 분석 단계에 있습니다. 이 값은 속성을 포함하지만 확인할 수 있습니다. 예를 들어 작업에서 unzip 명령어를 실행하는 경우 unzip을 실행하기 전에 확장될 파일을 지정해야 합니다. 내부적으로 가변적인 수의 파일을 생성하는 작업은 이러한 파일을 단일 파일 (예: zip, tar 또는 기타 보관 파일 형식)
작업은 모든 입력을 나열해야 합니다. 사용되지 않는 입력을 나열하는 것은 허용되지만 비효율적입니다
작업은 모든 출력을 생성해야 합니다. 다른 파일을 작성할 수도 있지만 출력에 없는 항목은 소비자가 사용할 수 없습니다. 선언된 모든 출력은 어떤 작업에 의해 작성되어야 합니다.
작업은 순수 함수와 비슷합니다. 제공된 입력에만 종속되어야 하며 컴퓨터 정보, 사용자 이름, 시계, 네트워크 또는 I/O 기기에 액세스해서는 안 됩니다(입력 읽기 및 출력 쓰기 제외). 이는 출력이 캐시되고 재사용되므로 중요합니다.
종속 항목은 Bazel에서 확인하며 Bazel은 실행할 작업을 결정합니다. 종속 항목 그래프에 주기가 있으면 오류입니다. 작업을 만들었다고 해서 반드시 실행된다고 보장할 수는 없습니다. 이는 빌드에 작업의 출력이 필요한지에 따라 다릅니다.
제공업체
제공업체는 규칙이 자신에 종속된 다른 규칙에 노출하는 정보입니다. 이 데이터에는 출력 파일, 라이브러리, 도구의 명령줄에 전달할 매개변수 또는 타겟의 소비자가 알아야 하는 기타 항목이 포함될 수 있습니다.
규칙의 구현 함수는 인스턴스화된 타겟의 즉시 종속 항목에서만 제공자를 읽을 수 있으므로 규칙은 일반적으로 depset
에 누적하여 타겟의 소비자가 알아야 하는 모든 정보를 타겟의 종속 항목에서 전달해야 합니다.
대상의 제공업체는 구현 함수에서 반환하는 Provider
객체 목록으로 지정됩니다.
기존 구현 함수를 다음과 같이 기존 스타일로 작성할 수도 있습니다.
구현 함수는 struct
provider 객체입니다. 이 스타일은 권장되지 않으며 규칙을 이 스타일에서 이전해야 합니다.
기본 출력
타겟의 기본 출력은 명령줄에서 타겟 빌드가 요청될 때 기본적으로 요청되는 출력입니다. 예를 들어 java_library
타겟 //pkg:foo
의 기본 출력은 foo.jar
이므로 bazel build //pkg:foo
명령어로 빌드됩니다.
기본 출력은 다음의 files
매개변수로 지정됩니다.
DefaultInfo
:
def _example_library_impl(ctx):
...
return [
DefaultInfo(files = depset([output_file]), ...),
...
]
DefaultInfo
가 규칙 구현에서 반환되지 않거나 files
매개변수가 지정되지 않은 경우 DefaultInfo.files
의 기본값은 모든 사전 선언된 출력(일반적으로 출력 속성으로 생성된 출력)입니다.
작업을 실행하는 규칙은 이러한 출력이 직접 사용되지 않을 것으로 예상되더라도 기본 출력을 제공해야 합니다. 요청된 출력의 그래프에 없는 작업은 제거됩니다. 출력이 대상의 소비자만 사용하는 경우 이러한 작업은 타겟이 격리된 상태로 빌드될 때는 수행되지 않습니다. 이 디버깅이 더 어려워집니다. 왜냐하면 실패한 타겟만 다시 빌드하는 것은 문제를 재현할 수 있습니다
Runfiles
실행 파일은 런타임 시 타겟이 사용하는 파일 세트입니다 (빌드가 아님). 시간). 실행 단계에서 Bazel은 실행 파일을 가리키는 심볼릭 링크가 포함된 디렉터리 트리를 만듭니다. 이 단계에서는 런타임 중 실행 파일에 액세스할 수 있도록 하는 것입니다.
규칙을 만들 때 런파일을 수동으로 추가할 수 있습니다.
runfiles
객체는 규칙 컨텍스트 ctx.runfiles
의 runfiles
메서드로 만들고 DefaultInfo
의 runfiles
매개변수에 전달할 수 있습니다. 실행 가능한 출력은
실행 가능 규칙이 암시적으로 실행 파일에 추가됩니다.
일부 규칙은 일반적으로 data
라는 이름의 속성을 지정하며, 이 속성의 출력은 타겟의 런파일에 추가됩니다. 실행 파일은 data
에서도 병합되어야 합니다.
최종 실행을 위한 코드를 제공할 수 있는 모든 속성에서
srcs
(연결된 data
가 있는 filegroup
타겟을 포함할 수 있음) 및
deps
입니다.
def _example_library_impl(ctx):
...
runfiles = ctx.runfiles(files = ctx.files.data)
transitive_runfiles = []
for runfiles_attr in (
ctx.attr.srcs,
ctx.attr.hdrs,
ctx.attr.deps,
ctx.attr.data,
):
for target in runfiles_attr:
transitive_runfiles.append(target[DefaultInfo].default_runfiles)
runfiles = runfiles.merge_all(transitive_runfiles)
return [
DefaultInfo(..., runfiles = runfiles),
...
]
커스텀 제공업체
provider
를 사용하여 제공업체를 정의할 수 있습니다.
함수를 사용하여 규칙별 정보를 전달합니다.
ExampleInfo = provider(
"Info needed to compile/link Example code.",
fields={
"headers": "depset of header Files from transitive dependencies.",
"files_to_link": "depset of Files from compilation.",
})
그러면 규칙 구현 함수에서 제공자 인스턴스를 구성하고 반환할 수 있습니다.
def _example_library_impl(ctx):
...
return [
...
ExampleInfo(
headers = headers,
files_to_link = depset(
[output_file],
transitive = [
dep[ExampleInfo].files_to_link for dep in ctx.attr.deps
],
),
)
]
제공자 맞춤 초기화
맞춤 전처리 및 유효성 검사 로직으로 제공업체의 인스턴스화를 보호할 수 있습니다. 이 방법을 사용하면 모든 제공자 인스턴스는 특정 불변 항목을 따르거나 사용자에게 인스턴스 가져오기
init
콜백을 provider
함수에 전달하면 됩니다. 이 콜백이 제공되면
provider()
의 반환 유형이 두 값의 튜플이 되도록 변경됩니다. 제공자
init
가 사용되지 않는 경우 일반적인 반환 값이고 '원시'는
'생성자'로 설정합니다.
이 경우 제공업체 기호가 호출되면 새 인스턴스를 직접 반환하는 대신 인수를 init
콜백에 전달합니다. 콜백의 반환 값은 필드 이름(문자열)을 값에 매핑하는 사전이어야 합니다. 이는 새 인스턴스의 필드를 초기화하는 데 사용됩니다. 참고:
콜백에 서명이 있을 수 있고 인수가 서명과 일치하지 않는 경우
콜백이 직접 호출된 것처럼 오류가 보고됩니다.
반면에 원시 생성자는 init
콜백을 우회합니다.
다음 예에서는 init
를 사용하여 인수를 사전 처리하고 유효성을 검사합니다.
# //pkg:exampleinfo.bzl
_core_headers = [...] # private constant representing standard library files
# It's possible to define an init accepting positional arguments, but
# keyword-only arguments are preferred.
def _exampleinfo_init(*, files_to_link, headers = None, allow_empty_files_to_link = False):
if not files_to_link and not allow_empty_files_to_link:
fail("files_to_link may not be empty")
all_headers = depset(_core_headers, transitive = headers)
return {'files_to_link': files_to_link, 'headers': all_headers}
ExampleInfo, _new_exampleinfo = provider(
...
init = _exampleinfo_init)
export ExampleInfo
그러면 규칙 구현은 다음과 같이 제공자를 인스턴스화할 수 있습니다.
ExampleInfo(
files_to_link=my_files_to_link, # may not be empty
headers = my_headers, # will automatically include the core headers
)
원시 생성자를 사용하여 대체 공개 팩토리 함수를 정의할 수 있습니다.
init
로직을 거치지 않습니다. 예를 들어 exampleinfo.bzl에서 다음을 정의할 수 있습니다.
def make_barebones_exampleinfo(headers):
"""Returns an ExampleInfo with no files_to_link and only the specified headers."""
return _new_exampleinfo(files_to_link = depset(), headers = all_headers)
일반적으로 원시 생성자는 이름이 밑줄(위의 _new_exampleinfo
)로 시작하는 변수에 바인딩되므로 사용자 코드가 이를 로드하고 임의의 제공자 인스턴스를 생성할 수 없습니다.
init
의 또 다른 용도는 사용자가 제공자 기호를 전혀 호출하지 못하도록 하고 대신 팩토리 함수를 사용하도록 강제하는 것입니다.
def _exampleinfo_init_banned(*args, **kwargs):
fail("Do not call ExampleInfo(). Use make_exampleinfo() instead.")
ExampleInfo, _new_exampleinfo = provider(
...
init = _exampleinfo_init_banned)
def make_exampleinfo(...):
...
return _new_exampleinfo(...)
실행 가능 규칙 및 테스트 규칙
실행 가능한 규칙은 bazel run
명령어로 호출할 수 있는 대상을 정의합니다.
테스트 규칙은 실행 파일 규칙의 특별한 종류로, 타겟을 bazel test
명령어로 호출할 수도 있습니다. 실행 파일 및 테스트 규칙은 rule
호출에서 각 executable
또는 test
인수를 True
로 설정하여 만듭니다.
example_binary = rule(
implementation = _example_binary_impl,
executable = True,
...
)
example_test = rule(
implementation = _example_binary_impl,
test = True,
...
)
테스트 규칙의 이름은 _test
로 끝나야 합니다. (대상 이름도 자주 테스트함
이는 규칙에 따라 _test
로 끝나지만 이는 필수는 아닙니다.) 테스트가 아닌 규칙에는 이 접미사가 없어야 합니다.
두 종류의 규칙 모두 run
또는 test
명령어에 의해 호출되는 실행 파일 출력 파일(사전 선언 여부와 관계없음)을 생성해야 합니다. 이 실행 파일로 사용할 규칙의 출력을 Bazel에 알리려면 반환된 DefaultInfo
제공자의 executable
인수로 전달합니다. 해당 executable
가 규칙의 기본 출력에 추가되므로
executable
와 files
에 모두 전달할 필요는 없습니다. 또한 암시적으로
runfiles에 추가됩니다.
def _example_binary_impl(ctx):
executable = ctx.actions.declare_file(ctx.label.name)
...
return [
DefaultInfo(executable = executable, ...),
...
]
이 파일을 생성하는 작업은 파일에서 실행 가능 비트를 설정해야 합니다. 대상
ctx.actions.run
또는
이 완료해야 할 ctx.actions.run_shell
작업
기본 도구에 의해 처리됩니다.
ctx.actions.write
작업에서 is_executable=True
을 전달합니다.
실행 파일 규칙은 기존 동작으로서 사전 선언된 특수 ctx.outputs.executable
출력을 갖습니다. 이 파일은 DefaultInfo
를 사용하여 실행 파일을 지정하지 않은 경우 기본 실행 파일로 사용됩니다. 그 외의 경우에는 사용해서는 안 됩니다. 이 출력 메커니즘은
분석 시 실행 파일의 이름을 사용자 지정할 수 있습니다.
예시 보기 실행 가능한 규칙 및 테스트 규칙을 따릅니다.
실행 가능한 규칙 및 테스트 규칙에는 속성에 추가된 속성 외에도 암시적으로 정의된 모든 규칙을 사용합니다. 기본값은 암시적으로 추가된 속성은 변경할 수 없지만 이 문제를 해결할 수는 있습니다. Starlark 매크로에서 비공개 규칙을 래핑하여 기본값:
def example_test(size="small", **kwargs):
_example_test(size=size, **kwargs)
_example_test = rule(
...
)
실행 파일 위치
실행 파일 타겟이 bazel run
(또는 test
)로 실행되면
runfiles 디렉토리가 실행 파일에 인접해 있습니다. 경로는 다음과 같습니다.
# Given launcher_path and runfile_file:
runfiles_root = launcher_path.path + ".runfiles"
workspace_name = ctx.workspace_name
runfile_path = runfile_file.short_path
execution_root_relative_path = "%s/%s/%s" % (
runfiles_root, workspace_name, runfile_path)
실행 파일 디렉터리 아래의 File
경로는 다음에 해당합니다.
File.short_path
bazel
에서 직접 실행되는 바이너리는 runfiles
디렉터리의 루트에 인접합니다. 그러나 runfile 에서 호출된 바이너리는 동일한 가정을 할 수 없습니다. 이를 완화하려면 각 바이너리가 환경 또는 명령줄 인수/플래그를 사용하여 runfiles 루트를 매개변수로 허용하는 방법을 제공해야 합니다. 이렇게 하면 바이너리가 호출하는 바이너리에 올바른 표준 런파일 루트를 전달할 수 있습니다. 이 값이 설정되지 않으면 바이너리는 호출된 첫 번째 바이너리라고 추측하고 인접한 runfiles 디렉터리를 찾을 수 있습니다.
고급 주제
출력 파일 요청
단일 타겟에 여러 출력 파일이 있을 수 있습니다. bazel build
명령어가 실행되면 명령어에 제공된 타겟의 일부 출력이 요청된 것으로 간주됩니다. Bazel은 이렇게 요청된 파일과
영향을 미칩니다. 작업 그래프 측면에서 Bazel은 요청된 파일의 전이 종속 항목으로 도달할 수 있는 작업만 실행합니다.
기본 출력 외에도 모든 사전 선언된 출력을 명령줄에서 명시적으로 요청할 수 있습니다. 규칙은 사전 선언된
출력을 출력 속성을 통해 출력할 수 있습니다. 이 경우 사용자는 규칙을 인스턴스화할 때 출력 라벨을 명시적으로 선택합니다. 획득하려면
출력 속성의 경우 File
객체를 사용하는 경우 해당하는
ctx.outputs
의 속성입니다. 규칙에서
다음을 기반으로 사전 선언된 출력을 암시적으로 정의합니다.
대상 이름에도 적용되지만 이 기능은 더 이상 사용되지 않습니다.
기본 출력 외에도 함께 요청할 수 있는 출력 파일 모음인 출력 그룹이 있습니다. --output_groups
를 사용하여 요청할 수 있습니다. 대상
예를 들어 대상 //pkg:mytarget
이 debug_files
가 있는 규칙 유형인 경우
출력 그룹의 경우 이러한 파일은 bazel build //pkg:mytarget
--output_groups=debug_files
를 실행하여 빌드할 수 있습니다. 사전 선언되지 않은 출력에는 라벨이 없으므로
기본 출력 또는 출력에 표시하는 방식으로만 요청할 수 있음
그룹
출력 그룹은
OutputGroupInfo
공급자. 많은 내장 제공업체와 달리 OutputGroupInfo
는 임의의 이름을 가진 매개변수를 사용하여 해당 이름으로 출력 그룹을 정의할 수 있습니다.
def _example_library_impl(ctx):
...
debug_file = ctx.actions.declare_file(name + ".pdb")
...
return [
DefaultInfo(files = depset([output_file]), ...),
OutputGroupInfo(
debug_files = depset([debug_file]),
all_files = depset([output_file, debug_file]),
),
...
]
또한 대부분의 제공업체와 달리 OutputGroupInfo
는
aspect 및 해당 관점이 적용되는 규칙 대상은
동일한 출력 그룹을 정의하지 않는 경우에 한합니다 이 경우 결과 제공업체가 병합됩니다.
일반적으로 OutputGroupInfo
는 특정 정렬을 전달하는 데 사용하면 안 됩니다.
소비자의 활동에 이르기까지 다양한 파일 형식을 지원합니다. 대신 규칙별 제공자를 정의합니다.
구성
다른 아키텍처용 C++ 바이너리를 빌드하려고 한다고 가정해 보겠습니다. 이 빌드는 복잡하고 여러 단계가 수반될 수 있습니다. 컴파일러 및 코드 생성기와 같은 일부 중간 바이너리는 실행 플랫폼(호스트 또는 원격 실행자일 수 있음)에서 실행되어야 합니다. 최종 출력과 같은 일부 바이너리는 타겟 아키텍처를 포함합니다.
이러한 이유로 Bazel에는 '구성'이라는 개념이 있습니다. 사용할 수 있습니다. 이 최상위 대상 (명령줄에서 요청된 대상)은 "target" 실행 플랫폼에서 실행되어야 하는 도구는 'exec'에 빌드되고 구성할 수 있습니다 규칙은 구성에 따라 다른 작업을 생성할 수 있습니다(예: 컴파일러에 전달되는 CPU 아키텍처 변경). 경우에 따라 여러 구성에 동일한 라이브러리가 필요할 수 있습니다. 이러한 경우, 분석된 후 잠재적으로 구축될 수 있습니다. 여러 번 반복해야 할 수도 있습니다.
기본적으로 Bazel은 대상의 종속 항목을 타겟 자체를 전환하지 않아도 됩니다. 종속 항목이 타겟 빌드에 필요한 도구인 경우 상응하는 속성은 실행 구성으로의 전환을 지정해야 합니다. 이렇게 하면 도구와 모든 종속 항목을 생성합니다.
각 종속 항목 속성에 cfg
를 사용하여 종속 항목
exec 구성으로 전환해야 합니다.
종속 항목 속성에 executable=True
플래그가 있으면 cfg
를 설정해야 합니다.
명시적으로 초기화합니다. 이는 실수로 잘못된 구성의 도구를 빌드하는 것을 방지하기 위한 것입니다.
예시 보기
일반적으로 런타임에 필요한 소스, 종속 라이브러리, 실행 파일은 동일한 구성을 사용할 수 있습니다.
빌드의 일부로 실행되는 도구(예: 컴파일러 또는 코드 생성기)는 실행 구성용으로 빌드해야 합니다. 이 경우 속성에 cfg="exec"
를 지정합니다.
그렇지 않은 경우 런타임에 사용되는 실행 파일 (예: 테스트의 일부로)은
빌드될 수 있습니다 이 경우 cfg="target"
를
속성
cfg="target"
는 실제로 아무것도 하지 않습니다. 규칙 설계자가 의도를 명시적으로 표현하는 데 도움이 되는 편의 값일 뿐입니다. executable=False
인 경우,
즉, cfg
는 선택사항이므로 가독성에 실제로 도움이 되는 경우에만 설정합니다.
cfg=my_transition
를 사용하여
사용자 정의 전환을 통해
규칙 작성자는 보다 유연하게 구성을 변경할 수 있으며,
단점은
빌드 그래프를 더 크고 이해하기 쉽게 만듭니다.
참고: 이전에는 Bazel에 실행 플랫폼이라는 개념이 없었으며 대신 모든 빌드 작업이 호스트 머신에서 실행되는 것으로 간주되었습니다. 바젤 6.0 이전 버전에서는 별개의 '호스트'를 나타냅니다. 'host'라는 참조가 표시되는 경우 이것이 바로 이것입니다 나타냅니다. 이러한 추가 개념적 오버헤드를 방지하려면 Bazel 6.0 이상을 사용하는 것이 좋습니다.
구성 프래그먼트
규칙은 cpp
, java
, jvm
와 같은 구성 프래그먼트에 액세스할 수 있습니다. 그러나 액세스 오류를 방지하려면 모든 필수 프래그먼트를 선언해야 합니다.
def _impl(ctx):
# Using ctx.fragments.cpp leads to an error since it was not declared.
x = ctx.fragments.java
...
my_rule = rule(
implementation = _impl,
fragments = ["java"], # Required fragments of the target configuration
host_fragments = ["java"], # Required fragments of the host configuration
...
)
실행 파일 심볼릭 링크
일반적으로 실행 파일 트리에 있는 파일의 상대 경로는
소스 트리나 생성된 출력 트리에 있는 해당 파일의 상대 경로입니다. 어떤 이유로든 이 두 값이 달라야 하는 경우 root_symlinks
또는 symlinks
인수를 지정할 수 있습니다. root_symlinks
는
파일을 찾을 수 있습니다. 여기서 경로는 실행 파일 디렉터리의 루트를 기준으로 합니다. symlinks
사전은 동일하지만 경로 앞에 기본 작업공간의 이름(현재 타겟이 포함된 저장소의 이름 아님)이 암시적으로 접두사로 추가됩니다.
...
runfiles = ctx.runfiles(
root_symlinks = {"some/path/here.foo": ctx.file.some_data_file2}
symlinks = {"some/path/here.bar": ctx.file.some_data_file3}
)
# Creates something like:
# sometarget.runfiles/
# some/
# path/
# here.foo -> some_data_file2
# <workspace_name>/
# some/
# path/
# here.bar -> some_data_file3
symlinks
또는 root_symlinks
를 사용하는 경우 서로 다른 두 개를 매핑하지 않도록 주의하세요.
실행 파일 트리에서 동일한 경로로 이동하는 것입니다. 그러면 충돌을 설명하는 오류와 함께 빌드가 실패합니다. 이를 수정하려면 충돌을 삭제하도록 ctx.runfiles
인수를 수정해야 합니다. 이 검사는 규칙을 사용하는 모든 대상과 이러한 대상에 종속되는 모든 유형의 대상에 대해 실행됩니다. 이는 도구가 전이적으로 사용될 가능성이 있는 경우 특히 위험합니다.
다른 도구에 의해 영향을 받습니다. 심볼릭 링크 이름은 도구의 실행 파일 전체에서 고유해야 하며
모든 종속 항목이 포함됩니다
코드 적용 범위
coverage
명령어를 실행할 때 빌드에서 특정 타겟의 적용 범위 계측을 추가해야 할 수 있습니다. 이
빌드는 계측된 소스 파일 목록도 수집합니다. 고려되는 타겟의 하위 집합은 --instrumentation_filter
플래그로 제어됩니다.
--instrument_test_targets
가 지정되지 않으면 테스트 타겟은 제외됩니다.
규칙 구현이 빌드 시간에 적용 범위 계측을 추가하는 경우 구현 함수에서 이를 고려해야 합니다. 타겟 소스에 계측이 적용되어야 하는 경우 ctx.coverage_instrumented는 적용 범위 모드에서 true를 반환합니다.
# Are this rule's sources instrumented?
if ctx.coverage_instrumented():
# Do something to turn on coverage for this compile action
적용 범위 모드에서 항상 사용 설정되어야 하는 로직(타겟 소스가 계측되었는지 여부와 관계없음)은 ctx.configuration.coverage_enabled에 조건을 설정할 수 있습니다.
컴파일 전에 규칙이 종속 항목의 소스(예: 헤더 파일)를 직접 포함하는 경우 종속 항목의 소스를 계측해야 하는 경우 컴파일 시간 계측을 사용 설정해야 할 수도 있습니다.
# Are this rule's sources or any of the sources for its direct dependencies
# in deps instrumented?
if (ctx.configuration.coverage_enabled and
(ctx.coverage_instrumented() or
any([ctx.coverage_instrumented(dep) for dep in ctx.attr.deps]))):
# Do something to turn on coverage for this compile action
또한 규칙은 coverage_common.instrumented_files_info
를 사용하여 구성된 InstrumentedFilesInfo
제공업체의 노출 범위와 관련된 속성에 관한 정보를 제공해야 합니다.
instrumented_files_info
의 dependency_attributes
매개변수는
deps
등의 코드 종속 항목을 포함한 모든 런타임 종속 항목 속성
데이터 종속 항목(예: data
) source_attributes
매개변수는
규칙의 소스 파일 속성을 업데이트합니다.
def _example_library_impl(ctx):
...
return [
...
coverage_common.instrumented_files_info(
ctx,
dependency_attributes = ["deps", "data"],
# Omitted if coverage is not supported for this rule:
source_attributes = ["srcs", "hdrs"],
)
...
]
InstrumentedFilesInfo
가 반환되지 않으면 dependency_attributes
에서 속성 스키마에서 cfg
를 "host"
또는 "exec"
로 설정하지 않는 각 도구가 아닌 종속 항목 속성으로 기본 항목이 생성됩니다. (이는 이상적인 동작이 아니며,
source_attributes
대신 dependency_attributes
의 srcs
와 같지만
모든 규칙에 대해 명시적인 적용 범위 구성을
종속 항목 체인)
검증 작업
빌드에 관해 유효성을 검사해야 하는 경우가 있는데, 유효성 검사에 필요한 정보는 아티팩트(소스 파일 또는 생성된 파일)에서만 사용할 수 있습니다. 이 정보는 아티팩트에 있으므로 규칙을 읽을 수 없기 때문에 분석 시 규칙이 검증을 수행할 수 없습니다. 할 수 있습니다. 대신 작업은 실행 시 이 유효성 검사를 실행해야 합니다. 날짜 유효성 검사가 실패하면 작업이 실패하므로 빌드도 실패합니다.
실행할 수 있는 검증의 예로는 정적 분석, 린트 작업, 스타일 검사, 종속 항목 검사, 일관성 검사 등을 사용할 수 있습니다
검증 작업은 움직이는 부분을 통해 빌드 성능을 개선하는 데도 도움이 될 수 있습니다. 몇 가지 작업을 수행할 수 있습니다. 예를 들어 컴파일과 린팅을 실행하는 단일 작업을 컴파일 작업과 린팅 작업으로 구분할 수 있다면 린팅 작업을 유효성 검사 작업으로 실행하고 다른 작업과 동시에 실행할 수 있습니다.
이러한 '유효성 검사 작업'은 입력에 관한 사항만 어설션하면 되므로 빌드의 다른 곳에서 사용되는 항목을 생성하지 않는 경우가 많습니다. 하지만 문제가 있습니다. 검증 작업이 빌드의 다른 위치에서 사용되는 항목을 생성하지 않으면 규칙은 어떻게 작업을 실행하도록 할 수 있을까요? 이전에는 유효성 검사 작업이 빈 파일을 출력하고 빌드의 다른 중요한 작업의 입력에 이 출력을 인위적으로 추가하는 방식을 사용했습니다.
Bazel은 컴파일 작업이 실행될 때 항상 유효성 검사 작업을 실행하므로 이 방법은 작동하지만 다음과 같은 심각한 단점이 있습니다.
유효성 검사 작업은 빌드의 주요 경로에서 이루어집니다. Bazel은 컴파일 작업을 실행하는 데 빈 출력이 필요하다고 생각하기 때문에 컴파일 작업이 입력을 무시하더라도 먼저 유효성 검사 작업을 실행합니다. 이렇게 하면 동시 로드가 줄어들고 빌드 속도가 느려집니다.
빌드의 다른 작업이 유효성 검사 작업의 빈 출력을 해당 작업도 실행합니다 (예:
java_library
의 소스 jar 출력). 컴파일 작업 대신 실행될 수 있는 새 작업이 나중에 추가되고 빈 유효성 검사 출력이 실수로 누락된 경우에도 문제가 됩니다.
이러한 문제를 해결하려면 유효성 검사 출력 그룹을 사용하는 것이 좋습니다.
유효성 검사 출력 그룹
유효성 검사 출력 그룹은 유효성 검사 작업의 사용되지 않는 출력을 보관하도록 설계된 출력 그룹이므로 다른 작업의 입력에 인위적으로 추가할 필요가 없습니다.
이 그룹은
--output_groups
플래그의 값(타겟 값과 무관)
종속된 모든 컨테이너 (예: 명령줄, 종속 항목으로 또는
대상의 암시적 출력) 일반 캐싱 및 성과 증분은
계속 적용됩니다. 유효성 검사 작업에 대한 입력이 변경되지 않았고
이전에 성공한 유효성 검사 작업의 경우 유효성 검사 작업을 실행할 수 없습니다.
실행할 수 있습니다
이 출력 그룹을 사용하려면 유효성 검사 작업에서 비어 있는 파일도 출력해야 합니다. 이를 위해서는 일반적으로 빌드되지 않는 일부 도구를 래핑해야 할 수 있습니다. 출력을 생성할 수 있습니다.
대상의 유효성 검사 작업은 다음 세 가지 경우에 실행되지 않습니다.
- 대상이 도구로 사용되는 경우
- 타겟이 암시적 종속 항목으로 의존하는 경우 (예: '_')로 시작하는 속성
- 타겟이 호스트 또는 exec 구성에서 빌드되는 경우
이러한 타겟에는 유효성 검사 실패를 발견할 수 있는 자체 빌드와 테스트가 있다고 가정합니다.
검증 출력 그룹 사용
유효성 검사 출력 그룹의 이름은 _validation
이며 다른 출력 그룹과 마찬가지로 사용됩니다.
def _rule_with_validation_impl(ctx):
ctx.actions.write(ctx.outputs.main, "main output\n")
ctx.actions.write(ctx.outputs.implicit, "implicit output\n")
validation_output = ctx.actions.declare_file(ctx.attr.name + ".validation")
ctx.actions.run(
outputs = [validation_output],
executable = ctx.executable._validation_tool,
arguments = [validation_output.path])
return [
DefaultInfo(files = depset([ctx.outputs.main])),
OutputGroupInfo(_validation = depset([validation_output])),
]
rule_with_validation = rule(
implementation = _rule_with_validation_impl,
outputs = {
"main": "%{name}.main",
"implicit": "%{name}.implicit",
},
attrs = {
"_validation_tool": attr.label(
default = Label("//validation_actions:validation_tool"),
executable = True,
cfg = "exec"),
}
)
유효성 검사 출력 파일이 DefaultInfo
또는 다른 작업의 입력에 추가되지 않습니다. 이 규칙 종류의 대상에 대한 유효성 검사 작업
대상이 라벨이나 대상의
직간접적으로 의존합니다
일반적으로 유효성 검사 작업의 출력이 다른 작업의 입력에는 추가되지 않으므로 이는 동시 로드 게인을 무효화할 수 있습니다 하지만 Bazel은 현재 이를 시행하기 위한 특별한 확인이 있어야 합니다 따라서 애플리케이션의 유효성 검사 작업 출력이 살펴보겠습니다 예를 들면 다음과 같습니다.
load("@bazel_skylib//lib:unittest.bzl", "analysistest")
def _validation_outputs_test_impl(ctx):
env = analysistest.begin(ctx)
actions = analysistest.target_actions(env)
target = analysistest.target_under_test(env)
validation_outputs = target.output_groups._validation.to_list()
for action in actions:
for validation_output in validation_outputs:
if validation_output in action.inputs.to_list():
analysistest.fail(env,
"%s is a validation action output, but is an input to action %s" % (
validation_output, action))
return analysistest.end(env)
validation_outputs_test = analysistest.make(_validation_outputs_test_impl)
유효성 검사 작업 플래그
검증 작업 실행은 --run_validations
명령줄로 제어됩니다.
true로 기본 설정되어 있습니다.
지원이 중단된 기능
지원 중단된 사전 선언된 출력
사전 선언된 출력을 사용하는 방법에는 두 가지 지원 중단된 방법이 있습니다.
rule
의outputs
매개변수는 출력을 생성하기 위한 출력 속성 이름과 문자열 템플릿 간의 매핑은 출력 라벨을 지정합니다 사전 선언되지 않은 출력 사용을 선호함 출력을DefaultInfo.files
에 명시적으로 추가합니다. 사전 선언된 출력 라벨 대신 규칙 타겟의 라벨을 출력을 사용하는 규칙의 입력으로 사용합니다.실행 파일 규칙의 경우
ctx.outputs.executable
는 규칙 타겟과 동일한 이름의 사전 선언된 실행 파일 출력을 참조합니다.ctx.actions.declare_file(ctx.label.name)
와 같이 출력을 명시적으로 선언하는 것이 좋으며 실행 파일을 생성하는 명령어는 실행을 허용하도록 권한을 설정해야 합니다. 명시적 실행 가능한 출력을DefaultInfo
의executable
매개변수에 전달합니다.
피해야 할 Runfiles 기능
ctx.runfiles
및 runfiles
유형에는 복잡한 특성 세트가 있으며 그 중 다수는 레거시 이유로 유지됩니다.
다음 권장사항은 복잡성을 줄이는 데 도움이 됩니다.
다음의
collect_data
모드와collect_default
모드를 사용하지 마세요.ctx.runfiles
입니다. 이러한 모드는 혼란스러운 방식으로 특정 하드코딩된 종속 항목 가장자리에서 런파일을 암시적으로 수집합니다. 대신 다음과 같은files
또는transitive_files
매개변수를 사용하여 파일을 추가합니다.ctx.runfiles
또는 종속 항목의 실행 파일에서runfiles = runfiles.merge(dep[DefaultInfo].default_runfiles)
입니다.다음 표현식의
data_runfiles
및default_runfiles
사용을 피합니다.DefaultInfo
생성자 대신DefaultInfo(runfiles = ...)
를 지정합니다. '기본'의 차이점 'data' 실행 파일이 유지관리되는 동안 도움이 될 수 있습니다 예를 들어 일부 규칙은 기본 출력을data_runfiles
(default_runfiles
제외) kubectl 명령어data_runfiles
, 규칙은 기본 출력을 모두 포함하고 실행 파일을 제공하는 속성의default_runfiles
(종종data
)을 입력합니다.DefaultInfo
에서runfiles
를 가져올 때 (일반적으로 병합에만 해당) 실행 파일이 필요한 경우DefaultInfo.data_runfiles
가 아닌DefaultInfo.default_runfiles
입니다.
기존 제공업체에서 이전
지금까지 Bazel 제공자는 Target
객체의 단순 필드였습니다. 그들은
점 연산자를 사용하여 액세스할 수 있으며
(규칙의 구현 함수에서 반환한 구조체에 포함)
이 스타일은 지원 중단되었으며 새 코드에서 사용하면 안 됩니다. 자세한 내용은 아래를 참고하세요. 마이그레이션에 도움이 될 만한 정보를 살펴보세요. 새 제공자 메커니즘은 이름 충돌을 방지합니다. 또한 제공자 인스턴스에 액세스하는 모든 코드가 제공자 기호를 사용하여 이를 검색하도록 요구하여 데이터 숨김을 지원합니다.
당분간 기존 제공업체는 계속 지원됩니다. 규칙은 다음과 같이 기존 및 최신 제공업체를 모두 반환할 수 있습니다.
def _old_rule_impl(ctx):
...
legacy_data = struct(x="foo", ...)
modern_data = MyInfo(y="bar", ...)
# When any legacy providers are returned, the top-level returned value is a
# struct.
return struct(
# One key = value entry for each legacy provider.
legacy_info = legacy_data,
...
# Additional modern providers:
providers = [modern_data, ...])
dep
가 이 규칙의 인스턴스에 관한 결과 Target
객체인 경우
제공자와 그 콘텐츠는 dep.legacy_info.x
로 가져올 수 있고
dep[MyInfo].y
입니다.
반환된 구조체는 providers
외에도 여러 다른
특별한 의미가 있으므로 해당하는 레거시를 생성하지 않는 필드
제공업체).
files
,runfiles
,data_runfiles
,default_runfiles
,executable
필드는DefaultInfo
의 동일한 이름의 필드에 해당합니다.DefaultInfo
제공자를 반환하는 동시에 이러한 필드를 지정하는 것은 허용되지 않습니다.output_groups
필드는 구조체 값을 가지며OutputGroupInfo
provides
규칙 선언에서
providers
종속 항목 선언
속성, 기존 제공자는 문자열로 전달되고 최신 제공자는
*Info
기호로 전달됩니다. 이전할 때 문자열에서 기호로 변경해야 합니다. 모든 규칙을 일괄적으로 업데이트하기 어려운 복잡하거나 대규모 규칙 세트의 경우 다음 단계를 따르는 것이 더 쉬울 수 있습니다.
위의 문법을 사용하여 기존 제공자를 생성하는 규칙을 수정하여 기존 제공자와 최신 제공자를 모두 생성합니다. 기존 제공업체를 반환한다고 선언하는 규칙의 경우 기존 제공업체와 최신 제공업체를 모두 포함하도록 선언을 업데이트합니다.
기존 제공업체를 사용하는 규칙을 수정하여 대신 최신 제공업체를 사용합니다. 속성 선언에 기존 제공업체가 필요한 경우 대신 최신 제공업체가 필요하도록 업데이트합니다. 원하는 경우 소비자가 제공업체 중 하나를 수락/요구하도록 하여 이 작업을 1단계와 교차할 수 있습니다.
hasattr(target, 'foo')
를 사용하여 기존 제공업체의 존재를 테스트하거나FooInfo in target
를 사용하여 새 제공업체를 테스트합니다.모든 규칙에서 기존 제공업체를 완전히 삭제합니다.