YamlManager

YamlManager

Biblioteca para simplificar o gerenciamento e a criação dos arquivos JSON e YAML.

Funções:

1. to_json_file:

   • Função:
     • Converte um dicionário em um jsonfile
   • Argumentos:
     • json_path - uma string ou um jsonfile , localização do jsonfile
     • dictionary - os dados que o jsonfile deveria ter
   • Argumentos opcionais:
     • save - se o jsonfile deve ser salvo (criado ou modificado) assim que os dados correspondem ao dicionário
   • Retornos:
     • Um jsonfile localizado em json_path

2. json_file_to_dict:

   • Função:
     • Converte os dados de um jsonfile em um dicionário
   • Argumentos:
     • json_path - uma string ou um jsonfile , localização do jsonfile
   • Retornos:
     • Um dicionário contendo todos os dados do jsonfile

3. json_file_to_yaml_file:

   • Função:
     • Converte os dados de um jsonfile em um yamlfile
   • Argumentos:
     • json_path - uma string ou um jsonfile , localização do jsonfile
     • yaml_path - uma string ou um yamlfile , localização do yamlfile
   • Argumentos opcionais:
     • save - se o Yamlfile deve ser salvo (criado ou modificado) assim que os dados correspondem ao jsonfile
   • Retornos:
     • Um Yamlfile localizado em yaml_path

4. to_yaml_file:

   • Função:
     • Converte um dicionário em um yamlfile
   • Argumentos:
     • yaml_path - uma string ou um yamlfile , localização do yamlfile
     • dictionary - os dados que o Yamlfile deveria ter
   • Argumentos opcionais:
     • save - se o Yamlfile deve ser salvo (criado ou modificado) assim que os dados correspondem ao dicionário
   • Retornos:
     • Um Yamlfile localizado em yaml_path

5. yaml_file_to_dict:

   • Função:
     • Converte os dados de um yamlfile em um dicionário
   • Argumentos:
     • yaml_path - uma string ou um yamlfile , localização do yamlfile
   • Retornos:
     • Um dicionário contendo todos os dados do Yamlfile

6. yaml_file_to_json_file:

   • Função:
     • Converte os dados de um yamlfile em um jsonfile
   • Argumentos:
     • yaml_path - uma string ou um yamlfile , localização do yamlfile
     • json_path - uma string ou um jsonfile , localização do jsonfile
   • Argumentos opcionais:
     • save - se o jsonfile deve ser salvo (criado ou modificado) assim que os dados correspondem ao Yamlfile
   • Retornos:
     • Um jsonfile localizado em json_path

Classes / Objetos

Yamlfile

• Descrição:
  • Representa um arquivo YAML e fornece métodos para manipular seus dados.
• Métodos:
  • load() : carrega os dados do arquivo YAML.
  • save() : salva os dados atuais no arquivo YAML.

JSONFILE

• Descrição:
  • Representa um arquivo JSON e fornece métodos para manipular seus dados.
• Métodos:
  • load() : carrega os dados do arquivo json.
  • save() : salva os dados atuais no arquivo json.

FileController

• Descrição:
  • Representa um controlador de arquivo abstrato e fornece métodos para manipular os dados do arquivo.
• Métodos:
  • __init__(file_path: str) : inicializa a instância FileController com o caminho do arquivo.
  • reload() : Método abstrato para carregar dados do arquivo. Deve ser implementado por subclasses.
  • save() : Método abstrato para salvar dados no arquivo. Deve ser implementado por subclasses.
  • contains(key: str) -> bool : verifica se existe uma chave no dicionário de dados.
  • set(key: str, value: any) -> None : Define, modifica ou exclui valores na configuração.
  • string(key: str, default_value: str | None = None) -> str | None : obtém um valor de string dos dados.
  • float(key: str, default_value: float | int | None = None) -> float | None : obtém um valor de flutuação dos dados.
  • int(key: str, default_value: int | None = None) -> int | None : obtém um valor inteiro dos dados.
  • boolean(key: str, default_value: bool | None = None) -> bool | None : recebe um valor booleano dos dados.
  • str_list(key: str, default_value: list[str] | None = None) -> list[str] | None : recebe uma lista de strings dos dados.
  • float_list(key: str, default_value: list[float | int] | None = None) -> list[float] | None : obtém uma lista de valores de flutuação dos dados.
  • int_list(key: str, default_value: list[int | float] | None = None) -> list[int] | None : obtém uma lista de valores inteiros dos dados.
  • bool_list(key: str, default_value: list[bool] | None = None) -> list[bool] | None : obtém uma lista de valores booleanos dos dados.
  • dictionary(key: str, default_value: dict | None = None) -> dict | None : recebe um dicionário dos dados.