# {py:mod}`phystool.latex`

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

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

## Module Contents

### Classes

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

* - {py:obj}`LogFileMessage <phystool.latex.LogFileMessage>`
  - ```{autodoc2-docstring} phystool.latex.LogFileMessage
    :summary:
    ```
* - {py:obj}`BadBoxMessage <phystool.latex.BadBoxMessage>`
  -
* - {py:obj}`InfoMessage <phystool.latex.InfoMessage>`
  -
* - {py:obj}`WarningMessage <phystool.latex.WarningMessage>`
  -
* - {py:obj}`ErrorMessage <phystool.latex.ErrorMessage>`
  -
* - {py:obj}`Latex3Message <phystool.latex.Latex3Message>`
  -
* - {py:obj}`LogMessageList <phystool.latex.LogMessageList>`
  - ```{autodoc2-docstring} phystool.latex.LogMessageList
    :summary:
    ```
* - {py:obj}`LatexLogParser <phystool.latex.LatexLogParser>`
  - ```{autodoc2-docstring} phystool.latex.LatexLogParser
    :summary:
    ```
* - {py:obj}`PdfLatex <phystool.latex.PdfLatex>`
  - ```{autodoc2-docstring} phystool.latex.PdfLatex
    :summary:
    ```
````

### Functions

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

* - {py:obj}`texfile_to_symlink <phystool.latex.texfile_to_symlink>`
  - ```{autodoc2-docstring} phystool.latex.texfile_to_symlink
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

`````{py:class} LogFileMessage(match: typing.Match[str], context: list[str], tex_file: pathlib.Path)
:canonical: phystool.latex.LogFileMessage

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} phystool.latex.LogFileMessage
```

```{rubric} Initialization
```

```{autodoc2-docstring} phystool.latex.LogFileMessage.__init__
```

````{py:attribute} PATTERN
:canonical: phystool.latex.LogFileMessage.PATTERN
:type: typing.Pattern
:value: >
   None

```{autodoc2-docstring} phystool.latex.LogFileMessage.PATTERN
```

````

````{py:attribute} VERBOSE
:canonical: phystool.latex.LogFileMessage.VERBOSE
:value: >
   False

```{autodoc2-docstring} phystool.latex.LogFileMessage.VERBOSE
```

````

````{py:method} toggle_verbose_mode() -> None
:canonical: phystool.latex.LogFileMessage.toggle_verbose_mode
:classmethod:

```{autodoc2-docstring} phystool.latex.LogFileMessage.toggle_verbose_mode
```

````

`````

`````{py:class} BadBoxMessage(match: typing.Match[str], context: list[str], tex_file: pathlib.Path)
:canonical: phystool.latex.BadBoxMessage

Bases: {py:obj}`phystool.latex.LogFileMessage`

````{py:attribute} PATTERN
:canonical: phystool.latex.BadBoxMessage.PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.latex.BadBoxMessage.PATTERN
```

````

`````

`````{py:class} InfoMessage(match: typing.Match[str], context: list[str], tex_file: pathlib.Path)
:canonical: phystool.latex.InfoMessage

Bases: {py:obj}`phystool.latex.LogFileMessage`

````{py:attribute} PATTERN
:canonical: phystool.latex.InfoMessage.PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.latex.InfoMessage.PATTERN
```

````

`````

`````{py:class} WarningMessage(match: typing.Match[str], context: list[str], tex_file: pathlib.Path)
:canonical: phystool.latex.WarningMessage

Bases: {py:obj}`phystool.latex.LogFileMessage`

````{py:attribute} PATTERN
:canonical: phystool.latex.WarningMessage.PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.latex.WarningMessage.PATTERN
```

````

````{py:attribute} should_recompile
:canonical: phystool.latex.WarningMessage.should_recompile
:type: bool
:value: >
   None

```{autodoc2-docstring} phystool.latex.WarningMessage.should_recompile
```

````

`````

`````{py:class} ErrorMessage(match: typing.Match[str], context: list[str], tex_file: pathlib.Path)
:canonical: phystool.latex.ErrorMessage

Bases: {py:obj}`phystool.latex.LogFileMessage`

````{py:attribute} PATTERN
:canonical: phystool.latex.ErrorMessage.PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.latex.ErrorMessage.PATTERN
```

````

`````

`````{py:class} Latex3Message(match: typing.Match[str], context: list[str], tex_file: pathlib.Path)
:canonical: phystool.latex.Latex3Message

Bases: {py:obj}`phystool.latex.LogFileMessage`

````{py:attribute} PATTERN
:canonical: phystool.latex.Latex3Message.PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.latex.Latex3Message.PATTERN
```

````

`````

`````{py:class} LogMessageList(klass: type[phystool.latex.LogFileMessage])
:canonical: phystool.latex.LogMessageList

```{autodoc2-docstring} phystool.latex.LogMessageList
```

```{rubric} Initialization
```

```{autodoc2-docstring} phystool.latex.LogMessageList.__init__
```

````{py:method} add(line: str, lines_iterable: phystool.helper.ContextIterator[str], tex_file: pathlib.Path) -> bool
:canonical: phystool.latex.LogMessageList.add

```{autodoc2-docstring} phystool.latex.LogMessageList.add
```

````

````{py:method} display() -> None
:canonical: phystool.latex.LogMessageList.display

```{autodoc2-docstring} phystool.latex.LogMessageList.display
```

````

````{py:method} stats() -> str
:canonical: phystool.latex.LogMessageList.stats

```{autodoc2-docstring} phystool.latex.LogMessageList.stats
```

````

`````

`````{py:class} LatexLogParser(texfile: pathlib.Path, message_types: list[type[phystool.latex.LogFileMessage]] = [BadBoxMessage, InfoMessage, WarningMessage, ErrorMessage, Latex3Message])
:canonical: phystool.latex.LatexLogParser

```{autodoc2-docstring} phystool.latex.LatexLogParser
```

```{rubric} Initialization
```

```{autodoc2-docstring} phystool.latex.LatexLogParser.__init__
```

````{py:attribute} TEX_FILE_PATTERN
:canonical: phystool.latex.LatexLogParser.TEX_FILE_PATTERN
:value: >
   'compile(...)'

```{autodoc2-docstring} phystool.latex.LatexLogParser.TEX_FILE_PATTERN
```

````

````{py:method} process() -> None
:canonical: phystool.latex.LatexLogParser.process

```{autodoc2-docstring} phystool.latex.LatexLogParser.process
```

````

````{py:method} should_recompile() -> bool
:canonical: phystool.latex.LatexLogParser.should_recompile

```{autodoc2-docstring} phystool.latex.LatexLogParser.should_recompile
```

````

````{py:method} display() -> None
:canonical: phystool.latex.LatexLogParser.display

```{autodoc2-docstring} phystool.latex.LatexLogParser.display
```

````

````{py:method} get_as_text() -> str
:canonical: phystool.latex.LatexLogParser.get_as_text

```{autodoc2-docstring} phystool.latex.LatexLogParser.get_as_text
```

````

````{py:method} warning() -> phystool.latex.LogMessageList
:canonical: phystool.latex.LatexLogParser.warning

```{autodoc2-docstring} phystool.latex.LatexLogParser.warning
```

````

````{py:method} error() -> phystool.latex.LogMessageList
:canonical: phystool.latex.LatexLogParser.error

```{autodoc2-docstring} phystool.latex.LatexLogParser.error
```

````

````{py:method} latex3() -> phystool.latex.LogMessageList
:canonical: phystool.latex.LatexLogParser.latex3

```{autodoc2-docstring} phystool.latex.LatexLogParser.latex3
```

````

`````

`````{py:class} PdfLatex(fullname: pathlib.Path)
:canonical: phystool.latex.PdfLatex

```{autodoc2-docstring} phystool.latex.PdfLatex
```

```{rubric} Initialization
```

```{autodoc2-docstring} phystool.latex.PdfLatex.__init__
```

````{py:method} output(as_string: str) -> pathlib.Path
:canonical: phystool.latex.PdfLatex.output
:classmethod:

```{autodoc2-docstring} phystool.latex.PdfLatex.output
```

````

````{py:method} compilation_command(fullname: pathlib.Path) -> list[str]
:canonical: phystool.latex.PdfLatex.compilation_command
:classmethod:

```{autodoc2-docstring} phystool.latex.PdfLatex.compilation_command
```

````

````{py:method} full_compile(dest: pathlib.Path | None, can_recompile: bool) -> None
:canonical: phystool.latex.PdfLatex.full_compile

```{autodoc2-docstring} phystool.latex.PdfLatex.full_compile
```

````

````{py:method} compile(env: dict[str, str] | None = None) -> None
:canonical: phystool.latex.PdfLatex.compile

```{autodoc2-docstring} phystool.latex.PdfLatex.compile
```

````

````{py:method} convert_pdf_to_png(dest_files: list[pathlib.Path] = [], cropped: bool = False) -> None
:canonical: phystool.latex.PdfLatex.convert_pdf_to_png

```{autodoc2-docstring} phystool.latex.PdfLatex.convert_pdf_to_png
```

````

````{py:method} clean(extensions: list[str]) -> None
:canonical: phystool.latex.PdfLatex.clean

```{autodoc2-docstring} phystool.latex.PdfLatex.clean
```

````

````{py:method} move_pdf(dest: pathlib.Path | None) -> None
:canonical: phystool.latex.PdfLatex.move_pdf

```{autodoc2-docstring} phystool.latex.PdfLatex.move_pdf
```

````

`````

````{py:function} texfile_to_symlink(tex_file: pathlib.Path) -> pathlib.Path
:canonical: phystool.latex.texfile_to_symlink

```{autodoc2-docstring} phystool.latex.texfile_to_symlink
```
````