# {py:mod}`simvx.editor.refactor_extract`

```{py:module} simvx.editor.refactor_extract
```

```{autodoc2-docstring} simvx.editor.refactor_extract
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ExtractResult <simvx.editor.refactor_extract.ExtractResult>`
  - ```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractResult
    :summary:
    ```
````

### Functions

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

* - {py:obj}`extract_to_folder <simvx.editor.refactor_extract.extract_to_folder>`
  - ```{autodoc2-docstring} simvx.editor.refactor_extract.extract_to_folder
    :summary:
    ```
````

### Data

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

* - {py:obj}`log <simvx.editor.refactor_extract.log>`
  - ```{autodoc2-docstring} simvx.editor.refactor_extract.log
    :summary:
    ```
````

### API

````{py:data} log
:canonical: simvx.editor.refactor_extract.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.editor.refactor_extract.log
```

````

`````{py:exception} ExtractRefused()
:canonical: simvx.editor.refactor_extract.ExtractRefused

Bases: {py:obj}`ValueError`

```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractRefused
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractRefused.__init__
```

```{py:class} __cause__
:canonical: simvx.editor.refactor_extract.ExtractRefused.__cause__

```

```{py:class} __context__
:canonical: simvx.editor.refactor_extract.ExtractRefused.__context__

```

````{py:method} __delattr__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__dir__

````

````{py:method} __eq__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__eq__

````

````{py:method} __format__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__format__

````

````{py:method} __ge__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__getattribute__

````

````{py:method} __getstate__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__gt__

````

````{py:method} __hash__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__hash__

````

````{py:method} __le__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__le__

````

````{py:method} __lt__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__lt__

````

````{py:method} __ne__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__ne__

````

````{py:method} __new__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__new__

````

````{py:method} __reduce__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__repr__

````

````{py:method} __setattr__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__setattr__

````

````{py:method} __setstate__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__setstate__

````

````{py:method} __sizeof__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.editor.refactor_extract.ExtractRefused.__subclasshook__

````

```{py:class} __suppress_context__
:canonical: simvx.editor.refactor_extract.ExtractRefused.__suppress_context__

```

```{py:class} __traceback__
:canonical: simvx.editor.refactor_extract.ExtractRefused.__traceback__

```

````{py:method} add_note()
:canonical: simvx.editor.refactor_extract.ExtractRefused.add_note

````

```{py:class} args
:canonical: simvx.editor.refactor_extract.ExtractRefused.args

```

````{py:method} with_traceback()
:canonical: simvx.editor.refactor_extract.ExtractRefused.with_traceback

````

`````

`````{py:class} ExtractResult
:canonical: simvx.editor.refactor_extract.ExtractResult

```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractResult
```

````{py:attribute} folder
:canonical: simvx.editor.refactor_extract.ExtractResult.folder
:type: pathlib.Path
:value: >
   None

```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractResult.folder
```

````

````{py:attribute} created_files
:canonical: simvx.editor.refactor_extract.ExtractResult.created_files
:type: tuple[pathlib.Path, ...]
:value: >
   None

```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractResult.created_files
```

````

````{py:attribute} original_path
:canonical: simvx.editor.refactor_extract.ExtractResult.original_path
:type: pathlib.Path
:value: >
   None

```{autodoc2-docstring} simvx.editor.refactor_extract.ExtractResult.original_path
```

````

`````

````{py:function} extract_to_folder(file_path: pathlib.Path, project_index: simvx.editor.project_classes.ProjectClassIndex | None = None) -> simvx.editor.refactor_extract.ExtractResult
:canonical: simvx.editor.refactor_extract.extract_to_folder

```{autodoc2-docstring} simvx.editor.refactor_extract.extract_to_folder
```
````