.stock_tools

class: StockToolsLanguageOptions

class StockToolsLanguageOptions(**kwargs)[source]

Language settings for the stock tools.

Class Inheritance
Inheritance diagram of StockToolsLanguageOptions

copy(other=None, overwrite=True, **kwargs)

Copy the configuration settings from this instance to the other instance.

Parameters:

  • other (HighchartsMeta) – The target instance to which the properties of this instance should be copied. If None, will create a new instance and populate it with properties copied from self. Defaults to None.

  • overwrite (bool) – if True, properties in other that are already set will be overwritten by their counterparts in self. Defaults to True.

  • kwargs – Additional keyword arguments. Some special descendents of HighchartsMeta may have special implementations of this method which rely on additional keyword arguments.

Returns:

A mutated version of other with new property values

classmethod from_dict(as_dict: dict, allow_snake_case: bool = True)

Construct an instance of the class from a dict object.

Parameters:

  • as_dict (dict) – A dict representation of the object.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python object representation of as_dict.

Return type:

HighchartsMeta

classmethod from_js_literal(as_str_or_file, allow_snake_case: bool = True, _break_loop_on_failure: bool = False)

Return a Python object representation of a Highcharts JavaScript object literal.

Parameters:

  • as_str_or_file (str) – The JavaScript object literal, represented either as a str or as a filename which contains the JS object literal.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

  • _break_loop_on_failure (bool) – If True, will break any looping operations in the event of a failure. Otherwise, will attempt to repair the failure. Defaults to False.

Returns:

A Python object representation of the Highcharts JavaScript object literal.

Return type:

HighchartsMeta

classmethod from_json(as_json_or_file, allow_snake_case: bool = True)

Construct an instance of the class from a JSON string.

Parameters:

  • as_json_or_file – The JSON string for the object or the filename of a file that contains the JSON string.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

to_dict() → dict

Generate a dict representation of the object compatible with the Highcharts JavaScript library.

Note

The dict representation has a property structure and naming convention that is intentionally consistent with the Highcharts JavaScript library. This is not Pythonic, but it makes managing the interplay between the two languages much, much simpler.

Returns:

A dict representation of the object.

Return type:

dict

to_js_literal(filename=None, encoding='utf-8', careful_validation=False) → str | None

Return the object represented as a str containing the JavaScript object literal.

Parameters:

  • filename (Path-like) – The name of a file to which the JavaScript object literal should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

  • careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

Return type:

str or None

to_json(filename=None, encoding='utf-8')

Generate a JSON string/byte string representation of the object compatible with the Highcharts JavaScript library.

Note

This method will either return a standard str or a bytes object depending on the JSON serialization library you are using. For example, if your environment has orjson, the result will be a bytes representation of the string.

Parameters:

  • filename (Path-like) – The name of a file to which the JSON string should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

Returns:

A JSON representation of the object compatible with the Highcharts library.

Return type:

str or bytes

static trim_dict(untrimmed: dict, to_json: bool = False, context: str = None) → dict

Remove keys from untrimmed whose values are None and convert values that have .to_dict() methods.

Parameters:

  • untrimmed (dict) – The dict whose values may still be None or Python objects.

  • to_json (bool) – If True, will remove all keys from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None)

Convert any EnforcedNullType values in untrimmed to 'null'.

Parameters:

  • untrimmed (iterable) – The iterable whose members may still be None or Python objects.

  • to_json (bool) – If True, will remove all members from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Return type:

iterable

property gui: StockToolsGUI | None

Language settings for the stock tools.

Return type:

StockToolsGUI or None

class: StockToolsGUI

class StockToolsGUI(**kwargs)[source]

Language settings for the stock tools.

Class Inheritance
Inheritance diagram of StockToolsGUI

copy(other=None, overwrite=True, **kwargs)

Copy the configuration settings from this instance to the other instance.

Parameters:

  • other (HighchartsMeta) – The target instance to which the properties of this instance should be copied. If None, will create a new instance and populate it with properties copied from self. Defaults to None.

  • overwrite (bool) – if True, properties in other that are already set will be overwritten by their counterparts in self. Defaults to True.

  • kwargs – Additional keyword arguments. Some special descendents of HighchartsMeta may have special implementations of this method which rely on additional keyword arguments.

Returns:

A mutated version of other with new property values

classmethod from_dict(as_dict: dict, allow_snake_case: bool = True)

Construct an instance of the class from a dict object.

Parameters:

  • as_dict (dict) – A dict representation of the object.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python object representation of as_dict.

Return type:

HighchartsMeta

classmethod from_js_literal(as_str_or_file, allow_snake_case: bool = True, _break_loop_on_failure: bool = False)

Return a Python object representation of a Highcharts JavaScript object literal.

Parameters:

  • as_str_or_file (str) – The JavaScript object literal, represented either as a str or as a filename which contains the JS object literal.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

  • _break_loop_on_failure (bool) – If True, will break any looping operations in the event of a failure. Otherwise, will attempt to repair the failure. Defaults to False.

Returns:

A Python object representation of the Highcharts JavaScript object literal.

Return type:

HighchartsMeta

classmethod from_json(as_json_or_file, allow_snake_case: bool = True)

Construct an instance of the class from a JSON string.

Parameters:

  • as_json_or_file – The JSON string for the object or the filename of a file that contains the JSON string.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

to_dict() → dict

Generate a dict representation of the object compatible with the Highcharts JavaScript library.

Note

The dict representation has a property structure and naming convention that is intentionally consistent with the Highcharts JavaScript library. This is not Pythonic, but it makes managing the interplay between the two languages much, much simpler.

Returns:

A dict representation of the object.

Return type:

dict

to_js_literal(filename=None, encoding='utf-8', careful_validation=False) → str | None

Return the object represented as a str containing the JavaScript object literal.

Parameters:

  • filename (Path-like) – The name of a file to which the JavaScript object literal should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

  • careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

Return type:

str or None

to_json(filename=None, encoding='utf-8')

Generate a JSON string/byte string representation of the object compatible with the Highcharts JavaScript library.

Note

This method will either return a standard str or a bytes object depending on the JSON serialization library you are using. For example, if your environment has orjson, the result will be a bytes representation of the string.

Parameters:

  • filename (Path-like) – The name of a file to which the JSON string should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

Returns:

A JSON representation of the object compatible with the Highcharts library.

Return type:

str or bytes

static trim_dict(untrimmed: dict, to_json: bool = False, context: str = None) → dict

Remove keys from untrimmed whose values are None and convert values that have .to_dict() methods.

Parameters:

  • untrimmed (dict) – The dict whose values may still be None or Python objects.

  • to_json (bool) – If True, will remove all keys from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None)

Convert any EnforcedNullType values in untrimmed to 'null'.

Parameters:

  • untrimmed (iterable) – The iterable whose members may still be None or Python objects.

  • to_json (bool) – If True, will remove all members from untrimmed that are not serializable to JSON. Defaults to False.

  • context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Return type:

iterable

property advanced: str | None

Defaults to 'Advanced'.

Return type:

str or None

property arrow_infinity_line: str | None

Defaults to 'Arrow line'.

Return type:

str or None

property arrow_ray: str | None

Defaults to 'Arrow ray'.

Return type:

str or None

property arrow_segment: str | None

Defaults to 'Arrow segment'.

Return type:

str or None

property circle: str | None

Defaults to 'Circle'.

Return type:

str or None

property crooked3: str | None

Defaults to 'Crooked 3 line'.

Return type:

str or None

property crooked5: str | None

Defaults to 'Crooked 5 line'.

Return type:

str or None

property crooked_lines: str | None

Defaults to 'Crooked lines'.

Return type:

str or None

property current_price_indicator: str | None

Defaults to 'Current Price Indicators'.

Return type:

str or None

property elliott3: str | None

Defaults to 'Elliott 3 line'.

Return type:

str or None

property elliott5: str | None

Defaults to 'Elliott 5 line'.

Return type:

str or None

property ellipse: str | None

Defaults to 'Ellipse'.

Return type:

str or None

property fibonacci: str | None

Defaults to 'Fibonacci'.

Return type:

str or None

property fibonacci_time_zones: str | None

Defaults to 'Fibonacci Time Zones'.

Return type:

str or None

property flag_circlepin: str | None

Defaults to 'Flag circle'.

Return type:

str or None

property flag_diamondpin: str | None

Defaults to 'Flag diamond'.

Return type:

str or None

property flag_simplepin: str | None

Defaults to 'Flag simple'.

Return type:

str or None

property flag_squarepin: str | None

Defaults to 'Flag square'.

Return type:

str or None

property flags: str | None

Defaults to 'Flags'.

Return type:

str or None

property fullscreen: str | None

Defaults to 'Fullscreen'.

Return type:

str or None

property horizontal_line: str | None

Defaults to 'Horizontal line'.

Return type:

str or None

property indicators: str | None

Defaults to 'Indicators'.

Return type:

str or None

property infinity_line: str | None

Defaults to 'Infinity line'.

Return type:

str or None

property label: str | None

Defaults to 'Label'.

Return type:

str or None

property line: str | None

Defaults to 'Line'.

Return type:

str or None

property lines: str | None

Defaults to 'Lines'.

Return type:

str or None

property measure: str | None

Defaults to 'Measure'.

Return type:

str or None

property measure_x: str | None

Defaults to 'Measure X'.

Return type:

str or None

property measure_xy: str | None

Defaults to 'Measure XY'.

Return type:

str or None

property measure_y: str | None

Defaults to 'Measure Y'.

Return type:

str or None

property parallel_channel: str | None

Defaults to 'Parallel Channel'.

Return type:

str or None

property pitchfork: str | None

Defaults to 'Pitchfork'.

Return type:

str or None

property ray: str | None

Defaults to 'Ray'.

Return type:

str or None

property rectangle: str | None

Defaults to 'Rectangle'.

Return type:

str or None

property save_chart: str | None

Defaults to 'Save chart'.

Return type:

str or None

property segment: str | None

Defaults to 'Segment'.

Return type:

str or None

property simple_shapes: str | None

Defaults to 'Simple shapes'.

Return type:

str or None

property time_cycles: str | None

Defaults to 'Time Cycles'.

Return type:

str or None

property toggle_annotations: str | None

Defaults to 'Toggle annotations'.

Return type:

str or None

property type_candlestick: str | None

Defaults to 'Candlestick'.

Return type:

str or None

property type_change: str | None

Defaults to 'Type change'.

Return type:

str or None

property type_heikin_ashi: str | None

Defaults to 'Heikin Ashi'.

Return type:

str or None

property type_hlc: str | None

Defaults to 'HLC'.

Return type:

str or None

property type_hollow_candlestick: str | None

Defaults to 'Hollow Candlestick'.

Return type:

str or None

property type_line: str | None

Defaults to 'Line'.

Return type:

str or None

property type_ohlc: str | None

Defaults to 'OHLC'.

Return type:

str or None

property vertical_arrow: str | None

Defaults to 'Vertical arrow'.

Return type:

str or None

property vertical_counter: str | None

Defaults to 'Vertical counter'.

Return type:

str or None

property vertical_label: str | None

Defaults to 'Vertical label'.

Return type:

str or None

property vertical_labels: str | None

Defaults to 'Vertical labels'.

Return type:

str or None

property vertical_line: str | None

Defaults to 'Vertical line'.

Return type:

str or None

property zoom_change: str | None

Defaults to 'Zoom change'.

Return type:

str or None

property zoom_x: str | None

Defaults to 'Zoom X'.

Return type:

str or None

property zoom_xy: str | None

Defaults to 'Zoom XY'.

Return type:

str or None

property zoom_y: str | None

Defaults to 'Zoom Y'.

Return type:

str or None