backtrader.test_helpers module

Test Helpers Module - Utility functions for testing.

This module provides helper functions for testing backtrader, including registering and retrieving expected test values.

Functions:

register_test_values: Register expected values for a test. get_test_value: Get expected value for a test. is_test_mode: Check if running in test context.

Example

Registering test values: >>> from backtrader.test_helpers import register_test_values >>> register_test_values(‘mytest’, values=[100.0], cash=[10000.0])

backtrader.test_helpers.register_test_values(test_name, values=None, cash=None)[source]

Register expected value and cash values for a specific test.

Parameters:
  • test_name – Name of the test.

  • values – Expected portfolio values.

  • cash – Expected cash values.

backtrader.test_helpers.get_test_value(test_file, index=0)[source]

Get expected value for current test if running in test mode

backtrader.test_helpers.is_test_mode()[source]

Check if we’re running in a test context

backtrader.test_helpers.get_current_test_file()[source]

Get current test file name if in test mode