Reglas
py_binary
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)
Un py_binary
es un programa ejecutable de Python que consta de una colección de archivos fuente .py
(posibles que pertenecen a otras reglas py_library
), un árbol de directorios *.runfiles
que contiene todo el código y los datos que necesita el programa en el tiempo de ejecución y una secuencia de comandos de stub que inicia el programa con el entorno y los datos iniciales correctos.
Ejemplos
py_binary( name = "foo", srcs = ["foo.py"], data = [":transform"], # a cc_binary which we invoke at run time deps = [ ":foolib", # a py_library ], )
Si deseas ejecutar un py_binary
desde otro objeto binario o prueba (por ejemplo, ejecutar un objeto binario de Python para configurar algún recurso simulado desde una java_test), el enfoque correcto es hacer que el otro objeto binario o prueba dependa del py_binary
en su sección de datos. El otro objeto binario puede ubicar el py_binary
en relación con el directorio del código fuente.
py_binary( name = "test_main", srcs = ["test_main.py"], deps = [":testlib"], ) java_library( name = "testing", srcs = glob(["*.java"]), data = [":test_main"] )
Argumentos
Atributos | |
---|---|
name |
Un nombre único para este destino. Si no se especifica main , debe ser el mismo que el nombre del archivo de origen que es el punto de entrada principal de la aplicación, menos la extensión. Por ejemplo, si tu punto de entrada se llama main.py , tu nombre debe ser main .
|
deps
|
deps en
Atributos típicos definidos por la mayoría de las reglas de compilación.
Por lo general, son reglas de py_library .
|
srcs
|
.py ) que se procesan para crear el destino.
Esto incluye todo el código de registro y los archivos fuente generados. Los destinos de biblioteca pertenecen a deps , mientras que los otros archivos binarios necesarios en el tiempo de ejecución pertenecen a data .
|
imports
|
PYTHONPATH .
Sujeto a la sustitución "Make variable". Se agregarán estos directorios de importación para esta regla y todas las reglas que dependan de ella (nota: no son las reglas de las que depende esta regla. Las reglas de
No se permiten las rutas de acceso absolutas (que comienzan con |
legacy_create_init
|
--incompatible_default_to_explicit_init_py . Si es falso, el usuario es responsable de crear archivos __init__.py (posiblemente vacíos) y agregarlos al srcs de los destinos de Python según sea necesario.
|
main
|
srcs . Si no se especifica, se usa name en su lugar (consulta la sección anterior). Si name no coincide con ningún nombre de archivo en srcs , se debe especificar main .
|
python_version
|
deps transitivo) para Python 2 o Python 3. Los valores válidos son "PY2" y "PY3" (el valor predeterminado).
La versión de Python siempre se restablece (posiblemente de forma predeterminada) a la versión que especifique este atributo, sin importar la versión especificada en la línea de comandos o por otros destinos superiores que dependan de este. Si deseas usar Advertencia de error: Este atributo establece la versión para la que Bazel compila tu destino. Sin embargo, debido a #4815, es posible que la secuencia de comandos de stub resultante aún invoque la versión incorrecta del intérprete en el entorno de ejecución. Consulta esta solución alternativa, que implica definir un destino |
srcs_version
|
srcs del destino es compatible con Python 2, Python 3 o ambos. Para configurar realmente la versión del entorno de ejecución de Python, usa el atributo python_version de una regla ejecutable de Python (py_binary o py_test ).
Los valores permitidos son Ten en cuenta que solo las reglas ejecutables ( Para obtener información de diagnóstico sobre qué dependencias presentan requisitos de versión, puedes ejecutar el aspecto bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfoDe esta manera, se compilará un archivo con el sufijo -pyversioninfo.txt que brinda información sobre por qué el destino requiere una versión de Python. Ten en cuenta que funciona incluso si el destino determinado no se pudo compilar debido a un conflicto de versión.
|
stamp
|
Los objetos binarios sellados no se vuelven a compilar, a menos que cambien sus dependencias. |
py_library
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 |
Un nombre único para este destino. |
deps
|
deps en
Atributos típicos definidos por la mayoría de las reglas de compilación.
Por lo general, son reglas de py_library .
|
srcs
|
.py ) que se procesan para crear el destino.
Esto incluye todo el código de registro y los archivos fuente generados.
|
imports
|
PYTHONPATH .
Sujeto a la sustitución "Make variable". Se agregarán estos directorios de importación para esta regla y todas las reglas que dependan de ella (nota: no son las reglas de las que depende esta regla. Las reglas de
No se permiten las rutas de acceso absolutas (que comienzan con |
srcs_version
|
srcs del destino es compatible con Python 2, Python 3 o ambos. Para configurar realmente la versión del entorno de ejecución de Python, usa el atributo python_version de una regla ejecutable de Python (py_binary o py_test ).
Los valores permitidos son Ten en cuenta que solo las reglas ejecutables ( Para obtener información de diagnóstico sobre qué dependencias presentan requisitos de versión, puedes ejecutar el aspecto bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfoDe esta manera, se compilará un archivo con el sufijo -pyversioninfo.txt que brinda información sobre por qué el destino requiere una versión de Python. Ten en cuenta que funciona incluso si el destino determinado no se pudo compilar debido a un conflicto de versión.
|
py_test
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)
Una regla py_test()
compila una prueba. Una prueba es un wrapper binario alrededor de un código de prueba.
Ejemplos
py_test( name = "runtest_test", srcs = ["runtest_test.py"], deps = [ "//path/to/a/py/library", ], )
También es posible especificar un módulo principal:
py_test( name = "runtest_test", srcs = [ "runtest_main.py", "runtest_lib.py", ], main = "runtest_main.py", )
Argumentos
Atributos | |
---|---|
name |
Un nombre único para este destino. |
deps
|
deps en
Atributos típicos definidos por la mayoría de las reglas de compilación.
Por lo general, son reglas de py_library .
|
srcs
|
.py ) que se procesan para crear el destino.
Esto incluye todo el código de registro y los archivos fuente generados. Los destinos de biblioteca pertenecen a deps , mientras que los otros archivos binarios necesarios en el tiempo de ejecución pertenecen a data .
|
imports
|
PYTHONPATH .
Sujeto a la sustitución "Make variable". Se agregarán estos directorios de importación para esta regla y todas las reglas que dependan de ella (nota: no son las reglas de las que depende esta regla. Las reglas de
No se permiten las rutas de acceso absolutas (que comienzan con |
legacy_create_init
|
--incompatible_default_to_explicit_init_py . Si es falso, el usuario es responsable de crear archivos __init__.py (posiblemente vacíos) y agregarlos al srcs de los destinos de Python según sea necesario.
|
main
|
srcs . Si no se especifica, se usa name en su lugar (consulta la sección anterior). Si name no coincide con ningún nombre de archivo en srcs , se debe especificar main .
|
python_version
|
deps transitivo) para Python 2 o Python 3. Los valores válidos son "PY2" y "PY3" (el valor predeterminado).
La versión de Python siempre se restablece (posiblemente de forma predeterminada) a la versión que especifique este atributo, sin importar la versión especificada en la línea de comandos o por otros destinos superiores que dependan de este. Si deseas usar Advertencia de error: Este atributo establece la versión para la que Bazel compila tu destino. Sin embargo, debido a #4815, es posible que la secuencia de comandos de stub resultante aún invoque la versión incorrecta del intérprete en el entorno de ejecución. Consulta esta solución alternativa, que implica definir un destino |
srcs_version
|
srcs del destino es compatible con Python 2, Python 3 o ambos. Para configurar realmente la versión del entorno de ejecución de Python, usa el atributo python_version de una regla ejecutable de Python (py_binary o py_test ).
Los valores permitidos son Ten en cuenta que solo las reglas ejecutables ( Para obtener información de diagnóstico sobre qué dependencias presentan requisitos de versión, puedes ejecutar el aspecto bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfoDe esta manera, se compilará un archivo con el sufijo -pyversioninfo.txt que brinda información sobre por qué el destino requiere una versión de Python. Ten en cuenta que funciona incluso si el destino determinado no se pudo compilar debido a un conflicto de versión.
|
stamp
|
|
py_runtime
py_runtime(name, 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 un entorno de ejecución de Python que se usa para ejecutar el código de Python.
Un destino py_runtime
puede representar un entorno de ejecución de la plataforma o un entorno de ejecución integrado en la compilación. Un entorno de ejecución de plataforma accede a un intérprete instalado en el sistema en una ruta de acceso conocida, mientras que un entorno de ejecución integrado en la compilación apunta a un destino ejecutable que actúa como intérprete. En ambos casos, “intérprete” se refiere a cualquier secuencia de comandos binaria o wrapper ejecutable que sea capaz de ejecutar una secuencia de comandos de Python pasada en la línea de comandos, siguiendo las mismas convenciones que el intérprete estándar de CPython.
Un entorno de ejecución de plataforma es, por su naturaleza, no hermético. En la plataforma de destino, se impone un requisito que tiene que tener un intérprete ubicado en una ruta de acceso específica. Un entorno de ejecución en la compilación puede ser hermético o no, dependiendo de si apunta a un intérprete registrado o a una secuencia de comandos de wrapper que accede al intérprete del sistema.
Ejemplo:
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 |
Un nombre único para este destino. |
coverage_tool
|
py_binary y py_test .
Si se establece, el destino debe producir un solo archivo o ser un destino ejecutable. La ruta al archivo único, o el ejecutable si el destino es ejecutable, determina el punto de entrada para la herramienta de cobertura de Python. El destino y sus archivos de ejecución se agregarán a los archivos de ejecución cuando se habilite la cobertura. Un intérprete de Python (p.ej., un archivo |
files
|
|
interpreter
|
|
interpreter_path
|
|
python_version
|
"PY2" y "PY3" .
El valor predeterminado se controla con la marca |
stub_shebang
|
py_binary .
Consulta el error 8685 para obtener motivación. No se aplica a Windows. |