RunCodeFlowModule / README.md
Tachi67's picture
Upload README.md
d617a81
# Table of Contents
* [RunCodeFlow](#RunCodeFlow)
* [RunCodeFlow](#RunCodeFlow.RunCodeFlow)
* [ExecuteCodeAtomicFlow](#ExecuteCodeAtomicFlow)
* [ExecuteCodeAtomicFlow](#ExecuteCodeAtomicFlow.ExecuteCodeAtomicFlow)
* [RunCodeAskUserFlow](#RunCodeAskUserFlow)
* [RunCodeAskUserFlow](#RunCodeAskUserFlow.RunCodeAskUserFlow)
* [library](#library)
* [run](#run)
* [RunCodeFileEditAtomicFlow](#RunCodeFileEditAtomicFlow)
* [RunCodeFileEditAtomicFlow](#RunCodeFileEditAtomicFlow.RunCodeFileEditAtomicFlow)
* [\_\_init\_\_](#__init__)
<a id="RunCodeFlow"></a>
# RunCodeFlow
<a id="RunCodeFlow.RunCodeFlow"></a>
## RunCodeFlow Objects
```python
class RunCodeFlow(SequentialFlow)
```
This flow is used to run code in a file. It opens up the file in VSCode and waits for the user to save the file.
Once the file is saved, it reads the code from the file and executes it. It then returns the output of the execution.
Finally, the flow asks the user for feedback on the execution of the code.
*Input Interface*:
- code: The code to be executed.
- language: The language of the code to be executed.
- memory_files: The dictionary containing the location of the code library.
*Output Interface*:
- summary: The summary of the execution of the code. (To be written to the logs of the caller flow)
- result: The result of the execution of the code. (To be returned to the controller of the caller flow)
<a id="ExecuteCodeAtomicFlow"></a>
# ExecuteCodeAtomicFlow
<a id="ExecuteCodeAtomicFlow.ExecuteCodeAtomicFlow"></a>
## ExecuteCodeAtomicFlow Objects
```python
class ExecuteCodeAtomicFlow(InterpreterAtomicFlow)
```
This class inherits from InterpreterAtomicFlow and is used to execute code in a file.
It opens up the file in VSCode and waits for the user to save the file. Once the file is saved, it reads the code
from the file and executes it. It then returns the output of the execution.
*Input Interface*:
- temp_code_file_location: The location of the file containing the code to be executed.
- language: The language of the code to be executed.
*Output Interface*:
- interpreter_output: The output of the execution of the code.
- code_ran: The code that was executed.
<a id="RunCodeAskUserFlow"></a>
# RunCodeAskUserFlow
<a id="RunCodeAskUserFlow.RunCodeAskUserFlow"></a>
## RunCodeAskUserFlow Objects
```python
class RunCodeAskUserFlow(HumanStandardInputFlow)
```
Refer to: https://huggingface.co/Tachi67/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py
<a id="library"></a>
# library
<a id="run"></a>
# run
<a id="RunCodeFileEditAtomicFlow"></a>
# RunCodeFileEditAtomicFlow
<a id="RunCodeFileEditAtomicFlow.RunCodeFileEditAtomicFlow"></a>
## RunCodeFileEditAtomicFlow Objects
```python
class RunCodeFileEditAtomicFlow(CodeFileEditAtomicFlow)
```
Refer to: https://huggingface.co/Tachi67/CodeFileEditFlowModule
<a id="__init__"></a>
# \_\_init\_\_