---
title: FrozenDict (latest version)
description: API reference for samplomatic.utils.FrozenDict in the latest version of samplomatic
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/samplomatic/auto/utils-frozen-dict
---

# FrozenDict

*class* `samplomatic.utils.FrozenDict(*args, **kwargs)`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/frozen_dict.py#L20-L110)

Bases: [`Mapping`](https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping)

An immutable and hashable dictionary-like mapping.

Keys and values must be hashable. Views onto keys, items, and values are read-only and preserve insertion order. Standard operands like `|` are supported, but return copies when necessary.

**Methods Summary**

|                                                                                          |                                                  |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------ |
| [`copy`](#samplomatic.utils.FrozenDict.copy "samplomatic.utils.FrozenDict.copy")()       | Return `self`, since this instance is immutable. |
| [`get`](#samplomatic.utils.FrozenDict.get "samplomatic.utils.FrozenDict.get")(k\[,d])    |                                                  |
| [`items`](#samplomatic.utils.FrozenDict.items "samplomatic.utils.FrozenDict.items")()    |                                                  |
| [`keys`](#samplomatic.utils.FrozenDict.keys "samplomatic.utils.FrozenDict.keys")()       |                                                  |
| [`values`](#samplomatic.utils.FrozenDict.values "samplomatic.utils.FrozenDict.values")() |                                                  |

**Methods Documentation**

### copy

`copy()`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/frozen_dict.py#L92-L94)

Return `self`, since this instance is immutable.

### get

`get(k[, d]) → D[k] if k in D, else d.  d defaults to None.`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/frozen_dict.py#L57-L58)

### items

`items() → a set-like object providing a view on D's items`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/frozen_dict.py#L51-L52)

### keys

`keys() → a set-like object providing a view on D's keys`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/frozen_dict.py#L48-L49)

### values

`values() → an object providing a view on D's values`

[GitHub](https://github.com/Qiskit/samplomatic/tree/main/samplomatic/utils/frozen_dict.py#L54-L55)