attrs
de rule()
y aspect()
.Consulta la página Reglas para obtener más información sobre cómo definir y usar atributos.
Miembros
- bool
- int
- int_list
- label
- label_keyed_string_dict
- label_list
- Resultado
- output_list
- string
- string_dict
- string_list
- string_list_dict
bool
Attribute attr.bool(default=False, doc=None, mandatory=False)Crea un esquema para un atributo booleano. El atributo
ctx.attr
correspondiente será del tipo bool
.
Parámetros
Parámetro | Descripción |
---|---|
default
|
el valor predeterminado es False Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
int
Attribute attr.int(default=0, doc=None, mandatory=False, values=[])Crea un esquema para un atributo de número entero. El valor debe estar dentro del rango de 32 bits con firma. El atributo
ctx.attr
correspondiente será del tipo int
.
Parámetros
Parámetro | Descripción |
---|---|
default
|
el valor predeterminado es 0 Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
values
|
secuencia de int; el valor predeterminado es [] La lista de valores permitidos para el atributo. Si se proporciona otro valor, se genera un error. |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)Crea un esquema para un atributo de lista de números enteros. Cada elemento debe estar dentro del rango de 32 bits firmado.
Parámetros
Parámetro | Descripción |
---|---|
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
default
|
secuencia de ints; el valor predeterminado es [] Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
etiqueta
Attribute attr.label(default=None, doc=None, executable=False, allow_files=None, allow_single_file=None, mandatory=False, providers=[], allow_rules=None, cfg=None, aspects=[])
Crea un esquema para un atributo de etiqueta. Este es un atributo de dependencia.
Este atributo contiene valores Label
únicos. Si se proporciona una string en lugar de un Label
, se convertirá mediante el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con un nombre nuevo), se resuelven con respecto al paquete del destino con instancia.
En el momento del análisis (dentro de la función de implementación de la regla), cuando se recupera el valor del atributo de ctx.attr
, las etiquetas se reemplazan por los Target
correspondientes. Esto te permite acceder a los proveedores de las dependencias del destino actual.
Además de los archivos fuente comunes, este tipo de atributo suele usarse para hacer referencia a una herramienta, por ejemplo, un compilador. Estas herramientas se consideran dependencias, al igual que los archivos fuente. Para evitar que los usuarios deban especificar la etiqueta de la herramienta cada vez que usen la regla en sus archivos BUILD, puedes codificar la etiqueta de una herramienta canónica como el valor default
de este atributo. Si también quieres evitar que los usuarios anulen esta configuración predeterminada, puedes establecer el atributo como privado. Para ello, asígnale un nombre que comience con un guion bajo. Consulta la página Reglas para obtener más información.
Parámetros
Parámetro | Descripción |
---|---|
default
|
Label, string, LateBoundDefault, NativeComputedDefault o función o None ; el valor predeterminado es None Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla.Usa una string o la función Label para especificar un valor predeterminado, por ejemplo, attr.label(default = "//a:b") .
|
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
executable
|
el valor predeterminado es False Es verdadero si la dependencia tiene que ser ejecutable. Esto significa que la etiqueta debe hacer referencia a un archivo ejecutable o a una regla que genere un archivo ejecutable. Accede a la etiqueta con ctx.executable.<attribute_name> .
|
allow_files
|
bool; o secuencia de strings; o None ; el valor predeterminado es None Si se permiten objetivos File . Puede ser True , False (predeterminado) o una lista de extensiones de archivo permitidas (por ejemplo, [".cc", ".cpp"] ).
|
allow_single_file
|
el valor predeterminado es None Esto es similar a allow_files , con la restricción de que la etiqueta debe corresponder a un solo File. Accede a él a través de ctx.file.<attribute_name> .
|
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
providers
|
el valor predeterminado es [] Son los proveedores que debe proporcionar cualquier dependencia que aparezca en este atributo. El formato de este argumento es una lista de listas de proveedores: objetos |
allow_rules
|
secuencia de strings; o None ; el valor predeterminado es None Las reglas de segmentación (nombre de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo para fines de compatibilidad). En su lugar, usa proveedores. |
cfg
|
el valor predeterminado es None Configuración del atributo. Puede ser "exec" , que indica que la dependencia se compila para execution platform , o "target" , que indica que la dependencia se compila para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, donde target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows . Se requiere este parámetro si executable es verdadero para evitar la compilación accidental de herramientas del host en la configuración de destino. "target" no tiene efecto semántico, así que no lo configures cuando executable sea False, a menos que realmente ayude a aclarar tus intenciones.
|
aspects
|
secuencia de Aspect; el valor predeterminado es [] Aspectos que se deben aplicar a la dependencia o dependencias especificadas por este atributo. |
label_keyed_string_dict
Attribute attr.label_keyed_string_dict(allow_empty=True, *, default={}, doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
Crea un esquema para un atributo que contiene un diccionario, donde las claves son etiquetas y los valores son cadenas. Este es un atributo de dependencia.
Este atributo contiene valores Label
únicos. Si se proporciona una string en lugar de un Label
, se convertirá mediante el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con un nombre nuevo), se resuelven con respecto al paquete del destino con instancia.
En el momento del análisis (dentro de la función de implementación de la regla), cuando se recupera el valor del atributo de ctx.attr
, las etiquetas se reemplazan por los Target
correspondientes. Esto te permite acceder a los proveedores de las dependencias del destino actual.
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
default
|
dict; o function;
el valor predeterminado es {} Un valor predeterminado que se usa si no se proporciona ningún valor para el atributo cuando se crea una instancia de la regla.Usa cadenas o la función Label para especificar valores predeterminados, por ejemplo, attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}) .
|
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
allow_files
|
bool; o secuencia de strings; o None ; el valor predeterminado es None Si se permiten objetivos File . Puede ser True , False (predeterminado) o una lista de extensiones de archivo permitidas (por ejemplo, [".cc", ".cpp"] ).
|
allow_rules
|
secuencia de strings; o None ; el valor predeterminado es None Las reglas de segmentación (nombre de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo para fines de compatibilidad). En su lugar, usa proveedores. |
providers
|
el valor predeterminado es [] Son los proveedores que debe proporcionar cualquier dependencia que aparezca en este atributo. El formato de este argumento es una lista de listas de proveedores: objetos |
flags
|
secuencia de strings; el valor predeterminado es [] Obsoleto; se quitará. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
cfg
|
el valor predeterminado es None Configuración del atributo. Puede ser "exec" , que indica que la dependencia se compila para execution platform , o "target" , que indica que la dependencia se compila para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, donde target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows .
|
aspects
|
secuencia de Aspect; el valor predeterminado es [] Aspectos que se deben aplicar a la dependencia o dependencias especificadas por este atributo. |
label_list
Attribute attr.label_list(allow_empty=True, *, default=[], doc=None, allow_files=None, allow_rules=None, providers=[], flags=[], mandatory=False, cfg=None, aspects=[])
Crea un esquema para un atributo de lista de etiquetas. Este es un atributo de dependencia. El atributo ctx.attr
correspondiente será del tipo list de Target
s.
Este atributo contiene valores Label
únicos. Si se proporciona una string en lugar de un Label
, se convertirá mediante el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con un nombre nuevo), se resuelven con respecto al paquete del destino con instancia.
En el momento del análisis (dentro de la función de implementación de la regla), cuando se recupera el valor del atributo de ctx.attr
, las etiquetas se reemplazan por los Target
correspondientes. Esto te permite acceder a los proveedores de las dependencias del destino actual.
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
default
|
secuencia de etiquetas o función; valor predeterminado es [] Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla.Usa cadenas o la función Label para especificar valores predeterminados, por ejemplo, attr.label_list(default = ["//a:b", "//a:c"]) .
|
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
allow_files
|
bool; o secuencia de strings; o None ; el valor predeterminado es None Si se permiten objetivos File . Puede ser True , False (predeterminado) o una lista de extensiones de archivo permitidas (por ejemplo, [".cc", ".cpp"] ).
|
allow_rules
|
secuencia de strings; o None ; el valor predeterminado es None Las reglas de segmentación (nombre de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo para fines de compatibilidad). En su lugar, usa proveedores. |
providers
|
el valor predeterminado es [] Son los proveedores que debe proporcionar cualquier dependencia que aparezca en este atributo. El formato de este argumento es una lista de listas de proveedores: objetos |
flags
|
secuencia de strings; el valor predeterminado es [] Obsoleto; se quitará. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
cfg
|
el valor predeterminado es None Configuración del atributo. Puede ser "exec" , que indica que la dependencia se compila para execution platform , o "target" , que indica que la dependencia se compila para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, donde target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows .
|
aspects
|
secuencia de Aspect; el valor predeterminado es [] Aspectos que se deben aplicar a la dependencia o dependencias especificadas por este atributo. |
salida
Attribute attr.output(doc=None, mandatory=False)
Crea un esquema para un atributo de salida (etiqueta).
Este atributo contiene valores Label
únicos. Si se proporciona una string en lugar de un Label
, se convertirá mediante el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con un nombre nuevo), se resuelven con respecto al paquete del destino con instancia.
En el momento del análisis, el File
correspondiente se puede recuperar con ctx.outputs
.
Parámetros
Parámetro | Descripción |
---|---|
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
output_list
Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)Crea un esquema para un atributo de lista de resultados.
Este atributo contiene valores Label
únicos. Si se proporciona una string en lugar de un Label
, se convertirá mediante el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con un nombre nuevo), se resuelven con respecto al paquete del destino con instancia.
En el momento del análisis, el File
correspondiente se puede recuperar con ctx.outputs
.
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
cadena
Attribute attr.string(default='', doc=None, mandatory=False, values=[])Crea un esquema para un atributo string.
Parámetros
Parámetro | Descripción |
---|---|
default
|
string; o NativeComputedDefault; el valor predeterminado es '' Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
values
|
secuencia de strings; el valor predeterminado es [] La lista de valores permitidos para el atributo. Si se proporciona otro valor, se genera un error. |
string_dict
Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)Crea un esquema para un atributo que contiene un diccionario, en el que las claves y los valores son cadenas.
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
default
|
el valor predeterminado es {} Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
string_list
Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)Crea un esquema para un atributo de lista de cadenas.
Parámetros
Parámetro | Descripción |
---|---|
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
default
|
secuencia de strings; o NativeComputedDefault; el valor predeterminado es [] Un valor predeterminado que se debe usar si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
string_list_dict
Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)Crea un esquema para un atributo que contiene un diccionario, donde las claves son cadenas y los valores son listas de cadenas.
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True Es verdadero si el atributo puede estar vacío. |
default
|
el valor predeterminado es {} Un valor predeterminado que se usa si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla. |
doc
|
string; o None ; el valor predeterminado es None Es una descripción del atributo que se puede extraer mediante herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor debe especificarse de forma explícita (incluso si tiene un default ).
|