Reglas de búfer de protocolo

Denuncia un problema Ver fuente Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Reglas

proto_lang_toolchain
proto_library

proto_lang_toolchain

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

Si usas Bazel, carga la regla desde https://github.com/bazelbuild/rules_proto.

Especifica cómo una regla LANG_proto_library (p.ej., java_proto_library) deben invocar el proto-compiler. Algunas reglas de LANG_proto_library permiten especificar qué cadena de herramientas usar con marcas de línea de comandos. Consulta su documentación.

Por lo general, no debes escribir ese tipo de reglas, a menos que desees ajustar tu compilador de Java.

No hay compilador. El protocompilador se toma de la regla proto_library a la que nos adjuntamos. Se pasa como una marca de línea de comandos a Blaze. Varias funciones requieren que se invoque un proto-compiler en la misma regla proto_library. Es beneficioso aplicar el compilador que usa LANG_proto_library es el mismo que el que usa proto_library.

Ejemplos

Un ejemplo simple sería el siguiente:

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

Argumentos

Atributos
`name`	Nombre: Obligatorio Un nombre único para este objetivo.
`blacklisted_protos`	Lista de etiquetas; el valor predeterminado es `[]` No se generará ningún código para los archivos del atributo `srcs` de `blacklisted_protos` Se usa para archivos .proto que ya están vinculados en entornos de ejecución proto, como `any.proto`
`command_line`	String; obligatorio. Este valor se pasará a proto-compiler para generar el código. Incluye solo las partes específicas de este generador de código o complemento (p. ej., no incluyas parámetros -I). `$(OUT)` es específico de LANG_proto_library. Se espera que las reglas definan cómo interpretan esta variable. En Java, por ejemplo, $(OUT) se reemplazará por el nombre del archivo src-jar que se creará.
`mnemonic`	Cadena; el valor predeterminado es `"GenProto"` Este valor se establecerá como mnemotécnico en la acción de protocolo.
`output_files`	Cadena; el valor predeterminado es `"legacy"` Controla el formato de `$(OUT)` en `command_line`, ya sea mediante una ruta a un solo archivo o directorio de salida en caso de varios archivos. Los valores posibles son “single”, “multiple”.
`plugin`	Etiqueta; el valor predeterminado es `None` Si se proporciona, estará disponible para la acción que llama al protocompilador y se le pasará al protocompilador: `--plugin=protoc-gen-PLUGIN=<executable>.`
`plugin_format_flag`	Cadena; el valor predeterminado es `""` Si se proporciona, este valor se pasará a proto-compiler para usar el complemento. El valor debe contener un solo %s que se reemplaza por el ejecutable del complemento. `--plugin=protoc-gen-PLUGIN=<executable>.`
`progress_message`	Cadena; el valor predeterminado es `"Generating proto_library %{label}"` Este valor se establecerá como el mensaje de progreso en la acción de protocolo.
`proto_compiler`	Etiqueta; el valor predeterminado es `None` El ejecutable del compilador de proto. Si se proporciona, este destino se usará como protocompilador para generar el código.
`runtime`	Etiqueta (Label); el valor predeterminado es `None` Es una biblioteca específica del lenguaje con la que se compila el código generado. El comportamiento exacto es específico de LANG_proto_library. Java, por ejemplo, debe compilar en el entorno de ejecución.

proto_library

Ver la fuente de la regla

proto_library(name, deps, srcs, data, allow_exports, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, exports, features, import_prefix, licenses, restricted_to, strip_import_prefix, tags, target_compatible_with, testonly, visibility)

Obsoleta. Utiliza https://github.com/bazelbuild/rules_proto.

Usa proto_library para definir bibliotecas de búferes de protocolo que se pueden usar desde varios lenguajes. Se puede incluir un proto_library en la cláusula deps de las reglas admitidas, como java_proto_library.

Cuando se compila en la línea de comandos, un proto_library crea un archivo llamado foo-descriptor-set.proto.bin, que es el conjunto de descriptores de la envía la regla srcs. El archivo es un FileDescriptorSet serializado, que se describe en https://developers.google.com/protocol-buffers/docs/techniques#self-description.

Solo contiene información sobre los archivos .proto que menciona directamente una regla proto_library. La colección de conjuntos de descriptores transitivos está disponible a través del proveedor de Starlark [ProtoInfo].transitive_descriptor_sets. Consulta la documentación en ProtoInfo.java.

Organización de código recomendada:

Una regla proto_library por archivo .proto.
Un archivo llamado foo.proto estará en una regla llamada foo_proto, que se encuentra en el mismo paquete.
Un [language]_proto_library que une un proto_library llamado Se debe llamar a foo_proto foo_[language]_proto y deben ubicarse en el mismo paquete.

Argumentos

Atributos
`name`	Nombre: obligatorio. Un nombre único para este destino.
`deps`	Es una lista de etiquetas. El valor predeterminado es `[]`. Es la lista de otras reglas `proto_library` de las que depende el destino. Un `proto_library` solo puede depender de otros `proto_library` objetivos. Es posible que no dependa de las bibliotecas específicas de un lenguaje.
`srcs`	Lista de etiquetas; el valor predeterminado es `[]` Es la lista de archivos `.proto` y `.protodevel` que se procesan para crear el destino. Por lo general, es una lista no vacía. Un caso de uso donde `srcs` puede estar vacío es una biblioteca de alias. Esta es una proto_library que tiene una o más proto_library en `deps`. Este patrón se puede usar, p.ej., exportar una API pública con un nombre persistente.
`allow_exports`	Etiqueta (Label); el valor predeterminado es `None` Una lista de entidades permitidas opcional que evita que la biblioteca de protos se vuelva a exportar o se use en una biblioteca de protos de lenguaje que no está en uno de los paquetes enumerados.
`exports`	Es una lista de etiquetas. El valor predeterminado es `[]`. Es la lista de destinos de proto_library a los que se puede hacer referencia a través de "import public" en la fuente de proto.
`import_prefix`	Cadena; el valor predeterminado es `""` Es el prefijo que se agregará a las rutas de acceso de los archivos .proto en esta regla. Cuando se establece, se puede acceder a los archivos fuente .proto en el atributo `srcs` de esta regla en el valor de este atributo que se antepone a su ruta de acceso relativa al repositorio. El prefijo del atributo `strip_import_prefix` se quita antes de agregar este prefijo.
`strip_import_prefix`	Cadena; el valor predeterminado es `""` Es el prefijo que se quitará de las rutas de acceso de los archivos .proto en esta regla. Cuando se establece, se puede acceder a los archivos fuente .proto en el atributo `srcs` de esta regla en su ruta de acceso con este prefijo cortado. Si es una ruta de acceso relativa (no comienza con una barra diagonal), se considera una ruta de acceso relativa al paquete. Si es una absoluta, se entiende como una ruta de acceso relativa de repositorio. El prefijo del atributo `import_prefix` se agrega después de que este prefijo despojado.