Reglas de Python

Denuncia un problema Ver fuente Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Reglas

py_binary
py_library
py_test
py_runtime

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 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 un java_test), el enfoque correcto es hacer que el otro objeto binario o prueba dependa 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 objetivo. Si no se especifica `main`, este 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 `[]` Es la lista de otras bibliotecas que se vincularán al objetivo binario. Consulta los comentarios generales sobre `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 que hayas confirmado y los archivos fuente generados. Los destinos de bibliotecas pertenecen a `deps`, mientras que otros archivos binarios necesarios en el tiempo de ejecución pertenecen a `data`.
`imports`	Es una lista de cadenas. El valor predeterminado es `[]`. Lista de directorios de importación que se agregarán a `PYTHONPATH`. Sujeto a la sustitución de "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. Cada directorio se agregará a `PYTHONPATH` mediante las reglas `py_binary` que dependen de esta regla. No se permiten las rutas de acceso absolutas (rutas que comienzan con `/`) ni las que hacen referencia a una ruta que está por encima de la raíz de ejecución, ya que se producirá un error.
`legacy_create_init`	Número entero; el valor predeterminado es `-1` Establece si se deben crear implícitamente archivos __init__.py vacíos en el árbol de archivos runfiles. Se crean en todos los directorios que contienen el código fuente de Python o las bibliotecas compartidas, y en todos los directorios superiores de esos directorios, excepto el directorio raíz del repositorio. El valor predeterminado, automático, significa verdadero, a menos que se use `--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`	Etiqueta; el valor predeterminado es `None` El nombre del archivo fuente que es el punto de entrada principal de la aplicación. Este archivo también debe estar incluido en `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`	Cadena; no configurable; el valor predeterminado es `"_INTERNAL_SENTINEL"` Si se debe compilar este destino (y su `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 `select()` en la versión actual de Python, puedes inspeccionar el valor de `@rules_python//python:python_version`. Consulta este vínculo para obtener más información. Advertencia de errores: Este atributo establece la versión para la que Bazel compila tu objetivo, pero debido al error #4815, la secuencia de comandos de stub resultante aún puede invocar la versión incorrecta del intérprete durante el tiempo de ejecución. Consulta esta solución, que implica definir un objetivo `py_runtime` que apunte a la versión de Python según sea necesario y activar este `py_runtime` configurando `--python_top`.
`srcs_version`	String; el valor predeterminado es `"PY2AND3"` Este atributo declara que el `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 `"PY2AND3"`, `"PY2"` y `"PY3"`. Los valores `"PY2ONLY"` y `"PY3ONLY"` también se permiten por razones históricas, pero son, en esencia, los mismos que `"PY2"` y `"PY3"`, y se deben evitar. Ten en cuenta que solo las reglas ejecutables (`py_binary` y `py_library`) verifican la versión actual de Python con el valor de este atributo. (Esta es una función, ya que `py_library` no cambia la versión actual de Python. Si hiciera la validación, sería imposible compilar las bibliotecas `PY2ONLY` y `PY3ONLY` en la misma invocación). Además, si hay una discrepancia de versión, el error solo se informa en la fase de ejecución. En particular, el error no aparecerá en una invocación `bazel build --nobuild`). Para obtener información de diagnóstico sobre qué dependencias introducen requisitos de versión, puedes ejecutar el aspecto `find_requirements` en tu destino: bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo Esto compilará un archivo con el sufijo `-pyversioninfo.txt` que brindará 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 `-1`) Establece si se debe codificar información de compilación en el objeto binario. Valores posibles: `stamp = 1`: Siempre marca la información de compilación en el binario, incluso en las compilaciones de `--nostamp`. Se debe evitar este parámetro de configuración, ya que puede finalizar la caché remota del binario y cualquier acción descendente que dependa de ella. `stamp = 0`: Siempre reemplaza la información de compilación por valores constantes. Esto proporciona una buena almacenamiento en caché de resultados de compilación. `stamp = -1`: La marca `--[no]stamp` controla la incorporación de la información de compilación. Los objetos binarios estampados no se vuelven a compilar, a menos que cambien sus dependencias.

py_library

Ver la fuente de la regla

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`	Name; obligatorio Un nombre único para este objetivo.
`deps`	Lista de etiquetas; el valor predeterminado es `[]` Es la lista de otras bibliotecas que se vincularán al destino binario. Consulta los comentarios generales sobre `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; el valor predeterminado es `[]` La lista de archivos de origen (`.py`) que se procesan para crear el destino. Esto incluye todo el código que hayas confirmado y los archivos fuente generados.
`imports`	Lista de cadenas; el valor predeterminado es `[]` Lista de directorios de importación que se agregarán a `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. Cada directorio se agregará a `PYTHONPATH` mediante las reglas `py_binary` que dependen de esta regla. No se permiten las rutas de acceso absolutas (que comienzan con `/`) ni las que hacen referencia a una ruta de acceso superior a la raíz de ejecución, ya que se producirá un error.
`srcs_version`	String; el valor predeterminado es `"PY2AND3"` Este atributo declara que el `srcs` del destino es compatible con Python 2, Python 3 o ambos. Para establecer 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 `"PY2AND3"`, `"PY2"` y `"PY3"`. Los valores `"PY2ONLY"` y `"PY3ONLY"` también se permiten por razones históricas, pero son, en esencia, los mismos que `"PY2"` y `"PY3"`, y se deben evitar. Ten en cuenta que solo las reglas ejecutables (`py_binary` y `py_library`) verifican la versión actual de Python con el valor de este atributo. (Esta es una función, ya que `py_library` no cambia la versión actual de Python. Si hiciera la validación, sería imposible compilar las bibliotecas `PY2ONLY` y `PY3ONLY` en la misma invocación). Además, si hay una discrepancia de versión, el error solo se informa en la fase de ejecución. En particular, el error no aparecerá en una invocación `bazel build --nobuild`). Para obtener información de diagnóstico sobre qué dependencias generan requisitos de versión, puedes ejecutar el aspecto `find_requirements` en tu destino: bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo Se compilará un archivo con el sufijo `-pyversioninfo.txt` que proporcionará información sobre por qué tu destino requiere una versión de Python o otra. Ten en cuenta que funciona incluso si el destino en cuestión no se pudo compilar debido a un conflicto de versiones.

py_test

Ver el origen de la regla

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`	Nombre: Obligatorio Un nombre único para este objetivo.
`deps`	Lista de etiquetas; el valor predeterminado es `[]` Es la lista de otras bibliotecas que se vincularán al destino binario. Consulta los comentarios generales sobre `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 Es la lista de archivos de origen (`.py`) que se procesan para crear el destino. Esto incluye todo el código que hayas confirmado y los archivos fuente generados. Los destinos de la biblioteca pertenecen a `deps`, mientras que otros archivos binarios necesarios en el tiempo de ejecución pertenecen a `data`.
`imports`	Es una lista de cadenas. El valor predeterminado es `[]`. Es la lista de directorios de importación que se agregarán a `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 las reglas de las que depende esta regla). Las reglas `py_binary` que dependen de esta regla agregarán cada directorio a `PYTHONPATH`. No se permiten las rutas de acceso absolutas (que comienzan con `/`) ni las que hacen referencia a una ruta de acceso superior a la raíz de ejecución, ya que se producirá un error.
`legacy_create_init`	Número entero; el valor predeterminado es `-1` Establece si se deben crear implícitamente archivos __init__.py vacíos en el árbol de archivos runfiles. Se crean en todos los directorios que contienen el código fuente de Python o las bibliotecas compartidas, y en todos los directorios superiores de esos directorios, excepto el directorio raíz del repositorio. El valor predeterminado, automático, significa verdadero, a menos que se use `--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 `None` El nombre del archivo fuente que es el punto de entrada principal de la aplicación. Este archivo también debe estar incluido en `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 `"_INTERNAL_SENTINEL"` Establece si se debe compilar este destino (y su `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 `select()` en la versión actual de Python, puedes inspeccionar el valor de `@rules_python//python:python_version`. Consulta aquí para obtener más información. Advertencia de errores: Este atributo establece la versión para la que Bazel compila tu objetivo, pero debido al error #4815, la secuencia de comandos de stub resultante aún puede invocar la versión incorrecta del intérprete durante el tiempo de ejecución. Consulta esta solución, que implica definir un objetivo `py_runtime` que apunte a la versión de Python según sea necesario y activar este `py_runtime` configurando `--python_top`.
`srcs_version`	String; el valor predeterminado es `"PY2AND3"` Este atributo declara que el `srcs` del destino es compatible con Python 2, Python 3 o ambos. Para establecer 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 `"PY2AND3"`, `"PY2"` y `"PY3"`. Los valores `"PY2ONLY"` y `"PY3ONLY"` también se permiten por razones históricas, pero, en esencia, son los mismos que `"PY2"` y `"PY3"`, y deben evitarse. Ten en cuenta que solo las reglas ejecutables (`py_binary` y `py_library`) verifican la versión actual de Python con el valor de este atributo. (Esta es una función, ya que `py_library` no cambia la versión actual de Python. Si hiciera la validación, sería imposible compilar las bibliotecas `PY2ONLY` y `PY3ONLY` en la misma invocación). Además, si hay una discrepancia de versión, el error solo se informa en la fase de ejecución. En particular, el error no aparecerá en una invocación `bazel build --nobuild`). Para obtener información de diagnóstico sobre qué dependencias introducen requisitos de versión, puedes ejecutar el aspecto `find_requirements` en tu destino: bazel build <your target> \ --aspects=@rules_python//python:defs.bzl%find_requirements \ --output_groups=pyversioninfo Esto compilará un archivo con el sufijo `-pyversioninfo.txt` que brindará información sobre por qué tu destino requiere una versión de Python u otra. Ten en cuenta que funciona incluso si no se pudo compilar el destino determinado debido a un conflicto de versiones.
`stamp`	Número entero (el valor predeterminado es `0`) Consulta la sección sobre los argumentos de py_binary(), excepto que el argumento de sello se establece en 0 de forma predeterminada para las pruebas.

py_runtime

Ver la fuente de la regla

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 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 integrado. 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 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`	Name; obligatorio Un nombre único para este objetivo.
`bootstrap_template`	Etiqueta; el valor predeterminado es `"@bazel_tools//tools/python:python_bootstrap_template.txt"` Antes conocida como la “secuencia de comandos stub de Python”, este es el punto de entrada a cada destino ejecutable de Python.
`coverage_tool`	Etiqueta; el valor predeterminado es `None` Este es un destino que se usa para recopilar información de cobertura de código de los destinos `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 el ejecutable si el destino es ejecutable, determina el punto de entrada de 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 `.py` o `.pyc`) debe poder cargar el punto de entrada de la herramienta. Debe aceptar los argumentos de línea de comandos de coverage.py, al menos, incluidos los subcomandos `run` y `lcov`.
`files`	Es una lista de etiquetas. El valor predeterminado es `[]`. En el caso de un entorno de ejecución integrado, este es el conjunto de archivos que lo componen. Estos archivos se agregarán a los archivos de ejecución de los objetos binarios de Python que usan este entorno de ejecución. Para un entorno de ejecución de plataforma, no se debe establecer este atributo.
`interpreter`	Etiqueta; el valor predeterminado es `None` Para un entorno de ejecución integrado en la compilación, este es el objetivo que se debe invocar como intérprete. Para un entorno de ejecución de la plataforma, no se debe establecer este atributo.
`interpreter_path`	String; el valor predeterminado es `""` Para un entorno de ejecución de plataforma, esta es la ruta de acceso absoluta de un intérprete de Python en la plataforma de destino. Para un entorno de ejecución en la compilación, no se debe configurar este atributo.
`python_version`	String; el valor predeterminado es `"_INTERNAL_SENTINEL"` Indica si este entorno de ejecución es para la versión principal 2 o 3 de Python. Los valores válidos son `"PY2"` y `"PY3"`. La marca `--incompatible_py3_is_default` controla el valor predeterminado. Sin embargo, en el futuro, este atributo será obligatorio y no tendrá un valor predeterminado.
`stub_shebang`	Cadena; el valor predeterminado es `"#!/usr/bin/env python3"` La expresión “Shebang” antepuesta a la secuencia de comandos de inicio de Python que se usa cuando se ejecutan objetivos `py_binary`. Consulta el problema 8685 para obtener motivación. No se aplica a Windows.