Removed deepcopy uses and replaced with Candle clean_copy

Author: MerlinR

CHANGELOG.md

@@ -11,6 +11,12 @@ The project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html
 *Release Date: -**
 
 - Added as_list and as_dict method's to Candle
+- Added clean_copy to Candle to copy core values to new Candle object
+    - Will remove indicators/sub_indicators
+    - Default used when appending new Candle
+
+- Optimisation
+    - Removed use of 'deepcopy' for 'clean_copy'
 
 ## 2.0.1
 

hexital/core/candle.py

@@ -269,6 +269,9 @@ def from_lists(candles: List[list]) -> List[Candle]:
         """
         return [Candle.from_list(candle) for candle in candles]
 
+    def clean_copy(self) -> Candle:
+        return Candle.from_list(self.as_list())
+
     def set_collapsed_timestamp(self, timestamp: datetime):
         if not self._start_timestamp:
             self._start_timestamp = self.timestamp

hexital/core/candle_manager.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from copy import deepcopy
 from datetime import datetime, timedelta
 from functools import cmp_to_key
 from typing import List, Optional, Set
@@ -45,7 +44,7 @@ def __init__(
         self.timeframe_fill = timeframe_fill
         self.candlestick = candlestick
 
-        self._tasks(True)
+        self._tasks()
 
     def __eq__(self, other) -> bool:
         if not isinstance(other, CandleManager):
@@ -70,10 +69,7 @@ def name(self) -> str:
     def name(self, name: str):
         self._name = name
 
-    def _tasks(self, to_sort: Optional[bool] = False):
-        if to_sort:
-            self.sort_candles()
-
+    def _tasks(self):
         self.collapse_candles()
         self.convert_candles()
         self.trim_candles()
@@ -115,11 +111,14 @@ def append(self, candles: Candle | List[Candle] | dict | List[dict] | list | Lis
             if last_timestamp and candle.timestamp < last_timestamp:
                 to_sort = True
             if not candle.timeframe or not self.timeframe:
-                self.candles.append(deepcopy(candle))
+                self.candles.append(candle.clean_copy())
             elif candle.timeframe <= self.timeframe:
-                self.candles.append(deepcopy(candle))
+                self.candles.append(candle.clean_copy())
+
+        if to_sort:
+            self.sort_candles()
 
-        self._tasks(to_sort)
+        self._tasks()
 
     def sort_candles(self, candles: Optional[List[Candle]] = None):
         """Sorts Candles in order of timestamp, accounts for collapsing"""

hexital/core/hexital.py

@@ -1,4 +1,4 @@
-from copy import copy, deepcopy
+from copy import copy
 from datetime import timedelta
 from importlib import import_module
 from typing import Dict, List, Optional, Set
@@ -166,7 +166,7 @@ def append(
         timeframe_name = self._parse_timeframe(timeframe)
 
         if timeframe_name and self._candles.get(timeframe_name):
-            self._candles[timeframe_name].append(deepcopy(candles))
+            self._candles[timeframe_name].append(candles)
         else:
             for candle_manager in self._candles.values():
                 candle_manager.append(candles)
@@ -240,12 +240,13 @@ def _validate_indicators(self, indicators: List[dict | Indicator]) -> Dict[str,
                 indicator.candle_manager = self._candles[indicator.timeframe]
             else:
                 manager = CandleManager(
-                    deepcopy(self._candles[DEFAULT_CANDLES]).candles,
+                    [],
                     candle_life=self.candle_life,
                     timeframe=indicator._timeframe if indicator._timeframe else self._timeframe,
                     timeframe_fill=self.timeframe_fill,
                     candlestick=self.candlestick,
                 )
+                manager.append(self._candles[DEFAULT_CANDLES].candles)
                 self._candles[manager.name] = manager
                 indicator.candle_manager = self._candles[manager.name]
 
@@ -261,15 +262,17 @@ def _build_indicator(self, raw_indicator: dict) -> Indicator:
             if indicator_class:
                 return indicator_class(**indicator)
             else:
-                raise InvalidIndicator(f"Indicator {indicator_name} does not exist. [{indicator}]")
+                raise InvalidIndicator(
+                    f"Indicator {indicator_name} does not exist. [{raw_indicator}]"
+                )
 
         elif indicator.get("analysis") and isinstance(indicator.get("analysis"), str):
             analysis_name = indicator.pop("analysis")
             analysis_class = getattr(import_module("hexital.analysis"), analysis_name, None)
 
             if not analysis_class:
                 raise InvalidAnalysis(
-                    f"analysis {analysis_name} does not exist in patterns or movements. [{indicator}]"
+                    f"analysis {analysis_name} does not exist in patterns or movements. [{raw_indicator}]"
                 )
 
             return Amorph(analysis=analysis_class, **indicator)

hexital/core/indicator.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
-from copy import deepcopy
+from copy import copy
 from dataclasses import dataclass, field
 from datetime import timedelta
 from typing import Dict, List, Optional, TypeVar
@@ -164,7 +164,7 @@ def settings(self) -> dict:
             elif name == "timeframe" and self._candles.timeframe is not None:
                 output[name] = timedelta_to_str(self._candles.timeframe)
             elif not name.startswith("_") and value is not None:
-                output[name] = deepcopy(value)
+                output[name] = copy(value)
 
         return output
 

hexital/indicators/amorph.py

@@ -1,5 +1,5 @@
 import inspect
-from copy import deepcopy
+from copy import copy
 from typing import Callable, Optional
 
 from hexital.core.indicator import Indicator
@@ -45,7 +45,7 @@ def settings(self) -> dict:
             if name == "timeframe_fill" and self.timeframe is None:
                 continue
             if not name.startswith("_") and value:
-                output[name] = deepcopy(value)
+                output[name] = copy(value)
 
         return output
 

tests/core/test_candle_manager.py

@@ -15,7 +15,16 @@ def test_append_candle(self, minimal_candles):
         manager = CandleManager()
         manager.append(new_candle)
 
-        assert manager.candles == [new_candle]
+        assert manager.candles == [
+            Candle(
+                open=2424,
+                high=10767,
+                low=13115,
+                close=13649,
+                volume=15750,
+                timestamp=datetime(2023, 6, 1, 9, 19),
+            )
+        ]
 
     def test_append_list_nada(self):
         manager = CandleManager()
@@ -28,14 +37,23 @@ def test_append_candle_list(self, minimal_candles):
         manager = CandleManager()
         manager.append(minimal_candles)
 
-        assert manager.candles == minimal_candles
+        assert manager.candles == [cdl.clean_copy() for cdl in minimal_candles]
 
     @pytest.mark.usefixtures("minimal_candles")
     def test_append_candle_list_single(self, minimal_candles):
         manager = CandleManager()
         manager.append([minimal_candles[0]])
 
-        assert manager.candles == [minimal_candles[0]]
+        assert manager.candles == [
+            Candle(
+                open=17213,
+                high=2395,
+                low=7813,
+                close=3615,
+                volume=19661,
+                timestamp=datetime(2023, 6, 1, 9, 0, 10),
+            )
+        ]
 
     def test_append_dict(self):
         manager = CandleManager()

tests/core/test_hexital.py

@@ -271,8 +271,6 @@ def test_hextial_timerange(minimal_candles):
             low=1903,
             close=6255,
             volume=31307,
-            indicators={"ATR": 1900, "MinTR": 1902, "NATR": {"nested": 1901}},
-            sub_indicators={"SATR": 1910, "SSATR": {"nested": 1911}},
             timestamp=datetime(2023, 6, 1, 9, 18),
         ),
         Candle(
@@ -281,8 +279,6 @@ def test_hextial_timerange(minimal_candles):
             low=13115,
             close=13649,
             volume=15750,
-            indicators={"ATR": 2000, "MinTR": 2002, "NATR": {"nested": 2001}},
-            sub_indicators={"SATR": 2010, "SSATR": {"nested": 2011}},
             timestamp=datetime(2023, 6, 1, 9, 19),
         ),
     ]

tests/core/test_indicator.py

@@ -178,12 +178,8 @@ def test_candle_timerange(minimal_candles):
             close=6255,
             volume=31307,
             indicators={
-                "ATR": 1900,
                 "Fake_10": 100.0,
-                "MinTR": 1902,
-                "NATR": {"nested": 1901},
             },
-            sub_indicators={"SATR": 1910, "SSATR": {"nested": 1911}},
             timestamp=datetime(2023, 6, 1, 9, 18),
         ),
         Candle(
@@ -193,12 +189,8 @@ def test_candle_timerange(minimal_candles):
             close=13649,
             volume=15750,
             indicators={
-                "ATR": 2000,
                 "Fake_10": 100.0,
-                "MinTR": 2002,
-                "NATR": {"nested": 2001},
             },
-            sub_indicators={"SATR": 2010, "SSATR": {"nested": 2011}},
             timestamp=datetime(2023, 6, 1, 9, 19),
         ),
     ]