gpt code commenter

gpt-코드 주석기

코드를 LLM(Chat-GPT)에 전달하여 자동으로 문서화합니다.

• 간단한 프롬프트를 통해 LLM에게 해당 언어의 규칙에 따라 주어진 코드에 주석을 달도록 요청합니다.

• NOTE - 이 도구에는 여전히 수동 감독이 필요합니다. 동일한 위치로 다시 출력하는 경우 변경 사항을 적용하기 전에 결과를 확인하십시오. 기본적으로 도구는 stdout 또는 새 디렉터리로 출력합니다.

• 설정 지침은 아래 Setup 섹션을 참조하세요.

용법

참고: 스크립트는 최상위 via-chat-gpt 폴더 내에서 실행되어야 합니다.

단일 파일에 주석을 달려면:

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

디렉터리의 파일에 주석을 달려면(재귀적이지 않음):

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

참고: 동일한 파일에 다시 쓰려면 --out-dir 지정하여 동일한 디렉터리를 가리키면 됩니다. 그러나 변경 사항을 적용하기 전에 결과를 확인하십시오.

예

생성된 문서 예시(pdoc를 통해 S3에 게시됨): cornsnake 문서.

입력:

 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)

산출:

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

설정

[권장] openai(원격 LLM)의 경우:

 cd via-chat-gpt

유닉스:

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

윈도우:

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

OpenAI 키를 사용하여 환경 변수를 설정합니다.

 export OPENAI_API_KEY= " xxx "

이를 쉘 초기화 스크립트( ~/.zprofile 또는 유사)에 추가하십시오.

현재 터미널에 로드:

 source ~ /.zprofile

OpenAI 테스트

(CD via-chat-gpt)

test-openai.sh

또는

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

phi2의 경우(llama-cpp-python을 통한 로컬 LLM) [UNIX 또는 Windows] [설치가 더 쉬움]

• 결과는 괜찮습니다(Chat-GPT의 결과가 훨씬 더 좋습니다).

• via-phi2-the-bloke 추가 정보를 참조하세요.

phi2의 경우(변환기를 통한 로컬 LLM) [Windows가 아닌 UNIX] [설치가 더 어렵습니다.]

• 이 버전에 대한 TODO 응답 처리 수정

• via-phi2 읽어보기를 참조하세요.