louis-saglio/getter_setter_maker

Script Python automatisant la création d'une classe Python

getter_setter_maker

Description :

Script Python automatisant la création d'une classe Python ainsi que des instances de cette classe

Avertissement : Ce fichier README n'est pas à jour, il manque la doc à propos du fichier write_in_file.py et de la fonction add_attribute_to_class

## Usage

Pour l'utiliser, il faut :

• Avoir les fichiers class_creator.py et getter_setter_maker.py dans le dossier courant
• Importer au minimum la fonction create_class_instance() du fichier getter_setter_maker.py dans le script devant l'utiliser

Fonctionnement de la fonction create_object() :

• Utilité : Créer automatiquement une liste d'instance d'une classe précédement créé avec class_creator, en remplissant les attributs de ces instances ainsi créées avec les différentes valeurs de votre choix

• Paramètres

  • Le paramètre classe : C'est un objet de type class créé avec class_creator et dont vous voulez créé des instances
  • Le paramètre 'attributs' : C'est un dictionnaire. Il correspond aux attributs de votre class et il contient également les valeurs de ces attributs pour les instances de cette class créés automatiquement.
    Il doit être construit sur ce model : {"nom_attribut_1": [valeur_de_attribut_1_pour_l'instance_1, valeur_de_attribut_2_pour_l'instance_2], "nom_attribut_2": [valeur_de_attribut_2_pour_l'instance_1, valeur_de_attribut_2_pour_l'instance_2]
• Retour : Une liste d'instance de la class dont les attributs sont remplis ainsi qu'ils auront été modélisé dans le paramètre attribut

Fonctionnement de la fonction : create_class_instance()

• Utilité : Créer automatiquement une class avec ses méthodes de base (__init__, getter, setter) et une liste d'instance(s) de cette class suivant les paramètres choisis par l'utilisateur

• Paramètres :

  • Le paramètre 'nom_classe' : De type str, ce sera le nom de votre class
  • Le paramètre 'attributs' : C'est un dictionnaire. Il correspond aux attributs de votre class et il contient également les valeurs de ces attributs pour les instances de cette class créés automatiquement.
    Il doit être construit sur ce model : {"nom_attribut_1": [valeur_de_attribut_1_pour_l'instance_1, valeur_de_attribut_2_pour_l'instance_2], "nom_attribut_2": [valeur_de_attribut_2_pour_l'instance_1, valeur_de_attribut_2_pour_l'instance_2]
• Retour : Une liste d'instance de la class dont les attributs sont remplis ainsi qu'ils auront été modélisé dans le paramètre attribut

### Fonctionnement de l'outil class_creator.py

• Utilité : Cet outil permet d'écrire automatiquement une classe compatible avec la fonction create_class_instance() avec sa fonction __init et ses accesseurs et mutateurs.
• Pour l'utiliser procédez comme il suit :
  • Placez le fichier class_creator.py là où vous voulez créer le fichier contenant votre classe
  • Ouvrez y un invite de commande
  • Lancez la commande suivante : C:\folder> python class_creator.py nom_de_votre_classe attribut1,attribut2,attribut3...

## Problèmes connus :

Impossible d'importer une classe

• Message d'erreur : ImportError: cannot import name 'Nom_class'
• Cause : Cette erreur est du à un problème de cache mémoire.
• Solutions : Supprimer le fichier __pycache__ dans le dossier du programme; si le problème persiste redémarrer l'ordinateur.