# {py:mod}`simvx.core.scene_io.syntax`

```{py:module} simvx.core.scene_io.syntax
```

```{autodoc2-docstring} simvx.core.scene_io.syntax
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`SyntaxIssue <simvx.core.scene_io.syntax.SyntaxIssue>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue
    :summary:
    ```
````

### Functions

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

* - {py:obj}`syntax_issues <simvx.core.scene_io.syntax.syntax_issues>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.syntax_issues
    :summary:
    ```
* - {py:obj}`refusal <simvx.core.scene_io.syntax.refusal>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.refusal
    :summary:
    ```
* - {py:obj}`issue_lines <simvx.core.scene_io.syntax.issue_lines>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.issue_lines
    :summary:
    ```
* - {py:obj}`first_unexplained <simvx.core.scene_io.syntax.first_unexplained>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.first_unexplained
    :summary:
    ```
* - {py:obj}`explain_at <simvx.core.scene_io.syntax.explain_at>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.explain_at
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.scene_io.syntax.__all__>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.__all__
    :summary:
    ```
* - {py:obj}`SUBSET_REFERENCE <simvx.core.scene_io.syntax.SUBSET_REFERENCE>`
  - ```{autodoc2-docstring} simvx.core.scene_io.syntax.SUBSET_REFERENCE
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.scene_io.syntax.__all__
:value: >
   ['SyntaxIssue', 'UnsupportedSceneSyntaxError', 'explain_at', 'first_unexplained', 'issue_lines', 're...

```{autodoc2-docstring} simvx.core.scene_io.syntax.__all__
```

````

````{py:data} SUBSET_REFERENCE
:canonical: simvx.core.scene_io.syntax.SUBSET_REFERENCE
:value: >
   'simvx.core.scene_io.syntax'

```{autodoc2-docstring} simvx.core.scene_io.syntax.SUBSET_REFERENCE
```

````

`````{py:exception} UnsupportedSceneSyntaxError(message: str, issues: list[simvx.core.scene_io.syntax.SyntaxIssue])
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError

Bases: {py:obj}`ValueError`

```{autodoc2-docstring} simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__init__
```

```{py:class} __cause__
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__cause__

```

```{py:class} __context__
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__context__

```

````{py:method} __delattr__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__dir__

````

````{py:method} __eq__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__eq__

````

````{py:method} __format__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__getattribute__

````

````{py:method} __getstate__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__hash__

````

````{py:method} __le__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__le__

````

````{py:method} __lt__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__lt__

````

````{py:method} __ne__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__ne__

````

````{py:method} __new__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__new__

````

````{py:method} __reduce__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__repr__

````

````{py:method} __setattr__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__setattr__

````

````{py:method} __setstate__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__setstate__

````

````{py:method} __sizeof__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__subclasshook__

````

```{py:class} __suppress_context__
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__suppress_context__

```

```{py:class} __traceback__
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.__traceback__

```

````{py:method} add_note()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.add_note

````

```{py:class} args
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.args

```

````{py:method} with_traceback()
:canonical: simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError.with_traceback

````

`````

`````{py:class} SyntaxIssue
:canonical: simvx.core.scene_io.syntax.SyntaxIssue

Bases: {py:obj}`typing.NamedTuple`

```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue
```

````{py:attribute} line
:canonical: simvx.core.scene_io.syntax.SyntaxIssue.line
:type: int
:value: >
   None

```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue.line
```

````

````{py:attribute} column
:canonical: simvx.core.scene_io.syntax.SyntaxIssue.column
:type: int
:value: >
   None

```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue.column
```

````

````{py:attribute} construct
:canonical: simvx.core.scene_io.syntax.SyntaxIssue.construct
:type: str | None
:value: >
   None

```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue.construct
```

````

````{py:attribute} message
:canonical: simvx.core.scene_io.syntax.SyntaxIssue.message
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue.message
```

````

````{py:method} describe() -> str
:canonical: simvx.core.scene_io.syntax.SyntaxIssue.describe

```{autodoc2-docstring} simvx.core.scene_io.syntax.SyntaxIssue.describe
```

````

`````

````{py:function} syntax_issues(module: parso.python.tree.Module) -> list[simvx.core.scene_io.syntax.SyntaxIssue]
:canonical: simvx.core.scene_io.syntax.syntax_issues

```{autodoc2-docstring} simvx.core.scene_io.syntax.syntax_issues
```
````

````{py:function} refusal(issues: list[simvx.core.scene_io.syntax.SyntaxIssue], *, subject: str, consequence: str) -> simvx.core.scene_io.syntax.UnsupportedSceneSyntaxError
:canonical: simvx.core.scene_io.syntax.refusal

```{autodoc2-docstring} simvx.core.scene_io.syntax.refusal
```
````

````{py:function} issue_lines(issues: list[simvx.core.scene_io.syntax.SyntaxIssue]) -> set[int]
:canonical: simvx.core.scene_io.syntax.issue_lines

```{autodoc2-docstring} simvx.core.scene_io.syntax.issue_lines
```
````

````{py:function} first_unexplained(issues: list[simvx.core.scene_io.syntax.SyntaxIssue]) -> simvx.core.scene_io.syntax.SyntaxIssue | None
:canonical: simvx.core.scene_io.syntax.first_unexplained

```{autodoc2-docstring} simvx.core.scene_io.syntax.first_unexplained
```
````

````{py:function} explain_at(issues: list[simvx.core.scene_io.syntax.SyntaxIssue], line: int) -> simvx.core.scene_io.syntax.SyntaxIssue | None
:canonical: simvx.core.scene_io.syntax.explain_at

```{autodoc2-docstring} simvx.core.scene_io.syntax.explain_at
```
````