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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.scene_io.scene_module.__all__
:value: >
   ['NotASceneModuleError', 'SceneModule']

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

````

`````{py:exception} NotASceneModuleError()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError

Bases: {py:obj}`ValueError`

```{autodoc2-docstring} simvx.core.scene_io.scene_module.NotASceneModuleError
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.scene_io.scene_module.NotASceneModuleError.__init__
```

```{py:class} __cause__
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__cause__

```

```{py:class} __context__
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__context__

```

````{py:method} __delattr__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__dir__

````

````{py:method} __eq__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__eq__

````

````{py:method} __format__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__format__

````

````{py:method} __ge__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__getattribute__

````

````{py:method} __getstate__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__gt__

````

````{py:method} __hash__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__hash__

````

````{py:method} __le__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__le__

````

````{py:method} __lt__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__lt__

````

````{py:method} __ne__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__ne__

````

````{py:method} __new__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__new__

````

````{py:method} __reduce__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__repr__

````

````{py:method} __setattr__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__setattr__

````

````{py:method} __setstate__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__setstate__

````

````{py:method} __sizeof__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__subclasshook__

````

```{py:class} __suppress_context__
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__suppress_context__

```

```{py:class} __traceback__
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.__traceback__

```

````{py:method} add_note()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.add_note

````

```{py:class} args
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.args

```

````{py:method} with_traceback()
:canonical: simvx.core.scene_io.scene_module.NotASceneModuleError.with_traceback

````

`````

`````{py:class} SceneModule(folder: pathlib.Path, root_path: pathlib.Path, root: simvx.core.scene_io.scene_file.SceneFile)
:canonical: simvx.core.scene_io.scene_module.SceneModule

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.scene_io.scene_module.SceneModule.__slots__
:value: >
   ('_folder', '_root_path', '_root', '_files', '_to_delete', '_added')

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.__slots__
```

````

````{py:method} load(folder: str | pathlib.Path) -> simvx.core.scene_io.scene_module.SceneModule
:canonical: simvx.core.scene_io.scene_module.SceneModule.load
:classmethod:

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.load
```

````

````{py:method} is_folder_scene(path: str | pathlib.Path) -> bool
:canonical: simvx.core.scene_io.scene_module.SceneModule.is_folder_scene
:staticmethod:

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.is_folder_scene
```

````

````{py:property} folder
:canonical: simvx.core.scene_io.scene_module.SceneModule.folder
:type: pathlib.Path

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.folder
```

````

````{py:property} root
:canonical: simvx.core.scene_io.scene_module.SceneModule.root
:type: simvx.core.scene_io.scene_file.SceneFile

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.root
```

````

````{py:property} root_path
:canonical: simvx.core.scene_io.scene_module.SceneModule.root_path
:type: pathlib.Path

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.root_path
```

````

````{py:method} files() -> list[simvx.core.scene_io.scene_file.SceneFile]
:canonical: simvx.core.scene_io.scene_module.SceneModule.files

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.files
```

````

````{py:method} file(name: str) -> simvx.core.scene_io.scene_file.SceneFile
:canonical: simvx.core.scene_io.scene_module.SceneModule.file

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.file
```

````

````{py:method} add_file(name: str, source: str) -> simvx.core.scene_io.scene_file.SceneFile
:canonical: simvx.core.scene_io.scene_module.SceneModule.add_file

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.add_file
```

````

````{py:method} remove_file(name: str) -> None
:canonical: simvx.core.scene_io.scene_module.SceneModule.remove_file

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.remove_file
```

````

````{py:method} split_child(child_var: str, into_file: str) -> simvx.core.scene_io.scene_file.SceneFile
:canonical: simvx.core.scene_io.scene_module.SceneModule.split_child

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.split_child
```

````

````{py:method} inline_file(child_path: str) -> None
:canonical: simvx.core.scene_io.scene_module.SceneModule.inline_file

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.inline_file
```

````

````{py:method} save() -> list[pathlib.Path]
:canonical: simvx.core.scene_io.scene_module.SceneModule.save

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.save
```

````

````{py:method} assert_idempotent() -> None
:canonical: simvx.core.scene_io.scene_module.SceneModule.assert_idempotent

```{autodoc2-docstring} simvx.core.scene_io.scene_module.SceneModule.assert_idempotent
```

````

`````