data-manipulation-utilities 0.2.8.dev730__tar.gz → 0.2.8.dev736__tar.gz

{data_manipulation_utilities-0.2.8.dev730 → data_manipulation_utilities-0.2.8.dev736}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: data-manipulation-utilities
-Version: 0.2.8.dev730
+Version: 0.2.8.dev736
 Summary: Project storing utilities needed to reduce boilerplate code when analyzing data
 Requires-Python: >=3.10,<3.13
 Classifier: Programming Language :: Python :: 3
@@ -68,6 +68,35 @@ Then, for each remote it pushes the tags and the commits.
 
 This section describes generic tools that could not be put in a specific category, but tend to be useful.
 
+## Naming
+
+### Name cleaning
+
+This is an alternative to projects like `slugify`. The function will
+take strings with characters that are not easy to use when naming files and
+will clean it up with:
+
+```python
+
+from dmu.generic import naming
+
+value = naming.clean_special_characters(name=name)
+```
+
+e.g.:
+
+```
+a  b'    ->  'a_b'
+a$b'     ->  'a_b'
+a > b'   ->  'a_gt_b'
+a < b'   ->  'a_lt_b'
+a = b'   ->  'a_eq_b'
+{a}'     ->  '_a_'
+a.b'     ->  'apb'
+a && b'  ->  'a_and_b'
+a || b'  ->  'a_or_b'
+```
+
 ## Caching data
 
 In order to reuse data that is hard to calculate one would need:

{data_manipulation_utilities-0.2.8.dev730 → data_manipulation_utilities-0.2.8.dev736}/README.md

@@ -33,6 +33,35 @@ Then, for each remote it pushes the tags and the commits.
 
 This section describes generic tools that could not be put in a specific category, but tend to be useful.
 
+## Naming
+
+### Name cleaning
+
+This is an alternative to projects like `slugify`. The function will
+take strings with characters that are not easy to use when naming files and
+will clean it up with:
+
+```python
+
+from dmu.generic import naming
+
+value = naming.clean_special_characters(name=name)
+```
+
+e.g.:
+
+```
+a  b'    ->  'a_b'
+a$b'     ->  'a_b'
+a > b'   ->  'a_gt_b'
+a < b'   ->  'a_lt_b'
+a = b'   ->  'a_eq_b'
+{a}'     ->  '_a_'
+a.b'     ->  'apb'
+a && b'  ->  'a_and_b'
+a || b'  ->  'a_or_b'
+```
+
 ## Caching data
 
 In order to reuse data that is hard to calculate one would need:

{data_manipulation_utilities-0.2.8.dev730 → data_manipulation_utilities-0.2.8.dev736}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name           = 'data-manipulation-utilities'
 description    = 'Project storing utilities needed to reduce boilerplate code when analyzing data'
-version        = "0.2.8.dev730"
+version        = "0.2.8.dev736"
 readme         = 'README.md'
 package-mode   = true 
 packages       = [

data_manipulation_utilities-0.2.8.dev736/src/dmu/generic/naming.py

@@ -0,0 +1,35 @@
+'''
+This module contains functions meant to deal with names
+i.e. strings that represent names
+'''
+
+import re
+
+from dmu.logging.log_store import LogStore
+
+log=LogStore.add_logger('dmu:generic:naming')
+# --------------------------------
+def clean_special_characters(name : str) -> str:
+    '''
+    Parameters
+    ----------------
+    name: String with potentially parenthesis, dollar signs, etc
+
+    Returns
+    ----------------
+    Cleaned string, where special signs were removed or replaced
+    '''
+    name = name.replace('||', 'or')
+    name = name.replace(' ' ,  '_')
+    name = name.replace('<' , 'lt')
+    name = name.replace('>' , 'gt')
+    name = name.replace('=' , 'eq')
+    name = name.replace('{' ,  '_')
+    name = name.replace('}' ,  '_')
+    name = name.replace('.' ,  'p')
+    name = name.replace('$' ,  '_')
+    name = name.replace('&&','and')
+    name = re.sub(r'_+' , '_', name)
+
+    return name
+# --------------------------------

{data_manipulation_utilities-0.2.8.dev730 → data_manipulation_utilities-0.2.8.dev736}/src/dmu/plotting/plotter_1d.py

@@ -290,14 +290,6 @@ class Plotter1D(Plotter):
         if 'vline' in var_cfg:
             line_cfg = var_cfg['vline']
             plt.axvline(**line_cfg)
-
-        if 'style' in self._d_cfg and 'skip_lines' in self._d_cfg['style'] and self._d_cfg['style']['skip_lines']:
-            return
-
-        if var in ['B_const_mass_M', 'B_M', 'B_Mass', 'B_Mass_smr']:
-            plt.axvline(x=5280, color='r', label=r'$B^+$'   , linestyle=':')
-        elif var == 'Jpsi_M':
-            plt.axvline(x=3096, color='r', label=r'$J/\psi$', linestyle=':')
     # --------------------------------------------
     def run(self):
         '''

{data_manipulation_utilities-0.2.8.dev730 → data_manipulation_utilities-0.2.8.dev736}/src/dmu/workflow/cache.py

@@ -63,19 +63,6 @@ class Cache:
         self._cache_dir = self._get_dir(kind='cache')
         self._hash_dir  : str
     # ---------------------------
-    @classmethod
-    def set_cache_root(cls, root : str) -> None:
-        '''
-        Sets the path to the directory WRT which the _out_path_
-        will be placed
-        '''
-        if cls._cache_root is not None:
-            raise ValueError(f'Trying to set {root}, but already found {cls._cache_root}')
-
-        os.makedirs(root, exist_ok=True)
-
-        cls._cache_root = root
-    # ---------------------------
     def _get_code_hash(self) -> str:
         '''
         If `MyTool` inherits from `Cache`. `mytool.py` git commit hash
@@ -242,9 +229,8 @@ class Cache:
 
         return True
     # ---------------------------
-    @contextmanager
-    @staticmethod
-    def turn_off_cache(val : list[str]|None):
+    @classmethod
+    def turn_off_cache(cls, val):
         '''
         Parameters
         ------------------
@@ -256,11 +242,30 @@ class Cache:
             log.error('This manager expects: list[str]|None')
             raise ValueError(f'Invalid value: {val}')
 
-        old_val = Cache._l_skip_class
+        old_val = cls._l_skip_class
+        @contextmanager
+        def _context():
+            cls._l_skip_class = val
+            try:
+                yield
+            finally:
+                cls._l_skip_class = old_val
 
-        Cache._l_skip_class = val
-        try:
-            yield
-        finally:
-            Cache._l_skip_class = old_val
+        return _context()
+    # ---------------------------
+    @classmethod
+    def set_cache_root(cls, root : str) -> None:
+        '''
+        Sets the path to the directory WRT which the _out_path_
+        will be placed.
+
+        This is meant to be called once per execution and has a lock
+        that will raise an exception if called twice
+        '''
+        if cls._cache_root is not None:
+            raise ValueError(f'Trying to set {root}, but already found {cls._cache_root}')
+
+        os.makedirs(root, exist_ok=True)
+
+        cls._cache_root = root
 # ---------------------------