Atelier - Scripting python - Notre lab

Installer un environnement de travail¶

PyCharm

Développé par JetBrains, offre auto-complétion intelligente et débogage visuel.

VS Code

Léger et personnalisable avec des extensions, idéal pour le développement Python.

Jupyter

Utilisé pour la science des données, permet de créer des documents interactifs.

Spyder

Conçu pour les scientifiques des données, interface similaire à MATLAB.

Eclipse/PyDev

IDE polyvalent avec plugin PyDev pour le développement Python.

Les outils nécessaires¶

Python

Le langage de programmation lui-même, installé à partir de python.org.

Gestionnaire

Gestionnaire de paquets pour installer des bibliothèques et dépendances.

Contrôle de version

Système de contrôle de version pour gérer le code source et collaborer.

Environnements

Outil pour créer des environnements Python isolés.

Débogueur

Outils intégrés dans les IDE ou bibliothèques pour le débogage.

Bibliothèques

Bibliothèques spécifiques au projet (calcul, web, réseau, etc.).

Documentation

Accès à la documentation officielle et aux ressources en ligne.

Formattage

Formattage du code pour en améliorer la lisibilité.

Linter

Vérifier la qualité du code.

Ces outils aident à écrire, tester, déboguer et déployer des applications Python de manière efficace.

Solution to Exercise #

Catégorie	Outils
Installation	python.org
Gestionnaire	Pip, Anaconda, Poetry
Contrôle	Git, GitHub, GitLab
Environnements	Virtualenv, Conda, Poetry
Débogage	pdb, Débogueurs intégrés dans les IDE
Bibliothèques	NumPy, Pandas, Matplotlib, Django, Flask, TensorFlow
Documentation	Documentation Python, Stack Overflow, Real Python, Sphinx
Formatage	Black, autopep8, YAPF
Linters	Pylint, Flake8, Bandit

On note que pour les Bibliothèques, pypi est pratique...

Bien écrire son code (PEP8)¶

Respecter les conventions de nommage¶

Utilisez des noms de variables et de fonctions explicites.
Suivez la convention snake_case pour les variables et les fonctions.
Utilisez CamelCase pour les noms de classes.

Exemples

exe_6_1_1.py

"""
Exemples pour la conventions de nommage
"""

def ma_fonction(param1: int | float, param2: int | float) -> int | float:
    """
    Cette fonction prend deux paramètres et retourne leur somme.

    :param param1: Premier paramètre de la fonction
    :param param2: Deuxième paramètre de la fonction
    :return: La somme de param1 et param2
    """
    return param1 + param2


class MaClasse:
    """
    Une classe exemple pour démontrer les conventions de nommage et la documentation.

    Attributes:
        attribut_public (int): Un attribut public de la classe.
        __attribut_prive (int): Un attribut privé de la classe.
    """

    _variable_interne = (
        42  # Variable interne, non destinée à être utilisée en dehors de ce contexte
    )
    __attribut_prive = 42  # Variable privée avec "name mangling"

    def __init__(self) -> None:
        self.attribut_public = 10
        self.__attribut_prive = 20

Structurer le code¶

Organisez le code en fonctions et en classes pour le rendre modulaire.
Évitez les fonctions trop longues ; privilégiez les petites fonctions avec une seule responsabilité.

Gérer les erreurs¶

Utilisez des exceptions pour gérer les erreurs de manière élégante.
Évitez les blocs try-except trop larges ; soyez spécifique sur les exceptions à attraper.

Optimiser les performances¶

Évitez les opérations coûteuses dans les boucles.
Utilisez des structures de données appropriées pour optimiser les performances.

Tester le code¶

Écrivez des tests unitaires pour vérifier le bon fonctionnement des différentes parties du code.
Utilisez des frameworks de test comme unittest ou pytest.

Utiliser des outils de linting¶

Utilisez des outils comme pylint ou flake8 pour vérifier la qualité du code.
Configurez votre éditeur pour qu’il applique automatiquement les règles de style PEP 8.

Éviter le code dupliqué¶

Réutilisez le code en créant des fonctions ou des classes communes.
Appliquez le principe DRY (Don’t Repeat Yourself).