gpt code commenter

comentarista de código gpt

Documente o código automaticamente, passando-o para um LLM (Chat-GPT).

• Com um simples prompt, pedimos ao LLM que anote o código fornecido, seguindo as convenções dessa linguagem.

• NOTE - esta ferramenta ainda requer supervisão manual: Se estiver retornando para o mesmo local, verifique os resultados antes de confirmar as alterações. Por padrão, a ferramenta envia para stdout OU para um novo diretório.

• para obter instruções de configuração, consulte a seção Setup abaixo.

Uso

observação: os scripts devem ser executados na pasta via-chat-gpt de nível superior.

Para comentar um único arquivo:

 pipenv run python via-chat-gpt  [--out-dir 
]

Para comentar arquivos em um diretório (NÃO é recursivo):

 pipenv run python via-chat-gpt  [--out-dir 
] [--exclude ]

nota: para escrever de volta no(s) mesmo(s) arquivo(s), simplesmente especifique --out-dir para apontar para o mesmo diretório. Mas então verifique o resultado antes de confirmar as alterações.

Exemplo

Exemplo de documentação gerada (publicada via pdoc para S3): documentação cornsnake.

ENTRADA:

 import json

def read_from_json_file(path_to_json, encoding='utf-8'):
    with open(path_to_json, encoding=encoding) as f:
        data = json.load(f)
        return data

def write_to_json_file(dict, file_path, encoding='utf-8', indent=2):
    json_object = json.dumps(dict, indent=indent)

    with open(file_path, "w", encoding=encoding) as outfile:
        outfile.write(json_object)

SAÍDA:

 """
This Python file contains functions for reading from and writing to a JSON file. The `read_from_json_file` function reads JSON data from a file, and the `write_to_json_file` function writes JSON data to a file.
"""

import json

def read_from_json_file(path_to_json, encoding='utf-8'):
    """
    Function to read JSON data from a file.

    Args:
    path_to_json (str): The path to the JSON file.
    encoding (str): The encoding of the file. Default is 'utf-8'.

    Returns:
    dict: The JSON data read from the file.
    """
    with open(path_to_json, encoding=encoding) as f:
        data = json.load(f)  # Load JSON data from the file
        return data

def write_to_json_file(dict, file_path, encoding='utf-8', indent=2):
    """
    Function to write JSON data to a file.

    Args:
    dict (dict): The dictionary containing JSON data to be written.
    file_path (str): The path to the output JSON file.
    encoding (str): The encoding of the file. Default is 'utf-8'.
    indent (int): The number of spaces to indent the JSON data. Default is 2.
    """
    json_object = json.dumps(dict, indent=indent)  # Convert dictionary to JSON string with specified indent

    with open(file_path, "w", encoding=encoding) as outfile:
        outfile.write(json_object)  # Write JSON data to the file

Configurar

[RECOMENDADO] Para openai (LLM remoto):

 cd via-chat-gpt

Unix:

pip install pipenv
export PYTHONPATH= " ${PYTHONPATH} :. "
pipenv install

Windows:

pip install pipenv
set PYTHONPATH= " %PYTHONPATH% " ; .
pipenv install

Defina a variável de ambiente com sua chave OpenAI:

 export OPENAI_API_KEY= " xxx "

Adicione isso ao seu script de inicialização do shell ( ~/.zprofile ou similar)

Carregar no terminal atual:

 source ~ /.zprofile

Teste OpenAI

(cd via-chat-gpt)

test-openai.sh

ou

pipenv run python via-chat-gpt ../test-resources/util_json.py

Para phi2 (LLM local via llama-cpp-python) [UNIX OU Windows] [MAIS FÁCIL DE INSTALAR]

• Os resultados são bons (Chat-GPT tem resultados muito melhores)

• veja o README via-phi2-the-bloke

Para phi2 (LLM local via transformadores) [UNIX, não Windows] [MAIS DIFÍCIL DE INSTALAR]

• Tratamento de resposta de correção TODO para esta versão

• veja o README via-phi2