arelle.packages.report.ReportPackage

See COPYRIGHT.md for copyright information.

Module Contents

Classes

ReportEntry
ReportPackage

Functions

pathsContainReportsDirectory
getReportPackageTopLevelDirectory
getReportPackageJsonFile
getPackageJson
forbidDuplicateKeys
getAllReportEntries

API

arelle.packages.report.ReportPackage.pathsContainReportsDirectory(paths: set[str], topLevelDir: str) → bool

arelle.packages.report.ReportPackage.getReportPackageTopLevelDirectory(filesource: arelle.FileSource.FileSource) → str | None

arelle.packages.report.ReportPackage.getReportPackageJsonFile(filesource: arelle.FileSource.FileSource, stld: str | None) → str | None

arelle.packages.report.ReportPackage.getPackageJson(filesource: arelle.FileSource.FileSource, selection: str | None) → dict[str, Any] | None

arelle.packages.report.ReportPackage.forbidDuplicateKeys(pairs: list[tuple[Any, Any]]) → Any

arelle.packages.report.ReportPackage.getAllReportEntries(filesource: arelle.FileSource.FileSource, stld: str | None) → list[ReportEntry] | None

class arelle.packages.report.ReportPackage.ReportEntry

baseDir: str

None

files: list[str]

None

property primary: str

property fullPathPrimary: str

property isInline: bool

property fullPathFiles: list[str]

property isTopLevel: bool

property dir: str

class arelle.packages.report.ReportPackage.ReportPackage(reportPackageZip: zipfile.ZipFile, stld: str | None, reportType: arelle.packages.report.ReportPackageConst.ReportType | None, reportPackageJson: dict[str, Any] | None, reports: list[arelle.packages.report.ReportPackage.ReportEntry] | None)

Initialization

static fromFileSource(filesource: arelle.FileSource.FileSource) → arelle.packages.report.ReportPackage.ReportPackage | None

property documentInfo: Any

property documentType: Any

property stld: str | None

property reportType: arelle.packages.report.ReportPackageConst.ReportType | None

property allReports: list[arelle.packages.report.ReportPackage.ReportEntry] | None

property reports: list[arelle.packages.report.ReportPackage.ReportEntry] | None

property reportPackageJson: dict[str, Any] | None

property reportPackageZip: zipfile.ZipFile