QuantConnect / QuantConnect/Lean
Adds Algorithm Exception Handler
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 21.7k
- Forks
- 5.3k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 34
Description
Expected Behavior
Be able to take action when a runtime exception is raised.
Actual Behavior
If a runtime error occurs, we cannot take actions such as close positions and open orders.
Potential Solution
Add IAlgorithm.OnError method.
Reproducing the Problem
from AlgorithmImports import *
class FormalFluorescentYellowPenguin(QCAlgorithm):
def initialize(self):
self.set_start_date(2024, 6, 30)
self.add_crypto("BTCUSD")
def on_data(self, data):
x=1/0
def on_end_of_algorithm(self):
self.liquidate()
In this case, on_end_of_algorithm is not called, so we cannot close positions and open orders if we want to.
Checklist
- I have completely filled out this template
- I have confirmed that this issue exists on the current
masterbranch - I have confirmed that this is not a duplicate issue by searching issues
- I have provided detailed steps to reproduce the issue
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the supplied Python reproduction, focusing on the on_data and on_end_of_algorithm entry points and how runtime exceptions affect the algorithm lifecycle. Trace the existing exception-handling path, then verify that an error callback can run the requested cleanup actions, including liquidating positions and closing open orders.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100