있습니다 doctstring 예 해당 설명서에서 스핑크스에 대한이. 특히 그들은 다음을 보여줍니다.
def public_fn_with_googley_docstring(name, state=None):
"""This function does something.
Args:
name (str): The name to use.
Kwargs:
state (bool): Current state to be in.
Returns:
int. The return code::
0 -- Success!
1 -- No good.
2 -- Try again.
Raises:
AttributeError, KeyError
A really great idea. A way you might use me is
>>> print public_fn_with_googley_docstring(name='foo', state=None)
0
BTW, this always returns 0. **NEVER** use with :class:`MyPublicClass`.
"""
return 0
질문했지만 스핑크스명시 적으로 Google Python 스타일 가이드를 가리킬 것 입니다. 그들의 독 스트링 예는 그들이 kwargs를 구체적으로 부르지 않는다는 것을 암시하는 것 같습니다. (other_silly_variable = 없음)
def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
"""Fetches rows from a Bigtable.
Retrieves rows pertaining to the given keys from the Table instance
represented by big_table. Silly things may happen if
other_silly_variable is not None.
Args:
big_table: An open Bigtable Table instance.
keys: A sequence of strings representing the key of each table row
to fetch.
other_silly_variable: Another optional variable, that has a much
longer name than the other args, and which does nothing.
Returns:
A dict mapping keys to the corresponding table row data
fetched. Each row is represented as a tuple of strings. For
example:
{'Serak': ('Rigel VII', 'Preparer'),
'Zim': ('Irk', 'Invader'),
'Lrrr': ('Omicron Persei 8', 'Emperor')}
If a key from the keys argument is missing from the dictionary,
then that row was not found in the table.
Raises:
IOError: An error occurred accessing the bigtable.Table object.
"""
pass
ABB는 하위 프로세스 관리 문서를 참조하는 데 허용되는 답변에 대해 질문이 있습니다. 모듈을 가져 오면 inspect.getsource를 통해 모듈 독 스트링을 빠르게 볼 수 있습니다.
Silent Ghost의 권장 사항을 사용하는 파이썬 인터프리터의 예 :
>>> import subprocess
>>> import inspect
>>> import print inspect.getsource(subprocess)
물론 도움말 기능을 통해 모듈 문서를 볼 수도 있습니다. 예를 들어 help (subprocess)
개인적으로 kwargs에 대한 하위 프로세스 독 스트링의 팬은 아니지만 Google 예제와 마찬가지로 Sphinx 문서 예제에 표시된대로 kwargs를 별도로 나열하지 않습니다.
def call(*popenargs, **kwargs):
"""Run command with arguments. Wait for command to complete, then
return the returncode attribute.
The arguments are the same as for the Popen constructor. Example:
retcode = call(["ls", "-l"])
"""
return Popen(*popenargs, **kwargs).wait()
ABB의 질문에 대한이 답변을 포함하고 있습니다. 코드에 주석을 달기위한 통찰력과 영감을 얻기 위해 이러한 방식으로 모든 모듈의 소스 또는 문서를 검토 할 수 있다는 점에 주목할 가치가 있기 때문입니다.