Projets Python

Le générateur de projet Python permet de créer une bibliothèque ou une application moderne Python configurée avec les bonnes pratiques, gérée avec UV, un fichier de verrouillage unique et un environnement virtuel dans un espace de travail UV, pytest pour exécuter les tests, et Ruff pour l’analyse statique.

Utilisation

Générer un projet Python

Vous pouvez générer un nouveau projet Python de deux manières :

VSCode

1. Installez le Nx Console VSCode Plugin si ce n'est pas déjà fait
2. Ouvrez la console Nx dans VSCode
3. Cliquez sur Generate (UI) dans la section "Common Nx Commands"
4. Recherchez @aws/nx-plugin - py#project
5. Remplissez les paramètres requis
6. Cliquez sur 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

Vous pouvez également effectuer une simulation pour voir quels fichiers seraient modifiés

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

Options

Paramètre	Type	Par défaut	Description
name Requis	string	-	The name of the Python project
directory	string	packages	Parent directory where the project is placed.
projectType Requis	string	application	Project type
moduleName	string	-	Python module name

Résultat du générateur

Le générateur créera la structure de projet suivante dans le répertoire <directory>/<name> :

• Répertoire<module-name>

  • __init__.py Initialisation du module
  • hello.py Exemple de fichier source Python
• Répertoiretests

  • __init__.py Initialisation du module
  • conftest.py Configuration des tests
  • test_hello.py Exemple de tests
• project.json Configuration du projet et cibles de build
• pyproject.toml Fichier de configuration d’empaquetage utilisé par UV
• .python-version Contient la version Python du projet

Vous remarquerez également les fichiers suivants créés/mis à jour à la racine de votre espace de travail :

• pyproject.toml Configuration d’empaquetage au niveau de l’espace de travail pour UV
• .python-version Contient la version Python de l’espace de travail
• uv.lock Fichier de verrouillage des dépendances Python

Écriture du code source Python

Ajoutez votre code source Python dans le répertoire <module-name>.

Importer votre code bibliothèque dans d’autres projets

Utilisez la cible add pour ajouter une dépendance à un projet Python.

Supposons que nous ayons créé deux projets Python, my_app et my_lib. Ceux-ci auront des noms de projet qualifiés complets my_scope.my_app et my_scope.my_lib, et auront par défaut des noms de module my_scope_my_app et my_scope_my_lib.

Pour que my_app dépende de my_lib, nous pouvons exécuter la commande suivante :

pnpm

pnpm nx run my_scope.my_app:add my_scope.my_lib

yarn

yarn nx run my_scope.my_app:add my_scope.my_lib

npm

npx nx run my_scope.my_app:add my_scope.my_lib

bun

bunx nx run my_scope.my_app:add my_scope.my_lib

Note

Nous utilisons le nom de projet qualifié complet pour le dépendant et le dépendu. Nous pouvons utiliser la syntaxe raccourcie pour le projet auquel ajouter la dépendance, mais devons qualifier complètement le nom du projet dont dépendre.

Vous pouvez ensuite importer votre code bibliothèque :

packages/my_app/my_scope_my_app/main.py

from my_scope_my_lib.hello import say_hello

Ci-dessus, my_scope_my_lib est le nom du module pour la bibliothèque, hello correspond au fichier source Python hello.py, et say_hello est une méthode définie dans hello.py.

Dépendances

Pour ajouter des dépendances à votre projet, vous pouvez exécuter la cible add dans votre projet Python, par exemple :

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

Cela ajoutera la dépendance au fichier pyproject.toml de votre projet et mettra à jour le uv.lock racine.

Code d’exécution

Lorsque vous utilisez votre projet Python comme code d’exécution (par exemple comme gestionnaire pour une fonction AWS Lambda), vous devrez créer un bundle du code source et de toutes ses dépendances. Vous pouvez y parvenir en ajoutant une cible comme celle-ci à votre fichier 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 --package my_scope.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"]
    },
  },
}

Build

Votre projet Python est configuré avec une cible build (définie dans project.json), que vous pouvez exécuter via :

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

Où <project-name> est le nom qualifié complet de votre projet.

La cible build compilera, linttera et testera votre projet.

Le résultat du build se trouve dans le dossier dist racine de votre espace de travail, dans un répertoire pour votre package et cible, par exemple dist/packages/<my-library>/build.

Tests

pytest est configuré pour tester votre projet.

Écriture des tests

Les tests doivent être écrits dans le répertoire test de votre projet, dans des fichiers Python préfixés par test_, par exemple :

• Répertoiremy_library

  • hello.py
• Répertoiretest

  • test_hello.py Tests pour hello.py

Les tests sont des méthodes commençant par test_ et utilisant des assertions pour vérifier les attentes, par exemple :

test/test_hello.py

from my_library.hello import say_hello

def test_say_hello():
  assert say_hello("Darth Vader") == "Hello, Darth Vader!"

Pour plus de détails sur l’écriture des tests, veuillez consulter la documentation pytest.

Exécution des tests

Les tests s’exécuteront dans le cadre de la cible build de votre projet, mais vous pouvez aussi les exécuter séparément en lançant la cible 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

Vous pouvez exécuter un test individuel ou une suite de tests en utilisant le flag -k, en spécifiant soit le nom du fichier de test soit celui de la méthode :

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

Les projets Python utilisent Ruff pour le linting.

Exécution du linter

Pour invoquer le linter et vérifier votre projet, vous pouvez exécuter la cible 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

Correction des problèmes de linting

La majorité des problèmes de linting ou de formatage peuvent être corrigés automatiquement. Vous pouvez demander à Ruff de corriger les problèmes de linting en utilisant l’argument --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 même, si vous souhaitez corriger tous les problèmes de linting dans tous les packages de votre espace de travail, vous pouvez exécuter :

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