Item Class

class rosteron.Item(date: datetime.date, title: str, detail: Sequence[Optional[str]])

An Item object represents one item on the roster.

Item objects aren’t returned directly; they are instead returned within a Snapshot object.

Data in an Item is minimally structured on the assumption that each RosterOn instance formats its data differently (the author has only seen data from one RosterOn Mobile instance). Future releases of this module can provide more structured output if samples are provided from other RosterOn Mobile instances.

Parameters:

• date – a date object.
• title – the text from the title above the roster item, minus the date and following separator.
• detail –

  a tuple of str/None values, where each value is either:

  • a string extracted from a <p> element in the roster item; or
  • None where an empty <p> element is encountered.