Proyectos de Python

El generador de proyectos Python permite crear bibliotecas o aplicaciones modernas de Python configuradas con mejores prácticas, gestionadas 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.

Uso

Generar un proyecto Python

Puedes generar un nuevo proyecto Python de dos formas:

VSCode

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
6. Haga clic en Generate

CLI

pnpm

pnpm nx g @aws/nx-plugin:py#project

yarn

yarn nx g @aws/nx-plugin:py#project

npm

npx nx g @aws/nx-plugin:py#project

bun

bunx nx g @aws/nx-plugin:py#project

También puede realizar una ejecución en seco para ver qué archivos se cambiarían

pnpm

pnpm nx g @aws/nx-plugin:py#project --dry-run

yarn

yarn nx g @aws/nx-plugin:py#project --dry-run

npm

npx nx g @aws/nx-plugin:py#project --dry-run

bun

bunx nx g @aws/nx-plugin:py#project --dry-run

Opciones

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

Resultado del Generador

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 con 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 build
• 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 del workspace:

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

Escribir código Python

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

Importar tu biblioteca en otros proyectos

Como tienes configurados espacios de trabajo UV, puedes referenciar tu proyecto Python desde cualquier otro proyecto Python en tu workspace:

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

Dependencias

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

pnpm

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

yarn

yarn nx run my_scope.my_library:add some-pip-package

npm

npx nx run my_scope.my_library:add some-pip-package

bun

bunx 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.

Código en tiempo de ejecución

Cuando uses tu proyecto Python como código de runtime (por ejemplo como handler 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 en 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 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"]
    },
  },
}

Construcción

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

pnpm

pnpm nx run <project-name>:build

yarn

yarn nx run <project-name>:build

npm

npx nx run <project-name>:build

bun

bunx nx run <project-name>:build

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

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

La salida del build se encontrará en la carpeta dist raíz de tu workspace, dentro de un directorio para tu paquete y objetivo, por ejemplo dist/packages/<my-library>/build

Pruebas

pytest está configurado para probar tu proyecto.

Escribir pruebas

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") == "Hello, Darth Vader!"

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

Ejecutar pruebas

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

pnpm

pnpm nx run <project-name>:test

yarn

yarn nx run <project-name>:test

npm

npx nx run <project-name>:test

bun

bunx nx run <project-name>:test

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

pnpm

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

yarn

yarn nx run <project-name>:test -k 'test_say_hello'

npm

npx nx run <project-name>:test -k 'test_say_hello'

bun

bunx nx run <project-name>:test -k 'test_say_hello'

Linting

Los proyectos Python usan Ruff para linting.

Ejecutar el Linter

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

pnpm

pnpm nx run <project-name>:lint

yarn

yarn nx run <project-name>:lint

npm

npx nx run <project-name>:lint

bun

bunx nx run <project-name>:lint

Corregir problemas de linting

La mayoría de problemas de linting o formato pueden corregirse automáticamente. Puedes indicar a Ruff que corrija problemas ejecutando con el argumento --configuration=fix:

pnpm

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

yarn

yarn nx run <project-name>:lint --configuration=fix

npm

npx nx run <project-name>:lint --configuration=fix

bun

bunx nx run <project-name>:lint --configuration=fix

De forma similar, si quieres corregir todos los problemas de linting en todos los paquetes de tu workspace, ejecuta:

pnpm

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

yarn

yarn nx run-many --target lint --all --configuration=fix

npm

npx nx run-many --target lint --all --configuration=fix

bun

bunx nx run-many --target lint --all --configuration=fix