프로토콜 버퍼 규칙

문제 신고 소스 보기 Nightly · 7.4 .

규칙

py_proto_library
proto_lang_toolchain
proto_toolchain

py_proto_library

py_proto_library(name, deps, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

`py_proto_library` 를 사용하여 `.proto` 파일에서 Python 라이브러리를 생성합니다. `proto_library` 규칙 `foo_proto`를 래핑할 때는 `py_proto_library` 규칙의 이름을 `foo_py_pb2`로 지정하는 것이 관례입니다. `deps` 는 `proto_library` 규칙을 가리켜야 합니다. 예: ```starlark py_library( name = "lib", deps = [":foo_py_pb2"], ) py_proto_library( name = "foo_py_pb2", deps = [":foo_proto"], ) proto_library( name = "foo_proto", srcs = ["foo.proto"], ) ```

인수

속성

name

이름: 필수사항

이 대상의 고유한 이름입니다.

deps

라벨 목록. 기본값은 []입니다.

Python 라이브러리를 생성할 `proto_library` 규칙 목록입니다. 일반적으로 관심 있는 프로토 라이브러리라는 단일 타겟만 있습니다. `ProtoInfo`를 제공하는 모든 타겟이 될 수 있습니다.

proto_lang_toolchain

규칙 소스 보기

proto_lang_toolchain(name, allowlist_different_package, blacklisted_protos, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, plugin, plugin_format_flag, progress_message, protoc_minimal_do_not_use, restricted_to, runtime, tags, target_compatible_with, testonly, toolchain_type, toolchains, visibility)

Bazel을 사용하는 경우 https://github.com/bazelbuild/rules_proto에서 규칙을 로드하세요.

LANG_proto_library 규칙 (예: java_proto_library)는 프로토 컴파일러를 호출해야 합니다. 일부 LANG_proto_library 규칙에서는 명령줄 플래그를 사용하여 사용할 도구 모음을 지정할 수 있습니다. 문서를 참고하세요.

일반적으로 Java 컴파일러를 조정하려는 경우가 아니면 이러한 종류의 규칙을 작성하면 안 됩니다.

컴파일러가 없습니다. proto 컴파일러는 연결된 proto_library 규칙에서 가져옵니다. Blaze에 명령줄 플래그로 전달됩니다. 몇몇 기능에는 proto_library 규칙 자체에서 proto-compiler를 호출해야 합니다. Lang_proto_library에서 사용하는 컴파일러를 proto_library와 동일한 컴파일러를 적용하는 것이 좋습니다.

예

간단한 예는 다음과 같습니다.


proto_lang_toolchain(
    name = "javalite_toolchain",
    command_line = "--javalite_out=shared,immutable:$(OUT)",
    plugin = ":javalite_plugin",
    runtime = ":protobuf_lite",
)

인수

속성
`name`	이름: 필수사항 이 타겟의 고유한 이름입니다.
`allowlist_different_package`	라벨. 기본값은 `None`입니다.
`blacklisted_protos`	라벨 목록입니다. 기본값은 `[]`입니다. `blacklisted_protos`의 `srcs` 속성에 있는 파일에는 코드가 생성되지 않습니다. `any.proto`와 같이 proto 런타임에 이미 연결된 .proto 파일에 사용됩니다.
`command_line`	문자열, 필수 이 값은 코드를 생성하기 위해 프로토 컴파일러에 전달됩니다. 이 코드 생성기/플러그인에만 해당하는 부분만 포함합니다 (예: -I 매개변수는 포함하지 않음). `$(OUT)`는 LANG_proto_library에 따라 다릅니다. 규칙은 이 변수를 해석하는 방법을 정의해야 합니다. 예를 들어 Java의 경우 $(OUT)가 생성할 src-jar 파일 이름으로 대체됩니다.
`mnemonic`	문자열, 기본값은 `"GenProto"`입니다. 이 값은 protoc 작업의 니모닉으로 설정됩니다.
`output_files`	문자열. 기본값은 `"legacy"`입니다. 단일 파일의 경로 또는 여러 파일의 경우 출력 디렉터리를 사용하여 `command_line`의 `$(OUT)` 형식을 지정하는 방법을 제어합니다. 가능한 값은 'single', 'multiple'입니다.
`plugin`	라벨. 기본값은 `None`입니다. 제공되는 경우 proto-compiler를 호출하는 작업에서 사용할 수 있으며 proto-compiler로 전달됩니다.`--plugin=protoc-gen-PLUGIN=<executable>.`
`plugin_format_flag`	문자열, 기본값은 `""`입니다. 이 값을 제공하면 플러그인을 사용하기 위해 proto-compiler에 전달됩니다. 값에는 플러그인 실행 파일로 대체되는 단일 %s가 포함되어야 합니다. `--plugin=protoc-gen-PLUGIN=<executable>.`
`progress_message`	문자열, 기본값은 `"Generating proto_library %{label}"`입니다. 이 값은 protoc 작업에 대한 진행 메시지로 설정됩니다.
`protoc_minimal_do_not_use`	라벨: 기본값은 `None`입니다.
`runtime`	라벨: 기본값은 `None`입니다. 생성된 코드가 컴파일되는 언어별 라이브러리입니다. 정확한 동작은 LANG_proto_library에 따라 다릅니다. 예를 들어 Java는 런타임에 맞게 컴파일해야 합니다.
`toolchain_type`	라벨: 기본값은 `None`입니다.

proto_toolchain

규칙 소스 보기

proto_toolchain(name, command_line, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, mnemonic, output_files, progress_message, proto_compiler, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)

인수

속성
`name`	이름: 필수사항 이 대상의 고유한 이름입니다.
`command_line`	문자열. 기본값은 `"--descriptor_set_out=%s"`입니다.
`mnemonic`	문자열, 기본값은 `"GenProtoDescriptorSet"`입니다.
`output_files`	문자열, 기본값은 `"single"`입니다.
`progress_message`	문자열, 기본값은 `"Generating Descriptor Set proto_library %{label}"`입니다.
`proto_compiler`	라벨: 기본값은 `None`입니다.