DownloadItem

class xbrl_filings_api.DownloadItem

Bases: object

Dataclass defining download item for download functions.

Attributes override download function parameters values for downloads of this file (JSON, XHTML, or package).

Methods

__repr__()	Return repr(self).
__str__()	Return str(self).

Attributes

filename	Name to be used for the saved file.
stem_pattern	Pattern to add to the filename stems.
to_dir	Directory to save the file.
__hash__

filename: str | None = None

Name to be used for the saved file.

Can only be set for Filing object download methods.

__hash__ = None

__repr__()

Return repr(self).

to_dir: str | PurePath | None = None

Directory to save the file.

stem_pattern: str | None = None

Pattern to add to the filename stems.

Placeholder “/name/” is always required.