template.py

"""
An example of the Template pattern in Python

*TL;DR
Defines the skeleton of a base algorithm, deferring definition of exact
steps to subclasses.

*Examples in Python ecosystem:
Django class based views: https://docs.djangoproject.com/en/2.1/topics/class-based-views/
"""


defget_text() ->str:
return"plain-text"


defget_pdf() ->str:
return"pdf"


defget_csv() ->str:
return"csv"


defconvert_to_text(data: str) ->str:
print("[CONVERT]")
returnf"{data} as text"


defsaver() ->None:
print("[SAVE]")


deftemplate_function(getter, converter=False, to_save=False) ->None:
data=getter()
print(f"Got `{data}`")

iflen(data) <=3andconverter:
data=converter(data)
else:
print("Skip conversion")

ifto_save:
saver()

print(f"`{data}` was processed")


defmain():
"""
 >>> template_function(get_text, to_save=True)
 Got `plain-text`
 Skip conversion
 [SAVE]
 `plain-text` was processed

 >>> template_function(get_pdf, converter=convert_to_text)
 Got `pdf`
 [CONVERT]
 `pdf as text` was processed

 >>> template_function(get_csv, to_save=True)
 Got `csv`
 Skip conversion
 [SAVE]
 `csv` was processed
 """


if__name__=="__main__":
importdoctest

doctest.testmod()