createFile¶

Infos¶

Projet: arboProject

Nom du fichier: createFile.py

Auteur: Poltergeist42

Version: 20181006

Licence: CC-BY-NC-SA

Liens: https://creativecommons.org/licenses/by-nc-sa/4.0/

dev langage: Python 3.6

Framework:

Descriptif¶

Projet:
Ce projet permet de créer une arborescence de dossier et de sous dossiers nécessaires à chaque nouveau projet. Ainsi que l’ensemble des fichiers qui y sont rattachés. Il permet également d’initialiser le dépôt Git et l’outil de documentation Sphinx.

Fichiers:
createFile.py regroupe le corps de l’ensemble des fichiers qui doivent être créés par défaut avec chaque nouveau projet.

N.B : Les fichiers qui sont générer ici sont optionnels et n’empêchent pas la création de l’arborescence ou la configuration de Sphinx.

lexique¶

v_: variable

l_: list

t_: tuple

d_: dictionnaire

f_: fonction

C_: Class

i_: Instance

m_: Matrice

_3_software.createFile.f_createInit(*args, **kwargs)¶

Retourne les informations pour la création du fichiers “__init__.py”

_3_software.createFile.f_createREADME(*args, **kwargs)¶

Retourne les informations pour la création du fichiers “README.rst”

Utilisation :¶

Chaque nouvelle fonction ajoutée doit avoir un nom sous la forme :
f_create[nom_du_fichier_sans_extension]

example :
f_createREADME
Le nom du fichier correspond à une clef du dictionnaire « _d_txtFileToCreate{} » extrait depuis le fichier de configuration « defArbo.json ». Cette est elle même un dictionnaire.
Chaque fonction reçoit 3 argument qui doivent être présenter dans l’ordre suivant :

v_projectName reçoit « args[0] ». C’est le nom du projet qui est fournie par l’utilisateur au lancement de l’application.

v_fileName reçoit args[1]. c’est le nom complet (avec son extension) du fichier à créer. Ce nom est récupérer depuis la clef « v_fileName » du dictionnaire correspondant au fichier dans le fichier de configuration « defArbo.json ».

v_filePath reçoit args[2]. c’est le chemin relatif du fichier à créer. Ce chemin est récupérer depuis la clef « v_filePath » du dictionnaire correspondant au fichier dans le fichier de configuration « defArbo.json ».
Donnée retournée par les fonctions :
Les données retournées par les méthodes sont :
v_fqfn : c’est le regroupement des 2 variables « v_filePath » et « v_fileName »
v_fqfn = f"{v_filePath}/{v_fileName}"
v_txtData : C’est le corps du fichiers. Si le fichiers est vide, mettre cette varriable à False. Si le fichiers doit contenir du texte, il faut le formater dans une chaine de caractère (type str)
N.B : les fonctions doivent obligatoirement retourner ces 2 variables (dans cette ordre)
return  v_fqfn, v_txtData