Regras do Python

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

Regras

py_binary

Ver origem da regra 
py_binary(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, exec_compatible_with, exec_properties, features, imports, legacy_create_init, licenses, main, output_licenses, python_version, restricted_to, srcs_version, stamp, tags, target_compatible_with, testonly, toolchains, visibility)

Um py_binary é um programa Python executável que consiste em uma coleção de arquivos de origem .py (que podem pertencer a outras regras py_library), uma árvore de diretórios *.runfiles que contém todo o código e os dados necessários para o programa em tempo de execução e um script stub que inicia o programa com o ambiente e os dados iniciais corretos.

Exemplos

py_binary(
    name = "foo",
    srcs = ["foo.py"],
    data = [":transform"],  # a cc_binary which we invoke at run time
    deps = [
        ":foolib",  # a py_library
    ],
)

Se você quiser executar um py_binary de outro binário ou teste (por exemplo, executar um binário Python para configurar algum recurso simulado de um java_test), a abordagem correta é fazer com que o outro binário ou teste dependa do py_binary na seção de dados. O outro binário pode localizar o py_binary relativo ao diretório de origem. 

py_binary(
    name = "test_main",
    srcs = ["test_main.py"],
    deps = [":testing"],
)

java_library(
    name = "testing",
    srcs = glob(["*.java"]),
    data = [":test_main"]
)

Argumentos

Atributos
name

Nome: obrigatório

Um nome exclusivo para essa segmentação.


Se main não for especificado, ele será igual ao nome do arquivo de origem que é o ponto de entrada principal do aplicativo, sem a extensão. Por exemplo, se o ponto de entrada for chamado de main.py, o nome deverá ser main.
deps

Lista de rótulos. O padrão é [].

A lista de outras bibliotecas a serem vinculadas ao destino binário. Consulte comentários gerais sobre deps em Atributos típicos definidos pela maioria das regras de build. Geralmente, são regras de py_library.
srcs

Lista de marcadores; obrigatório

A lista de arquivos de origem (.py) que são processados para criar o destino. Isso inclui todo o código registrado e os arquivos de origem gerados. Os destinos de biblioteca pertencem a deps, enquanto outros arquivos binários necessários no tempo de execução pertencem a data.
imports

Lista de strings. O padrão é [].

Lista de diretórios de importação a serem adicionados ao PYTHONPATH.

Sujeito à substituição "Criar variável". Esses diretórios de importação serão adicionados a essa regra e a todas as regras que dependem dela (observação: não as regras de que essa regra depende). Cada diretório será adicionado a PYTHONPATH por regras de py_binary que dependem desta regra.

Caminhos absolutos (que começam com /) e caminhos que referenciam um caminho acima da raiz de execução não são permitidos e resultam em um erro.

legacy_create_init

Número inteiro. O padrão é -1.

Se é preciso criar implicitamente arquivos __init__.py vazios na árvore de runfiles. Eles são criados em todos os diretórios que contêm código-fonte Python ou bibliotecas compartilhadas, e em todos os diretórios principais desses diretórios, exceto o diretório raiz do repositório. O padrão, "auto", significa "true", a menos que --incompatible_default_to_explicit_init_py seja usado. Se for "false", o usuário será responsável por criar arquivos __init__.py (possivelmente vazios) e adicioná-los ao srcs de destinos Python, conforme necessário.
main

Rótulo; o padrão é None

O nome do arquivo de origem que é o ponto de entrada principal do aplicativo. Esse arquivo também precisa estar listado em srcs. Se não for especificado, name será usado (veja acima). Se name não corresponder a nenhum nome de arquivo em srcs, main precisará ser especificado.
python_version

String; não configurável; o padrão é "_INTERNAL_SENTINEL"

Se vai criar esse destino (e suas dependências transitivas deps) para Python 2 ou Python 3. Os valores válidos são "PY2" e "PY3" (o padrão).

A versão do Python é sempre redefinida (possivelmente por padrão) para qualquer versão especificada por esse atributo, independente da versão especificada na linha de comando ou por outros destinos mais altos que dependem dela.

Se você quiser select() na versão atual do Python, inspecione o valor de @rules_python//python:python_version. Confira este link para mais informações.

Aviso de bug:esse atributo define a versão para que o Bazel crie seu destino, mas, devido a #4815, o script stub resultante ainda pode invocar a versão errada do interpretador no tempo de execução. Consulte esta solução alternativa, que envolve definir uma meta py_runtime que aponta para qualquer uma das versões do Python conforme necessário e ativar essa py_runtime definindo --python_top.

srcs_version

String; o padrão é "PY2AND3"

Esse atributo declara que o srcs do destino é compatível com Python 2, Python 3 ou ambos. Para definir a versão do ambiente de execução do Python, use o atributo python_version de uma regra executável do Python (py_binary ou py_test).

Os valores permitidos são: "PY2AND3", "PY2" e "PY3". Os valores "PY2ONLY" e "PY3ONLY" também são permitidos por motivos históricos, mas são essencialmente os mesmos que "PY2" e "PY3" e devem ser evitados.

Somente as regras executáveis (py_binary e py_library ) verificam a versão atual do Python em relação ao valor desse atributo. Esse é um recurso. Como o py_library não muda a versão atual do Python, se ele fizesse a validação, seria impossível criar as bibliotecas PY2ONLY e PY3ONLY na mesma invocação. Além disso, se houver uma incompatibilidade de versão, o erro será informado apenas na fase de execução. Em particular, o erro não vai aparecer em uma invocação de bazel build --nobuild.)

Para receber informações de diagnóstico sobre quais dependências introduzem requisitos de versão, execute o aspecto find_requirements na sua meta: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
Isso vai criar um arquivo com o sufixo -pyversioninfo.txt, que informa por que seu destino exige uma versão do Python ou outra. Isso funciona mesmo que o destino especificado não tenha sido criado devido a um conflito de versão.
stamp

Número inteiro. O padrão é -1.

Determina se as informações de build serão codificadas no binário. Valores possíveis:
  • stamp = 1: sempre adicione as informações de build ao binário, mesmo em builds --nostamp. Evite essa configuração, já que ela pode encerrar o armazenamento em cache remoto para o binário e qualquer ação downstream que dependa dele.
  • stamp = 0: sempre substitua as informações de build por valores constantes. Isso oferece um bom cache de resultados de build.
  • stamp = -1: o embedding de informações de build é controlado pela flag --[no]stamp.

Os binários carimbados não são recriados, a menos que as dependências mudem.

py_library

Ver origem da regra 
py_library(name, deps, srcs, data, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, imports, licenses, restricted_to, srcs_version, tags, target_compatible_with, testonly, visibility)

Argumentos

Atributos
name

Nome: obrigatório

Um nome exclusivo para essa segmentação.
deps

Lista de rótulos. O padrão é [].

A lista de outras bibliotecas a serem vinculadas ao destino binário. Consulte comentários gerais sobre deps em Atributos típicos definidos pela maioria das regras de build. Geralmente, são regras de py_library.
srcs

Lista de rótulos. O padrão é [].

A lista de arquivos de origem (.py) que são processados para criar o destino. Isso inclui todo o código registrado e os arquivos de origem gerados.
imports

Lista de strings. O padrão é [].

Lista de diretórios de importação a serem adicionados ao PYTHONPATH.

Sujeito à substituição "Criar variável". Esses diretórios de importação serão adicionados a essa regra e a todas as regras que dependem dela (observação: não as regras de que essa regra depende). Cada diretório será adicionado a PYTHONPATH por regras de py_binary que dependem desta regra.

Caminhos absolutos (que começam com /) e caminhos que referenciam um caminho acima da raiz de execução não são permitidos e resultam em um erro.

srcs_version

String; o padrão é "PY2AND3"

Esse atributo declara que o srcs do destino é compatível com Python 2, Python 3 ou ambos. Para definir a versão do ambiente de execução do Python, use o atributo python_version de uma regra executável do Python (py_binary ou py_test).

Os valores permitidos são: "PY2AND3", "PY2" e "PY3". Os valores "PY2ONLY" e "PY3ONLY" também são permitidos por motivos históricos, mas são essencialmente os mesmos que "PY2" e "PY3" e devem ser evitados.

Somente as regras executáveis (py_binary e py_library ) verificam a versão atual do Python em relação ao valor desse atributo. Esse é um recurso. Como o py_library não muda a versão atual do Python, se ele fizesse a validação, seria impossível criar as bibliotecas PY2ONLY e PY3ONLY na mesma invocação. Além disso, se houver uma incompatibilidade de versão, o erro será informado apenas na fase de execução. Em particular, o erro não vai aparecer em uma invocação de bazel build --nobuild.)

Para receber informações de diagnóstico sobre quais dependências introduzem requisitos de versão, execute o aspecto find_requirements na sua meta: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
Isso vai criar um arquivo com o sufixo -pyversioninfo.txt, que informa por que seu destino exige uma versão do Python ou outra. Isso funciona mesmo que o destino especificado não tenha sido criado devido a um conflito de versão.

py_test

Ver origem da regra 
py_test(name, deps, srcs, data, args, compatible_with, deprecation, distribs, env, env_inherit, exec_compatible_with, exec_properties, features, flaky, imports, legacy_create_init, licenses, local, main, python_version, restricted_to, shard_count, size, srcs_version, stamp, tags, target_compatible_with, testonly, timeout, toolchains, visibility)

Uma regra py_test() compila um teste. Um teste é um wrapper binário em torno de algum código de teste.

Exemplos

py_test(
    name = "runtest_test",
    srcs = ["runtest_test.py"],
    deps = [
        "//path/to/a/py/library",
    ],
)

Também é possível especificar um módulo principal:

py_test(
    name = "runtest_test",
    srcs = [
        "runtest_main.py",
        "runtest_lib.py",
    ],
    main = "runtest_main.py",
)

Argumentos

Atributos
name

Nome: obrigatório

Um nome exclusivo para essa segmentação.
deps

Lista de rótulos. O padrão é [].

A lista de outras bibliotecas a serem vinculadas ao destino binário. Consulte comentários gerais sobre deps em Atributos típicos definidos pela maioria das regras de build. Geralmente, são regras de py_library.
srcs

Lista de marcadores; obrigatório

A lista de arquivos de origem (.py) que são processados para criar o destino. Isso inclui todo o código registrado e os arquivos de origem gerados. Os destinos de biblioteca pertencem a deps, enquanto outros arquivos binários necessários no tempo de execução pertencem a data.
imports

Lista de strings. O padrão é [].

Lista de diretórios de importação a serem adicionados ao PYTHONPATH.

Sujeito à substituição "Criar variável". Esses diretórios de importação serão adicionados a essa regra e a todas as regras que dependem dela (observação: não as regras de que essa regra depende). Cada diretório será adicionado a PYTHONPATH por regras de py_binary que dependem desta regra.

Caminhos absolutos (que começam com /) e caminhos que referenciam um caminho acima da raiz de execução não são permitidos e resultam em um erro.

legacy_create_init

Número inteiro. O padrão é -1.

Se é preciso criar implicitamente arquivos __init__.py vazios na árvore de runfiles. Eles são criados em todos os diretórios que contêm código-fonte Python ou bibliotecas compartilhadas, e em todos os diretórios principais desses diretórios, exceto o diretório raiz do repositório. O padrão, "auto", significa "true", a menos que --incompatible_default_to_explicit_init_py seja usado. Se for "false", o usuário será responsável por criar arquivos __init__.py (possivelmente vazios) e adicioná-los ao srcs de destinos Python, conforme necessário.
main

Rótulo; o padrão é None

O nome do arquivo de origem que é o ponto de entrada principal do aplicativo. Esse arquivo também precisa estar listado em srcs. Se não for especificado, name será usado (veja acima). Se name não corresponder a nenhum nome de arquivo em srcs, main precisará ser especificado.
python_version

String; não configurável; o padrão é "_INTERNAL_SENTINEL"

Se vai criar esse destino (e suas dependências transitivas deps) para Python 2 ou Python 3. Os valores válidos são "PY2" e "PY3" (o padrão).

A versão do Python é sempre redefinida (possivelmente por padrão) para qualquer versão especificada por esse atributo, independente da versão especificada na linha de comando ou por outros destinos mais altos que dependem dela.

Se você quiser select() na versão atual do Python, inspecione o valor de @rules_python//python:python_version. Confira este link para mais informações.

Aviso de bug:esse atributo define a versão para que o Bazel crie seu destino, mas, devido a #4815, o script stub resultante ainda pode invocar a versão errada do interpretador no tempo de execução. Consulte esta solução alternativa, que envolve definir uma meta py_runtime que aponta para qualquer uma das versões do Python conforme necessário e ativar essa py_runtime definindo --python_top.

srcs_version

String; o padrão é "PY2AND3"

Esse atributo declara que o srcs do destino é compatível com Python 2, Python 3 ou ambos. Para definir a versão do ambiente de execução do Python, use o atributo python_version de uma regra executável do Python (py_binary ou py_test).

Os valores permitidos são: "PY2AND3", "PY2" e "PY3". Os valores "PY2ONLY" e "PY3ONLY" também são permitidos por motivos históricos, mas são essencialmente os mesmos que "PY2" e "PY3" e devem ser evitados.

Somente as regras executáveis (py_binary e py_library ) verificam a versão atual do Python em relação ao valor desse atributo. Esse é um recurso. Como o py_library não muda a versão atual do Python, se ele fizesse a validação, seria impossível criar as bibliotecas PY2ONLY e PY3ONLY na mesma invocação. Além disso, se houver uma incompatibilidade de versão, o erro será informado apenas na fase de execução. Em particular, o erro não vai aparecer em uma invocação de bazel build --nobuild.)

Para receber informações de diagnóstico sobre quais dependências introduzem requisitos de versão, execute o aspecto find_requirements na sua meta: 

          bazel build <your target> \
              --aspects=@rules_python//python:defs.bzl%find_requirements \
              --output_groups=pyversioninfo
Isso vai criar um arquivo com o sufixo -pyversioninfo.txt, que informa por que seu destino exige uma versão do Python ou outra. Isso funciona mesmo que o destino especificado não tenha sido criado devido a um conflito de versão.
stamp

Número inteiro. O padrão é 0.

Consulte a seção sobre argumentos py_binary(), exceto que o argumento "stamp" é definido como 0 por padrão para testes.

py_runtime

Ver origem da regra 
py_runtime(name, bootstrap_template, compatible_with, coverage_tool, deprecation, distribs, features, files, interpreter, interpreter_path, licenses, python_version, restricted_to, stub_shebang, tags, target_compatible_with, testonly, visibility)

Representa um ambiente de execução do Python usado para executar código Python.

Um destino py_runtime pode representar um ambiente de execução da plataforma ou um ambiente de execução no build. Um ambiente de execução de plataforma acessa um interpretador instalado pelo sistema em um caminho conhecido, enquanto um ambiente de execução no build aponta para um destino executável que atua como o interpretador. Em ambos os casos, um "interpretador" significa qualquer binário executável ou script wrapper capaz de executar um script Python transmitido na linha de comando, seguindo as mesmas convenções do interpretador CPython padrão.

Um ambiente de execução de plataforma é não hermético por natureza. Ela impõe um requisito à plataforma de destino para ter um intérprete localizado em um caminho específico. Um ambiente de execução integrado pode ou não ser hermético, dependendo se ele aponta para um intérprete verificado ou um script de wrapper que acessa o intérprete do sistema.

Exemplo:

py_runtime(
    name = "python-2.7.12",
    files = glob(["python-2.7.12/**"]),
    interpreter = "python-2.7.12/bin/python",
)

py_runtime(
    name = "python-3.6.0",
    interpreter_path = "/opt/pyenv/versions/3.6.0/bin/python",
)

Argumentos

Atributos
name

Nome: obrigatório

Um nome exclusivo para essa segmentação.
bootstrap_template

Rótulo; o padrão é "@bazel_tools//tools/python:python_bootstrap_template.txt"

Antes chamado de "script stub do Python", esse é o ponto de entrada para cada destino executável do Python.
coverage_tool

Rótulo; o padrão é None

É uma meta usada para coletar informações de cobertura de código das metas py_binary e py_test.

Se definido, o destino precisa produzir um único arquivo ou ser um destino executável. O caminho para o arquivo único ou o executável, se o destino for executável, determina o ponto de entrada para a ferramenta de cobertura do Python. O destino e os arquivos de execução dele serão adicionados aos arquivos de execução quando a cobertura for ativada.

O ponto de entrada da ferramenta precisa ser carregável por um interpretador Python (por exemplo, um arquivo .py ou .pyc). Ele precisa aceitar os argumentos da linha de comando de coverage.py, incluindo pelo menos os subcomandos run e lcov.

files

Lista de rótulos. O padrão é [].

Para um ambiente de execução no build, esse é o conjunto de arquivos que o compõem. Esses arquivos serão adicionados aos runfiles de binários Python que usam esse ambiente de execução. Para um ambiente de execução de plataforma, esse atributo não pode ser definido.
interpreter

Rótulo; o padrão é None

Para um ambiente de execução no build, esse é o destino a ser invocado como o interpretador. Para um ambiente de execução de plataforma, esse atributo não pode ser definido.
interpreter_path

String; o padrão é ""

Para um ambiente de execução de plataforma, esse é o caminho absoluto de um interpretador Python na plataforma de destino. Para um ambiente de execução integrado, esse atributo não pode ser definido.
python_version

String; o padrão é "_INTERNAL_SENTINEL"

Indica se este ambiente de execução é para a versão principal 2 ou 3 do Python. Os valores válidos são "PY2" e "PY3".

O valor padrão é controlado pela flag --incompatible_py3_is_default. No entanto, no futuro, esse atributo será obrigatório e não terá um valor padrão.

stub_shebang

String; o padrão é "#!/usr/bin/env python3"

Expressão "Shebang" adicionada ao script Python de bootstrap usado ao executar destinos py_binary.

Consulte o problema 8685 para entender a motivação.

Não se aplica ao Windows.