adjunct.opml¶

A simple, nay, simplistic! OPML parser.

`OpmlError` ¶

Raised when there's a problem parsing an OPML document.

Bases: list

An outline.

Contains the element's attributes in the attrs member and the outlines nested within it as elements.

Parameters:

Name	Type	Description	Default
`attrs`	`dict[str, str] \| None`	any attributes on the element	`None`
`items`	`Sequence[Outline]`	any child outlines nested within this outline	`()`
`root`	`bool`	is this outline the root outline?	`False`

Attributes:

Name	Type	Description
`attrs`	`dict[str, str]`	any attributes on the element
`root`	`bool`	is this outline the root outline?

Parse an OPML file from the given file object.

Parameters:

Name	Type	Description	Default
`fh`	`TextIO`	a file-like object containing an OPML document	required

Returns:

Type	Description
`Outline \| None`	An outline if the document could be parsed, otherwise `None`.

Parse an OPML document from the given string.

Parameters:

Name	Type	Description	Default
`s`	`str`	an OPML document.	required

Returns:

Type	Description
`Outline \| None`	An outline if the document could be parsed, otherwise `None`.

Convert an RFC 2822 timestamp (as used in OPML) to a UTC DateTime object.

Parameters:

Name	Type	Description	Default
`ts`	`str`	an RFC 2822 timestamp	required

Returns:

Type	Description
`datetime \| None`	A timezone-aware datetime, or `None` if the timestamp could not be parsed.