Projets Python

Le générateur de projets Python permet de créer une bibliothèque ou application Python moderne configurée selon les meilleures 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	-	Le nom du projet Python
directory	string	packages	Répertoire parent où le projet est placé.
subDirectory	string	-	Le sous-répertoire dans lequel le projet est placé. Par défaut, il s'agit du nom du projet.
projectType Requis	string	application	Si le projet est une application ou une bibliothèque
moduleName	string	-	Nom du module Python

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
• Répertoiretests

  • __init__.py Initialisation du module
  • conftest.py Configuration des tests
  • test_noop.py Test placeholder
• 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 peut-être é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

Écrire du code Python

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

Importer votre code 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, exécutez 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

Noms entièrement qualifiés

Nous utilisons le nom qualifié complet du projet 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 entièrement le nom du projet dépendu.

Vous pouvez ensuite importer votre code :

packages/my_app/my_scope_my_app/main.py

from my_scope_my_lib.my_module import my_function

Ci-dessus, my_scope_my_lib est le nom du module pour la bibliothèque, my_module correspond à un fichier source Python my_module.py, et my_function est une méthode définie dans ce fichier.

Dépendances

Pour ajouter des dépendances à votre projet, exécutez 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 dans 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-deps --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 build <project-name>

yarn

yarn nx build <project-name>

npm

npx nx build <project-name>

bun

bunx nx build <project-name>

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 spécifique à votre package et à la cible, par exemple dist/packages/<my-library>/build.

Pour builder tous les projets de votre espace de travail, exécutez :

pnpm

pnpm nx run-many --target build

yarn

yarn nx run-many --target build

npm

npx nx run-many --target build

bun

bunx nx run-many --target build

Ou utilisez la commande raccourcie :

pnpm

pnpm build

yarn

yarn build

npm

npm run build

bun

bun build

Tests

pytest est configuré pour tester votre projet.

Écrire 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

  • my_module.py
• Répertoiretests

  • test_my_module.py Tests pour my_module.py

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

tests/test_my_module.py

from my_library.my_module import say_hello

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

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

Exécuter les tests

Les tests s’exécutent dans le cadre de la cible build de votre projet, mais vous pouvez aussi les exécuter séparément avec la cible test :

pnpm

pnpm nx test <project-name>

yarn

yarn nx test <project-name>

npm

npx nx test <project-name>

bun

bunx nx test <project-name>

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

pnpm

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

yarn

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

npm

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

bun

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

Linting

Les projets Python utilisent Ruff pour le linting.

Exécuter le linter

Pour invoquer le linter et vérifier votre projet, exécutez la cible lint :

pnpm

pnpm nx lint <project-name>

yarn

yarn nx lint <project-name>

npm

npx nx lint <project-name>

bun

bunx nx lint <project-name>

Corriger les problèmes de lint

La majorité des problèmes de lint ou de formatage peuvent être corrigés automatiquement. Vous pouvez demander à Ruff de corriger les problèmes de lint en utilisant l’argument --configuration=fix :

pnpm

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

yarn

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

npm

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

bun

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

De même, pour corriger tous les problèmes de lint dans tous les packages de votre espace de travail, exécutez :

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

Commande abrégée

Ceci dispose d’une commande raccourcie depuis la racine de votre espace de travail :

pnpm

pnpm lint

yarn

yarn lint

npm

npm run lint

bun

bun lint

Ignorer les problèmes de lint

Pour éviter que les problèmes de linting ne vous ralentissent pendant le développement (en particulier si vous avez des problèmes non corrigeables automatiquement dans votre projet), vous pouvez exécuter un build avec la configuration skip-lint :

pnpm

pnpm nx run-many --target build --configuration=skip-lint

yarn

yarn nx run-many --target build --configuration=skip-lint

npm

npx nx run-many --target build --configuration=skip-lint

bun

bunx nx run-many --target build --configuration=skip-lint

Cela exécutera toujours Ruff dans le cadre du build, mais la cible lint sera toujours considérée comme réussie.

Commande abrégée

Ceci dispose d’une commande raccourcie depuis la racine de votre espace de travail :

pnpm

pnpm build:skip-lint

yarn

yarn build:skip-lint

npm

npm run build:skip-lint

bun

bun build:skip-lint