풀 요청을 통해 파이썬 코드 스타일을 자동으로 검토하는 github 앱


pycodestyle 또는 flake8 중에서 Linter로 선택할 수 있습니다. 봇은 두 가지 모두에 대한 구성을 읽을 수 있습니다.[flake8] 및 [pycodestyle] 섹션의 setup.cfg 읽을 수 있습니다. 아래 Configuration 섹션을 확인하십시오. 통합이 작동하기 위해 구성 파일이 필요하지 않습니다 . 그러나 프로젝트 루트에 .pep8speaks.yml 파일을 추가하여 추가로 구성 할 수 있습니다. 예는 다음과 같습니다.
# File : .pep8speaks.yml
scanner :
diff_only : True # If False, the entire file touched by the Pull Request is scanned for errors. If True, only the diff is scanned.
linter : pycodestyle # Other option is flake8
pycodestyle : # Same as scanner.linter value. Other option is flake8
max-line-length : 100 # Default is 79 in PEP 8
ignore : # Errors and warnings to ignore
- W504 # line break after binary operator
- E402 # module level import not at top of file
- E731 # do not assign a lambda expression, use a def
- C406 # Unnecessary list literal - rewrite as a dict literal.
- E741 # ambiguous variable name
no_blank_comment : True # If True, no comment is made on PR without any errors.
descending_issues_order : False # If True, PEP 8 issues in message will be displayed in descending order of line numbers in the file
message : # Customize the comment made by the bot
opened : # Messages when a new PR is submitted
header :
" Hello @{name}! Thanks for opening this PR. "
# The keyword {name} is converted into the author's username
footer :
" Do see the [Hitchhiker's guide to code style](https://goo.gl/hqbW4r) "
# The messages can be written as they would over GitHub
updated : # Messages when new commits are added to the PR
header : " Hello @{name}! Thanks for updating this PR. "
footer : " " # Why to comment the link to the style guide everytime? :)
no_errors : " There are currently no PEP 8 issues detected in this Pull Request. Cheers! :beers: "참고 :
.pep8speaks.yml 은이 값을 무시합니다.base 분기 (기존 분기)에서 .pep8speaks.yml 찾습니다. 파일을 찾을 수 없으면 head 브랜치 (들어오는 변경)를 검색합니다.scanner.linter 의 값을 pycodestyle 또는 flake8 로 설정하십시오.ignore 또는 max-line-length )의 경우 PEP8speaks는 다음 순서로 구성을보고 우선 순위를 정합니다.pycodestyle: 또는 flake8: .pep8speaks.yml 의 섹션.scanner.linter 값에 따라 다릅니다.[pycodestyle] 또는 [flake8] setup.cfg 프로젝트의 루트에있는 [flake8] 섹션.scanner.linter 와 무관합니다. 따라서 setup.cfg 의 [flake8] 섹션도 pycodestyle에서도 작동합니다.| 조직 | 설명 | |
|---|---|---|
| 팬더 | 파이썬을위한 강력한 데이터 조작 도구 | |
| 어도비 벽돌 | Adobe의 오픈 소스 | |
| OpenSuse | 리눅스 배포 | |
| Pytorch Lightning | ML 연구원을위한 가벼운 파이터 래퍼. | |
| 네트워크 | 그래프 이론 및 복잡한 네트워크를위한 파이썬 라이브러리 | |
| 통계 모들 | 파이썬의 통계 모델링 및 경제학 | |
| Xarray (Pydata) | 파이썬의 ND 라벨링 된 배열 및 데이터 세트 (데이터 용 파이썬) | |
![]() | 호피 | 태양열 물리학을위한 파이썬 |
| astropy | 파이썬의 천문학 | |
| Scikit은 기여를 배웁니다 | Scikit-Learn 호환 프로젝트 | |
| Scikit 이미지 | 파이썬의 이미지 처리 | |
| 스파이더 IDE | 과학적 파이썬 개발 환경 | |
![]() | 촉매 | 딥 러닝 연구 및 개발을위한 Pytorch 프레임 워크 |
조직 및 사용자의 전체 목록을 참조하십시오.
@pep8speaks suggest diff , PR에 대한 수정을 제안하는 Diff의 요점을 주석 할 것입니다. 예@pep8speaks pep8ify pr의 저자의 분기에 대해 autopep8 에서 제안한 변경 사항으로 풀 요청을 생성합니다. autopep8 pycodestyle 에서보고 한 대부분의 오류를 수정합니다.[skip pep8] Messag이 앱은 공개적으로 호스팅 된 저장소에만 작동합니다. 따라서 포크를 배포하거나 개인 리포지토리에 앱을 사용하려는 경우 지침은 다음과 같습니다.
pep8 이라고 알려짐)으로 로컬로 오류를 확인하십시오. 앱에 대한 업데이트는 여기에 Github 릴리스 기능을 사용하여 발표됩니다. 커뮤니티가 커짐에 따라 많은 주요 변화가 이루어집니다. 새 구성 또는 기능 업데이트에 대한 알림을 얻으려면 Watch -> Releases only 클릭하십시오.
일반적으로 풀 요청이 저장소에 병합 되 자마자 마스터 브랜치가 배포됩니다. 그러나 매주 금요일마다 릴리스를하고 최신 코드가 배치되어 있는지 확인합니다. 최신 버전을 사용하기 위해 아무것도 할 필요가 없습니다. Pep 8의 포크를 사용하는 경우 릴리스 공간을 확인하십시오.
금 스폰서가되어 README 및 웹 사이트에서 귀하의 사이트에 대한 링크와 함께 로고와 이름을 얻으십시오.
사마 그라 거버넌스 | ![]() Samagrax |
금 스폰서가되어 README 및 웹 사이트에서 귀하의 사이트에 대한 링크와 함께 로고와 이름을 얻으십시오.
파이썬 소프트웨어 재단 | Weblate |
은 스폰서가되어 README 및 웹 사이트의 사이트에 대한 링크와 함께 로고와 이름을 얻으십시오.
ccextractor | Sudhanshu Mishra |
개발에 기여하여 프로젝트를 지원할 수 있습니다. 새로운 기능이나 개선 사항에 대한 제안이 있으면 문제를 만드십시오. 풀 요청이 가장 환영합니다! Doc 기고를 읽고 프로젝트의 작동 방식과 변경 방법을 이해하십시오.
이 프로젝트는 서버에서 호스팅해야하며, 이로 인해 재정 지원이 필요합니다.
Pep 8의 자금 조달 사례를 읽으십시오.
이 프로젝트를 사용하고 마음에 들면 알려주십시오. 감사해요!
❤️
이 프로젝트는 원래 PEP 8의 모든 규칙을 보증하지 않으므로 pycodestyle 사용자 정의를 믿습니다.
.