Este es un módulo de nivel superior para definir los esquemas de atributos de una regla o un aspecto. Cada función muestra un objeto que representa el esquema de un solo atributo. Estos objetos se usan como valores del argumento del diccionario 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
- output
- output_list
- string
- string_dict
- string_keyed_label_dict
- string_list
- string_list_dict
bool
Attribute attr.bool(default=False, doc=None, mandatory=False)
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
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
int
Attribute attr.int(default=0, doc=None, mandatory=False, values=[])
ctx.attr
correspondiente será del tipo int
.
Parámetros
Parámetro | Descripción |
---|---|
default
|
El valor predeterminado es 0 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
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
values
|
secuencia de int; el valor predeterminado es [] Es la lista de valores permitidos para el atributo. Se genera un error si se proporciona cualquier otro valor. |
int_list
Attribute attr.int_list(mandatory=False, allow_empty=True, *, default=[], doc=None)
Parámetros
Parámetro | Descripción |
---|---|
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar 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 int;
el valor predeterminado es [] 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
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las 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=[], flags=[])
Crea un esquema para un atributo de etiqueta. Este es un atributo de dependencia.
Este atributo contiene valores únicos de Label
. Si se proporciona una cadena en lugar de un Label
, se convertirá con el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente renombrado) se resuelven con respecto al paquete de destino en el que se creó la 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 objetivo actual.
Además de los archivos de origen comunes, este tipo de atributo se usa a menudo 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 este valor predeterminado, puedes establecer el atributo como privado otorgándole un nombre que comience con un guion bajo. Consulta la página Rules para obtener más información.
Parámetros
Parámetro | Descripción |
---|---|
default
|
Etiqueta, cadena, LateBoundDefault, NativeComputedDefault, función o None .
El valor predeterminado es None .Es un valor predeterminado que se usará si no se proporciona un valor para este atributo cuando se crea una instancia de la regla. Usa una cadena o la función Label para especificar un valor predeterminado, por ejemplo, attr.label(default = "//a:b") .
|
doc
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
executable
|
El valor predeterminado es False . Es verdadero si la dependencia debe poder ejecutarse. 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 cadenas; o None ;
El valor predeterminado es None Indica si se permiten los destinos 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 archivo. Accede a él a través de ctx.file.<attribute_name> .
|
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar 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 cadenas o None ;
El valor predeterminado es None Indica qué objetivos de reglas (nombres de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo por motivos de compatibilidad). Usa proveedores en su lugar. |
cfg
|
El valor predeterminado es None . Configuración del atributo. Puede ser "exec" , lo que indica que la dependencia se compiló para execution platform , o "target" , que indica que la dependencia se compiló para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, en las que target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows . Este parámetro es obligatorio si executable es verdadero para evitar la compilación accidental de herramientas de host en la configuración de destino. "target" no tiene efecto semántico, por lo que no debes configurarlo cuando executable sea falso, a menos que realmente ayude a aclarar tus intenciones.
|
aspects
|
Secuencia de Aspectos.
El valor predeterminado es [] . Son los aspectos que se deben aplicar a la o las dependencias especificadas por este atributo. |
flags
|
Secuencia de cadenas.
El valor predeterminado es [] . Está obsoleto y se quitará. |
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, en el que las claves son etiquetas y los valores son cadenas. Este es un atributo de dependencia.
Este atributo contiene valores únicos de Label
. Si se proporciona una cadena en lugar de un Label
, se convertirá con el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con otro nombre), se resuelven en función del paquete del destino al que se le creó una 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 objetivo 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 debe usar si no se proporciona ningún valor para este atributo cuando se crea una instancia de la regla.Usa strings o la función Label para especificar valores predeterminados, por ejemplo, attr.label_keyed_string_dict(default = {"//a:b": "value", "//a:c": "string"}) .
|
doc
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
allow_files
|
bool; o secuencia de cadenas; o None ;
El valor predeterminado es None Indica si se permiten los destinos File . Puede ser True , False (predeterminado) o una lista de extensiones de archivo permitidas (por ejemplo, [".cc", ".cpp"] ).
|
allow_rules
|
Secuencia de cadenas o None ;
El valor predeterminado es None Indica qué objetivos de reglas (nombres de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo por motivos de compatibilidad). Usa proveedores en su lugar. |
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 cadenas.
El valor predeterminado es [] . Está obsoleto y se quitará. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
cfg
|
el valor predeterminado es None Configuración del atributo. Puede ser "exec" , lo que indica que la dependencia se compiló para execution platform , o "target" , que indica que la dependencia se compiló para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, en las que target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows .
|
aspects
|
secuencia de Aspects;
la opción predeterminada es [] Aspectos que deben aplicarse 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 lista de Target
.
Este atributo contiene valores Label
únicos. Si se proporciona una cadena en lugar de un Label
, se convertirá con el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con otro nombre), se resuelven en función del paquete del destino al que se le creó una instancia.
Durante el 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 las 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 Verdadero si el atributo puede estar vacío. |
default
|
secuencia de etiquetas o función;
el valor predeterminado es [] Es un valor predeterminado que se usará 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
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
allow_files
|
bool; o secuencia de cadenas; o None ;
El valor predeterminado es None Indica si se permiten los destinos File . Puede ser True , False (predeterminado) o una lista de extensiones de archivo permitidas (por ejemplo, [".cc", ".cpp"] ).
|
allow_rules
|
Secuencia de cadenas o None ;
El valor predeterminado es None Indica qué objetivos de reglas (nombres de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo por motivos de compatibilidad). Usa proveedores en su lugar. |
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 [] ) Se quitará, ya que es obsoleta. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar 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 compiló para execution platform , o "target" , que indica que la dependencia se compiló para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, en las que target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows .
|
aspects
|
secuencia de Aspects;
la opción predeterminada es [] Aspectos que deben aplicarse a la dependencia o dependencias especificadas por este atributo. |
output
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 cadena en lugar de un Label
, se convertirá con el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con otro nombre), se resuelven en función del paquete del destino al que se le creó una instancia.
En el momento del análisis, se puede recuperar el File
correspondiente 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 con las herramientas de generación de documentación. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
output_list
Attribute attr.output_list(allow_empty=True, *, doc=None, mandatory=False)
Este atributo contiene valores únicos de Label
. Si se proporciona una cadena en lugar de un Label
, se convertirá con el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente con otro nombre), se resuelven en función del paquete del destino al que se le creó una instancia.
En el momento del análisis, se puede recuperar el File
correspondiente 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
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
string
Attribute attr.string(default='', doc=None, mandatory=False, values=[])
Parámetros
Parámetro | Descripción |
---|---|
default
|
cadena; o NativeComputedDefault;
el valor predeterminado es '' Es un valor predeterminado que se usará si no se proporciona un valor para este atributo cuando se crea una instancia de la regla. |
doc
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
values
|
secuencia de cadenas;
el valor predeterminado es [] Es la lista de valores permitidos para el atributo. Se genera un error si se proporciona cualquier otro valor. |
string_dict
Attribute attr.string_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True 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
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|
string_keyed_label_dict
Attribute attr.string_keyed_label_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 cuyo valor es un diccionario en el que las claves son cadenas y los valores son etiquetas. Este es un atributo de dependencia.
Este atributo contiene valores únicos de Label
. Si se proporciona una cadena en lugar de un Label
, se convertirá con el constructor de etiquetas. Las partes relativas de la ruta de acceso de la etiqueta, incluido el repositorio (posiblemente renombrado) se resuelven con respecto al paquete de destino en el que se creó la 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 Verdadero si el atributo puede estar vacío. |
default
|
dict o function;
El valor predeterminado es {} Es un valor predeterminado que se usará 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.string_keyed_label_dict(default = {"foo": "//a:b", "bar": "//a:c"}) .
|
doc
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
allow_files
|
bool; o secuencia de cadenas; o None ;
El valor predeterminado es None Indica si se permiten los destinos File . Puede ser True , False (predeterminado) o una lista de extensiones de archivo permitidas (por ejemplo, [".cc", ".cpp"] ).
|
allow_rules
|
Secuencia de cadenas o None ;
El valor predeterminado es None Indica qué objetivos de reglas (nombres de las clases) se permiten. Esta función dejó de estar disponible (se conserva solo por motivos de compatibilidad). Usa proveedores en su lugar. |
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 cadenas.
El valor predeterminado es [] . Está obsoleto y se quitará. |
mandatory
|
el valor predeterminado es False Si es verdadero, el valor se debe especificar 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 compiló para execution platform , o "target" , que indica que la dependencia se compiló para target platform . Un ejemplo típico de la diferencia es cuando se compilan apps para dispositivos móviles, en las que target platform es Android o iOS , mientras que execution platform es Linux , macOS o Windows .
|
aspects
|
Secuencia de Aspectos.
El valor predeterminado es [] . Son los aspectos que se deben aplicar a la o las dependencias especificadas por este atributo. |
string_list
Attribute attr.string_list(mandatory=False, allow_empty=True, *, default=[], doc=None)
Parámetros
Parámetro | Descripción |
---|---|
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar 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 cadenas; o NativeComputedDefault;
el valor predeterminado es [] Es un valor predeterminado que se usará si no se proporciona un valor para este atributo cuando se crea una instancia de la regla. |
doc
|
cadena; o None ;
el valor predeterminado es None Es una descripción del atributo que pueden extraer las herramientas de generación de documentación. |
string_list_dict
Attribute attr.string_list_dict(allow_empty=True, *, default={}, doc=None, mandatory=False)
Parámetros
Parámetro | Descripción |
---|---|
allow_empty
|
el valor predeterminado es True 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 con las herramientas de generación de documentación. |
mandatory
|
El valor predeterminado es False . Si es verdadero, el valor se debe especificar de forma explícita (incluso si tiene un default ).
|