명명 된 튜플을 문서화하는 표준 방법은 무엇입니까?

Question

명명 된 튜플을 사용하여 여러 함수를 통과하는 여러 변수를 유지하면서 일부 코드를 정리하려고합니다. 다음은 간단한 예입니다 (실제로 몇 가지 추가 인수가 있습니다).

하기 전에 :

def my_function(session_cass, session_solr, session_mysql, some_var, another): 
"""Blah blah. 

Args: 
    session_cass (Session): Cassandra session to execute queries with. 
    session_solr (SolrConnection): Solr connection to execute requests with. 
    session_mysql (connection): MySQL connection to execute queries with. 
    some_var (str): Yada yada. 
    another (int): Yada yada. 
""" 

후 : 문서화 문자열에 대한

def my_function(sessions, some_var, another): 
"""Blah blah. 

Args: 
    sessions (namedtuple): Holds all the database sessions. 
    some_var (str): Yada yada. 
    another (int): Yada yada. 
""" 

, 나는 (this post에서 영감) 유형의 추가와 함께, 구글 스타일 가이드 다음 봤는데 어떤 정말 좋아 어떤 형식이 들어오는 지 추적하는 것이 훨씬 쉽기 때문입니다.

제 질문은이 시나리오에서 명명 된 튜플을 문서화하는 방법에 대해 설명하겠습니까? 분명히 현재 설정되어 있기 때문에 명명 된 튜플 내의 유형에 대한 정보가 없습니다. 여기에 문서화 문자열을 확장하거나 정의 된 곳에 이름이 붙은 파일을 문서화하는 방법이 있습니까?

나는이 매너에 클래스를 문서화 할 수 있지만 변수를 보유하는 것 이외에 다른 목적을 가지고 있지 않기 때문에 클래스를 사용하지 않으려 고합니다.

Answer 1

나는 구글 스타일 가이드에 익숙하지 않은,하지만 이것에 대해 방법 : namedtuple 또는 튜플 또는 목록 또는 무엇이든을위한

그게 내가 온이

def my_function(sessions, some_var, another): 
    """Blah blah. 

    Args: 
     sessions (sequence): A sequence of length n that 
          holds all the database sessions. 
          In position 0 need bla bla 
          In position 1 need ble ble 
          ... 
          In position n-1 need blu blu 
     some_var (str): Yada yada. 
     another (int): Yada yada. 
    """  

처럼 뭔가를 갈 것입니다 교환 할 수있다 반면 나는 어떻게

에 대한 namedtuple의 속성, 사전이

def my_function(sessions, some_var, another): 
    """Blah blah. 

    Args: 
     sessions (object): A object that holds all the database sessions. 
          It need the following attributes 
          bla_bla is ... 
          ble_ble is ... 
          ... 
          blu_blu is ... 
     some_var (str): Yada yada. 
     another (int): Yada yada. 
    """  

같은 어쩌면 무언가를 사용하는 경우 6,

def my_function(sessions, some_var, another): 
    """Blah blah. 

    Args: 
     sessions (map): A dictionary-like object that holds all the 
         database sessions, it need the following keys 
         bla_bla is ... 
         ble_ble is ... 
          ... 
         blu_blu is ... 
     some_var (str): Yada yada. 
     another (int): Yada yada. 
    """  

또는 각 인스턴스에서

def my_function(sessions, some_var, another): 
    """Blah blah. 

    Args: 
     sessions (customclass): Holds all the database sessions. 
     some_var (str): Yada yada. 
     another (int): Yada yada. 
    """ 

는 기능이 제대로 작동하는 데 필요한 최소한의 기능을 요청