Saltearse al contenido

Proyectos de Python

El generador de proyectos Python permite crear una biblioteca o aplicación moderna de Python configurada con mejores prácticas, gestionada con UV, un único archivo de bloqueo y entorno virtual en un espacio de trabajo UV, pytest para ejecutar pruebas, y Ruff para análisis estático.

Puedes generar un nuevo proyecto de Python de dos formas:

  1. Instale el Nx Console VSCode Plugin si aún no lo ha hecho
  2. Abra la consola Nx en VSCode
  3. Haga clic en Generate (UI) en la sección "Common Nx Commands"
  4. Busque @aws/nx-plugin - py#project
  5. Complete los parámetros requeridos
    • Haga clic en Generate
    Parámetro Tipo Predeterminado Descripción
    name Requerido string - The name of the Python project
    directory string packages Parent directory where the project is placed.
    projectType Requerido string application Project type
    moduleName string - Python module name

    El generador creará la siguiente estructura de proyecto en el directorio <directory>/<name>:

    • Directory<module-name>
      • __init__.py Inicialización del módulo
      • hello.py Archivo de ejemplo de código Python
    • Directorytests
      • __init__.py Inicialización del módulo
      • conftest.py Configuración de pruebas
      • test_hello.py Pruebas de ejemplo
    • project.json Configuración del proyecto y objetivos de compilación
    • pyproject.toml Archivo de configuración de empaquetado usado por UV
    • .python-version Contiene la versión de Python del proyecto

    También podrás observar estos archivos creados/actualizados en la raíz de tu espacio de trabajo:

    • pyproject.toml Configuración de empaquetado a nivel de espacio de trabajo para UV
    • .python-version Contiene la versión de Python del espacio de trabajo
    • uv.lock Archivo de bloqueo de dependencias Python

    Añade tu código fuente Python en el directorio <module-name>.

    Como los espacios de trabajo UV están configurados, puedes referenciar tu proyecto Python desde cualquier otro proyecto Python en tu espacio de trabajo:

    packages/my_other_project/my_other_project/main.py
    from "my_library.hello" import say_hello

    Aquí, my_library es el nombre del módulo, hello corresponde al archivo fuente Python hello.py, y say_hello es un método definido en hello.py.

    Para añadir dependencias a tu proyecto, puedes ejecutar el objetivo add en tu proyecto Python, por ejemplo:

    Terminal window
    pnpm nx run my_scope.my_library:add some-pip-package

    Esto añadirá la dependencia al archivo pyproject.toml de tu proyecto y actualizará el uv.lock raíz.

    Cuando uses tu proyecto Python como código de runtime (por ejemplo como manejador para una función AWS Lambda), necesitarás crear un paquete del código fuente y todas sus dependencias. Puedes lograrlo añadiendo un objetivo como el siguiente a tu archivo project.json:

    project.json
    {
    ...
    "targets": {
    ...
    "bundle": {
    "cache": true,
    "executor": "nx:run-commands",
    "outputs": ["{workspaceRoot}/dist/packages/my_library/bundle"],
    "options": {
    "commands": [
    "uv export --frozen --no-dev --no-editable --project packages/my_library -o dist/packages/my_library/bundle/requirements.txt",
    "uv pip install -n --no-installer-metadata --no-compile-bytecode --python-platform x86_64-manylinux2014 --python `uv python pin` --target dist/packages/my_library/bundle -r dist/packages/my_library/bundle/requirements.txt"
    ],
    "parallel": false
    },
    "dependsOn": ["compile"]
    },
    },
    }

    Tu proyecto Python está configurado con un objetivo build (definido en project.json), que puedes ejecutar mediante:

    Terminal window
    pnpm nx run <project-name>:build

    Donde <project-name> es el nombre completo de tu proyecto.

    El objetivo build compilará, verificará y probará tu proyecto.

    La salida de compilación se encuentra en la carpeta dist raíz de tu espacio de trabajo, dentro de un directorio para tu paquete y objetivo, por ejemplo dist/packages/<my-library>/build.

    pytest está configurado para probar tu proyecto.

    Las pruebas deben escribirse en el directorio test dentro de tu proyecto, en archivos Python con prefijo test_, por ejemplo:

    • Directorymy_library
      • hello.py
    • Directorytest
      • test_hello.py Pruebas para hello.py

    Las pruebas son métodos que comienzan con test_ y realizan aserciones para verificar expectativas, por ejemplo:

    test/test_hello.py
    from my_library.hello import say_hello
    def test_say_hello():
    assert say_hello("Darth Vader") == "¡Hola, Darth Vader!"

    Para más detalles sobre cómo escribir pruebas, consulta la documentación de pytest.

    Las pruebas se ejecutarán como parte del objetivo build de tu proyecto, pero también puedes ejecutarlas por separado usando el objetivo test:

    Terminal window
    pnpm nx run <project-name>:test

    Puedes ejecutar una prueba individual o un conjunto de pruebas usando el flag -k, especificando el nombre del archivo de prueba o método:

    Terminal window
    pnpm nx run <project-name>:test -k 'test_say_hello'

    Los proyectos Python usan Ruff para análisis estático.

    Para invocar el linter y verificar tu proyecto, ejecuta el objetivo lint:

    Terminal window
    pnpm nx run <project-name>:lint

    La mayoría de problemas de formato o análisis estático pueden corregirse automáticamente. Puedes indicar a Ruff que corrija los problemas usando el argumento --configuration=fix:

    Terminal window
    pnpm nx run <project-name>:lint --configuration=fix

    De forma similar, si deseas corregir todos los problemas en todos los paquetes de tu espacio de trabajo, ejecuta:

    Terminal window
    pnpm nx run-many --target lint --all --configuration=fix