# {py:mod}`phystool.metadata`

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

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

## Module Contents

### Classes

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

* - {py:obj}`Metadata <phystool.metadata.Metadata>`
  - ```{autodoc2-docstring} phystool.metadata.Metadata
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

`````{py:class} Metadata()
:canonical: phystool.metadata.Metadata

```{autodoc2-docstring} phystool.metadata.Metadata
```

```{rubric} Initialization
```

```{autodoc2-docstring} phystool.metadata.Metadata.__init__
```

````{py:method} stats() -> dict[str, str | int]
:canonical: phystool.metadata.Metadata.stats

```{autodoc2-docstring} phystool.metadata.Metadata.stats
```

````

````{py:method} get_klass(name: str, year: int) -> phystool.helper.Klass
:canonical: phystool.metadata.Metadata.get_klass

```{autodoc2-docstring} phystool.metadata.Metadata.get_klass
```

````

````{py:method} klass_list(current: bool = True) -> None
:canonical: phystool.metadata.Metadata.klass_list

```{autodoc2-docstring} phystool.metadata.Metadata.klass_list
```

````

````{py:method} klass_display(klass_uuid: str) -> None
:canonical: phystool.metadata.Metadata.klass_display

```{autodoc2-docstring} phystool.metadata.Metadata.klass_display
```

````

````{py:method} evaluation_list(current: bool = True) -> None
:canonical: phystool.metadata.Metadata.evaluation_list

```{autodoc2-docstring} phystool.metadata.Metadata.evaluation_list
```

````

````{py:method} evaluation_create_for_klass(klass_uuid: str) -> str
:canonical: phystool.metadata.Metadata.evaluation_create_for_klass

```{autodoc2-docstring} phystool.metadata.Metadata.evaluation_create_for_klass
```

````

````{py:method} evaluation_edit(evaluation_uuid: str) -> None
:canonical: phystool.metadata.Metadata.evaluation_edit

```{autodoc2-docstring} phystool.metadata.Metadata.evaluation_edit
```

````

````{py:method} evaluation_update(evaluation_uuid: str) -> None
:canonical: phystool.metadata.Metadata.evaluation_update

```{autodoc2-docstring} phystool.metadata.Metadata.evaluation_update
```

````

````{py:method} evaluation_display(evaluation_uuid: str) -> None
:canonical: phystool.metadata.Metadata.evaluation_display

```{autodoc2-docstring} phystool.metadata.Metadata.evaluation_display
```

````

````{py:method} evaluation_search(uuid: str) -> None
:canonical: phystool.metadata.Metadata.evaluation_search

```{autodoc2-docstring} phystool.metadata.Metadata.evaluation_search
```

````

````{py:method} dmenu_dict(file_types: list[str]) -> dict[str, str]
:canonical: phystool.metadata.Metadata.dmenu_dict

```{autodoc2-docstring} phystool.metadata.Metadata.dmenu_dict
```

````

````{py:method} update(pdb_file: phystool.pdbfile.PDBFile) -> None
:canonical: phystool.metadata.Metadata.update

```{autodoc2-docstring} phystool.metadata.Metadata.update
```

````

````{py:method} remove(pdb_file: phystool.pdbfile.PDBFile) -> None
:canonical: phystool.metadata.Metadata.remove

```{autodoc2-docstring} phystool.metadata.Metadata.remove
```

````

````{py:method} consolidate() -> None
:canonical: phystool.metadata.Metadata.consolidate

```{autodoc2-docstring} phystool.metadata.Metadata.consolidate
```

````

````{py:method} consolidate_progress() -> typing.Iterator[tuple[int, int, str]]
:canonical: phystool.metadata.Metadata.consolidate_progress

```{autodoc2-docstring} phystool.metadata.Metadata.consolidate_progress
```

````

````{py:method} save() -> None
:canonical: phystool.metadata.Metadata.save

```{autodoc2-docstring} phystool.metadata.Metadata.save
```

````

````{py:method} filter(query: str, uuid_bit: str, file_types: set[str], selected_tags: phystool.tags.Tags, excluded_tags: phystool.tags.Tags) -> list[phystool.pdbfile.PDBFile]
:canonical: phystool.metadata.Metadata.filter

```{autodoc2-docstring} phystool.metadata.Metadata.filter
```

````

`````