Referencia de la consulta de Bazel

Informar un problema Ver fuente

Esta página es el manual de referencia del lenguaje de consulta de Bazel que se usa cuando utilizas bazel query para analizar dependencias de compilación. También se describen los formatos de salida compatibles con bazel query.

Para casos de uso prácticos, consulta el instructivo de consulta de Bazel.

Referencia de consulta adicional

Además de query, que se ejecuta en el gráfico de destino de la fase posterior a la carga, Bazel incluye la consulta del gráfico de acciones y la consulta configurable.

Consulta del gráfico de acción

La consulta del gráfico de acciones (aquery) opera en el gráfico de destino configurado posterior al análisis y expone información sobre acciones, artefactos y sus relaciones. aquery es útil cuando te interesan las propiedades de las acciones o artefactos generados a partir del gráfico de destino configurado. Por ejemplo, los comandos reales se ejecutan y sus entradas, salidas y mnemónicos.

Para obtener más detalles, consulta la referencia de aquery.

Consulta configurable

La consulta tradicional de Bazel se ejecuta en el gráfico de destino de la fase posterior a la carga y, por lo tanto, no tiene un concepto de la configuración ni sus conceptos relacionados. Cabe destacar que no resuelve correctamente las instrucciones de selección y, en su lugar, muestra todas las resoluciones posibles de las selecciones. Sin embargo, el entorno de consulta configurable, cquery, controla de forma correcta la configuración, pero no proporciona todas las funciones de esta consulta original.

Para obtener más detalles, consulta la referencia de cquery.

Ejemplos

¿Cómo usan las personas bazel query? Estos son algunos ejemplos típicos:

¿Por qué el árbol //foo depende de //bar/baz? Muestra una ruta:

somepath(foo/..., //bar/baz:all)

¿De qué bibliotecas C++ dependen todas las pruebas de foo que no dependen del destino foo_bin?

kind("cc_library", deps(kind(".*test rule", foo/...)) except deps(//foo:foo_bin))

Tokens: La sintaxis léxica

Las expresiones en el lenguaje de consulta están compuestas por los siguientes tokens:

  • Palabras clave, como let. Las palabras clave son los términos reservados del idioma, y cada una de ellas se describe a continuación. El conjunto completo de palabras clave es:

  • Palabras, como “foo/...”, “.*test rule” o “//bar/baz:all”. Si una secuencia de caracteres está “entrecomillada” (comienza y termina con una comilla simple “ o comienza y termina con una comilla doble”), se trata de una palabra. Si una secuencia de caracteres no está entre comillas, aún se puede analizar como una palabra. Las palabras sin comillas son secuencias de caracteres extraídas de los caracteres del alfabeto de la A a la Z, los números del 0 al 9 y los caracteres especiales */@.-_:$~[] (asterisco, barra diagonal, en, punto, guion, guion bajo, dos puntos, signo de dólar, virgulilla, llave de la izquierda, llave cuadrada derecha). Sin embargo, las palabras sin comillas no pueden comenzar con un guion - ni un asterisco *, aunque los nombres de destino relativos puedan comenzar con esos caracteres.

    Las palabras sin comillas tampoco pueden incluir los caracteres más + ni el signo igual =, aunque esos caracteres están permitidos en los nombres de destino. Cuando se escribe el código que genera expresiones de consulta, los nombres de los destinos deben estar entre comillas.

    La cotización es necesaria cuando se escriben secuencias de comandos que construyen expresiones de consulta de Bazel a partir de valores proporcionados por el usuario.

     //foo:bar+wiz    # WRONG: scanned as //foo:bar + wiz.
     //foo:bar=wiz    # WRONG: scanned as //foo:bar = wiz.
     "//foo:bar+wiz"  # OK.
     "//foo:bar=wiz"  # OK.
    

    Ten en cuenta que esta cita se suma a cualquier otra que requiera tu shell, por ejemplo:

    bazel query ' "//foo:bar=wiz" '   # single-quotes for shell, double-quotes for Bazel.
    

    Las palabras clave y los operadores, cuando se citan, se tratan como palabras comunes. Por ejemplo, some es una palabra clave, pero "algo" es una palabra. Tanto foo como "foo" son palabras.

    Sin embargo, ten cuidado cuando uses comillas simples o dobles en los nombres de destino. Cuando uses comillas de uno o más nombres de destino, usa solo un tipo de comillas (todas las comillas simples o dobles).

    Los siguientes son ejemplos de lo que será la cadena de consulta de Java:

      'a"'a'         # WRONG: Error message: unclosed quotation.
      "a'"a"         # WRONG: Error message: unclosed quotation.
      '"a" + 'a''    # WRONG: Error message: unexpected token 'a' after query expression '"a" + '
      "'a' + "a""    # WRONG: Error message: unexpected token 'a' after query expression ''a' + '
      "a'a"          # OK.
      'a"a'          # OK.
      '"a" + "a"'    # OK
      "'a' + 'a'"    # OK
    

    Elegimos esta sintaxis para que no se necesiten las comillas en la mayoría de los casos. El ejemplo (inusual) de ".*test rule" necesita comillas: comienza con un punto y contiene un espacio. La cotización de "cc_library" es innecesaria, pero inofensiva.

  • Puntuación, como paréntesis (), punto . y coma ,. Las palabras que contengan signos de puntuación (excepto las excepciones enumeradas anteriormente) deben estar entre comillas.

Se ignoran los espacios en blanco que se encuentren fuera de las palabras entrecomilladas.

Conceptos del lenguaje de consulta de Bazel

El lenguaje de consulta de Bazel es un lenguaje de expresiones. Cada expresión se evalúa como un conjunto parcialmente ordenado de objetivos o, lo que equivale, un gráfico (DAG) de objetivos. Este es el único tipo de datos.

El conjunto y el gráfico hacen referencia al mismo tipo de datos, pero enfatizan diferentes aspectos de él, por ejemplo:

  • Set: El orden parcial de los destinos no es interesante.
  • Gráfico: El orden parcial de los objetivos es significativo.

Ciclos en el gráfico de dependencias

Los grafos de dependencia de compilación deben ser acíclicos.

Los algoritmos utilizados por el lenguaje de consulta están diseñados para usarse en grafos acíclicos, pero son sólidos frente a los ciclos. No se especifican los detalles de cómo se tratan los ciclos y no se debe confiar en ellos.

Dependencias implícitas

Además de las dependencias de compilación que se definen de forma explícita en los archivos BUILD, Bazel agrega dependencias implícitas adicionales a las reglas. Por ejemplo, cada regla de Java depende implícitamente de JavaBuilder. Las dependencias implícitas se establecen mediante atributos que comienzan con $ y no se pueden anular en archivos BUILD.

De forma predeterminada, bazel query tiene en cuenta las dependencias implícitas cuando se calcula el resultado de la consulta. Este comportamiento se puede cambiar con la opción --[no]implicit_deps. Ten en cuenta que, como la consulta no considera las opciones de configuración, nunca se consideran las cadenas de herramientas potenciales.

Exhaustividad

Las expresiones de lenguaje de consulta de Bazel operan en el gráfico de dependencias de compilación, que es el gráfico definido de forma implícita por todas las declaraciones de reglas en todos los archivos BUILD. Es importante comprender que este gráfico es algo abstracto y no constituye una descripción completa de cómo realizar todos los pasos de una compilación. Para realizar una compilación, también se requiere una configuración. Consulta la sección de configuraciones de la Guía del usuario para obtener más detalles.

El resultado de evaluar una expresión en el lenguaje de consulta de Bazel es verdadero para todas las configuraciones, lo que significa que puede ser una sobreaproximación conservadora y no exactamente precisa. Si utilizas la Herramienta de consultas para calcular el conjunto de todos los archivos de origen necesarios durante una compilación, es posible que informe más de los necesarios porque, por ejemplo, la Herramienta de consultas incluirá todos los archivos necesarios para admitir la traducción de mensajes, aunque no tengas la intención de usar esa función en tu compilación.

Sobre la preservación del orden de los gráficos

Las operaciones conservan cualquier restricción de orden heredada de sus subexpresiones. Puedes pensar en esto como "la ley de conservación del orden parcial". Considera un ejemplo: si emites una consulta para determinar el cierre transitivo de las dependencias de un destino en particular, el conjunto resultante se ordena de acuerdo con el gráfico de dependencias. Si filtras ese conjunto para incluir solo los destinos de la categoría file, se mantendrá la misma relación de orden parcial transitivo entre cada par de destinos en el subconjunto resultante, aunque ninguno de estos pares esté conectado directamente en el gráfico original. (No hay bordes de archivo en el gráfico de dependencia de compilación).

Sin embargo, si bien todos los operadores conservan el orden, algunas operaciones, como las operaciones set, no introducen ninguna restricción de orden propia. Considera esta expresión:

deps(x) union y

Se garantiza que el orden del conjunto de resultados final conserve todas las restricciones de orden de sus subexpresiones, es decir, que todas las dependencias transitivas de x se ordenen de forma correcta con respecto a las demás. Sin embargo, la consulta no garantiza nada sobre el orden de los destinos en y ni con el orden de los destinos en deps(x) en relación con los objetivos en y (excepto los destinos en y que también están en deps(x)).

Entre los operadores que introducen restricciones de orden, se incluyen los siguientes: allpaths, deps, rdeps y somepath, y los comodines de patrones de destino package:*, dir/..., etcétera.

Consulta de Sky

Sky Query es un modo de consulta que opera en un alcance universal especificado.

Funciones especiales disponibles solo en SkyQuery

El modo de consulta de Sky tiene las funciones de consulta adicionales allrdeps y rbuildfiles. Estas funciones operan en todo el alcance universal (por eso no tienen sentido para las consultas normales).

Cómo especificar un alcance del universo

El modo de consulta de Sky se activa cuando se pasan las siguientes dos marcas: (--universe_scope o --infer_universe_scope) y --order_output=no. --universe_scope=<target_pattern1>,...,<target_patternN> le indica a la consulta que precargue el cierre transitivo del patrón de destino especificado por los patrones de destino, que puede ser aditivo y sustractivo. Luego, todas las consultas se evalúan en este “alcance”. En particular, los operadores allrdeps y rbuildfiles solo muestran resultados de este alcance. --infer_universe_scope le dice a Bazel que infiera un valor para --universe_scope a partir de la expresión de consulta. Este valor inferido es la lista de patrones de destino únicos en la expresión de consulta, pero podría no ser lo que deseas. Por ejemplo:

bazel query --infer_universe_scope --order_output=no "allrdeps(//my:target)"

La lista de patrones de destino únicos en esta expresión de consulta es ["//my:target"], por lo que Bazel lo trata de la misma manera que la invocación:

bazel query --universe_scope=//my:target --order_output=no "allrdeps(//my:target)"

Sin embargo, el resultado de esa consulta con --universe_scope es solo //my:target; ninguna de las dependencias inversas de //my:target está en el universo, por construcción. Por otro lado, considera lo siguiente:

bazel query --infer_universe_scope --order_output=no "tests(//a/... + b/...) intersect allrdeps(siblings(rbuildfiles(my/starlark/file.bzl)))"

Esta es una invocación de consulta significativa que intenta calcular los destinos de prueba en la expansión tests de los destinos en algunos directorios que dependen de manera transitiva de los destinos cuya definición usa un determinado archivo .bzl. Aquí, --infer_universe_scope es conveniente, en especial cuando la opción de --universe_scope requeriría que analices la expresión de consulta tú mismo.

Por lo tanto, para las expresiones de consulta que usan operadores con alcance universal, como allrdeps y rbuildfiles, asegúrate de usar --infer_universe_scope solo si su comportamiento es lo que deseas.

Sky Query tiene algunas ventajas y desventajas en comparación con la consulta predeterminada. La principal desventaja es que no puede ordenar los resultados según el orden de los gráficos y, por lo tanto, no se permiten ciertos formatos de salida. Sus ventajas son que proporciona dos operadores (allrdeps y rbuildfiles) que no están disponibles en la consulta predeterminada. Además, Sky Query hace su trabajo mediante la introspección del gráfico Skyframe en lugar de crear uno nuevo, que es lo que hace la implementación predeterminada. Por lo tanto, en algunas circunstancias, es más rápido y usa menos memoria.

Expresiones: Sintaxis y semántica de la gramática

Esta es la gramática del lenguaje de consulta de Bazel, expresada en notación EBNF:

expr ::= word
       | let name = expr in expr
       | (expr)
       | expr intersect expr
       | expr ^ expr
       | expr union expr
       | expr + expr
       | expr except expr
       | expr - expr
       | set(word *)
       | word '(' int | word | expr ... ')'

Las siguientes secciones describen cada una de las producciones de esta gramática en orden.

Patrones de destino

expr ::= word

Sintácticamente, un patrón de destino es solo una palabra. Se interpreta como un conjunto (no ordenado) de objetivos. El patrón de destino más simple es una etiqueta, que identifica un solo objetivo (archivo o regla). Por ejemplo, el patrón de destino //foo:bar se evalúa como un conjunto que contiene un elemento, el objetivo, la regla bar.

Los patrones de destino generalizan las etiquetas para incluir comodines sobre los paquetes y los destinos. Por ejemplo, foo/...:all (o solo foo/...) es un patrón de destino que se evalúa como un conjunto que contiene todas las reglas en cada paquete de forma recurrente debajo del directorio foo; bar/baz:all es un patrón de destino que se evalúa como un conjunto que contiene todas las reglas del paquete bar/baz, pero no sus subpaquetes.

De manera similar, foo/...:* es un patrón de destino que se evalúa como un conjunto que contiene todos los destinos (reglas y archivos) en cada paquete de manera recurrente debajo del directorio foo; bar/baz:* se evalúa como un conjunto que contiene todos los destinos en el paquete bar/baz, pero no sus subpaquetes.

Debido a que el comodín :* coincide con los archivos y las reglas, suele ser más útil que :all para las consultas. Por el contrario, el comodín :all (implícito en patrones de destino como foo/...) suele ser más útil para las compilaciones.

Los patrones de destino bazel query funcionan igual que los objetivos de compilación bazel build. Para obtener más detalles, consulta Patrones de destino o escribe bazel help target-syntax.

Los patrones de destino pueden evaluarse como un conjunto singleton (en el caso de una etiqueta), un conjunto que contiene muchos elementos (como en el caso de foo/..., que tiene miles de elementos) o un conjunto vacío, si el patrón de destino no coincide con ningún objetivo.

Todos los nodos que aparecen en el resultado de una expresión de patrón de destino se ordenan correctamente entre sí según la relación de dependencia. Por lo tanto, el resultado de foo:* no es solo el conjunto de objetivos en el paquete foo, sino también el gráfico sobre esos objetivos. (No se garantiza el orden relativo de los nodos resultantes en comparación con otros nodos). Para obtener más detalles, consulta la sección Orden del gráfico.

Variables

expr ::= let name = expr1 in expr2
       | $name

El lenguaje de consulta de Bazel permite definiciones y referencias de variables. El resultado de la evaluación de una expresión let es el mismo que el de expr2, y todos los casos gratuitos de la variable name se reemplazan por el valor de expr1.

Por ejemplo, let v = foo/... in allpaths($v, //common) intersect $v es equivalente a allpaths(foo/...,//common) intersect foo/....

Un caso de una referencia de variable name que no sea una expresión let name = ... que la contiene es un error. En otras palabras, las expresiones de consulta de nivel superior no pueden tener variables libres.

En las producciones gramaticales anteriores, name es como word, pero con la restricción adicional de que es un identificador legal en el lenguaje de programación C. Las referencias a la variable deben estar precedidas por el carácter "$".

Cada expresión let define solo una variable, pero puedes anidarla.

Los patrones de destino y las referencias de variables constan de un solo token, una palabra, lo que crea una ambigüedad sintáctica. Sin embargo, no hay ambigüedad semántica, ya que el subconjunto de palabras que son nombres de variables legales está inconexo del subconjunto de palabras que son patrones legales objetivo.

En términos técnicos, las expresiones let no aumentan la expresividad del lenguaje de consulta: cualquier consulta que se pueda expresar en el lenguaje también se puede expresar sin ellas. Sin embargo, mejoran la concisión de muchas consultas y también pueden llevar a una evaluación de consultas más eficiente.

Expresiones entre paréntesis

expr ::= (expr)

Los paréntesis asocian las subexpresiones para forzar un orden de evaluación. Una expresión entre paréntesis se evalúa según el valor de su argumento.

Operaciones de conjuntos algebraicos: intersección, unión, establecer diferencia

expr ::= expr intersect expr
       | expr ^ expr
       | expr union expr
       | expr + expr
       | expr except expr
       | expr - expr

Estos tres operadores calculan las operaciones de conjuntos habituales sobre sus argumentos. Cada operador tiene dos formas: una nominal, como intersect, y una simbólica, como ^. Ambas formas son equivalentes; las formas simbólicas son más rápidas de escribir. (Para mayor claridad, el resto de esta página utiliza las formas nominales).

Por ejemplo,

foo/... except foo/bar/...

Se evalúa como el conjunto de objetivos que coinciden con foo/..., pero no con foo/bar/....

Puedes escribir la misma consulta como:

foo/... - foo/bar/...

Las operaciones intersect (^) y union (+) son conmutativas (simétricas), mientras que except (-) es asimétrica. El analizador trata los tres operadores como asociativos a la izquierda y de igual prioridad, por lo que quizás quieras usar paréntesis. Por ejemplo, las dos primeras expresiones son equivalentes, pero la tercera no lo es:

x intersect y union z
(x intersect y) union z
x intersect (y union z)

Leer destinos de una fuente externa: establecer

expr ::= set(word *)

El operador set(a b c ...) calcula la unión de un conjunto de cero o más patrones de destino separados por espacios en blanco (sin comas).

Junto con la función $(...) de la shell Bourne, set() proporciona un medio para guardar los resultados de una consulta en un archivo de texto normal, manipular ese archivo de texto con otros programas (como herramientas de shell UNIX estándar) y, luego, volver a ingresar el resultado en la herramienta de consultas como valor para su procesamiento posterior. Por ejemplo:

bazel query deps(//my:target) --output=label | grep ... | sed ... | awk ... > foo
bazel query "kind(cc_binary, set($(<foo)))"

En el siguiente ejemplo,kind(cc_library, deps(//some_dir/foo:main, 5)) se calcula filtrando los valores de maxrank con un programa awk.

bazel query 'deps(//some_dir/foo:main)' --output maxrank | awk '($1 < 5) { print $2;} ' > foo
bazel query "kind(cc_library, set($(<foo)))"

En estos ejemplos, $(<foo) es una abreviatura de $(cat foo), pero también se pueden usar comandos de shell que no sean cat, como el comando awk anterior.

Funciones

expr ::= word '(' int | word | expr ... ')'

El lenguaje de consulta define varias funciones. El nombre de la función determina la cantidad y el tipo de argumentos que requiere. Las siguientes funciones están disponibles:

Cierre transitivo de dependencias: dependencias

expr ::= deps(expr)
       | deps(expr, depth)

El operador deps(x) evalúa el gráfico formado por el cierre transitivo de las dependencias de su conjunto de argumentos x. Por ejemplo, el valor de deps(//foo) es el gráfico de dependencias basado en el nodo único foo, incluidas todas sus dependencias. El valor de deps(foo/...) son los gráficos de dependencia cuyas raíces son todas las reglas de cada paquete que se encuentra debajo del directorio foo. En este contexto, “dependencias” hace referencia solo a los objetivos de reglas y archivos, por lo que no se incluyen aquí los archivos BUILD y Starlark necesarios para crear estos destinos. Para ello, debes usar el operador buildfiles.

El gráfico resultante se ordena según la relación de dependencia. Para obtener más detalles, consulta la sección sobre el orden de los gráficos.

El operador deps acepta un segundo argumento opcional, que es un literal de número entero que especifica un límite superior en la profundidad de la búsqueda. Por lo tanto, deps(foo:*, 0) muestra todos los destinos en el paquete foo, mientras que deps(foo:*, 1) incluye, además, los requisitos previos directos de cualquier destino en el paquete foo, y deps(foo:*, 2) incluye, además, los nodos a los que se puede acceder directamente desde los nodos en deps(foo:*, 1), y así sucesivamente. (Estos números corresponden a las clasificaciones que se muestran en el formato de salida minrank). Si se omite el parámetro depth, la búsqueda no tiene límites: calcula el cierre transitivo reflexivo de los requisitos previos.

Cierre transitivo de dependencias inversas: rdeps

expr ::= rdeps(expr, expr)
       | rdeps(expr, expr, depth)

El operador rdeps(u, x) evalúa las dependencias inversas del conjunto de argumentos x dentro del cierre transitivo del conjunto de universos u.

El gráfico resultante se ordena según la relación de dependencia. Consulta la sección sobre el orden de los gráficos para obtener más detalles.

El operador rdeps acepta un tercer argumento opcional, que es un literal de número entero que especifica un límite superior en la profundidad de la búsqueda. El gráfico resultante solo incluye nodos a una distancia de la profundidad especificada desde cualquier nodo en el conjunto de argumentos. Por lo tanto, rdeps(//foo, //common, 1) se evalúa en todos los nodos del cierre transitivo de //foo que dependen directamente de //common. (Estos números corresponden a las clasificaciones que se muestran en el formato de salida minrank). Si se omite el parámetro depth, la búsqueda es ilimitada.

Cierre transitivo de todas las dependencias inversas: allrdeps

expr ::= allrdeps(expr)
       | allrdeps(expr, depth)

El operador allrdeps se comporta igual que el operador rdeps, con la excepción de que el "conjunto universal" es lo que se haya evaluado en la marca --universe_scope, en lugar de especificarse por separado. Por lo tanto, si se pasó --universe_scope=//foo/..., entonces allrdeps(//bar) es equivalente a rdeps(//foo/..., //bar).

Dependencias inversas directas en el mismo paquete: same_pkg_direct_rdeps

expr ::= same_pkg_direct_rdeps(expr)

El operador same_pkg_direct_rdeps(x) evalúa el conjunto completo de destinos que se encuentran en el mismo paquete que un objetivo en el conjunto de argumentos y que dependen directamente de él.

Cómo tratar con el paquete de un destino: hermanos

expr ::= siblings(expr)

El operador siblings(x) se evalúa como el conjunto completo de objetivos que se encuentran en el mismo paquete que un objetivo en el conjunto de argumentos.

Elección arbitraria: algunas

expr ::= some(expr)
       | some(expr, count )

El operador some(x, k) selecciona, como máximo, k objetivos de manera arbitraria de su conjunto de argumentos x y se evalúa como un conjunto que contiene solo esos objetivos. El parámetro k es opcional. Si falta, el resultado será un conjunto singleton que contiene solo un objetivo seleccionado de forma arbitraria. Si el tamaño del conjunto de argumentos x es menor que k, se mostrará todo el conjunto de argumentos x.

Por ejemplo, la expresión some(//foo:main union //bar:baz) se evalúa como un conjunto singleton que contiene //foo:main o //bar:baz, aunque no está definido. La expresión some(//foo:main union //bar:baz, 2) o some(//foo:main union //bar:baz, 3) muestran //foo:main y //bar:baz.

Si el argumento es un singleton, entonces some calcula la función de identidad: some(//foo:main) es equivalente a //foo:main.

Es un error si el conjunto de argumentos especificado está vacío, como en la expresión some(//foo:main intersect //bar:baz).

Operadores de rutas de acceso: somepath, allpaths

expr ::= somepath(expr, expr)
       | allpaths(expr, expr)

Los operadores somepath(S, E) y allpaths(S, E) calculan rutas entre dos conjuntos de objetivos. Ambas consultas aceptan dos argumentos: un conjunto S de puntos de partida y un conjunto E de puntos de finalización. somepath muestra el gráfico de nodos en alguna ruta arbitraria desde un destino en S hasta un destino en E; allpaths muestra el gráfico de nodos en todas las rutas de acceso desde cualquier destino en S hacia cualquier destino en E.

Los gráficos resultantes se ordenan según la relación de dependencia. Consulta la sección sobre el orden de los gráficos para obtener más detalles.

Algún Ruta
somepath(S1 + S2, E), un resultado posible.
Algún Ruta
somepath(S1 + S2, E), otro resultado posible.
Todas las rutas
allpaths(S1 + S2, E)

Filtrado de tipos de destino: tipo

expr ::= kind(word, expr)

El operador kind(pattern, input) aplica un filtro a un conjunto de objetivos y descarta aquellos que no son del tipo esperado. El parámetro pattern especifica con qué tipo de destino debe coincidir.

Por ejemplo, en la tabla, se ilustran las categorías para los cuatro destinos definidos por el archivo BUILD (para el paquete p) que se muestran a continuación:

Escribe código Diana Tipo
        genrule(
            name = "a",
            srcs = ["a.in"],
            outs = ["a.out"],
            cmd = "...",
        )
      
//p:a regla genrule
//p:a.in archivo de origen
//p:a.out archivo generado
//p:BUILD archivo de origen

Por lo tanto, kind("cc_.* rule", foo/...) se evalúa como el conjunto de todos los objetivos de regla cc_library, cc_binary, etc. debajo de foo, y kind("source file", deps(//foo)) se evalúa como el conjunto de todos los archivos de origen en el cierre transitivo de las dependencias del destino //foo.

A menudo, se requiere la cita del argumento pattern porque, sin él, el analizador no considera palabras muchas expresiones regulares, como source file y .*_test.

Cuando coinciden con package group, es posible que los objetivos que terminen en :all no generen resultados. Utiliza :all-targets en lugar de esta función.

Filtrado de nombres objetivo: filtro

expr ::= filter(word, expr)

El operador filter(pattern, input) aplica un filtro a un conjunto de destinos y descarta los destinos cuyas etiquetas (en forma absoluta) no coinciden con el patrón; se evalúa como un subconjunto de su entrada.

El primer argumento, pattern, es una palabra que contiene una expresión regular sobre los nombres de destino. Se evalúa una expresión filter para el conjunto que contiene todos los destinos x, de modo que x sea miembro del conjunto input y la etiqueta (en forma absoluta, como //foo:bar) de x contenga una coincidencia (sin anclar) para la expresión regular pattern. Dado que todos los nombres de destino comienzan con //, se puede usar como alternativa al ancla de expresión regular ^.

A menudo, este operador proporciona una alternativa mucho más rápida y sólida al operador intersect. Por ejemplo, para ver todas las dependencias bar del destino //foo:foo, se podría evaluar

deps(//foo) intersect //bar/...

Sin embargo, esta sentencia requerirá el análisis de todos los archivos BUILD en el árbol bar, que será lento y propenso a errores en archivos BUILD irrelevantes. Una alternativa sería:

filter(//bar, deps(//foo))

que primero calcularía el conjunto de dependencias //foo y, luego, filtraría solo los destinos que coinciden con el patrón proporcionado; en otras palabras, destinos con nombres que contienen //bar como substring.

Otro uso común del operador filter(pattern, expr) es filtrar archivos específicos por su nombre o extensión. Por ejemplo,

filter("\.cc$", deps(//foo))

Proporciona una lista de todos los archivos .cc que se usaron para compilar //foo.

Filtrado de atributos de la regla: attr

expr ::= attr(word, word, expr)

El operador attr(name, pattern, input) aplica un filtro a un conjunto de objetivos y descarta los objetivos que no son reglas, los objetivos de reglas que no tienen definido el atributo name o los objetivos de reglas en los que el valor del atributo no coincide con la expresión regular pattern proporcionada. Se evalúa como un subconjunto de su entrada.

El primer argumento, name, es el nombre del atributo de la regla que debe coincidir con el patrón de expresión regular proporcionado. El segundo argumento, pattern, es una expresión regular sobre los valores del atributo. Una expresión attr se evalúa como el conjunto que contiene todos los objetivos x, de modo que x es miembro del conjunto input, es una regla con el atributo definido name y el valor del atributo contiene una coincidencia (sin anclar) para la expresión regular pattern. Si name es un atributo opcional y la regla no lo especifica explícitamente, se usará el valor del atributo predeterminado para la comparación. Por ejemplo,

attr(linkshared, 0, deps(//foo))

Se seleccionarán todas las dependencias //foo que pueden tener un atributo linkshared (como la regla cc_binary) y lo establecerán explícitamente en 0 o no lo establecerán en absoluto, pero el valor predeterminado es 0 (como para las reglas cc_binary).

Los atributos de tipo de lista (como srcs, data, etc.) se convierten en cadenas con el formato [value<sub>1</sub>, ..., value<sub>n</sub>], que comienzan con un corchete [, terminan con un corchete ] y usan "," (coma, espacio) para delimitar varios valores. Las etiquetas se convierten en strings mediante el uso de la forma absoluta de la etiqueta. Por ejemplo, un atributo deps=[":foo", "//otherpkg:bar", "wiz"] se convertiría en la string [//thispkg:foo, //otherpkg:bar, //thispkg:wiz]. Los corchetes siempre están presentes, por lo que la lista vacía usaría el valor de string [] para fines de coincidencia. Por ejemplo,

attr("srcs", "\[\]", deps(//foo))

se seleccionarán todas las reglas entre las dependencias //foo que tienen un atributo srcs vacío, mientras que

attr("data", ".{3,}", deps(//foo))

Se seleccionarán todas las reglas entre las dependencias //foo que especifiquen al menos un valor en el atributo data (cada etiqueta tiene al menos 3 caracteres debido a // y :).

Para seleccionar todas las reglas entre dependencias //foo con un value específico en un atributo tipo lista, usa

attr("tags", "[\[ ]value[,\]]", deps(//foo))

Esto funciona porque el carácter antes de value será [ o un espacio, y el carácter después de value será una coma o ].

Filtrado de visibilidad de la regla: Visible

expr ::= visible(expr, expr)

El operador visible(predicate, input) aplica un filtro a un conjunto de objetivos y descarta los destinos sin la visibilidad requerida.

El primer argumento, predicate, es un conjunto de objetivos para el que todos los destinos de la salida deben ser visibles para ellos. Se evalúa una expresión visible en el conjunto que contiene todos los destinos x, de modo que x sea miembro del conjunto input y, para todos los destinos y en predicate, x sea visible para y. Por ejemplo:

visible(//foo, //bar:*)

Se seleccionarán todos los objetivos en el paquete //bar del que puede depender //foo sin infringir las restricciones de visibilidad.

Evaluación de los atributos de la regla de tipo etiqueta: etiquetas

expr ::= labels(word, expr)

El operador labels(attr_name, inputs) muestra el conjunto de objetivos especificados en el atributo attr_name de tipo “etiqueta” o “lista de etiquetas” en alguna regla del conjunto inputs.

Por ejemplo, labels(srcs, //foo) muestra el conjunto de destinos que aparece en el atributo srcs de la regla //foo. Si hay varias reglas con atributos srcs en el conjunto inputs, se muestra la unión de sus srcs.

Expande y filtra test_suites: pruebas

expr ::= tests(expr)

El operador tests(x) muestra el conjunto de todas las reglas de prueba del conjunto x, expande las reglas test_suite al conjunto de pruebas individuales al que hace referencia y aplica el filtrado por tag y size.

De forma predeterminada, la evaluación de las consultas ignora los destinos que no sean de prueba en todas las reglas de test_suite. Esto se puede cambiar a errores con la opción --strict_test_suite.

Por ejemplo, la consulta kind(test, foo:*) enumera todas las reglas *_test y test_suite en el paquete foo. Por definición, todos los resultados son miembros del paquete foo. Por el contrario, la consulta tests(foo:*) mostrará todas las pruebas individuales que ejecutaría bazel test foo:*: esto puede incluir pruebas que pertenecen a otros paquetes a los que se hace referencia de forma directa o indirecta a través de las reglas test_suite.

Archivos de definición del paquete: buildfiles

expr ::= buildfiles(expr)

El operador buildfiles(x) muestra el conjunto de archivos que definen los paquetes de cada destino en el conjunto x; en otras palabras, para cada paquete, su archivo BUILD más cualquier archivo .bzl al que haga referencia a través de load. Ten en cuenta que esto también muestra los archivos BUILD de los paquetes que contienen estos archivos load.

Por lo general, este operador se usa para determinar qué archivos o paquetes se requieren para compilar un destino específico, a menudo en combinación con la opción --output package que se muestra a continuación. Por ejemplo,

bazel query 'buildfiles(deps(//foo))' --output package

muestra el conjunto de todos los paquetes de los que depende //foo de forma transitiva.

Archivos de definición del paquete: rbuildfiles

expr ::= rbuildfiles(word, ...)

El operador rbuildfiles toma una lista separada por comas de fragmentos de ruta de acceso y muestra el conjunto de archivos BUILD que dependen de manera transitiva de estos fragmentos de ruta. Por ejemplo, si //foo es un paquete, rbuildfiles(foo/BUILD) mostrará el destino //foo:BUILD. Si el archivo foo/BUILD tiene load('//bar:file.bzl'..., rbuildfiles(bar/file.bzl) mostrará el destino //foo:BUILD, así como los destinos de cualquier otro archivo BUILD que cargue //bar:file.bzl.

El alcance del operador rbuildfiles es el universo que especifica la marca --universe_scope. Los archivos que no corresponden de forma directa a los archivos BUILD y .bzl no afectan los resultados. Por ejemplo, los archivos de origen (como foo.cc) se ignoran, incluso si se mencionan de forma explícita en el archivo BUILD. Sin embargo, se respetan los symlinks, de modo que si foo/BUILD es un symlink a bar/BUILD, entonces rbuildfiles(bar/BUILD) incluirá //foo:BUILD en los resultados.

El operador rbuildfiles es casi moralmente el inverso al operador buildfiles. Sin embargo, esta inversión moral tiene más fuerza en una dirección: los resultados de rbuildfiles son como las entradas de buildfiles; el primero solo contendrá destinos de archivo BUILD en paquetes y el segundo puede contener esos objetivos. En la otra dirección, la correspondencia es más débil. Los resultados del operador buildfiles son objetivos que corresponden a todos los paquetes y .bzl que necesita una entrada determinada. Sin embargo, las entradas del operador rbuildfiles no son esos objetivos, sino los fragmentos de ruta de acceso que corresponden a esos objetivos.

Archivos de definición del paquete: loadfiles

expr ::= loadfiles(expr)

El operador loadfiles(x) muestra el conjunto de archivos de Starlark que se necesitan para cargar los paquetes de cada destino en el conjunto x. En otras palabras, para cada paquete, muestra los archivos .bzl a los que se hace referencia desde sus archivos BUILD.

Formatos de salida

bazel query genera un gráfico. Especifica el contenido, el formato y el orden en que bazel query presenta este gráfico mediante la opción de línea de comandos --output.

Cuando se ejecuta con Sky Query, solo se permiten los formatos de salida compatibles con resultados desordenados. Específicamente, no se permiten los formatos de salida graph, minrank y maxrank.

Algunos de los formatos de salida aceptan opciones adicionales. El nombre de cada opción de salida tiene el prefijo del formato de salida al que se aplica, por lo que --graph:factored se aplica solo cuando se usa --output=graph; no tiene ningún efecto si se usa un formato de salida distinto de graph. Del mismo modo, --xml:line_numbers solo se aplica cuando se usa --output=xml.

Sobre el orden de los resultados

Aunque las expresiones de consulta siempre siguen la “ley de conservación del orden de los grafos”, presentan los resultados se pueden realizar de forma ordenada por dependencia o no ordenada. Esto no influye en los objetivos del conjunto de resultados ni en la forma en que se calcula la consulta. Solo afecta la forma en que se imprimen los resultados en stdout. Además, los nodos que son equivalentes en el orden de dependencia pueden o no estar ordenados alfabéticamente. Se puede usar la marca --order_output para controlar este comportamiento. La marca --[no]order_results tiene un subconjunto de la funcionalidad de la marca --order_output y está obsoleta.

El valor predeterminado de esta marca es auto, que imprime los resultados en un orden lexicográfico. Sin embargo, cuando se usa somepath(a,b), los resultados se imprimirán en orden deps.

Cuando esta marca es no y --output es una de las siguientes build, label, label_kind, location, package, proto o xml, las salidas se imprimirán en orden arbitrario. Por lo general, esta es la opción más rápida. Sin embargo, no se admite cuando --output es graph, minrank o maxrank: con estos formatos, Bazel siempre imprime resultados ordenados por el orden o la clasificación de dependencia.

Cuando esta marca es deps, Bazel imprime los resultados en algún orden topológico, es decir, las dependencias primero. Sin embargo, los nodos que no están ordenados por el orden de la dependencia (porque no hay una ruta de acceso de uno a otro) se pueden imprimir en cualquier orden.

Cuando esta marca es full, Bazel imprime los nodos en un orden completamente determinista (total). Primero, todos los nodos se ordenan alfabéticamente. Luego, cada nodo de la lista se usa como el inicio de una búsqueda de profundidad de orden posterior, en la que las aristas salientes a los nodos no visitados se recorren en orden alfabético de los nodos sucesores. Por último, los nodos se imprimen en el orden inverso del orden en que se visitaron.

Es posible que los nodos de impresión en este orden sean más lentos, por lo que solo debe usarse cuando el determinismo sea importante.

Imprime el formulario de origen de los destinos tal como aparecerían en BUILD

--output build

Con esta opción, la representación de cada destino es como si estuviera escrita a mano en el lenguaje BUILD. Todas las variables y las llamadas a funciones (como glob o macros) se expanden, lo que es útil para ver el efecto de las macros de Starlark. Además, cada regla vigente informa un valor generator_name o generator_function, lo que proporciona el nombre de la macro evaluada para producir la regla vigente.

Aunque el resultado usa la misma sintaxis que los archivos BUILD, no se garantiza que produzca un archivo BUILD válido.

--output label

Con esta opción, se imprime el conjunto de nombres (o etiquetas) de cada objetivo en el gráfico resultante, una etiqueta por línea, en orden topológico (a menos que se especifique --noorder_results; consulta las notas sobre el orden de los resultados). (Un orden topológico es uno en el que el nodo de un gráfico aparece antes que todos sus sucesores). Por supuesto, existen muchos órdenes topográficos posibles de un gráfico (el orden posterior inverso es solo uno); no se especifica cuál se elige.

Cuando se imprime el resultado de una consulta somepath, el orden en el que se imprimen los nodos es el orden de la ruta de acceso.

Advertencia: En algunos casos excepcionales, puede haber dos objetivos distintos con la misma etiqueta. Por ejemplo, una regla sh_binary y su único archivo srcs (implícito) pueden llamarse foo.sh. Si el resultado de una consulta contiene ambos destinos, el resultado (en formato label) parecerá contener un duplicado. Cuando se usa el formato label_kind (consulta a continuación), la distinción es clara: los dos destinos tienen el mismo nombre, pero uno tiene el tipo sh_binary rule y el otro tipo source file.

--output label_kind

Al igual que label, este formato de salida imprime las etiquetas de cada objetivo en el gráfico resultante, en orden topológico, pero además antecede a la etiqueta por el tipo del destino.

--output proto

Imprime el resultado de la consulta como un búfer de protocolo QueryResult.

--output streamed_proto

Imprime un flujo delimitado por longitud de búferes de protocolo Target. Esto es útil para (i) evitar las limitaciones de tamaño de los búferes de protocolo cuando hay demasiados destinos para caber en un solo QueryResult o (ii) a fin de comenzar a procesar mientras Bazel aún genera salidas.

--output textproto

Al igual que --output proto, imprime el búfer de protocolo QueryResult, pero en formato de texto.

--output streamed_jsonproto

Al igual que --output streamed_proto, imprime un flujo de búferes de protocolo Target, pero en formato ndjson.

--output minrank --output maxrank

Al igual que label, los formatos de salida minrank y maxrank imprimen las etiquetas de cada objetivo en el gráfico resultante, pero, en lugar de aparecer en orden topoológico, aparecen en orden de clasificación, precedidos por su número de rango. Estos no se ven afectados por la marca --[no]order_results de orden de los resultados (consulta las notas sobre el orden de los resultados).

Hay dos variantes de este formato: minrank clasifica cada nodo según la longitud de la ruta más corta desde un nodo raíz hasta él. Los nodos “raíz” (aquellos que no tienen aristas entrantes) son de rango 0, sus sucesores son de rango 1, etc. (como siempre, las aristas apuntan de un objetivo a sus requisitos previos: los objetivos de los que depende).

maxrank clasifica cada nodo según la longitud de la ruta más larga desde un nodo raíz hasta él. Una vez más, las “raíces” tienen un rango de 0; todos los demás nodos tienen un rango que es uno mayor que el rango máximo de todos sus predecesores.

Todos los nodos en un ciclo se consideran de la misma clasificación. (la mayoría de los grafos son acíclicos, pero los ciclos se producen simplemente porque los archivos BUILD contienen ciclos erróneos).

Estos formatos de salida son útiles a fin de descubrir la profundidad de un gráfico. Si se usa para el resultado de una consulta deps(x), rdeps(x) o allpaths, el número de clasificación es igual a la longitud de la ruta más corta (con minrank) o más larga (con maxrank) desde x hasta un nodo en esa clasificación. maxrank se puede usar para determinar la secuencia más larga de pasos de compilación necesaria para compilar un destino.

Por ejemplo, el gráfico de la izquierda produce los resultados de la derecha cuando se especifican --output minrank y --output maxrank, respectivamente.

Fuera de clasificación
      minrank

      0 //c:c
      1 //b:b
      1 //a:a
      2 //b:b.cc
      2 //a:a.cc
      
      maxrank

      0 //c:c
      1 //b:b
      2 //a:a
      2 //b:b.cc
      3 //a:a.cc
      
--output location

Al igual que label_kind, esta opción imprime, para cada destino en el resultado, el tipo y la etiqueta del destino, pero está precedida por una string que describe la ubicación de ese destino, como un nombre de archivo y un número de línea. El formato se parece al resultado de grep. Por lo tanto, las herramientas que pueden analizar esta última (como Emacs o vi) también pueden usar el resultado de la consulta para recorrer una serie de coincidencias, lo que permite que la Herramienta de consultas de Bazel se use como un “grep para archivos BUILD” que tiene en cuenta el gráfico de dependencias.

La información de la ubicación varía según el tipo de segmentación (consulta el operador kind). Para las reglas, se muestra la ubicación de la declaración de la regla dentro del archivo BUILD. Para los archivos de origen, se imprime la ubicación de la línea 1 del archivo real. Para un archivo generado, se imprime la ubicación de la regla que lo genera. (La Herramienta de consultas no tiene suficiente información para encontrar la ubicación real del archivo generado y, en cualquier caso, es posible que no exista si aún no se realizó una compilación).

--output package

Esta opción imprime el nombre de todos los paquetes a los que pertenece algún destino del conjunto de resultados. Los nombres se imprimen en orden lexicográfico; se excluyen los duplicados. De manera formal, esta es una proyección del conjunto de etiquetas (paquete, destino) en paquetes.

Los paquetes en repositorios externos tienen el formato @repo//foo/bar, mientras que los paquetes en el repositorio principal tienen el formato foo/bar.

Junto con la consulta deps(...), esta opción de salida se puede usar para buscar el conjunto de paquetes que se deben pagar para compilar un conjunto determinado de destinos.

Muestra un gráfico del resultado

--output graph

Esta opción hace que el resultado de la consulta se imprima como un gráfico dirigido en el popular formato de GraphViz de AT&T. Por lo general, el resultado se guarda en un archivo, como .png o .svg. (Si el programa dot no está instalado en la estación de trabajo, puedes instalarlo con el comando sudo apt-get install graphviz). Consulta la sección de ejemplos a continuación para ver una invocación de ejemplo.

Este formato de salida es particularmente útil para consultas allpaths, deps o rdeps, en las que el resultado incluye un conjunto de rutas que no se puede visualizar con facilidad cuando se renderiza de forma lineal, como con --output label.

De forma predeterminada, el gráfico se renderiza de forma factorizada. Es decir, los nodos equivalentes topológicamente se combinan en un solo nodo con varias etiquetas. Esto hace que el gráfico sea más compacto y legible, ya que los gráficos de resultados típicos contienen patrones muy repetitivos. Por ejemplo, una regla java_library puede depender de cientos de archivos de origen de Java generados por el mismo genrule. En el gráfico factorizado, todos estos archivos están representados por un solo nodo. Este comportamiento se puede inhabilitar con la opción --nograph:factored.

--graph:node_limit n

La opción especifica la longitud máxima de la string de etiqueta para un nodo gráfico en el resultado. Las etiquetas más largas se truncarán; -1 inhabilita el truncamiento. Debido a la forma factorizada en la que los grafos suelen imprimirse, las etiquetas de los nodos pueden ser muy largas. GraphViz no puede manejar etiquetas que superen los 1,024 caracteres, que es el valor predeterminado de esta opción. Esta opción no tiene efecto, a menos que se use --output=graph.

--[no]graph:factored

De forma predeterminada, los gráficos se muestran de forma factorizada, como se explicó anteriormente. Cuando se especifica --nograph:factored, los gráficos se imprimen sin factorización. Esto hace que la visualización con GraphViz sea poco práctica, pero el formato más simple puede facilitar el procesamiento por parte de otras herramientas (como grep). Esta opción no tiene efecto, a menos que se use --output=graph.

XML

--output xml

Esta opción hace que los destinos resultantes se impriman en un formulario XML. El resultado comienza con un encabezado XML como este.

  <?xml version="1.0" encoding="UTF-8"?>
  <query version="2">

Luego, continúa con un elemento XML para cada destino en el gráfico de resultados, en orden topológico (a menos que se soliciten resultados sin ordenar), y termina con una finalización.

</query>

Se emiten entradas simples para los destinos del tipo file:

  <source-file name='//foo:foo_main.cc' .../>
  <generated-file name='//foo:libfoo.so' .../>

Sin embargo, en el caso de las reglas, el XML está estructurado y contiene definiciones de todos los atributos de la regla, incluidos aquellos cuyo valor no se especificó de manera explícita en el archivo BUILD de la regla.

Además, el resultado incluye elementos rule-input y rule-output para que la topología del gráfico de dependencia se pueda reconstruir sin tener que saber que, por ejemplo, los elementos del atributo srcs son dependencias futuras (requisitos previos) y el contenido del atributo outs son dependencias inversas (consumidores).

Los elementos rule-input para las dependencias implícitas se suprimen si se especifica --noimplicit_deps.

  <rule class='cc_binary rule' name='//foo:foo' ...>
    <list name='srcs'>
      <label value='//foo:foo_main.cc'/>
      <label value='//foo:bar.cc'/>
      ...
    </list>
    <list name='deps'>
      <label value='//common:common'/>
      <label value='//collections:collections'/>
      ...
    </list>
    <list name='data'>
      ...
    </list>
    <int name='linkstatic' value='0'/>
    <int name='linkshared' value='0'/>
    <list name='licenses'/>
    <list name='distribs'>
      <distribution value="INTERNAL" />
    </list>
    <rule-input name="//common:common" />
    <rule-input name="//collections:collections" />
    <rule-input name="//foo:foo_main.cc" />
    <rule-input name="//foo:bar.cc" />
    ...
  </rule>

Cada elemento XML de un destino contiene un atributo name, cuyo valor es la etiqueta del destino, y un atributo location, cuyo valor es la ubicación del destino tal como lo imprime la --output location.

--[no]xml:line_numbers

De forma predeterminada, las ubicaciones que se muestran en el archivo XML contienen números de línea. Cuando se especifica --noxml:line_numbers, no se imprimen los números de línea.

--[no]xml:default_values

De forma predeterminada, el resultado en formato XML no incluye un atributo de regla cuyo valor sea el predeterminado para ese tipo de atributo (por ejemplo, si no se especificó en el archivo BUILD o si el valor predeterminado se proporcionó de forma explícita). Esta opción hace que los valores de esos atributos se incluyan en el resultado en formato XML.

Expresiones regulares

Las expresiones regulares en el lenguaje de consulta usan la biblioteca de regex de Java, por lo que puedes usar la sintaxis completa de java.util.regex.Pattern.

Consulta con repositorios externos

Si la compilación depende de reglas de repositorios externos, los resultados de la consulta incluirán estas dependencias. Por ejemplo, si //foo:bar depende de @other-repo//baz:lib, bazel query 'deps(//foo:bar)' mostrará @other-repo//baz:lib como una dependencia.