Tafiila

class aruudy.poetry.foot.Tafiila

Bases: object

A class describing the foot.

Methods Summary

get_form([used]) Get the form of this Tafiila (foot).
process(text_emeter) Process a given emeter to decide if it starts with this foot.

Methods Documentation

get_form(used=True)

Get the form of this Tafiila (foot).

Parameters:used (bool) – if True, it will return the used form. Otherwise, it will return the standard one.
Returns:The from describing this Tafiila (foot).
Return type:TafiilaComp
process(text_emeter)

Process a given emeter to decide if it starts with this foot.

Parameters:text_emeter (str) – The English meter of the text we want to process.
Returns:If the text’s emeter starts with one of this foot’s forms, this function will return a tuple of:
  • The form (TafiilaComp) which the emeter starts with.
  • The rest of the emeter

Otherwise, it returns (None, None)

Return type:tuple(TafiilaComp, str)