gpt code commenter

comentarista-código-gpt

Documente automáticamente el código pasándolo a un LLM (Chat-GPT).

• Con un simple mensaje, le pedimos al LLM que anote el código dado, siguiendo las convenciones para ese idioma.

• NOTE : esta herramienta aún requiere supervisión manual: si vuelve a enviar a la misma ubicación, verifique los resultados antes de realizar los cambios. De forma predeterminada, la herramienta genera salida estándar O un nuevo directorio.

• Para obtener instrucciones de configuración, consulte la sección Setup a continuación.

Uso

nota: los scripts deben ejecutarse desde la carpeta via-chat-gpt de nivel superior.

Para comentar un solo archivo:

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

Para comentar archivos en un directorio (NO es recursivo):

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

nota: para volver a escribir en los mismos archivos, simplemente especifique --out-dir para que apunte al mismo directorio. Pero luego verifique el resultado antes de realizar cambios.

Ejemplo

Documentación de ejemplo generada (publicada a través de pdoc en S3): documentación de cornsnake.

APORTE:

 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)

PRODUCCIÓN:

 """
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

Configuración

[RECOMENDADO] Para openai (LLM remoto):

 cd via-chat-gpt

Unix:

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

Ventanas:

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

Establezca la variable de entorno con su clave OpenAI:

 export OPENAI_API_KEY= " xxx "

Agregue eso a su script de inicialización de shell ( ~/.zprofile o similar)

Carga en terminal actual:

 source ~ /.zprofile

Prueba OpenAI

(cd vía-chat-gpt)

test-openai.sh

o

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

Para phi2 (LLM local a través de llama-cpp-python) [UNIX O Windows] [MÁS FÁCIL DE INSTALAR]

• Los resultados solo están bien (Chat-GPT tiene resultados mucho mejores)

• ver vía-phi2-the-bloke README

Para phi2 (LLM local a través de transformadores) [UNIX, no Windows] [MÁS DIFÍCIL DE INSTALAR]

• TODO corrige el manejo de respuestas para esta versión

• ver vía-phi2 LÉAME