# {py:mod}`phystool.pdbfile`

```{py:module} phystool.pdbfile
```

```{autodoc2-docstring} phystool.pdbfile
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`PDBFile <phystool.pdbfile.PDBFile>`
  -
* - {py:obj}`CheckForTikzMixin <phystool.pdbfile.CheckForTikzMixin>`
  - ```{autodoc2-docstring} phystool.pdbfile.CheckForTikzMixin
    :summary:
    ```
* - {py:obj}`Exercise <phystool.pdbfile.Exercise>`
  -
* - {py:obj}`Theory <phystool.pdbfile.Theory>`
  -
* - {py:obj}`TP <phystool.pdbfile.TP>`
  -
* - {py:obj}`QCM <phystool.pdbfile.QCM>`
  -
* - {py:obj}`Figure <phystool.pdbfile.Figure>`
  -
````

### Data

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

* - {py:obj}`logger <phystool.pdbfile.logger>`
  - ```{autodoc2-docstring} phystool.pdbfile.logger
    :summary:
    ```
* - {py:obj}`FILE_TYPE_MAP <phystool.pdbfile.FILE_TYPE_MAP>`
  - ```{autodoc2-docstring} phystool.pdbfile.FILE_TYPE_MAP
    :summary:
    ```
* - {py:obj}`VALID_TYPES <phystool.pdbfile.VALID_TYPES>`
  - ```{autodoc2-docstring} phystool.pdbfile.VALID_TYPES
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: phystool.pdbfile.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} phystool.pdbfile.logger
```

````

`````{py:class} PDBFile(tex_file: pathlib.Path)
:canonical: phystool.pdbfile.PDBFile

Bases: {py:obj}`abc.ABC`

````{py:attribute} PDB_TYPE
:canonical: phystool.pdbfile.PDBFile.PDB_TYPE
:type: str
:value: >
   None

```{autodoc2-docstring} phystool.pdbfile.PDBFile.PDB_TYPE
```

````

````{py:method} validate_type(list_of_types: str) -> list[str]
:canonical: phystool.pdbfile.PDBFile.validate_type
:classmethod:

```{autodoc2-docstring} phystool.pdbfile.PDBFile.validate_type
```

````

````{py:method} open_unkown(tex_file: pathlib.Path) -> typing.Self
:canonical: phystool.pdbfile.PDBFile.open_unkown
:classmethod:

```{autodoc2-docstring} phystool.pdbfile.PDBFile.open_unkown
```

````

````{py:method} open(uuid: str) -> typing.Self
:canonical: phystool.pdbfile.PDBFile.open
:classmethod:

```{autodoc2-docstring} phystool.pdbfile.PDBFile.open
```

````

````{py:method} parse_texfile() -> bool
:canonical: phystool.pdbfile.PDBFile.parse_texfile

```{autodoc2-docstring} phystool.pdbfile.PDBFile.parse_texfile
```

````

````{py:method} save() -> None
:canonical: phystool.pdbfile.PDBFile.save

```{autodoc2-docstring} phystool.pdbfile.PDBFile.save
```

````

````{py:method} pytex() -> bool
:canonical: phystool.pdbfile.PDBFile.pytex

```{autodoc2-docstring} phystool.pdbfile.PDBFile.pytex
```

````

````{py:method} cat() -> None
:canonical: phystool.pdbfile.PDBFile.cat

```{autodoc2-docstring} phystool.pdbfile.PDBFile.cat
```

````

````{py:method} to_dict() -> dict[str, str | dict | list[str]]
:canonical: phystool.pdbfile.PDBFile.to_dict
:abstractmethod:

```{autodoc2-docstring} phystool.pdbfile.PDBFile.to_dict
```

````

````{py:method} tex_export() -> None
:canonical: phystool.pdbfile.PDBFile.tex_export
:abstractmethod:

```{autodoc2-docstring} phystool.pdbfile.PDBFile.tex_export
```

````

````{py:method} zip() -> None
:canonical: phystool.pdbfile.PDBFile.zip

```{autodoc2-docstring} phystool.pdbfile.PDBFile.zip
```

````

````{py:method} create_tmp_tex_file() -> pathlib.Path
:canonical: phystool.pdbfile.PDBFile.create_tmp_tex_file

```{autodoc2-docstring} phystool.pdbfile.PDBFile.create_tmp_tex_file
```

````

````{py:method} should_compile() -> bool
:canonical: phystool.pdbfile.PDBFile.should_compile

```{autodoc2-docstring} phystool.pdbfile.PDBFile.should_compile
```

````

````{py:method} compile() -> bool
:canonical: phystool.pdbfile.PDBFile.compile

```{autodoc2-docstring} phystool.pdbfile.PDBFile.compile
```

````

`````

`````{py:class} CheckForTikzMixin
:canonical: phystool.pdbfile.CheckForTikzMixin

```{autodoc2-docstring} phystool.pdbfile.CheckForTikzMixin
```

````{py:attribute} TIKZ_PATTERN
:canonical: phystool.pdbfile.CheckForTikzMixin.TIKZ_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.CheckForTikzMixin.TIKZ_PATTERN
```

````

`````

`````{py:class} Exercise(pdb_file: pathlib.Path, pdb_data: dict)
:canonical: phystool.pdbfile.Exercise

Bases: {py:obj}`phystool.pdbfile.PDBFile`, {py:obj}`phystool.pdbfile.CheckForTikzMixin`

````{py:attribute} PDB_TYPE
:canonical: phystool.pdbfile.Exercise.PDB_TYPE
:value: >
   'exercise'

```{autodoc2-docstring} phystool.pdbfile.Exercise.PDB_TYPE
```

````

````{py:attribute} EXO_PATTERN
:canonical: phystool.pdbfile.Exercise.EXO_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.Exercise.EXO_PATTERN
```

````

````{py:attribute} TITLE_PATTERN
:canonical: phystool.pdbfile.Exercise.TITLE_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.Exercise.TITLE_PATTERN
```

````

````{py:method} to_dict() -> dict[str, str | dict | list[str]]
:canonical: phystool.pdbfile.Exercise.to_dict

````

````{py:method} tex_export() -> None
:canonical: phystool.pdbfile.Exercise.tex_export

````

`````

`````{py:class} Theory(pdb_file: pathlib.Path, pdb_data: dict)
:canonical: phystool.pdbfile.Theory

Bases: {py:obj}`phystool.pdbfile.PDBFile`, {py:obj}`phystool.pdbfile.CheckForTikzMixin`

````{py:attribute} PDB_TYPE
:canonical: phystool.pdbfile.Theory.PDB_TYPE
:value: >
   'theory'

```{autodoc2-docstring} phystool.pdbfile.Theory.PDB_TYPE
```

````

````{py:attribute} THE_PATTERN
:canonical: phystool.pdbfile.Theory.THE_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.Theory.THE_PATTERN
```

````

````{py:attribute} TITLE_PATTERN
:canonical: phystool.pdbfile.Theory.TITLE_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.Theory.TITLE_PATTERN
```

````

````{py:method} to_dict() -> dict[str, str | dict | list[str]]
:canonical: phystool.pdbfile.Theory.to_dict

````

````{py:method} tex_export() -> None
:canonical: phystool.pdbfile.Theory.tex_export

````

`````

`````{py:class} TP(pdb_file: pathlib.Path, pdb_data: dict)
:canonical: phystool.pdbfile.TP

Bases: {py:obj}`phystool.pdbfile.PDBFile`, {py:obj}`phystool.pdbfile.CheckForTikzMixin`

````{py:attribute} PDB_TYPE
:canonical: phystool.pdbfile.TP.PDB_TYPE
:value: >
   'tp'

```{autodoc2-docstring} phystool.pdbfile.TP.PDB_TYPE
```

````

````{py:attribute} TP_STUDENT_PATTERN
:canonical: phystool.pdbfile.TP.TP_STUDENT_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.TP.TP_STUDENT_PATTERN
```

````

````{py:attribute} TITLE_PATTERN
:canonical: phystool.pdbfile.TP.TITLE_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.TP.TITLE_PATTERN
```

````

````{py:method} to_dict() -> dict[str, str | dict | list[str]]
:canonical: phystool.pdbfile.TP.to_dict

````

````{py:method} tex_export() -> None
:canonical: phystool.pdbfile.TP.tex_export

````

`````

`````{py:class} QCM(pdb_file: pathlib.Path, pdb_data: dict)
:canonical: phystool.pdbfile.QCM

Bases: {py:obj}`phystool.pdbfile.PDBFile`, {py:obj}`phystool.pdbfile.CheckForTikzMixin`

````{py:attribute} PDB_TYPE
:canonical: phystool.pdbfile.QCM.PDB_TYPE
:value: >
   'qcm'

```{autodoc2-docstring} phystool.pdbfile.QCM.PDB_TYPE
```

````

````{py:attribute} QCM_PATTERN
:canonical: phystool.pdbfile.QCM.QCM_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.QCM.QCM_PATTERN
```

````

````{py:method} to_dict() -> dict[str, str | dict | list[str]]
:canonical: phystool.pdbfile.QCM.to_dict

````

````{py:method} tex_export() -> None
:canonical: phystool.pdbfile.QCM.tex_export

````

`````

`````{py:class} Figure(pdb_file: pathlib.Path, pdb_data: dict)
:canonical: phystool.pdbfile.Figure

Bases: {py:obj}`phystool.pdbfile.PDBFile`

````{py:attribute} PDB_TYPE
:canonical: phystool.pdbfile.Figure.PDB_TYPE
:value: >
   'figure'

```{autodoc2-docstring} phystool.pdbfile.Figure.PDB_TYPE
```

````

````{py:attribute} FIG_PATTERN
:canonical: phystool.pdbfile.Figure.FIG_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.pdbfile.Figure.FIG_PATTERN
```

````

````{py:method} to_dict() -> dict[str, str | dict | list[str]]
:canonical: phystool.pdbfile.Figure.to_dict

````

````{py:method} tex_export() -> None
:canonical: phystool.pdbfile.Figure.tex_export

````

````{py:method} create_tmp_tex_file() -> pathlib.Path
:canonical: phystool.pdbfile.Figure.create_tmp_tex_file

```{autodoc2-docstring} phystool.pdbfile.Figure.create_tmp_tex_file
```

````

`````

````{py:data} FILE_TYPE_MAP
:canonical: phystool.pdbfile.FILE_TYPE_MAP
:value: >
   None

```{autodoc2-docstring} phystool.pdbfile.FILE_TYPE_MAP
```

````

````{py:data} VALID_TYPES
:canonical: phystool.pdbfile.VALID_TYPES
:value: >
   'list(...)'

```{autodoc2-docstring} phystool.pdbfile.VALID_TYPES
```

````