Python에서 pydoc 모듈을 사용한 문서 생성

<시간/>

소개

파이독 모듈은 Python 모듈에서 문서를 자동으로 생성합니다. 문서는 콘솔에 텍스트 페이지로 저장하거나 웹 브라우저에 표시하거나 HTML 파일로 저장할 수 있습니다.

이 문서에서는 다양한 경우에 이러한 문서를 보는 방법을 배우고 Python 스크립트에 대한 문서를 만드는 데 도움이 되는 독스트링에 대해서도 배울 것입니다.

이제 pydoc의 사용법을 알았으니 시작하겠습니다.

pydoc 모듈은 Python과 함께 패키지로 제공되므로 별도로 다운로드하여 설치할 필요가 없습니다.

pydoc에 액세스하려면 먼저 가져와야 합니다.

import pydoc

pydoc의 도움말 기능을 사용하여 대화형 셸에 액세스할 수 있습니다.

이렇게 하려면 터미널을 실행하고 python 대화형 셸로 들어갑니다.

이제 pydoc을 가져온 다음 pydoc.help() 명령을 사용하여 대화형 셸을 시작합니다.

>>>import pydoc
>>>pydoc.help()

Python에서 pydoc 모듈을 사용한 문서 생성

이제 모듈 이름, 데이터 유형, 함수, 클래스 등을 입력하여 대화형 스크립트에서 바로 문서를 얻을 수 있습니다.

브라우저에서 문서를 보려면 pydoc을 사용하여 쉽게 볼 수 있습니다.

이번에는 파이썬 셸을 통해 명령을 실행할 필요가 없습니다. 오히려 인수를 제공하고 직접 실행할 수 있습니다.

그렇게 하려면 터미널을 실행하고 아래 명령을 입력하십시오.

python −m pydoc −b

그러면 브라우저의 로컬 시스템에 있는 모든 파이썬 모듈, 함수, 개체에 대한 문서가 생성됩니다.

이 방법으로 특정 키워드를 검색할 수도 있습니다.

C:\Users\vijay>python −m pydoc −b
Server ready at https://localhost:50621/
Server commands: [b]rowser, [q]uit
server> q
Server stopped

Python에서 pydoc 모듈을 사용한 문서 생성

def documentation():
   '''Documentation using docstrings'''
print(documentation.__doc__)
help(documentation)

Documentation using docstrings
Help on function documentation in module __main__:

documentation()
Documentation using docstrings

이제 pydoc 함수를 사용하여 오프라인에서 다양한 python 키워드, 함수, 모듈, 메서드에 대한 문서를 보고 읽는 방법을 알게 되었습니다.

또한 독스트링을 사용하여 자신만의 문서를 생성하고 만드는 방법을 배웠습니다.

대규모 프로젝트를 진행하는 동안 현재 수행 중인 작업을 파악하고 나중에 혼동을 피하기 위해 좋은 문서를 유지 관리하는 것이 중요합니다. 또한 다양한 알 수 없는 오류 또는 런타임 오류를 방지하는 데 도움이 됩니다.