API Reference
This page provides documentation for our Python API.
SynapseNotebookConverter
Bases: SynapseNotebookHandler, PythonFileHandler
This class is responsible for converting Python files to Synapse notebooks and vice versa.
convert
Converts a source file into a target file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
source |
str
|
The file to be converted. |
required |
target |
str
|
The path of the resulting file. |
required |
convert_python_file_to_synapse_notebook
Converts a Python file into a Synapse notebook.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
python_file |
str
|
The Python file to be converted. |
required |
notebook_file |
str
|
The path of the resulting Synapse notebook. |
required |
convert_synapse_notebook_to_python_file
Converts a Synapse notebook into a Python file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
notebook_file |
str
|
The Synapse notebook to be converted. |
required |
python_file |
str
|
The path of the resulting Python file. |
required |