YamlManager

Yamlmanager

Biblioteca para simplificar la administración y la creación de archivos JSON y YAML.

Funciones:

1. to_json_file:

   • Función:
     • Convierte un diccionario a un jsonfile
   • Argumentos:
     • json_path - Una cadena o una ubicación JSONFILE , Ubicación del JSONFILE
     • dictionary : los datos que debe tener el JSONFILE
   • Argumentos opcionales:
     • save : si el jsonfile debe guardarse (crear o modificar) tan pronto como los datos coincidan con el diccionario
   • Devoluciones:
     • Un jsonfile ubicado en json_path

2. JSON_FILE_TO_DICT:

   • Función:
     • Convierte los datos de un jsonfile a un diccionario
   • Argumentos:
     • json_path - Una cadena o una ubicación JSONFILE , Ubicación del JSONFILE
   • Devoluciones:
     • Un diccionario que contiene todos los datos del jsonfile

3. json_file_to_yaml_file:

   • Función:
     • Convierte los datos de un jsonfile a un yamlfile
   • Argumentos:
     • json_path - Una cadena o una ubicación JSONFILE , Ubicación del JSONFILE
     • yaml_path - una cadena o un yamlfile , ubicación del yamlfile
   • Argumentos opcionales:
     • save : ya sea que el YamlFile se debe guardar (crear o modificar) tan pronto como los datos coincidan con el JSONFILE
   • Devoluciones:
     • Un yamlfile ubicado en yaml_path

4. to_yaml_file:

   • Función:
     • Convierte un diccionario a un YamlFile
   • Argumentos:
     • yaml_path - una cadena o un yamlfile , ubicación del yamlfile
     • dictionary : los datos que debería tener el YamlFile
   • Argumentos opcionales:
     • save : si el YamlFile debe guardar (crear o modificar) tan pronto como los datos coincidan con el diccionario
   • Devoluciones:
     • Un yamlfile ubicado en yaml_path

5. yaml_file_to_dict:

   • Función:
     • Convierte los datos de un YamlFile a un diccionario
   • Argumentos:
     • yaml_path - una cadena o un yamlfile , ubicación del yamlfile
   • Devoluciones:
     • Un diccionario que contiene todos los datos del YamlFile

6. yaml_file_to_json_file:

   • Función:
     • Convierte los datos de un YamlFile a un JSONFILE
   • Argumentos:
     • yaml_path - una cadena o un yamlfile , ubicación del yamlfile
     • json_path - Una cadena o una ubicación JSONFILE , Ubicación del JSONFILE
   • Argumentos opcionales:
     • save : si el JSONFILE debe guardar (crear o modificar) tan pronto como los datos coincidan con YAMLFILE
   • Devoluciones:
     • Un jsonfile ubicado en json_path

Clases / objetos

Yamlfile

• Descripción:
  • Representa un archivo YAML y proporciona métodos para manipular sus datos.
• Métodos:
  • load() : Carga los datos del archivo YAML.
  • save() : guarda los datos actuales en el archivo YAML.

Jonfile

• Descripción:
  • Representa un archivo JSON y proporciona métodos para manipular sus datos.
• Métodos:
  • load() : Carga los datos del archivo JSON.
  • save() : guarda los datos actuales en el archivo JSON.

Filecontrolador

• Descripción:
  • Representa un controlador de archivos abstracto y proporciona métodos para manipular los datos del archivo.
• Métodos:
  • __init__(file_path: str) : inicializa la instancia FileController con la ruta del archivo.
  • reload() : método abstracto para cargar datos del archivo. Debe ser implementado por subclases.
  • save() : método abstracto para guardar datos en el archivo. Debe ser implementado por subclases.
  • contains(key: str) -> bool : verifica si existe una clave en el diccionario de datos.
  • set(key: str, value: any) -> None : establece, modifica o elimina los valores en la configuración.
  • string(key: str, default_value: str | None = None) -> str | None : Obtiene un valor de cadena de los datos.
  • float(key: str, default_value: float | int | None = None) -> float | None : Obtiene un valor flotante de los datos.
  • int(key: str, default_value: int | None = None) -> int | None : Obtiene un valor entero de los datos.
  • boolean(key: str, default_value: bool | None = None) -> bool | None : Obtiene un valor booleano de los datos.
  • str_list(key: str, default_value: list[str] | None = None) -> list[str] | None : Obtiene una lista de cadenas de los datos.
  • float_list(key: str, default_value: list[float | int] | None = None) -> list[float] | None : Obtiene una lista de valores flotantes de los datos.
  • int_list(key: str, default_value: list[int | float] | None = None) -> list[int] | None : Obtiene una lista de valores enteros de los datos.
  • bool_list(key: str, default_value: list[bool] | None = None) -> list[bool] | None : Obtiene una lista de valores booleanos de los datos.
  • dictionary(key: str, default_value: dict | None = None) -> dict | None : Obtiene un diccionario de los datos.