이것은 Ubuntu Online, Fedora Online, Windows 온라인 에뮬레이터 또는 MAC OS 온라인 에뮬레이터와 같은 여러 무료 온라인 워크스테이션 중 하나를 사용하여 OnWorks 무료 호스팅 공급자에서 실행할 수 있는 pydocstyle 명령입니다.
프로그램:
이름
pydocstyle - pydocstyle 문서
(이전 pep257)
파이독스타일 Python docstring 준수 여부를 확인하기 위한 정적 분석 도구입니다.
관례.
파이독스타일 대부분을 지원합니다 PEP 257 즉시 사용할 수 있지만
참조 구현.
1. 설치
핍 설치 pydocstyle
2. 실행
$ 파이독스타일 test.py
test.py:18 비공개 중첩 클래스 `meta`:
D101: 문서 문자열 누락
test.py:22 공개 메서드 `method`:
D102: 문서 문자열 누락
...
3. 코드 수정 :)
내용 :
사용법
설치
삐악 삐악 울다 또는 easy_install:
핍 설치 pydocstyle
또는 다음을 사용할 수 있습니다. 파이독스타일.py 소스 파일 직접 - 자체 포함되어 있습니다.
명령 라인 인터페이스
용법
사용법: pydocstyle [옵션] [ ...]
옵션 :
--version 프로그램의 버전 번호를 표시하고 종료합니다.
-h, --help 이 도움말 메시지를 표시하고 종료
-e, --explain 각 오류에 대한 설명 표시
-s, --source 각 오류에 대한 소스 표시
-d, --debug 디버그 정보 인쇄
-v, --자세한 출력 상태 정보
--count 총 오류 수를 stdout으로 출력
--선택= 다음을 지정하여 확인된 오류의 기본 목록을 선택합니다.
확인할 오류(쉼표-
분리된 오류 코드). 예를 들어:
--선택=D101,D202
--무시= 다음을 지정하여 확인된 오류의 기본 목록을 선택합니다.
무시할 오류(쉼표로 구분된 목록 포함)
오류 코드). 예: --ignore=D101,D202
--협약= 다음을 지정하여 확인된 오류의 기본 목록을 선택합니다.
기존 컨벤션. 가능한 규칙: pep257
--추가-선택= 다음을 지정하여 확인할 오류 목록을 수정합니다.
더 많은 오류 코드를 확인하십시오.
--추가-무시= 다음을 지정하여 확인할 오류 목록을 수정합니다.
무시할 더 많은 오류 코드.
--일치= 정확히 일치하는 파일만 확인 정기적인
표현; 기본값은 --match='(?!test_).*\.py' 입니다.
'test_'로 시작하지 않고 끝나는 파일과 일치
'.py'로
--일치-디렉토리=
정확히 일치하는 디렉토리만 검색 정기적인
표현; 기본값은 --match-dir='[^\.].*'입니다.
점으로 시작하지 않는 모든 디렉토리와 일치
반품 암호
┌──┬─────────────────────────────────┐
│0 │ 성공 - 위반 없음 │
├──┼─────────────────────────────────┤
│1 │ 일부 규정 위반이 발견됨 │
├──┼─────────────────────────────────┤
│2 │ 불법 사용 - 오류 참조 │
│ │ 메시지 │
└──┴─────────────────────────────────┘
구성 파일
파이독스타일 지원 INI-같은 구성 파일. 위해서는 파이독스타일 그것을 사용하기 위해, 그것을
다음 옵션 중 하나로 이름을 지정해야 하며 [파이독 스타일] 안내
· 설정.cfg
· tox.ini
· .pydoc스타일
· .pydocstylerc
구성 파일을 검색할 때, 파이독스타일 지정된 파일 중 하나를 찾습니다
위의 in 그 정확한 주문. 구성 파일을 찾을 수 없으면 계속 찾습니다.
하나를 찾거나 기본 구성을 사용할 때까지 디렉토리 트리를 위로 이동합니다.
알림:
이전 버전과의 호환성을 위해 파이독스타일 명명된 구성 파일 지원
.pep257, 뿐만 아니라 섹션 헤더 [펩257]. 그러나 이들은 더 이상 사용되지 않는 것으로 간주됩니다.
다음 주 버전에서는 지원이 제거됩니다.
유효한 옵션
일부 구성 옵션은 구성 파일에서 사용할 수 없습니다. 사용 가능한 옵션
위치 :
· 컨벤션
· 고르다
· 무시
· 추가_선택
· 추가_무시
· 일치
· match_dir
을 참조 용법 자세한 내용은 섹션을 참조하십시오.
계승
기본적으로 구성 파일을 찾을 때 파이독스타일 부모 상속 시도
디렉토리의 구성을 로컬 구성에 병합합니다.
병합 프로세스는 다음과 같습니다.
· 다음 중 하나인 경우 고르다, 무시 or 컨벤션 하위 구성에 지정됨 -
상위 구성을 무시하고 확인할 새 오류 코드를 설정합니다. 그렇지 않으면 간단히
부모가 확인한 오류 코드를 복사합니다.
· 만약에 추가-무시 or 추가 선택 지정된 오류 코드를 추가하거나 제거합니다.
확인된 오류 코드 목록에서.
· 만약에 일치 or 일치 디렉토리 지정되었습니다 - 사용하십시오. 그렇지 않으면 부모의 것을 사용하십시오.
이를 비활성화하려면(repo의 루트에 있는 구성 파일에 유용함),
간단히 추가 상속=거짓 구성 파일에.
알림:
만약에 고르다, 무시 or 컨벤션 CLI에 지정되었으며 구성
파일은 검사할 오류 코드를 선택하는 데 관여하지 않습니다. 일치 and
일치 디렉토리 여전히 유효합니다.
예시
[파이독 스타일]
상속 = 거짓
무시 = D100,D203,D405
일치 = *.py
ERROR 코드
그룹화
┌─────────────────────────┬─────────────────────── ───────────┐
│누락 독 스트링 │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D100 │ 공개된 독스트링 누락 │
│ │ 모듈 │
├─────────────────────────┼─────────────────────── ───────────┤
│D101 │ 공개된 독스트링 누락 │
│ │ 클래스 │
├─────────────────────────┼─────────────────────── ───────────┤
│D102 │ 공개된 독스트링 누락 │
│ │ 방법 │
├─────────────────────────┼─────────────────────── ───────────┤
│D103 │ 공개된 독스트링 누락 │
│ │ 기능 │
├─────────────────────────┼─────────────────────── ───────────┤
│D104 │ 공개된 독스트링 누락 │
│ │ 패키지 │
├─────────────────────────┼─────────────────────── ───────────┤
│D105 │ 매직에서 독스트링 누락 │
│ │ 방법 │
├─────────────────────────┼─────────────────────── ───────────┤
│공백 문제 │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D200 │ 한 줄 독스트링이 맞아야 함 │
│ │ 따옴표가 있는 한 줄 │
├─────────────────────────┼─────────────────────── ───────────┤
│D201 │ 이전에는 빈 줄을 사용할 수 없습니다.
│ │ 함수 독스트링 │
├─────────────────────────┼─────────────────────── ───────────┤
│D202 │ │ 다음에는 빈 줄을 사용할 수 없습니다.
│ │ 함수 독스트링 │
├─────────────────────────┼─────────────────────── ───────────┤
│D203 │ 이전에 1개의 빈 줄이 필요함 │
│ │ 클래스 독스트링 │
├─────────────────────────┼─────────────────────── ───────────┤
│D204 │ │ 다음에 빈 줄 1개가 필요합니다.
│ │ 클래스 독스트링 │
├─────────────────────────┼─────────────────────── ───────────┤
│D205 │ │ 사이에 1개의 빈 줄이 필요합니다.
│ │ 요약 줄 및 설명 │
└─────────────────────────┴─────────────────────── ───────────┘
│D206 │ 독스트링은 들여쓰기 해야 함 │
│ │ 탭이 아닌 공백 포함 │
├─────────────────────────┼─────────────────────── ───────────┤
│D207 │ Docsstring이 덜 들여쓰기됨 │
├─────────────────────────┼─────────────────────── ───────────┤
│D208 │ Docsstring이 과도하게 들여쓰기됨 │
├─────────────────────────┼─────────────────────── ───────────┤
│D209 │ 여러 줄 독스트링 닫기 │
│ │ 따옴표는 별도의 │에 있어야 합니다.
│ │ 라인 │
├─────────────────────────┼─────────────────────── ───────────┤
│D210 │ 공백이 허용되지 않음 │
│ │ 주변 독스트링 텍스트 │
├─────────────────────────┼─────────────────────── ───────────┤
│D211 │ 이전에는 빈 줄을 사용할 수 없습니다.
│ │ 클래스 독스트링 │
├─────────────────────────┼─────────────────────── ───────────┤
│인용 부호 문제 │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D300 │ """큰따옴표 XNUMX개""" 사용 │
├─────────────────────────┼─────────────────────── ───────────┤
│D301 │ │에 백슬래시가 있으면 r"""을 사용하십시오.
│ │ 독스트링 │
├─────────────────────────┼─────────────────────── ───────────┤
│D302 │ 유니코드 독스트링에 u""" 사용 │
├─────────────────────────┼─────────────────────── ───────────┤
│독스트링 내용 문제 │ │
├─────────────────────────┼─────────────────────── ───────────┤
│D400 │ 첫 줄은 │로 끝나야 합니다.
│ │ 기간 │
├─────────────────────────┼─────────────────────── ───────────┤
│D401 │ 첫 번째 줄은 │에 있어야 합니다.
│ │ 긴박한 분위기 │
├─────────────────────────┼─────────────────────── ───────────┤
│D402 │ 첫 번째 줄은 │가 아니어야 합니다.
│ │ 함수의 "서명" │
├─────────────────────────┼─────────────────────── ───────────┤
│D403 │ 첫 줄의 첫 단어 │
│ │ 대소문자를 구분해야 함 │
└─────────────────────────┴─────────────────────── ───────────┘
태만 확인하는 것이 좋다.
모든 오류 코드가 기본적으로 확인되는 것은 아닙니다. 기본 동작은 확인만 하는 것입니다.
일부인 오류 코드 PEP257 공식 대회.
위의 모든 오류 코드는 D203을 제외하고 기본적으로 확인됩니다.
pydocstyle은 Vladimir Keleshev가 만든 프로젝트인 pep257의 이름 변경 및 연속입니다.
Amir Rachum이 관리합니다.
onworks.net 서비스를 사용하여 온라인에서 pydocstyle 사용