# {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>`
  - ```{autodoc2-docstring} phystool.pdbfile.PDBFile
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

`````{py:class} PDBFile(id: int, uuid: uuid.UUID, pdb_type: str, standalone: bool, title: str, tags: phystool.tags.Tags, references: list[uuid.UUID])
:canonical: phystool.pdbfile.PDBFile

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

```{rubric} Initialization
```

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

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

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

````

````{py:method} from_record(pdb_record: phystool.physql.models.PDBRecord) -> phystool.pdbfile.PDBFile
:canonical: phystool.pdbfile.PDBFile.from_record
:classmethod:

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

````

````{py:method} from_file(key: uuid.UUID | pathlib.Path) -> phystool.pdbfile.PDBFile
:canonical: phystool.pdbfile.PDBFile.from_file
:classmethod:

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

````

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

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

````

````{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} compile(verbose: bool) -> None
:canonical: phystool.pdbfile.PDBFile.compile

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

````

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

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

````

`````