# {py:mod}`pyirk._core.keymanager`

```{py:module} pyirk._core.keymanager
```

```{autodoc2-docstring} pyirk._core.keymanager
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`EType <pyirk._core.keymanager.EType>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.EType
    :summary:
    ```
* - {py:obj}`SType <pyirk._core.keymanager.SType>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.SType
    :summary:
    ```
* - {py:obj}`VType <pyirk._core.keymanager.VType>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.VType
    :summary:
    ```
* - {py:obj}`ProcessedStmtKey <pyirk._core.keymanager.ProcessedStmtKey>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey
    :summary:
    ```
* - {py:obj}`KeyManager <pyirk._core.keymanager.KeyManager>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.KeyManager
    :summary:
    ```
````

### Functions

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

* - {py:obj}`unpack_l1d <pyirk._core.keymanager.unpack_l1d>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.unpack_l1d
    :summary:
    ```
* - {py:obj}`process_key_str <pyirk._core.keymanager.process_key_str>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.process_key_str
    :summary:
    ```
* - {py:obj}`_resolve_prefix <pyirk._core.keymanager._resolve_prefix>`
  - ```{autodoc2-docstring} pyirk._core.keymanager._resolve_prefix
    :summary:
    ```
* - {py:obj}`check_processed_key_label <pyirk._core.keymanager.check_processed_key_label>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.check_processed_key_label
    :summary:
    ```
* - {py:obj}`ilk2nlk <pyirk._core.keymanager.ilk2nlk>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.ilk2nlk
    :summary:
    ```
* - {py:obj}`u <pyirk._core.keymanager.u>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.u
    :summary:
    ```
* - {py:obj}`pop_uri_based_key <pyirk._core.keymanager.pop_uri_based_key>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.pop_uri_based_key
    :summary:
    ```
* - {py:obj}`generate_new_key <pyirk._core.keymanager.generate_new_key>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.generate_new_key
    :summary:
    ```
* - {py:obj}`print_new_keys <pyirk._core.keymanager.print_new_keys>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.print_new_keys
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <pyirk._core.keymanager.__all__>`
  - ```{autodoc2-docstring} pyirk._core.keymanager.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: pyirk._core.keymanager.__all__
:value: >
   ['EType', 'SType', 'VType', 'ProcessedStmtKey', 'unpack_l1d', 'process_key_str', '_resolve_prefix', ...

```{autodoc2-docstring} pyirk._core.keymanager.__all__
```

````

`````{py:class} EType(*args, **kwds)
:canonical: pyirk._core.keymanager.EType

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyirk._core.keymanager.EType
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._core.keymanager.EType.__init__
```

````{py:attribute} ITEM
:canonical: pyirk._core.keymanager.EType.ITEM
:value: >
   0

```{autodoc2-docstring} pyirk._core.keymanager.EType.ITEM
```

````

````{py:attribute} RELATION
:canonical: pyirk._core.keymanager.EType.RELATION
:value: >
   1

```{autodoc2-docstring} pyirk._core.keymanager.EType.RELATION
```

````

````{py:attribute} LITERAL
:canonical: pyirk._core.keymanager.EType.LITERAL
:value: >
   2

```{autodoc2-docstring} pyirk._core.keymanager.EType.LITERAL
```

````

`````

`````{py:class} SType(*args, **kwds)
:canonical: pyirk._core.keymanager.SType

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyirk._core.keymanager.SType
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._core.keymanager.SType.__init__
```

````{py:attribute} CREATION
:canonical: pyirk._core.keymanager.SType.CREATION
:value: >
   0

```{autodoc2-docstring} pyirk._core.keymanager.SType.CREATION
```

````

````{py:attribute} EXTENSION
:canonical: pyirk._core.keymanager.SType.EXTENSION
:value: >
   1

```{autodoc2-docstring} pyirk._core.keymanager.SType.EXTENSION
```

````

````{py:attribute} UNDEFINED
:canonical: pyirk._core.keymanager.SType.UNDEFINED
:value: >
   2

```{autodoc2-docstring} pyirk._core.keymanager.SType.UNDEFINED
```

````

`````

`````{py:class} VType(*args, **kwds)
:canonical: pyirk._core.keymanager.VType

Bases: {py:obj}`enum.Enum`

```{autodoc2-docstring} pyirk._core.keymanager.VType
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._core.keymanager.VType.__init__
```

````{py:attribute} LITERAL
:canonical: pyirk._core.keymanager.VType.LITERAL
:value: >
   0

```{autodoc2-docstring} pyirk._core.keymanager.VType.LITERAL
```

````

````{py:attribute} ENTITY
:canonical: pyirk._core.keymanager.VType.ENTITY
:value: >
   1

```{autodoc2-docstring} pyirk._core.keymanager.VType.ENTITY
```

````

````{py:attribute} LIST
:canonical: pyirk._core.keymanager.VType.LIST
:value: >
   2

```{autodoc2-docstring} pyirk._core.keymanager.VType.LIST
```

````

````{py:attribute} DICT
:canonical: pyirk._core.keymanager.VType.DICT
:value: >
   3

```{autodoc2-docstring} pyirk._core.keymanager.VType.DICT
```

````

`````

`````{py:class} ProcessedStmtKey
:canonical: pyirk._core.keymanager.ProcessedStmtKey

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey
```

````{py:attribute} short_key
:canonical: pyirk._core.keymanager.ProcessedStmtKey.short_key
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.short_key
```

````

````{py:attribute} etype
:canonical: pyirk._core.keymanager.ProcessedStmtKey.etype
:type: pyirk._core.keymanager.EType
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.etype
```

````

````{py:attribute} stype
:canonical: pyirk._core.keymanager.ProcessedStmtKey.stype
:type: pyirk._core.keymanager.SType
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.stype
```

````

````{py:attribute} vtype
:canonical: pyirk._core.keymanager.ProcessedStmtKey.vtype
:type: pyirk._core.keymanager.VType
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.vtype
```

````

````{py:attribute} content
:canonical: pyirk._core.keymanager.ProcessedStmtKey.content
:type: object
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.content
```

````

````{py:attribute} delimiter
:canonical: pyirk._core.keymanager.ProcessedStmtKey.delimiter
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.delimiter
```

````

````{py:attribute} label
:canonical: pyirk._core.keymanager.ProcessedStmtKey.label
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.label
```

````

````{py:attribute} prefix
:canonical: pyirk._core.keymanager.ProcessedStmtKey.prefix
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.prefix
```

````

````{py:attribute} uri
:canonical: pyirk._core.keymanager.ProcessedStmtKey.uri
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.uri
```

````

````{py:attribute} lang_indicator
:canonical: pyirk._core.keymanager.ProcessedStmtKey.lang_indicator
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.lang_indicator
```

````

````{py:attribute} original_key_str
:canonical: pyirk._core.keymanager.ProcessedStmtKey.original_key_str
:type: str
:value: >
   None

```{autodoc2-docstring} pyirk._core.keymanager.ProcessedStmtKey.original_key_str
```

````

`````

````{py:function} unpack_l1d(l1d: typing.Dict[str, object])
:canonical: pyirk._core.keymanager.unpack_l1d

```{autodoc2-docstring} pyirk._core.keymanager.unpack_l1d
```
````

````{py:function} process_key_str(key_str: str, check: bool = True, resolve_prefix: bool = True, mod_uri: str = None) -> pyirk._core.keymanager.ProcessedStmtKey
:canonical: pyirk._core.keymanager.process_key_str

```{autodoc2-docstring} pyirk._core.keymanager.process_key_str
```
````

````{py:function} _resolve_prefix(pr_key: pyirk._core.keymanager.ProcessedStmtKey, passed_mod_uri: str = None) -> None
:canonical: pyirk._core.keymanager._resolve_prefix

```{autodoc2-docstring} pyirk._core.keymanager._resolve_prefix
```
````

````{py:function} check_processed_key_label(pkey: pyirk._core.keymanager.ProcessedStmtKey) -> None
:canonical: pyirk._core.keymanager.check_processed_key_label

```{autodoc2-docstring} pyirk._core.keymanager.check_processed_key_label
```
````

````{py:function} ilk2nlk(ilk: str) -> str
:canonical: pyirk._core.keymanager.ilk2nlk

```{autodoc2-docstring} pyirk._core.keymanager.ilk2nlk
```
````

````{py:function} u(key_str: str) -> str
:canonical: pyirk._core.keymanager.u

```{autodoc2-docstring} pyirk._core.keymanager.u
```
````

`````{py:class} KeyManager(minval=1000, maxval=99999, keyseed=None)
:canonical: pyirk._core.keymanager.KeyManager

```{autodoc2-docstring} pyirk._core.keymanager.KeyManager
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._core.keymanager.KeyManager.__init__
```

````{py:method} pop(index: int = -1) -> int
:canonical: pyirk._core.keymanager.KeyManager.pop

```{autodoc2-docstring} pyirk._core.keymanager.KeyManager.pop
```

````

````{py:method} _generate_key_numbers() -> None
:canonical: pyirk._core.keymanager.KeyManager._generate_key_numbers

```{autodoc2-docstring} pyirk._core.keymanager.KeyManager._generate_key_numbers
```

````

`````

````{py:function} pop_uri_based_key(prefix: typing.Optional[str] = None, prefix2: str = '') -> typing.Union[int, str]
:canonical: pyirk._core.keymanager.pop_uri_based_key

```{autodoc2-docstring} pyirk._core.keymanager.pop_uri_based_key
```
````

````{py:function} generate_new_key(prefix, prefix2='', mod_uri=None)
:canonical: pyirk._core.keymanager.generate_new_key

```{autodoc2-docstring} pyirk._core.keymanager.generate_new_key
```
````

````{py:function} print_new_keys(n=30, loaded_mod=None)
:canonical: pyirk._core.keymanager.print_new_keys

```{autodoc2-docstring} pyirk._core.keymanager.print_new_keys
```
````