# {py:mod}`arelle.logging.handlers.LogToXmlHandler`

```{py:module} arelle.logging.handlers.LogToXmlHandler
```

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`LogToXmlHandler <arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler>`
  - ```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler
    :summary:
    ```
````

### API

`````{py:class} LogToXmlHandler(cntlr: arelle.Cntlr.Cntlr | None = None, filename: str | None = None, mode: str = 'w', logXmlMaxAttributeLength: int | None = None)
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler

Bases: {py:obj}`arelle.logging.handlers.LogHandlerWithXml.LogHandlerWithXml`

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.__init__
```

````{py:attribute} logRecordBuffer
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.logRecordBuffer
:type: list[logging.LogRecord]
:value: >
   None

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.logRecordBuffer
```

````

````{py:attribute} cntlr
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.cntlr
:type: arelle.Cntlr.Cntlr | None
:value: >
   None

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.cntlr
```

````

````{py:attribute} filename
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.filename
:type: str | None
:value: >
   None

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.filename
```

````

````{py:attribute} filemode
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.filemode
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.filemode
```

````

````{py:attribute} htmlTitle
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.htmlTitle
:type: str
:value: >
   'Arelle Message Log'

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.htmlTitle
```

````

````{py:method} flush() -> None
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.flush

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.flush
```

````

````{py:method} clearLogBuffer() -> None
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.clearLogBuffer

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.clearLogBuffer
```

````

````{py:method} getXml(clearLogBuffer: bool = True, includeDeclaration: bool = True) -> str
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getXml

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getXml
```

````

````{py:method} getJson(clearLogBuffer: bool = True) -> str
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getJson

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getJson
```

````

````{py:method} getHtml(clearLogBuffer: bool = True) -> str
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getHtml

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getHtml
```

````

````{py:method} getLines(clearLogBuffer: bool = True) -> list[str]
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getLines

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getLines
```

````

````{py:method} getText(separator: str = '\n', clearLogBuffer: bool = True) -> str
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getText

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.getText
```

````

````{py:method} emit(logRecord: logging.LogRecord) -> None
:canonical: arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.emit

```{autodoc2-docstring} arelle.logging.handlers.LogToXmlHandler.LogToXmlHandler.emit
```

````

`````