In a Python docstring how should one document the :rtype:
for a function that can return multiple possible data types?
For example, if a function can return defaultdict
OR dict
OR list
, based on the functions parameters, how do you document this?
Code example:
from collections import defaultdict
def read_state(state_file, state_file_type='defaultdict'):
"""Deserialize state file or create empty state and return it.
:param state_file: The path and file name of state file to read.
:type state_file: str
:param state_file_type: Data type in which state is stored.
:type state_file_type: str
:return: Current or new empty state.
:rtype: ?????
"""
if os.path.exists(state_file):
with open(state_file) as conf_fo:
state = json.load(conf_fo)
elif state_file_type == 'defaultdict':
state = defaultdict(lambda: defaultdict(list))
elif state_file_type == 'dict':
state = {}
elif state_file_type == 'list':
state = []
else:
raise TypeError("State file type not defined.")
return state
You can use 'or' explicitly in the rtype
:rtype: collections.defaultdict or dict or list
variant
:rtype: collections.defaultdict | dict | list
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With