Reglas
py_binary
Ver el código fuente de la reglapy_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 de origen .py
(que posiblemente pertenezcan a otras reglas py_library
), un árbol de directorio *.runfiles
que contiene todos los datos y el código que necesita el programa en el tiempo de ejecución, y una secuencia de comandos de stub que inicia el programa con el entorno inicial y los datos 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 la prueba dependan de 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 = [":testing"], ) java_library( name = "testing", srcs = glob(["*.java"]), data = [":test_main"] )
Argumentos
Atributos | |
---|---|
name |
Name; obligatorio 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 , entonces tu nombre debería ser main .
|
deps
|
Lista de etiquetas; el valor predeterminado es 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
|
Lista de etiquetas; obligatorio La lista de archivos de origen (.py ) que se procesan para crear el destino.
Esto incluye todo el código subido y cualquier archivo fuente generado. Los destinos de la biblioteca pertenecen a deps , mientras que otros archivos binarios necesarios en el tiempo de ejecución pertenecen a data .
|
imports
|
Lista de cadenas; el valor predeterminado es PYTHONPATH .
Sujeto a la sustitución "Make variable". Estos directorios de importación se agregarán para esta regla y todas las reglas que dependen de ella (nota: no son las reglas de las que depende esta regla. Las reglas
No se permiten las rutas de acceso absolutas (las que comienzan con |
legacy_create_init
|
Número entero; el valor predeterminado es --incompatible_default_to_explicit_init_py . Si es falso, el usuario es responsable de crear (posiblemente vacíos) archivos __init__.py y de agregarlos a la srcs de los objetivos de Python según sea necesario.
|
main
|
Etiqueta; el valor predeterminado es 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 de srcs , se debe especificar main .
|
python_version
|
String; no configurable; el valor predeterminado es 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 cualquier 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 ejecutar Advertencia de error: Este atributo establece la versión para la que Bazel compila tu destino,
pero, debido a #4815, la
secuencia de comandos de stub resultante aún puede invocar la versión de intérprete incorrecta en el tiempo de ejecución. Consulta esta solución alternativa, que implica definir un destino |
srcs_version
|
String; el valor predeterminado es 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 introducen 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 proporcionará información
sobre por qué tu destino requiere una versión de Python u otra. Ten en cuenta que funciona incluso si el destino en cuestión no se pudo compilar debido a un conflicto de versiones.
|
stamp
|
Número entero; el valor predeterminado es
Los objetos binarios sellados no se vuelven a compilar, a menos que cambien sus dependencias. |
py_library
Ver el código fuente de la reglapy_library(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)
Argumentos
Atributos | |
---|---|
name |
Name; obligatorio Un nombre único para este destino. |
py_test
Ver el código fuente de la reglapy_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 para algún 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 |
Name; obligatorio Un nombre único para este destino. |
deps
|
Lista de etiquetas; el valor predeterminado es 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
|
Lista de etiquetas; obligatorio La lista de archivos de origen (.py ) que se procesan para crear el destino.
Esto incluye todo el código subido y cualquier archivo fuente generado. Los destinos de la biblioteca pertenecen a deps , mientras que otros archivos binarios necesarios en el tiempo de ejecución pertenecen a data .
|
imports
|
Lista de cadenas; el valor predeterminado es PYTHONPATH .
Sujeto a la sustitución "Make variable". Estos directorios de importación se agregarán para esta regla y todas las reglas que dependen de ella (nota: no son las reglas de las que depende esta regla. Las reglas
No se permiten las rutas de acceso absolutas (las que comienzan con |
legacy_create_init
|
Número entero; el valor predeterminado es --incompatible_default_to_explicit_init_py . Si es falso, el usuario es responsable de crear (posiblemente vacíos) archivos __init__.py y de agregarlos a la srcs de los objetivos de Python según sea necesario.
|
main
|
Etiqueta; el valor predeterminado es 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 de srcs , se debe especificar main .
|
python_version
|
String; no configurable; el valor predeterminado es 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 cualquier 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 ejecutar Advertencia de error: Este atributo establece la versión para la que Bazel compila tu destino,
pero, debido a #4815, la
secuencia de comandos de stub resultante aún puede invocar la versión de intérprete incorrecta en el tiempo de ejecución. Consulta esta solución alternativa, que implica definir un destino |
srcs_version
|
String; el valor predeterminado es 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 introducen 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 proporcionará información
sobre por qué tu destino requiere una versión de Python u otra. Ten en cuenta que funciona incluso si el destino en cuestión no se pudo compilar debido a un conflicto de versiones.
|
stamp
|
Número entero; el valor predeterminado es |
py_runtime
Ver el código fuente de la reglapy_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 un entorno de ejecución de Python que se usa para ejecutar un código de Python.
Un destino py_runtime
puede representar un entorno de ejecución de la plataforma o un entorno de ejecución en la compilación. Un entorno de ejecución de la plataforma accede a un intérprete instalado por el sistema en una ruta de acceso conocida, mientras que un entorno de ejecución en compilación apunta a un destino ejecutable que actúa como intérprete. En ambos casos, “interpretador” se refiere a cualquier objeto binario ejecutable o secuencia de comandos de wrapper capaz de ejecutar una secuencia de comandos de Python pasada en la línea de comandos, siguiendo las mismas convenciones que el intérprete de CPython estándar.
Por naturaleza, el entorno de ejecución de una plataforma no es hermético. Impone el requisito de que la plataforma de destino tenga un intérprete ubicado en una ruta de acceso específica. Un entorno de ejecución integrado puede ser hermético o no, según si apunta a un intérprete registrado o a una secuencia de comandos 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 |
Name; obligatorio Un nombre único para este destino. |
bootstrap_template
|
Etiqueta; el valor predeterminado es |
coverage_tool
|
Etiqueta; el valor predeterminado es py_binary y py_test .
Si se configura, el destino debe producir un solo archivo o ser un destino ejecutable. La ruta de acceso al archivo único, o al 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
|
Lista de etiquetas; el valor predeterminado es |
interpreter
|
Etiqueta; el valor predeterminado es |
interpreter_path
|
String; el valor predeterminado es |
python_version
|
String; el valor predeterminado es "PY2" y "PY3" .
La marca |
stub_shebang
|
String; el valor predeterminado es py_binary .
Consulta el problema 8685 para obtener motivación. No se aplica a Windows. |