QuantConnect / QuantConnect/Lean

Better Error Reporting from Custom Data Types

Open
#7,472 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
C#
Stars
21.7k
Forks
5.3k
Avg merge
2d 22h
Merged PRs (30d)
34

Description

Expected Behavior

LEAN provides information about errors in Custom Data Types.

Actual Behavior

The Reader of Custom Data types doesn't always display the error to the user.

Potential Solution

TextSubscriptionDataSourceReader.ReaderError should not be null. OnReaderError will not log anywhere if it is.

Reproducing the Problem

Run CustomDataBitcoinAlgorithm in live mode. There is a bug at

coin.EndTime =  datetime.utcnow().astimezone(timezone(str(config.ExchangeTimeZone))).replace(tzinfo=None)

since the timezone constructor doesn't accept a string argument. We should receive a message:

'timezone() argument 1 must be datetime.timedelta, not str'

we can fix that line with

coin.EndTime = Extensions.ConvertFromUtc(datetime.utcnow(), config.ExchangeTimeZone)
Checklist
  • I have completely filled out this template
  • I have confirmed that this issue exists on the current master branch
  • I have confirmed that this is not a duplicate issue by searching issues
  • I have provided detailed steps to reproduce the issue

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with TextSubscriptionDataSourceReader.ReaderError and its OnReaderError path, then reproduce the problem by running CustomDataBitcoinAlgorithm in live mode. Check how the reader handles the shown Python timezone error; done means the error is no longer lost and the expected message is displayed to the user.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, python
Domain
backend, data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.