chasten
v0.2.0: Merge pull request #81 from AstuteSource
Chasten 은 XPath 표현식을 사용하여 Python 프로그램의 AST (Abstract Syntax Tree)에서 패턴을 찾는 Python 프로그램입니다. CHASTEN을 사용하여 복잡한 AST 분석 프레임 워크를 사용하거나 잘못된 정규 표현식에 의존하지 않고도 자신만의 구성 가능한 라인팅 규칙을 빠르게 구현할 수 있습니다.
Python 프로그램에 async 함수 내부의 루프 for 트리플 네스트가 없는지 확인하고 싶습니까? 아니면 Python 프로그램 내의 모든 기능이 유형 주석과 문서 주석이 있음을 확인하고 싶습니까? Chasten은 도울 수 있습니다 ! XPath 표현식이 포함 된 간단한 YAML 파일로 이러한 검사 및 기타 여러 유형의 분석을 표현할 수 있습니다.
Cambridge Dictionary , "누군가가 실패를 알리거나 무언가 잘못한 것을 알리기 위해"(전이 동사) "Cambridge Dictionary.
Chasten (uncountable 또는 singular noun) "Python 프로그램의 추상 구문 트리를 분석하여 프로그래머 실수의 잠재적 원인을 감지하여 프로그램 실패를 방지하기 위해", AstuteSource 개발자는 개발자가 자원 자원 개발자에게 "Python 프로그램의 추상 구문 트리를 분석하는 도구".
chasten main.py 의 모든 기능에 docstrings를 추가하고 주석을 입력하도록 상기시켜 주셔서 기쁩니다. 무엇을 해결 해야할지 쉽게 볼 수있었습니다!"chasten 학생 프로그램이 필요한 코딩 구성을 가지고 있음을 확실하게 확인할 수 있습니다. 정규 표현을 사용하는 것보다 훨씬 낫습니다!"chasten 내가 유지하는 Python 코드베이스의 자동 분석을 즐겁고 쉽게 만들었습니다."chasten 의 분석 대시 보드를 사용하면 수집 한 데이터를 효과적으로 탐색 할 수 있습니다." 다음 단계에 따라 chasten 프로그램을 설치하십시오.
pipx install chasten 하려면 Chasten을 설치하십시오pipx list 입력하고 Chasten이 설치되었는지 확인하십시오chasten --help 입력하려면 도구 사용 방법을 알아보십시오. 일반적으로 config.yml 및 checks.yml 이라고하는 두 개의 YAML 파일로 chasten 구성 할 수 있습니다. chasten 시작 구성을 생성 할 수 있지만 확인할 수 있습니까? ASTUTESOURCE/Chasten-Configuration Repository 예를 들어 도구를 설정하는 구성 파일의 경우입니다. config.yml 파일은 다중 확인 구성 파일을 참조 할 수 있지만이 예제는 단일 checks.yml 파일을 지정하는 방법을 보여줍니다.
# chasten configuration
chasten :
# point to a single checks file
checks-file :
- checks.yml checks.yml 파일에는 하나 이상의 수표가 포함되어야합니다. 다음은 Python 프로젝트에서 비 테스트 및 테스트 사례 기능의 첫 번째 실행 가능 라인을 찾는 두 개의 검사가있는 검사 구성 파일의 예입니다. pattern 속성은 지정된 유형의 파이썬 함수를 감지하는 데 chasten 이 사용할 XPath 버전 2.0 표현식을 지정합니다. chasten configure validate --config <path to chasten-configuration/ directory | config url> 채운 후 <path to chasten-configuration/directory | config url> 구성 디렉토리의 완전히 자격이있는 이름을 사용하면 도구가 구성이 도구 사양을 충족하는지 확인합니다. 또한 명령 chasten configure create 명령을 사용하여 시작 구성을 자동으로 생성 할 수 있습니다! chasten configure --help 도구 구성 방법을 설명합니다.
checks :
- name : " all-non-test-function-definition "
code : " FUNC "
id : " FUNC001 "
description : " First executable line of a non-test function, skipping over docstrings and/or comments "
pattern : ' //FunctionDef[not(contains(@name, "test_"))]/body/Expr[value/Constant]/following-sibling::*[1] | //FunctionDef[not(contains(@name, "test_"))]/body[not(Expr/value/Constant)]/*[1] '
- name : " all-test-function-definition "
code : " FUNC "
id : " FUNC002 "
description : " First executable line of a test function, skipping over docstrings and/or comments "
pattern : ' //FunctionDef[starts-with(@name, "test_")]/body/Expr[value/Constant]/following-sibling::*[1] | //AsyncFunctionDef[starts-with(@name, "test_")]/body/Expr[value/Constant]/following-sibling::*[1] | //FunctionDef[starts-with(@name, "test_")]/body[not(Expr/value/Constant)]/*[1] | //AsyncFunctionDef[starts-with(@name, "test_")]/body[not(Expr/value/Constant)]/*[1] '
count :
min : 1
max : 10 chasten Python 소스 코드가있는 프로젝트가 필요하므로 analysis 하위 명령에 대한 입력으로 Python 소스 코드가 필요하므로 복제 할 수 있습니까? Astutesource/LazyTracker 및? 편리한 분석을 위해 생성 된 기존 Python 프로젝트의 포크 인 Astutesource/Multicounter 리포지토리. chasten 사용 하여이 두 프로젝트를 점진적으로 분석하려면 다음 명령을 입력하여 각 프로젝트에 대한 결과 JSON 파일을 생성 할 수 있습니다.
lazytracker/ Directory가 포함 된 subject-data/ 디렉토리를 작성한 후 lazytracker 프로그램의 chasten analyze 명령을 실행할 수 있습니다. chasten analyze lazytracker
--config < path to the chasten-configuration/ directory | config url >
--search-path < path to the lazytracker/ directory >
--save-directory < path to the subject-data/lazytracker/ directory >
--save 이제 출력을 스캔하여 예를 들어 chasten lazytracker 프로젝트에서 6 테스트 기능을 찾도록 확인할 수 있습니다. subject-data/lazytracker 디렉토리를 살펴보면 chasten-results-lazytracker-20230823162341-4c23fc443a6b4c4aa09886f1ecb96e9f.json 과 같은 이름의 JSON 파일이 있습니다. 이 프로그램에서 chasten --save 번 이상 실행하면 다른 타임 스탬프 (예 : 20230823162341 )와 고유 식별자 (예 : 4c23fc443a6b4c4aa09886f1ecb96e9f )가있는 새로운 결과 파일을 생성 할 것입니다.
기존 subject-data/ 디렉토리에서 multicounter/ / 디렉토리를 작성한 후 multicounter 프로그램의 chasten analyze 명령을 실행할 수 있습니다.
chasten analyze multicounter
--config < path to the chasten-configuration/ directory | config url >
--search-path < path to the multicounter/ directory >
--save-directory < path to the subject-data/lazytracker/ directory >
--save 이제 출력을 스캔하여 예를 들어 chasten multicounter 프로젝트에서 10 테스트 기능을 찾도록 확인할 수 있습니다. subject-data/lazytracker 디렉토리를 살펴보면 chasten-results-multicounter-20230821171712-5c52f2f1b61b4cce97624cc34cb39d4f.json 및 multicounter 파일과 유사한 이름 구성 요소와 같은 JSON 파일을 찾을 수 있습니다.
all-test-function-definition Check는 프로그램에 1 ~ 10 테스트가 있어야한다는 것을 지정하기 때문에이 점검이 lazytracker 와 multicounter 모두에 대해 통과 함을 알 수 있습니다. 즉, chasten 0 오류 코드를 반환하여 수표가 통과 한 운영 체제에 통신합니다.
chasten analyze --help 입력하여 analyze 하위 명령을 사용하는 방법에 대한 자세한 내용을 알 수 있습니다. 예를 들어, chasten checks.yml 파일에 지정된 확인 속성에 대해 지정할 수있는 퍼지 일치 규칙에 따라 각각 특정 점검을 포함하고 제외 할 수있는 --check-include 및 --check-exclude 옵션을 지원합니다.
lazytracker 및 multicounter 프로그램에서 chasten 실행 한 후 개별 JSON 파일을 단일 JSON 파일, 관련 CSV 파일 및 SQLITE 데이터베이스에 통합 할 수 있습니다. integrated-data/ 디렉토리를 만든 후에는이 명령을 입력하여 통합을 수행 할 수 있습니다.
chasten integrate all-programs
< path to subject-data > / ** / * .json
--save-directory < path to the integrated-data/ directory > 이 명령은 chasten-flattened-csvs-sqlite-db-all-programs-20230823171016-2061b524276b4299b04359ba30452923/ 와 같은 디렉토리를 생성 할 것입니다. chasten.db 및 a csv/ directory와 함께 CSV/ Directory를 포함하는 SQL 라이트 데이터베이스를 포함하는 SQL 라이트 데이터베이스가 포함되어 있습니다. 데이터베이스.
chasten integrate --help 입력하여 integrate 하위 명령에 대한 자세한 내용을 배울 수 있습니다.
chasten Command를 활용할 때,이를 추가하면 --verbose 플래그는 문제 해결 경험을 크게 향상시키고 도구의 기능에 대한 자세한 이해를 제공 할 수 있습니다. chasten analyze lazytracker 의 예는 다음과 같습니다.
chasten analyze lazytracker
--config < path to the chasten-configuration/ directory >
--search-path < path to the lazytracker/ directory >
--save-directory < path to the subject-data/lazytracker/ directory >
--save
--verbose 이 명령을 실행하면 출력이 Matching source code: 도구가 지정된 패턴과 소스 코드를 적극적으로 비교하고 있음을 나타냅니다. 또한, 식별 된 수표에 대한 통찰력을 제공하여 상세한 매치 결과를 받게됩니다.
사용하는 대화식 분석 대시 보드를 만들려면? SIMONW/DATASETTE chasten datasette-serve <path containing integrated results>/chasten.db --port 8001 . 이제 웹 브라우저의 대시 보드를 사용하여 편집자와 함께 이러한 프로젝트의 소스 코드를 연구하는 동안 결과를 분석 할 수 있습니다! 결과를 검토하면 사용을 통해 chasten 낼 수 있습니까? Spookylukey/Pyastgrep는 XPath 표현식을 올바르게 사용하여 all-test-function-definition 사용하여 각 테스트 내부에서 실행 가능한 소스 코드의 첫 번째 줄을 찾아 기능의 docString 및 주요 주석을 건너 뜁니다.
lazytracker 프로그램의 경우 chasten pytest 5 테스트 만 찾아서 실행하더라도 6 테스트 사례가 있다고보고합니다. 이는 lazytracker 의 tests/test_tracked.py Test Suite에 test_ 로 시작하는 다른 기능 내부의 test_ 로 시작하는 기능이 포함되어 있기 때문입니다. 이 예제는 chasten 사용한 정적 분석의 한계를 보여줍니다! 도구가 모든 "테스트 기능"을 올바르게 감지했지만 테스트 스위트의 기능의 중첩은 pytest OUTER test_ 기능을 실행하고 테스트 목적으로 내부 test_ 기능을 사용한다는 것을 의미합니다.
그렇게 말하면, chasten multicounter 프로젝트에 대한 각 테스트를 올바르게 찾습니다. 이 문서의 이전 단계를 따라 자신의 Python 프로그램에 chasten 적용 할 수 있습니다!
모든 사람이 공부할 수 있도록 chasten.db 공개적으로 이용할 수있게하려면 chasten datasette-publish 하위 명령을 사용할 수 있습니다. 설치 지침을 따르는 한? simonw/datasette-publish-fly 및? SIMONW/DATASETTE-PUBLISH-VERCEL 플러그인을 사용하여 chasten.db 호스팅하는 공개 datasette 서버를 배포 할 수 있습니다. 예를 들어, 명령을 실행하여 chasten datasette-publish <path containing integrated results>/chasten.db --platform vercel lazytracker 에서 chasten multicounter 한 결과를 게시합니다.
중요하게도 --platform vercel 옵션과 함께 chasten datasette-publish 명령을 사용하려면 이전에 datasette-publish-vercel 플러그인의 지침을 따라 vercel 명령 줄 도구를 설치해야합니다. datasette-publish-vercel 은 chasten 의 종속성 중 하나이지만 datasette-publish-vercel 사용하더라도 vercel 도구를 제공하지 chasten 때문에 필요합니다. 데이터베이스를 게시하기 전에 비슷한 단계를 밟아야합니다!
chasten 은 명령 줄 응용 프로그램이지만 터미널 사용자 인터페이스 (TUI)를 통해 대화식으로 도구의 명령 줄 인수 및 옵션을 작성합니다. TUI 기반 방법을 사용하여 chasten 위한 완전한 명령 줄을 만들려면 chasten interact 명령을 입력 할 수 있습니다.
Chasten 에는 내장 시스템 로그가 있습니다. Chasten을 사용하는 동안 터미널에서 chasten log 명령을 사용할 수 있습니다. 시스템 로그 기능을 통해 사용자는 chasten 이 생성 한 이벤트 및 메시지를 볼 수 있습니다. 또한, chasten log 기능은 버그와 버그가 발생하는 이벤트를 찾는 데 도움이됩니다. chasten 프로그램이 시스템 로그에 표시하려면 별도의 터미널을 열고 명령 chasten log 사용해야합니다. 또한 실행되는 각 명령에 대해 --debug-level <choice of level> 및 --debug-dest SYSLOG 추가해야합니다.
예를 들어, chasten datasette-serve --debug-level DEBUG --debug-dest SYSLOG < database path to file> 시스템 로그에서 다음 출력을 생성합니다.
? chasten: Analyze the AST of Python Source Code
? GitHub: https://github.com/gkapfham/chasten
Syslog server for receiving debugging information
Display verbose output? False
Debug level? DEBUG
Debug destination? SYSLOG
chasten 의 각 명령에는 --debug-level 추가 할 수있는 옵션이 있습니다. 디버그 레벨에는 5 가지 옵션 디버그, 정보, 경고, 오류 및 중요합니다. 각 레벨은 디버그가 가장 높은 오류 수준 인 입력에서 가장 낮은 수준 인 시스템 로그에서 다른 문제를 보여줍니다. 이에 대한 추가 정보를 활용하려면 debug.py 파일을 참조 할 수 있습니다.
class DebugLevel ( str , Enum ):
"""The predefined levels for debugging."""
DEBUG = "DEBUG"
INFO = "INFO"
WARNING = "WARNING"
ERROR = "ERROR"
CRITICAL = "CRITICAL" Usage: chasten [OPTIONS] COMMAND [ARGS]...
╭─ Options ───────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or │
│ customize the installation. │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────╮
│ analyze ? Analyze the AST of Python source code. │
│ configure ? Manage chasten ' s configuration. │
│ datasette-publish ? Publish a datasette to Fly or Vercel. │
│ datasette-serve ? Start a local datasette server. │
│ integrate ? Integrate files and make a database. │
│ interact Interactively configure and run. │
│ log ? Start the logging server. │
╰─────────────────────────────────────────────────────────────────────────────────────────────╯
다음 단계에 따라 향후 개발을 위해 chasten 도구를 설치하십시오.
파이썬과 시가 설치되면 Github의 Chasten 저장소로 이동하여 터미널의 git clone 명령을 사용하여 도구를 설치하십시오. 그런 다음 Chasten 디렉토리로 이동하여 명령 poetry install 실행하여 모든 종속성을 설치하십시오.
Docker를 사용하여 chasten 사용하는 옵션도 있습니다.
다음 단계를 따라 Docker를 사용하십시오.
Dockerfile 이있는 Chasten 디렉토리에 cddocker build -t chasten . 컨테이너를 만들려면docker run --rm -v "%cd%":/root/src -it chastendocker run --rm -v ${pwd}:/root/src -it chastendocker run --rm -v $(pwd):/root/src -it chastenpoetry install 내부docker ps 실행중인 컨테이너 정보를 볼 수 있습니다.docker commit <your-container-id> <your-image-name> 부근 설치를 저장하려면chasten 요구에 따라 Docker를 사용할 수 있습니다! Black 과 Ruff 사용하여 전체 프로젝트에서 미리 정의 된 형식 표준에 대한 코드 일관성, 가독성 및 준수를 보장하여 궁극적으로 개발자 간의 유지 관리 및 협업을 향상시킵니다.poetry run task fiximports 및/또는 poetry run task fixformat 새로운 기능을 배송하십시오. 기능에 라인 문제가 제공되면 테스트 스위트의 실패로 인해 빌드가 GitHub에서 중단됩니다.Pytest 및 Hypothesis 사용하여 코드 일관성, 가독성 및 프로젝트 전반에 걸쳐 확립 된 형식 표준과 정렬 할 수 있습니다. 기능에 대한 테스트 케이스를 작성할 때는 이름 지정 컨벤션 test_(name of file) 로 테스트 디렉토리에 새 파일을 만듭니다.poetry run task test 또는 배송 전에 OpenAI API 기반 기능 poetry run task test-api 테스트하려는 경우. 테스트 스위트없이 기능이 배송되면 테스트 스위트가 추가되지 않은 코드가 추가되어 GitHub에서 적용 범위가 낮아지고 향후 더 큰 문제로 이어질 수 있습니다. Simon Willison이 작성한 Chasten과 Symbex는 Python 소스 코드를 분석하도록 설계된 도구, 특히 파일 내에서 기능 및 클래스 검색에 중점을 둔 도구입니다. 그들은 공통 목표를 공유하지만, 특히 명령 줄 인터페이스와 기능 측면에서 둘 사이에 주목할만한 차이가 있습니다.
명령 줄 인터페이스 측면에서 Symbex는 다양한 옵션에 대한 약어를 사용하여 간결한 CLI를 사용합니다. 예를 들어, test_debug.py 라는 파일에서 함수 서명을 검색하라는 명령은 다음과 같습니다.
command : symbex - s - f symbex / test_debug . py
def test_debug_level_values ():
def test_debug_level_isinstance ():
def test_debug_level_iteration ():
def test_debug_destination_values ():
def test_debug_destination_isinstance ():
def test_debug_destination_iteration ():
def test_level_destination_invalid ():
def test_debug_destination_invalid ():반면에 Chasten은 Typer 및 Rich와 같은 Python 패키지를 활용하여 사용자 친화적이고 기능이 풍부한 명령 줄 인터페이스를 제공합니다. Chasten의 사용 가능한 명령에는 다음이 포함됩니다.
기능 측면에서 Symbex는 이름 또는 와일드 카드로 기능 및 클래스에 대한 Python 코드를 검색하도록 설계되었습니다. 함수 유형 (비동기 또는 비 동기력), 문서화 존재, 가시성 및 유형 주석을 포함한 다양한 기준에 따라 결과를 필터링하는 기능을 제공합니다.
반면에 Chasten의 analyze 명령은 Python 소스 코드에서 AST 분석을 수행합니다. 사용자는 프로젝트 이름, XPath 버전, 검색 경로 및 다양한 필터링 기준을 지정할 수 있습니다. Chasten은 속성, 값 및 일치 신뢰 수준에 따라 포함 및 제외 점검을 지원합니다. 이 도구는 또한 광범위한 구성 옵션과 Markdown을 포함한 다양한 형식으로 결과를 저장하는 기능을 제공합니다.
요약하면 Chasten과 Symbex는 모두 Python 소스 코드를 분석하는 일반적인 목적을 제공하지만 Chasten은 구성 및 결과 관리의 추가 기능을 갖춘보다 다재다능하고 사용자 친화적 인 CLI를 제공합니다. 반면에 Symbex는 기능 검색 및 필터링에 중점을 둔 간결한 CLI를 채택합니다. 두 도구 사이의 선택은 사용자의 환경 설정과 Python 코드 분석에 대한 특정 요구 사항에 따라 다릅니다.
Chasten 및 Symbex 외에도 Python 소스 코드를 통해 분석 및 검색을위한 고유 한 기능을 제공합니다. 각 도구는 각각 특정 사용 사례를 제공합니다.
