call_report.fca.get_fca_file_metadata#

call_report.fca.get_fca_file_metadata(*, schedule: FCASchedule) → FileMetadata[source]#

Return the canonical FileMetadata for one FCA schedule.

Parsed from the packaged JSON on the first call for schedule, then cached for the life of the process.

Parameters:

scheduleFCASchedule: The schedule to return metadata for.

Returns:

FileMetadata: schedule’s canonical, cross-time field metadata.

Examples

>>> from call_report.fca import FCASchedule, get_fca_file_metadata
>>> metadata = get_fca_file_metadata(schedule=FCASchedule.RCB)
>>> metadata.name
'RCB'
>>> metadata.first_period.label
'2000Q1'
>>> "UNINUM" in metadata.file_schema
True