# {py:mod}`arelle.packages.report.ReportPackage`

```{py:module} arelle.packages.report.ReportPackage
```

```{autodoc2-docstring} arelle.packages.report.ReportPackage
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ReportEntry <arelle.packages.report.ReportPackage.ReportEntry>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry
    :summary:
    ```
* - {py:obj}`ReportPackage <arelle.packages.report.ReportPackage.ReportPackage>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`pathsContainReportsDirectory <arelle.packages.report.ReportPackage.pathsContainReportsDirectory>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.pathsContainReportsDirectory
    :summary:
    ```
* - {py:obj}`getReportPackageTopLevelDirectory <arelle.packages.report.ReportPackage.getReportPackageTopLevelDirectory>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.getReportPackageTopLevelDirectory
    :summary:
    ```
* - {py:obj}`getReportPackageJsonFile <arelle.packages.report.ReportPackage.getReportPackageJsonFile>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.getReportPackageJsonFile
    :summary:
    ```
* - {py:obj}`getPackageJson <arelle.packages.report.ReportPackage.getPackageJson>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.getPackageJson
    :summary:
    ```
* - {py:obj}`forbidDuplicateKeys <arelle.packages.report.ReportPackage.forbidDuplicateKeys>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.forbidDuplicateKeys
    :summary:
    ```
* - {py:obj}`getAllReportEntries <arelle.packages.report.ReportPackage.getAllReportEntries>`
  - ```{autodoc2-docstring} arelle.packages.report.ReportPackage.getAllReportEntries
    :summary:
    ```
````

### API

````{py:function} pathsContainReportsDirectory(paths: set[str], topLevelDir: str) -> bool
:canonical: arelle.packages.report.ReportPackage.pathsContainReportsDirectory

```{autodoc2-docstring} arelle.packages.report.ReportPackage.pathsContainReportsDirectory
```
````

````{py:function} getReportPackageTopLevelDirectory(filesource: arelle.FileSource.FileSource) -> str | None
:canonical: arelle.packages.report.ReportPackage.getReportPackageTopLevelDirectory

```{autodoc2-docstring} arelle.packages.report.ReportPackage.getReportPackageTopLevelDirectory
```
````

````{py:function} getReportPackageJsonFile(filesource: arelle.FileSource.FileSource, stld: str | None) -> str | None
:canonical: arelle.packages.report.ReportPackage.getReportPackageJsonFile

```{autodoc2-docstring} arelle.packages.report.ReportPackage.getReportPackageJsonFile
```
````

````{py:function} getPackageJson(filesource: arelle.FileSource.FileSource, selection: str | None) -> dict[str, typing.Any] | None
:canonical: arelle.packages.report.ReportPackage.getPackageJson

```{autodoc2-docstring} arelle.packages.report.ReportPackage.getPackageJson
```
````

````{py:function} forbidDuplicateKeys(pairs: list[tuple[typing.Any, typing.Any]]) -> typing.Any
:canonical: arelle.packages.report.ReportPackage.forbidDuplicateKeys

```{autodoc2-docstring} arelle.packages.report.ReportPackage.forbidDuplicateKeys
```
````

````{py:function} getAllReportEntries(filesource: arelle.FileSource.FileSource, stld: str | None) -> list[ReportEntry] | None
:canonical: arelle.packages.report.ReportPackage.getAllReportEntries

```{autodoc2-docstring} arelle.packages.report.ReportPackage.getAllReportEntries
```
````

`````{py:class} ReportEntry
:canonical: arelle.packages.report.ReportPackage.ReportEntry

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry
```

````{py:attribute} baseDir
:canonical: arelle.packages.report.ReportPackage.ReportEntry.baseDir
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.baseDir
```

````

````{py:attribute} files
:canonical: arelle.packages.report.ReportPackage.ReportEntry.files
:type: list[str]
:value: >
   None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.files
```

````

````{py:property} primary
:canonical: arelle.packages.report.ReportPackage.ReportEntry.primary
:type: str

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.primary
```

````

````{py:property} fullPathPrimary
:canonical: arelle.packages.report.ReportPackage.ReportEntry.fullPathPrimary
:type: str

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.fullPathPrimary
```

````

````{py:property} isInline
:canonical: arelle.packages.report.ReportPackage.ReportEntry.isInline
:type: bool

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.isInline
```

````

````{py:property} fullPathFiles
:canonical: arelle.packages.report.ReportPackage.ReportEntry.fullPathFiles
:type: list[str]

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.fullPathFiles
```

````

````{py:property} isTopLevel
:canonical: arelle.packages.report.ReportPackage.ReportEntry.isTopLevel
:type: bool

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.isTopLevel
```

````

````{py:property} dir
:canonical: arelle.packages.report.ReportPackage.ReportEntry.dir
:type: str

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportEntry.dir
```

````

`````

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

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.__init__
```

````{py:method} fromFileSource(filesource: arelle.FileSource.FileSource) -> arelle.packages.report.ReportPackage.ReportPackage | None
:canonical: arelle.packages.report.ReportPackage.ReportPackage.fromFileSource
:staticmethod:

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.fromFileSource
```

````

````{py:property} documentInfo
:canonical: arelle.packages.report.ReportPackage.ReportPackage.documentInfo
:type: typing.Any

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.documentInfo
```

````

````{py:property} documentType
:canonical: arelle.packages.report.ReportPackage.ReportPackage.documentType
:type: typing.Any

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.documentType
```

````

````{py:property} stld
:canonical: arelle.packages.report.ReportPackage.ReportPackage.stld
:type: str | None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.stld
```

````

````{py:property} reportType
:canonical: arelle.packages.report.ReportPackage.ReportPackage.reportType
:type: arelle.packages.report.ReportPackageConst.ReportType | None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.reportType
```

````

````{py:property} allReports
:canonical: arelle.packages.report.ReportPackage.ReportPackage.allReports
:type: list[arelle.packages.report.ReportPackage.ReportEntry] | None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.allReports
```

````

````{py:property} reports
:canonical: arelle.packages.report.ReportPackage.ReportPackage.reports
:type: list[arelle.packages.report.ReportPackage.ReportEntry] | None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.reports
```

````

````{py:property} reportPackageJson
:canonical: arelle.packages.report.ReportPackage.ReportPackage.reportPackageJson
:type: dict[str, typing.Any] | None

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.reportPackageJson
```

````

````{py:property} reportPackageZip
:canonical: arelle.packages.report.ReportPackage.ReportPackage.reportPackageZip
:type: zipfile.ZipFile

```{autodoc2-docstring} arelle.packages.report.ReportPackage.ReportPackage.reportPackageZip
```

````

`````