mirror of
https://github.com/Ichinga-Samuel/aiomql.git
synced 2026-08-04 07:47:44 +00:00
v4
This commit is contained in:
Ichinga Samuel
@@ -1,125 +1,104 @@
|
||||
# Table of Contents
|
||||
# BackTestController
|
||||
|
||||
* [backtest\_controller](#backtest_controller)
|
||||
* [BackTestController](#backtest_controller.BackTestController)
|
||||
* [backtest\_engine](#backtest_controller.BackTestController.backtest_engine)
|
||||
* [add\_tasks](#backtest_controller.BackTestController.add_tasks)
|
||||
* [set\_parties](#backtest_controller.BackTestController.set_parties)
|
||||
* [parties](#backtest_controller.BackTestController.parties)
|
||||
* [control](#backtest_controller.BackTestController.control)
|
||||
* [stop\_backtesting](#backtest_controller.BackTestController.stop_backtesting)
|
||||
* [wait](#backtest_controller.BackTestController.wait)
|
||||
* [abort](#backtest_controller.BackTestController.abort)
|
||||
## Table of Contents
|
||||
- [BackTestController](#backtest_controller.back_test_controller)
|
||||
- [backtest_engine](#backtest_controller.backtest_engine)
|
||||
- [add_tasks](#backtest_controller.add_tasks)
|
||||
- [set_parties](#backtest_controller.set_parties)
|
||||
- [parties](#backtest_controller.parties)
|
||||
- [control](#backtest_controller.control)
|
||||
- [stop_backtesting](#backtest_controller.stop_backtesting)
|
||||
- [wait](#backtest_controller.wait)
|
||||
- [abort](#backtest_controller.abort)
|
||||
|
||||
<a id="backtest_controller"></a>
|
||||
|
||||
# backtest\_controller
|
||||
|
||||
<a id="backtest_controller.BackTestController"></a>
|
||||
|
||||
## BackTestController Objects
|
||||
|
||||
<a id="backtest_controller.back_test_controller"></a>
|
||||
### BackTestController
|
||||
```python
|
||||
class BackTestController()
|
||||
class BackTestController
|
||||
```
|
||||
|
||||
The controller for the backtesting engine.
|
||||
It also act's as a synchronizier for running multiple strategies (tasks) using a threading.Barrier primitive.
|
||||
It also acts as a synchronizer for running multiple strategies (tasks) using a threading.Barrier primitive.
|
||||
It handles the updating of open positions and close them when necessary.
|
||||
It handles the iterator for the backtesting engine and handles it movement in time by moving it to the next time step.
|
||||
|
||||
**Attributes**:
|
||||
#### Attributes:
|
||||
| Name | Type | Description |
|
||||
|-------------|----------------------|----------------------------------------------|
|
||||
| `_instance` | `BackTestController` | The instance of the controller |
|
||||
| `config` | `Config` | The configuration for the backtesting engine |
|
||||
| `tasks` | `list[Task]` | The tasks that are being run |
|
||||
| `barrier` | `Barrier` | The barrier for synchronizing the tasks |
|
||||
|
||||
- `_instance` _Self_ - The instance of the controller
|
||||
- `config` _Config_ - The configuration for the backtesting engine
|
||||
- `tasks` _list[Task]_ - The tasks that are being run
|
||||
- `barrier` _Barrier_ - The barrier for synchronizing the tasks
|
||||
|
||||
<a id="backtest_controller.BackTestController.backtest_engine"></a>
|
||||
|
||||
#### backtest\_engine
|
||||
|
||||
<a id="backtest_controller.backtest_engine"></a>
|
||||
#### backtest_engine
|
||||
```python
|
||||
@property
|
||||
def backtest_engine()
|
||||
```
|
||||
|
||||
Returns the backtest engine
|
||||
|
||||
<a id="backtest_controller.BackTestController.add_tasks"></a>
|
||||
|
||||
#### add\_tasks
|
||||
|
||||
<a id="backtest_controller.add_tasks"></a>
|
||||
#### add_tasks
|
||||
```python
|
||||
def add_tasks(*tasks: Task)
|
||||
```
|
||||
Adds a task to the tasks list
|
||||
|
||||
Adds tasks to the tasks list
|
||||
|
||||
<a id="backtest_controller.BackTestController.set_parties"></a>
|
||||
|
||||
#### set\_parties
|
||||
|
||||
<a id="backtest_controller.set_parties"></a>
|
||||
#### set_parties
|
||||
```python
|
||||
def set_parties(*, parties: int)
|
||||
```
|
||||
|
||||
Sets the number of parties for the barrier. The barrier will wait for the number of parties to reach the barrier.
|
||||
This has to be done here as it can be impossible to know the eventual number of parties to set the barrier to during initialization.
|
||||
|
||||
**Arguments**:
|
||||
#### Parameters:
|
||||
| Name | Type | Description |
|
||||
|-----------|-------|---------------------------------------------|
|
||||
| `parties` | `int` | The number of parties to set the barrier to |
|
||||
|
||||
- `parties` _int_ - The number of parties to set the barrier to
|
||||
|
||||
<a id="backtest_controller.BackTestController.parties"></a>
|
||||
|
||||
<a id="backtest_controller.parties"></a>
|
||||
#### parties
|
||||
|
||||
```python
|
||||
@property
|
||||
def parties()
|
||||
```
|
||||
|
||||
Returns the number of parties for the barrier
|
||||
|
||||
<a id="backtest_controller.BackTestController.control"></a>
|
||||
|
||||
<a id="backtest_controller.control"></a>
|
||||
#### control
|
||||
|
||||
```python
|
||||
async def control()
|
||||
```
|
||||
|
||||
The backtest controller. It controls the backtesting engine and the tasks that are being run.
|
||||
It acts as a synchronizer for the tasks and the backtesting engine.
|
||||
|
||||
<a id="backtest_controller.BackTestController.stop_backtesting"></a>
|
||||
|
||||
#### stop\_backtesting
|
||||
|
||||
<a id="backtest_controller.stop_backtesting"></a>
|
||||
#### stop_backtesting
|
||||
```python
|
||||
def stop_backtesting()
|
||||
```
|
||||
|
||||
Stop the backtester, and shutdown the executor
|
||||
|
||||
<a id="backtest_controller.BackTestController.wait"></a>
|
||||
|
||||
<a id="backtest_controller.wait"></a>
|
||||
#### wait
|
||||
|
||||
```python
|
||||
def wait()
|
||||
```
|
||||
|
||||
Called by individual tasks to indicate completion of their cycle
|
||||
|
||||
<a id="backtest_controller.BackTestController.abort"></a>
|
||||
|
||||
<a id="backtest_controller.abort"></a>
|
||||
#### abort
|
||||
|
||||
```python
|
||||
def abort()
|
||||
```
|
||||
|
||||
Aborts the barrier
|
||||
|
||||
|
||||
Reference in New Issue
Block a user