webspirit.config package#
Submodules#
webspirit.config.constants module#
Les différentes constantes pour manipuler aisément les différents dossiers, sous-dossiers, fichiers dans l’arborescence complète du projet.
webspirit.config.introspection module#
Un module qui fournit des fonctions utiles pour manipuler des objets, et avoir des aides pour les Jupiter Notebooks, ou encore les fichiers Readme pour la présentation du dépôt.
- webspirit.config.introspection.links_from_cell(path, index=0, type=<class 'webspirit.classes.tools.typing.HyperLink'>)[source]#
Permet dans un Jupiter Notebooks de récupérer des chaînes de caractères lignes par lignes dans le type voulue dans une cellule de type ‘raw’
- Parameters:
path (StrPath) – Le chemin vers le Notebooks.
index (int, optional) – Le numéro de la cellule auquel il faut prendre en compte les cellules en Markdown, Python, … Defaults to 0.
type (type, optional) – Ce en quoi les chaines de caractères seront converties. Defaults to HyperLink.
- Returns:
Une liste avec les instances du type spécifié.
- Return type:
list[type]
- webspirit.config.introspection.show(obj)[source]#
Affiche la représentation d’un objet grâce à str et repr
- Parameters:
obj (Any) – L’objet en question.
- webspirit.config.introspection.tree_directory(root=PosixPath('/home/runner/work/Webspirit/Webspirit/src/webspirit'), ignore=PosixPath('/home/runner/work/Webspirit/Webspirit/.gitignore'), show_var=False, show_doc=False, show_files=True, indent='│ ', branch='├── ', close='└── ', empty=' ')[source]#
Construit une représentation textuelle propre et esthétique d’un répertoire
- Parameters:
root (StrPath, optional) – Chemin du dossier racine à explorer. Defaults to DIR_WEBSPIRIT.
ignore (StrPath, optional) – Un fichier .gitignore qui permet de restreindre l’affichage de manière dynamique. Defaults to PATH_GITIGNORE.
show_var (bool, optional) – Permet d’afficher les variable contenue dans ‘__all__’ de chaque module. Defaults to False.
show_doc (bool, optional) – Permet d’afficher la documentation de chaque module. Defaults to False.
show_files (bool, optional) – Permet d’afficher les fichiers contenu dans les dossiers. Defaults to True.
indent (str, optional) – La branche d’indentation normale. Defaults to ‘│ ‘.
branch (str, optional) – La branche d’intersection. Defaults to ‘├── ‘.
close (str, optional) – La branche finale. Defaults to ‘└── ‘.
empty (str, optional) – Un espace vide. Defaults to ‘ ‘.
- Raises:
TypeError – Lève une erreur si le chemin ‘root’ ne mène pas à un dossier
- Returns:
Arborescence formatée
- Return type:
str
webspirit.config.logger module#
Le fichier qui regroupe toutes les constantes pour le logging, et la définition de la gestion du logging dans la console, avec les fichiers ou encore les Notebooks pour avoir une gestion centralisé dans tous le projet.
- webspirit.config.logger.critical(message: Any, *, level: int = 50, logger: Logger | None = None)#
- webspirit.config.logger.debug(message: Any, *, level: int = 10, logger: Logger | None = None)#
- webspirit.config.logger.error(message: Any, *, level: int = 40, logger: Logger | None = None)#
- webspirit.config.logger.info(message: Any, *, level: int = 20, logger: Logger | None = None)#
- webspirit.config.logger.warning(message: Any, *, level: int = 30, logger: Logger | None = None)#
webspirit.config.settings module#
Les constantes générées de manière dynamique grâce aux valeurs définies dans les fichier json de configurations.
- class webspirit.config.settings.ConfigManager(**kwargs)[source]#
Bases:
dict- build()[source]#
Construit les paramètres de configuration avec leurs valeurs respectives à partir du schéma défini
- Return type:
dict[str,Parameter]
- class webspirit.config.settings.IPythonConfig(manager={'dark_mode': True, 'language': 'es', 'launch_animation': True, 'path_FFmpeg': '/home/runner/work/Webspirit/Webspirit/src/webspirit/resources/FFmpeg/bin/ffmpeg.exe', 'theme': 'light', 'username': 'Solange'})[source]#
Bases:
object
- class webspirit.config.settings.Parameter(name, schema=PosixPath('/home/runner/work/Webspirit/Webspirit/src/webspirit/data/settings/settings.json'), user=PosixPath('/home/runner/work/Webspirit/Webspirit/src/webspirit/data/settings/user.json'), dir_config=PosixPath('/home/runner/work/Webspirit/Webspirit/src/webspirit/data/settings'))[source]#
Bases:
dict- property attr: Any | None#
- property default: Any | None#
- property default_src: dict#
- get_default()[source]#
Récupère la valeur par défaut du paramètre en fonction des différentes sources possibles
- Return type:
Any
- get_default_obj()[source]#
Récupère la valeur par défaut du paramètre en fonction de l’objet source et des options pré-définies
- Return type:
Any
- get_obj()[source]#
Récupère l’objet source défini dans le paramètre de configuration
- Return type:
Any|None
- get_options()[source]#
Récupère les valeurs possibles du paramètre si l’objet source est itérable
- Return type:
Iterable|None
- get_widgets()[source]#
Génère un widget ipywidgets en fonction du type de paramètre défini
- Return type:
Any|None
- property index: Any | None#
- property label: str | None#
- property obj: Any | None#
Si défini, l’objet source qui permet de récupérer la valeur du paramètre
- property object: str | None#
- property options: Iterable | None#
Si défini, les valeurs possibles du paramètre
- property params: list[Any]#
- property resource: Any#
La valeur du paramètre dans la configuration
- serial()[source]#
Renvoi le paramètre serializable avec les normes d’un fichier json
- Return type:
Any|None
- property source: dict | None#
- property type: str | None#
- property value: Any | None#
Module contents#
Répertoire contenant différents modules pour la configuration de tous les paramètres par défauts relatifs aux chemins (dossiers/fichiers) de l’arborescence, ainsi qu’au logging et au constantes de bases.