Args

Reportar um problema Ver código-fonte Nightly · 7.4 . 7,3 · 7.2 · 7,1 · 7,0 · 6,5

Um objeto que encapsula, com eficiência de memória, os dados necessários para criar parte ou a totalidade de uma linha de comando.

Muitas vezes, uma ação exige uma linha de comando grande com valores acumulados de dependências transitivas. Por exemplo, uma linha de comando do vinculador pode listar todos os arquivos de objeto necessários para todas as bibliotecas vinculadas. É recomendável armazenar esses dados transitivos em depsets para que possam ser compartilhados por vários destinos. No entanto, se o autor da regra precisasse converter esses recursos em listas de strings para construir uma linha de comando de ação, essa otimização de compartilhamento de memória seria invalidada.

Por esse motivo, as funções de construção de ações aceitam objetos Args além de strings. Cada objeto Args representa uma concatenação de strings e depsets, com transformações opcionais para manipular os dados. Os objetos Args não processam as dependências encapsuladas até a fase de execução, quando é preciso calcular a linha de comando. Isso ajuda a adiar cópias caras até que a fase de análise seja concluída. Consulte a página Como otimizar o desempenho para mais informações.

Args são criados chamando ctx.actions.args(). Eles podem ser transmitidos como o parâmetro arguments de ctx.actions.run() ou ctx.actions.run_shell(). Cada mutação de um objeto Args anexa valores à linha de comando eventual.

O recurso map_each permite personalizar como os itens são transformados em strings. Se você não fornecer uma função map_each, a conversão padrão será a seguinte:

  • Os valores que já são strings são mantidos como estão.
  • Objetos File são transformados em seus valores File.path.
  • Os objetos Label são transformados em uma representação de string que retorna ao mesmo objeto quando resolvidos no contexto do repositório principal. Se possível, a representação da string usa o nome aparente de um repositório em favor do nome canônico dele, o que torna essa representação adequada para uso em arquivos BUILD. Embora a forma exata da representação não seja garantida, exemplos típicos são //foo:bar, @repo//foo:bar e @@canonical_name~//foo:bar.bzl.
  • Todos os outros tipos são transformados em strings de maneira não especificada. Por esse motivo, evite transmitir valores que não sejam do tipo string ou File para add(). Se você os transmitir para add_all() ou add_joined(), forneça uma função map_each.

Ao usar a formatação de string (format, format_each e format_joined dos métodos add*()), o modelo de formatação é interpretado da mesma forma que a substituição % em strings, exceto que o modelo precisa ter exatamente um marcador de posição de substituição e precisa ser %s. As porcentagens de literal podem ter escape como %%. A formatação é aplicada depois que o valor é convertido em uma string, conforme mostrado acima.

Cada um dos métodos add*() tem uma forma alternativa que aceita um parâmetro de posicionamento extra, um "nome do argumento". string a ser inserida antes do restante dos argumentos. Para add_all e add_joined, a string extra não será adicionada se a sequência estiver vazia. Por exemplo, o mesmo uso pode adicionar --foo val1 val2 val3 --bar ou apenas --bar à linha de comando, dependendo se a sequência especificada contém val1..val3 ou está vazia.

Se o tamanho da linha de comando ultrapassar o tamanho máximo permitido pelo sistema, os argumentos poderão ser espalhados nos arquivos de parâmetros. Consulte use_param_file() e set_param_file_format().

Exemplo: imagine que você queira gerar a linha de comando: 

--foo foo1.txt foo2.txt ... fooN.txt --bar bar1.txt,bar2.txt,...,barM.txt --baz
Podemos usar o seguinte objeto Args: 
# foo_deps and bar_deps are depsets containing
# File objects for the foo and bar .txt files.
args = ctx.actions.args()
args.add_all("--foo", foo_deps)
args.add_joined("--bar", bar_deps, join_with=",")
args.add("--baz")
ctx.actions.run(
  ...
  arguments = [args],
  ...
)

Membros

adicionar

Args Args.add(arg_name_or_value, value=unbound, *, format=None)

Anexar um argumento a essa linha de comando.

Parâmetros

Parâmetro Descrição
arg_name_or_value obrigatório
Se dois parâmetros de posição forem passados, ele será interpretado como o nome do argumento. O nome do argumento é adicionado antes do valor, sem qualquer processamento. Se apenas um parâmetro posicional for transmitido, ele será interpretado como value (consulte abaixo).
value O padrão é unbound
, o objeto a ser anexado. Ele será convertido em uma string usando a conversão padrão mencionada acima. Como não há um parâmetro map_each para essa função, value precisa ser uma string ou um File. Uma lista, tupla, depset ou diretório File precisa ser transmitido para add_all() ou add_joined() em vez deste método.
format string; ou None o padrão é None
Um padrão de string de formato a ser aplicado à versão em strings de value.

add_all

Args Args.add_all(arg_name_or_values, values=unbound, *, map_each=None, format_each=None, before_each=None, omit_if_empty=True, uniquify=False, expand_directories=True, terminate_with=None, allow_closure=False)

Anexar vários argumentos a essa linha de comando. Os itens são processados de forma lenta durante a fase de execução.

A maior parte do processamento ocorre com base em uma lista de argumentos a serem anexados, de acordo com estas etapas:

  1. Cada item do diretório File é substituído por todos os Files recursivamente contidos nesse diretório.
  2. Se map_each for fornecido, ele será aplicado a cada item, e as listas de strings resultantes serão concatenadas para formar a lista de argumentos iniciais. Caso contrário, a lista inicial de argumentos vai ser o resultado da aplicação da conversão padrão a cada item.
  3. Cada argumento na lista é formatado com format_each, se houver.
  4. Se uniquify for verdadeiro, os argumentos duplicados serão removidos. A primeira ocorrência é a que permanece.
  5. Se uma string before_each for fornecida, ela será inserida como um novo argumento antes de cada argumento atual na lista. Isso dobra efetivamente o número de argumentos a serem anexados a esse ponto.
  6. Exceto no caso de a lista estar vazia e omit_if_empty ser verdadeiro (o padrão), o nome do argumento e terminate_with serão inseridos como o primeiro e o último argumento, respectivamente, se forem fornecidos.
Strings vazias são argumentos válidos que estão sujeitos a todas essas etapas de processamento.

Parâmetros

Parâmetro Descrição
arg_name_or_values obrigatório
Se dois parâmetros de posição forem passados, ele será interpretado como o nome do argumento. O nome do argumento é adicionado antes do values como um argumento separado sem nenhum processamento. Esse nome de argumento não será adicionado se omit_if_empty for verdadeiro (padrão) e nenhum outro item for anexado, como acontece quando values está vazio ou se todos os itens estão filtrados. Se apenas um parâmetro posicional for transmitido, ele será interpretado como values (consulte abaixo).
values sequence; ou depset o padrão é unbound
A lista, a tupla ou o encerramento cujos itens serão anexados.
map_each callable; ou None o padrão é None
Uma função que converte cada item em zero ou mais strings, que podem ser processadas ainda mais antes de anexar. Se esse parâmetro não for fornecido, a conversão padrão será usada.

A função recebe um ou dois argumentos posicionais: o item a ser convertido, seguido por um DirectoryExpander opcional. O segundo argumento só será transmitido se a função fornecida for definida pelo usuário (não integrada) e declarar mais de um parâmetro.

O tipo do valor de retorno depende de quantos argumentos precisam ser produzidos para o item:

  • No caso comum, em que cada item se transforma em uma string, a função precisa retornar essa string.
  • Se o item for totalmente filtrado, a função retornará None.
  • Se o item se transformar em várias strings, a função retornará uma lista delas.
Retornar uma única string ou None tem o mesmo efeito que retornar uma lista de comprimento 1 ou 0, respectivamente. No entanto, é mais eficiente e legível evitar a criação de uma lista onde ela não é necessária.

Normalmente, os itens que são diretórios são expandidos automaticamente para o conteúdo quando expand_directories=True é definido. No entanto, isso não expande diretórios contidos em outros valores, por exemplo, quando os itens são estruturas que têm diretórios como campos. Nessa situação, o argumento DirectoryExpander pode ser aplicado para conseguir manualmente os arquivos de um determinado diretório.

Para evitar a retenção não intencional de grandes estruturas de dados da fase de análise na fase de execução, a função map_each precisa ser declarada por uma instrução def de nível superior. Ela não pode ser um fechamento de função aninhado por padrão.

Aviso: as instruções print() que são executadas durante a chamada para map_each não produzem nenhuma saída visível.

format_each string ou None; o padrão é None
Um padrão de string de formatação opcional, aplicado a cada string retornada pela função map_each. A string de formato precisa ter exatamente um marcador de posição "%s".
before_each string; ou None o padrão é None
Um argumento opcional a ser anexado antes de cada argumento derivado de values.
omit_if_empty O padrão é True
Se verdadeiro, se não houver argumentos derivados de values a serem anexados, todo o processamento adicional será suprimido e a linha de comando não será alterada. Se for false, o nome do argumento e o terminate_with, se fornecidos, ainda serão anexados, independentemente de haver ou não outros argumentos.
uniquify o padrão é False
Se verdadeiro, os argumentos duplicados derivados de values serão omitidos. Somente a primeira ocorrência de cada argumento permanecerá. Normalmente, esse recurso não é necessário porque os depsets já omitem cópias, mas pode ser útil se map_each emitir a mesma string para vários itens.
expand_directories o padrão é True
Se verdadeiro, todos os diretórios em values serão expandidos para uma lista simples de arquivos. Isso acontece antes que map_each seja aplicado.
terminate_with string; ou None o padrão é None
Um argumento opcional que será anexado depois de todos os outros argumentos. Esse argumento não será adicionado se omit_if_empty for verdadeiro (padrão) e nenhum outro item for anexado (como acontece se values estiver vazio ou todos os itens forem filtrados).
allow_closure O padrão é False
Se verdadeiro, permite o uso de fechamentos em parâmetros de função, como map_each. Isso geralmente não é necessário e arrisca manter grandes estruturas de dados na fase de análise na fase de execução.

add_joined

Args Args.add_joined(arg_name_or_values, values=unbound, *, join_with, map_each=None, format_each=None, format_joined=None, omit_if_empty=True, uniquify=False, expand_directories=True, allow_closure=False)

Anexar um argumento a essa linha de comando concatenando vários valores usando um separador. Os itens são processados de forma lenta durante a fase de execução.

O processamento é semelhante ao add_all(), mas a lista de argumentos derivados de values é combinada em um único argumento, como se fosse por join_with.join(...), e formatada usando o modelo de string format_joined fornecido. Ao contrário de add_all(), não há o parâmetro before_each ou terminate_with, já que eles geralmente não são úteis quando os itens são combinados em um único argumento.

Se, após a filtragem, não houver strings para serem agrupadas em um argumento e se omit_if_empty for verdadeiro (padrão), nenhum processamento será feito. Caso contrário, se não houver strings para mesclar, mas omit_if_empty for falso, a string unida será uma string vazia.

Parâmetros

Parâmetro Descrição
arg_name_or_values obrigatório
Se dois parâmetros de posição forem passados, ele será interpretado como o nome do argumento. O nome do argumento é adicionado antes de values sem nenhum processamento. Esse argumento não será adicionado se omit_if_empty for verdadeiro (padrão) e não houver strings derivadas de values para serem combinadas. Isso pode acontecer se values estiver vazio ou se todos os itens dele forem filtrados. Se apenas um parâmetro posicional for transmitido, ele será interpretado como values (consulte abaixo).
values sequence ou depset. O padrão é unbound
. A lista, tupla ou depset cujos itens serão unidos.
join_with obrigatório
Uma string delimitadora usada para unir as strings da aplicação de map_each e format_each, da mesma maneira que string.join().
map_each callable; ou None o padrão é None
O mesmo que em add_all.
format_each string; ou None o padrão é None
Igual a add_all.
format_joined string; ou None o padrão é None
Um padrão de string de formato opcional aplicado à string mesclada. A string de formato precisa ter exatamente um marcador de posição "%s".
omit_if_empty O padrão é True
Se verdadeiro, se não houver strings para serem combinadas (porque values está vazio ou todos os itens foram filtrados), todo o processamento adicional será suprimido e a linha de comando não será alterada. Se for falso, mesmo que não haja strings para unir, dois argumentos serão anexados: o nome do argumento seguido por uma string vazia (que é a junção lógica das strings zero).
uniquify O padrão é False
O mesmo que para add_all.
expand_directories O padrão é True
O mesmo que para add_all.
allow_closure o padrão é False
O mesmo que em add_all.

set_param_file_format

Args Args.set_param_file_format(format)

Define o formato do arquivo de parâmetro, se um for usado

Parâmetros

Parâmetro Descrição
format required
Precisa ser um destes:
  • "multiline": cada item (nome ou valor do argumento) é gravado literalmente no arquivo de parâmetro com um caractere de nova linha após ele.
  • "shell": igual a "multiline", mas os itens são citados como shell
  • "flag_per_line": igual a "multiline", mas (1) somente as flags (começando com '--') são gravadas no arquivo de parâmetro e (2) os valores das flags, se houver, são gravadas na mesma linha com um '=' separador. Esse é o formato esperado pela biblioteca de flags do Abseil.

O formato padrão é "shell". se não for chamado.

use_param_file

Args Args.use_param_file(param_file_arg, *, use_always=False)

Distribui os argumentos para um arquivo de parâmetros, substituindo-os por um ponteiro para o arquivo de parâmetro. Use quando seus argumentos forem grandes demais para os limites de tamanho de comando do sistema.

O Bazel pode optar por ignorar a gravação do arquivo de parâmetros na árvore de saída durante a execução para aumentar a eficiência. Se você estiver depurando ações e quiser inspecionar o arquivo de parâmetro, transmita --materialize_param_files para seu build.

Parâmetros

Parâmetro Descrição
param_file_arg required
Uma string de formato com um único "%s". Se os argumentos forem espalhados para um arquivo params, eles serão substituídos por um argumento que consiste nessa string formatada com o caminho do arquivo params.

Por exemplo, se os argumentos forem transferidos para um arquivo de parâmetros "params.txt", a especificação de "--file=%s" fará com que a linha de comando da ação contenha "--file=params.txt".

use_always o padrão é False
Define se os argumentos devem sempre ser enviados para um arquivo de parâmetros. Se for falso, o Bazel vai decidir se os argumentos precisam ser espalhados com base no sistema e no comprimento do argumento.