# {py:mod}`arelle.LeiUtil`

```{py:module} arelle.LeiUtil
```

```{autodoc2-docstring} arelle.LeiUtil
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`LEIValidationResult <arelle.LeiUtil.LEIValidationResult>`
  -
````

### Functions

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

* - {py:obj}`checkLei <arelle.LeiUtil.checkLei>`
  - ```{autodoc2-docstring} arelle.LeiUtil.checkLei
    :summary:
    ```
````

### Data

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

* - {py:obj}`LEI_VALID <arelle.LeiUtil.LEI_VALID>`
  - ```{autodoc2-docstring} arelle.LeiUtil.LEI_VALID
    :summary:
    ```
* - {py:obj}`LEI_INVALID_LEXICAL <arelle.LeiUtil.LEI_INVALID_LEXICAL>`
  - ```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_LEXICAL
    :summary:
    ```
* - {py:obj}`LEI_INVALID_CHECKSUM <arelle.LeiUtil.LEI_INVALID_CHECKSUM>`
  - ```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_CHECKSUM
    :summary:
    ```
* - {py:obj}`_leiLexicalPattern <arelle.LeiUtil._leiLexicalPattern>`
  - ```{autodoc2-docstring} arelle.LeiUtil._leiLexicalPattern
    :summary:
    ```
* - {py:obj}`_requiredLEILength <arelle.LeiUtil._requiredLEILength>`
  - ```{autodoc2-docstring} arelle.LeiUtil._requiredLEILength
    :summary:
    ```
* - {py:obj}`_leiToDigitTable <arelle.LeiUtil._leiToDigitTable>`
  - ```{autodoc2-docstring} arelle.LeiUtil._leiToDigitTable
    :summary:
    ```
* - {py:obj}`_validLeiDespiteChecksumFailPatternString <arelle.LeiUtil._validLeiDespiteChecksumFailPatternString>`
  - ```{autodoc2-docstring} arelle.LeiUtil._validLeiDespiteChecksumFailPatternString
    :summary:
    ```
* - {py:obj}`_validLeiDespiteChecksumFailSet <arelle.LeiUtil._validLeiDespiteChecksumFailSet>`
  - ```{autodoc2-docstring} arelle.LeiUtil._validLeiDespiteChecksumFailSet
    :summary:
    ```
````

### API

`````{py:class} LEIValidationResult
:canonical: arelle.LeiUtil.LEIValidationResult

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

````{py:attribute} VALID
:canonical: arelle.LeiUtil.LEIValidationResult.VALID
:value: >
   'auto(...)'

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.VALID
```

````

````{py:attribute} INVALID_LEXICAL
:canonical: arelle.LeiUtil.LEIValidationResult.INVALID_LEXICAL
:value: >
   'auto(...)'

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.INVALID_LEXICAL
```

````

````{py:attribute} INVALID_CHECKSUM
:canonical: arelle.LeiUtil.LEIValidationResult.INVALID_CHECKSUM
:value: >
   'auto(...)'

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.INVALID_CHECKSUM
```

````

````{py:method} description() -> str
:canonical: arelle.LeiUtil.LEIValidationResult.description

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.description
```

````

`````

````{py:data} LEI_VALID
:canonical: arelle.LeiUtil.LEI_VALID
:value: >
   None

```{autodoc2-docstring} arelle.LeiUtil.LEI_VALID
```

````

````{py:data} LEI_INVALID_LEXICAL
:canonical: arelle.LeiUtil.LEI_INVALID_LEXICAL
:value: >
   None

```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_LEXICAL
```

````

````{py:data} LEI_INVALID_CHECKSUM
:canonical: arelle.LeiUtil.LEI_INVALID_CHECKSUM
:value: >
   None

```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_CHECKSUM
```

````

````{py:data} _leiLexicalPattern
:canonical: arelle.LeiUtil._leiLexicalPattern
:value: >
   'compile(...)'

```{autodoc2-docstring} arelle.LeiUtil._leiLexicalPattern
```

````

````{py:data} _requiredLEILength
:canonical: arelle.LeiUtil._requiredLEILength
:value: >
   20

```{autodoc2-docstring} arelle.LeiUtil._requiredLEILength
```

````

````{py:data} _leiToDigitTable
:canonical: arelle.LeiUtil._leiToDigitTable
:value: >
   'maketrans(...)'

```{autodoc2-docstring} arelle.LeiUtil._leiToDigitTable
```

````

````{py:data} _validLeiDespiteChecksumFailPatternString
:canonical: arelle.LeiUtil._validLeiDespiteChecksumFailPatternString
:value: >
   '^(029200720E3M3A4D6D01|029200758D5M0AI3F601|315700X8JQ3IU0NGK501|3157007SCCESQAUH5Z01|315700TCC9NTEP...'

```{autodoc2-docstring} arelle.LeiUtil._validLeiDespiteChecksumFailPatternString
```

````

````{py:data} _validLeiDespiteChecksumFailSet
:canonical: arelle.LeiUtil._validLeiDespiteChecksumFailSet
:value: >
   'frozenset(...)'

```{autodoc2-docstring} arelle.LeiUtil._validLeiDespiteChecksumFailSet
```

````

````{py:function} checkLei(lei: str) -> arelle.LeiUtil.LEIValidationResult
:canonical: arelle.LeiUtil.checkLei

```{autodoc2-docstring} arelle.LeiUtil.checkLei
```
````