python-backpack 2.0.3__py3-none-any.whl → 2.0.5__py3-none-any.whl

backpack/folder_utils.py

@@ -1,105 +1,105 @@
-# ----------------------------------------------------------------------------------------
-# Python-Backpack - Folder Utilities
-# Maximiliano Rocamora / maxirocamora@gmail.com
-# https://github.com/MaxRocamora/python-backpack
-# ----------------------------------------------------------------------------------------
-
-import os
-import shutil
-import subprocess
-from collections.abc import Sequence
-
-from backpack.logger import get_logger
-
-log = get_logger('Python Backpack - FolderUtils')
-
-
-def browse_folder(folder: str | None) -> bool:
-    """Open windows explorer on folder.
-
-    Args:
-        folder: (string path) folder to open
-    """
-    if folder and os.path.isdir(folder):
-        try:
-            subprocess.Popen(['explorer', os.path.abspath(folder)])
-            return True
-        except OSError as error:
-            log.warning(f'Unable to open folder {folder}')
-            log.error(str(error))
-            return False
-
-    log.warning(f'Unable to open folder {folder}')
-    return False
-
-
-def create_folders(
-    folders: Sequence[str],
-    force_empty: bool = False,
-    verbose: bool = False,
-) -> None:
-    """Creates multiple folders on disc.
-
-    Args:
-        folders (list): folder list
-        force_empty (bool, optional): forces clearing folder content. Defaults to False.
-        verbose (bool, optional):shows log. Defaults to False.
-    """
-    for folder in folders:
-        create_folder(folder, force_empty=force_empty, verbose=verbose)
-
-
-def create_folder(path: str, force_empty: bool = False, verbose: bool = True) -> bool:
-    """Creates a folder.
-
-    Args:
-        path (str): folder path
-        force_empty (bool, optional): forces clearing folder content. Defaults to False.
-        verbose (bool, optional): show log. Defaults to True.
-    """
-    abspath = os.path.abspath(path)
-    if verbose:
-        log.info(f'Creating Folder {abspath}')
-
-    try:
-        if not os.path.exists(abspath):
-            os.makedirs(f'{abspath}/')
-        elif force_empty:
-            remove_files_in_dir(abspath)
-    except OSError as e:
-        log.warning(f'Unable to create folder: {path}')
-        log.error(str(e))
-
-    return True
-
-
-def remove_files_in_dir(path: str) -> None:
-    """Clears all content in given directory."""
-    for root, dirs, files in os.walk(path):
-        for f in files:
-            os.unlink(os.path.join(root, f))
-        for d in dirs:
-            shutil.rmtree(os.path.join(root, d))
-
-
-def recursive_dir_copy(source_path: str, target_path: str) -> None:
-    """Copy all files src dir to dest dir, including sub-directories.
-
-    Args:
-        source_path (str): source path
-        target_path (str): destination path
-    """
-
-    create_folder(source_path)
-    create_folder(target_path)
-
-    for item in os.listdir(source_path):
-        file_path = os.path.join(source_path, item)
-
-        # if item is a file, copy it
-        if os.path.isfile(file_path):
-            shutil.copy(file_path, target_path)
-        # else if item is a folder, recurse
-        elif os.path.isdir(file_path):
-            new_dest = os.path.join(target_path, item)
-            recursive_dir_copy(file_path, new_dest)
+# ----------------------------------------------------------------------------------------
+# Python-Backpack - Folder Utilities
+# Maximiliano Rocamora / maxirocamora@gmail.com
+# https://github.com/MaxRocamora/python-backpack
+# ----------------------------------------------------------------------------------------
+
+import os
+import shutil
+import subprocess
+from collections.abc import Sequence
+
+from backpack.logger import get_logger
+
+log = get_logger('Python Backpack - FolderUtils')
+
+
+def browse_folder(folder: str | None) -> bool:
+    """Open windows explorer on folder.
+
+    Args:
+        folder: (string path) folder to open
+    """
+    if folder and os.path.isdir(folder):
+        try:
+            subprocess.Popen(['explorer', os.path.abspath(folder)])
+            return True
+        except OSError as error:
+            log.warning(f'Unable to open folder {folder}')
+            log.error(str(error))
+            return False
+
+    log.warning(f'Unable to open folder {folder}')
+    return False
+
+
+def create_folders(
+    folders: Sequence[str],
+    force_empty: bool = False,
+    verbose: bool = False,
+) -> None:
+    """Creates multiple folders on disc.
+
+    Args:
+        folders (list): folder list
+        force_empty (bool, optional): forces clearing folder content. Defaults to False.
+        verbose (bool, optional):shows log. Defaults to False.
+    """
+    for folder in folders:
+        create_folder(folder, force_empty=force_empty, verbose=verbose)
+
+
+def create_folder(path: str, force_empty: bool = False, verbose: bool = True) -> bool:
+    """Creates a folder.
+
+    Args:
+        path (str): folder path
+        force_empty (bool, optional): forces clearing folder content. Defaults to False.
+        verbose (bool, optional): show log. Defaults to True.
+    """
+    abspath = os.path.abspath(path)
+    if verbose:
+        log.info(f'Creating Folder {abspath}')
+
+    try:
+        if not os.path.exists(abspath):
+            os.makedirs(f'{abspath}/')
+        elif force_empty:
+            remove_files_in_dir(abspath)
+    except OSError as e:
+        log.warning(f'Unable to create folder: {path}')
+        log.error(str(e))
+
+    return True
+
+
+def remove_files_in_dir(path: str) -> None:
+    """Clears all content in given directory."""
+    for root, dirs, files in os.walk(path):
+        for f in files:
+            os.unlink(os.path.join(root, f))
+        for d in dirs:
+            shutil.rmtree(os.path.join(root, d))
+
+
+def recursive_dir_copy(source_path: str, target_path: str) -> None:
+    """Copy all files src dir to dest dir, including sub-directories.
+
+    Args:
+        source_path (str): source path
+        target_path (str): destination path
+    """
+
+    create_folder(source_path)
+    create_folder(target_path)
+
+    for item in os.listdir(source_path):
+        file_path = os.path.join(source_path, item)
+
+        # if item is a file, copy it
+        if os.path.isfile(file_path):
+            shutil.copy(file_path, target_path)
+        # else if item is a folder, recurse
+        elif os.path.isdir(file_path):
+            new_dest = os.path.join(target_path, item)
+            recursive_dir_copy(file_path, new_dest)

backpack/json_metadata.py

@@ -1,135 +1,135 @@
-# ----------------------------------------------------------------------------------------
-# Python-Backpack - JsonMetadata
-# Maximiliano Rocamora / maxirocamora@gmail.com
-# https://github.com/MaxRocamora/python-backpack
-# ----------------------------------------------------------------------------------------
-import getpass
-import inspect
-import os
-import platform
-import sys
-import time
-from datetime import datetime
-from typing import Any
-
-from backpack.json_utils import json_load, json_save
-from backpack.version import version
-
-
-class JsonMetaFile:
-    PREFIX = 'MD_'
-
-    def __init__(self, name: str, path: str) -> None:
-        """saves/load a class/dict as a json metadata file.
-
-        Args:
-            name (str): name of the file/class
-            path (str, optional): filepath. Defaults to None.
-        """
-        self._name = name
-        self._path = path
-        self._data = {'_about': {'package': 'python-backpack', 'version': self.version}}
-
-    @property
-    def name(self) -> str:
-        """Name of this metadata class."""
-        return self._name
-
-    @property
-    def version(self) -> str:
-        """Version of this metadata class."""
-        return version
-
-    @property
-    def filename(self) -> str:
-        """Returns default filename with prefix and extension."""
-        return self.PREFIX + self.name + '.json'
-
-    @property
-    def filepath(self) -> str:
-        """Full json metadata filepath."""
-        return os.path.join(self.path, self.filename)
-
-    @property
-    def path(self) -> str:
-        """Base path location of metadata json file."""
-        return self._path
-
-    def has_file(self) -> bool:
-        """Returns true if file exists."""
-        return os.path.exists(self.filepath)
-
-    # ------------------------------------------------------------------------------------
-    # LOAD/INSERT/REMOVE/SAVE
-    # ------------------------------------------------------------------------------------
-
-    def load(self) -> None:
-        """Loads metadata from disk."""
-        self._data = json_load(self.filepath) if self.has_file() else {}
-
-    def insert(self, key: str, value: Any) -> None:
-        """Inserts value into metadata."""
-        self._data[key] = value
-
-    def remove(self, key: str) -> None:
-        """Remove key from metadata."""
-        if key in self._data.keys():
-            del self._data[key]
-
-    def save(self) -> None:
-        """Save current metadata into json file."""
-        if not os.path.exists(self.path):
-            os.makedirs(self.path)
-
-        self._data['system'] = self._system_data()
-        json_save(self._data, self.filepath)
-
-    # ------------------------------------------------------------------------------------
-    # CLASS MODE METHODS
-    # ------------------------------------------------------------------------------------
-
-    def load_as_class(self) -> type:
-        """Returns the metadata dict as a class obj."""
-        metadata_class = type(self.name, (), self._data)
-        return metadata_class
-
-    def insert_class(self, _class: type) -> None:
-        """Load all attributes from  a  given class into this class metadata."""
-        attributes = {}
-        for name in dir(_class):
-            value = getattr(_class, name)
-            if not name.startswith('__') and not (
-                inspect.isroutine(value) or inspect.isdatadescriptor(value)
-            ):
-                attributes[name] = value
-
-        self._data = attributes
-
-    # ------------------------------------------------------------------------------------
-    # SYSTEM METADATA OS/USER/TIME
-    # ------------------------------------------------------------------------------------
-
-    def _system_data(self) -> dict:
-        """Add system metadata to the default data before save."""
-        return {
-            'name': self.name,
-            'app': os.path.basename(sys.executable),
-            'PC': str(platform.node()),
-            'python_version': sys.version,
-            'User': getpass.getuser(),
-            'time': self._current_time_metadata(),
-        }
-
-    def _current_time_metadata(self) -> dict:
-        """Get export time info."""
-        ftime = time.strftime('%Y,%b,%d,%j,%H:%M', time.localtime())
-        times = ftime.split(',')
-        td = {
-            'year': times[0],
-            'month': times[1],
-            'day': times[2],
-            'year_day': times[3],
-            'time': times[4],
-            'save_time': datetime.now().ctime(),
-        }
-        return td
+# ----------------------------------------------------------------------------------------
+# Python-Backpack - JsonMetadata
+# Maximiliano Rocamora / maxirocamora@gmail.com
+# https://github.com/MaxRocamora/python-backpack
+# ----------------------------------------------------------------------------------------
+import getpass
+import inspect
+import os
+import platform
+import sys
+import time
+from datetime import datetime
+from typing import Any
+
+from backpack.json_utils import json_load, json_save
+from backpack.version import version
+
+
+class JsonMetaFile:
+    PREFIX = 'MD_'
+
+    def __init__(self, name: str, path: str) -> None:
+        """saves/load a class/dict as a json metadata file.
+
+        Args:
+            name (str): name of the file/class
+            path (str, optional): filepath. Defaults to None.
+        """
+        self._name = name
+        self._path = path
+        self._data = {'_about': {'package': 'python-backpack', 'version': self.version}}
+
+    @property
+    def name(self) -> str:
+        """Name of this metadata class."""
+        return self._name
+
+    @property
+    def version(self) -> str:
+        """Version of this metadata class."""
+        return version
+
+    @property
+    def filename(self) -> str:
+        """Returns default filename with prefix and extension."""
+        return self.PREFIX + self.name + '.json'
+
+    @property
+    def filepath(self) -> str:
+        """Full json metadata filepath."""
+        return os.path.join(self.path, self.filename)
+
+    @property
+    def path(self) -> str:
+        """Base path location of metadata json file."""
+        return self._path
+
+    def has_file(self) -> bool:
+        """Returns true if file exists."""
+        return os.path.exists(self.filepath)
+
+    # ------------------------------------------------------------------------------------
+    # LOAD/INSERT/REMOVE/SAVE
+    # ------------------------------------------------------------------------------------
+
+    def load(self) -> None:
+        """Loads metadata from disk."""
+        self._data = json_load(self.filepath) if self.has_file() else {}
+
+    def insert(self, key: str, value: Any) -> None:
+        """Inserts value into metadata."""
+        self._data[key] = value
+
+    def remove(self, key: str) -> None:
+        """Remove key from metadata."""
+        if key in self._data.keys():
+            del self._data[key]
+
+    def save(self) -> None:
+        """Save current metadata into json file."""
+        if not os.path.exists(self.path):
+            os.makedirs(self.path)
+
+        self._data['system'] = self._system_data()
+        json_save(self._data, self.filepath)
+
+    # ------------------------------------------------------------------------------------
+    # CLASS MODE METHODS
+    # ------------------------------------------------------------------------------------
+
+    def load_as_class(self) -> type:
+        """Returns the metadata dict as a class obj."""
+        metadata_class = type(self.name, (), self._data)
+        return metadata_class
+
+    def insert_class(self, _class: type) -> None:
+        """Load all attributes from  a  given class into this class metadata."""
+        attributes = {}
+        for name in dir(_class):
+            value = getattr(_class, name)
+            if not name.startswith('__') and not (
+                inspect.isroutine(value) or inspect.isdatadescriptor(value)
+            ):
+                attributes[name] = value
+
+        self._data = attributes
+
+    # ------------------------------------------------------------------------------------
+    # SYSTEM METADATA OS/USER/TIME
+    # ------------------------------------------------------------------------------------
+
+    def _system_data(self) -> dict:
+        """Add system metadata to the default data before save."""
+        return {
+            'name': self.name,
+            'app': os.path.basename(sys.executable),
+            'PC': str(platform.node()),
+            'python_version': sys.version,
+            'User': getpass.getuser(),
+            'time': self._current_time_metadata(),
+        }
+
+    def _current_time_metadata(self) -> dict:
+        """Get export time info."""
+        ftime = time.strftime('%Y,%b,%d,%j,%H:%M', time.localtime())
+        times = ftime.split(',')
+        td = {
+            'year': times[0],
+            'month': times[1],
+            'day': times[2],
+            'year_day': times[3],
+            'time': times[4],
+            'save_time': datetime.now().ctime(),
+        }
+        return td

backpack/json_user_settings.py

@@ -1,85 +1,85 @@
-# ----------------------------------------------------------------------------------------
-# Json Settings Class
-# This class handle load/save json files on win/linux local user folder
-
-"""Usage.
-
-us = JsonUserSettings('my_app')
-us.save(someDict)
-data = us.load()
-
-"""
-
-# ----------------------------------------------------------------------------------------
-import os
-
-from backpack.json_utils import json_load, json_save
-from backpack.logger import get_logger
-
-log = get_logger('Python Backpack - UserSettings')
-
-
-class JsonUserSettings:
-    def __init__(self, folder: str, name: str) -> None:
-        """Manages saving/loading json file on local user folder.
-
-        Args:
-            folder (str): name of sub folder inside user path. Defaults to 'json_settings'.
-            name (str): name used for the json file. Defaults to 'user_data'.
-        """
-        self.filename = name
-        self.folder = folder
-        self._user_data = {}
-        self._verify_path()
-
-    @property
-    def filepath(self) -> str:
-        """Returns user filepath."""
-        path = os.path.join(self.os_user_folder, self.folder, f'{self.filename}.json')
-        return os.path.abspath(path)
-
-    @property
-    def os_user_folder(self) -> str:
-        """Returns os users home directory."""
-        return os.path.expanduser('~')
-
-    @property
-    def user_data(self) -> dict:
-        """Override this property to modify saving dict."""
-        return self._user_data
-
-    @user_data.setter
-    def user_data(self, v: dict) -> None:
-        self._user_data = v
-
-    def _verify_path(self) -> bool:
-        """Checks for target directory or make it."""
-        path = os.path.dirname(self.filepath)
-        if not os.path.exists(path):
-            os.makedirs(path)
-
-        return True
-
-    def save_settings(self, data: dict | None = None) -> bool:
-        """Saves a dictionary into a json file (os user path).
-
-        Args:
-            data (dict): info dictionary to save, if not provided,
-                saves instead local self.user_data property
-        Returns:
-            bool: True if the file was saved, otherwise False.
-        """
-        if data is None:
-            data = self.user_data
-
-        r = json_save(data, self.filepath)
-        if r:
-            log.info('json settings file saved! [%s]', self.filepath)
-        return r
-
-    def load_settings(self) -> dict | bool:
-        """Load json file from path and returns its contents."""
-        try:
-            return json_load(self.filepath)
-        except OSError:
-            return False
+# ----------------------------------------------------------------------------------------
+# Json Settings Class
+# This class handle load/save json files on win/linux local user folder
+
+"""Usage.
+
+us = JsonUserSettings('my_app')
+us.save(someDict)
+data = us.load()
+
+"""
+
+# ----------------------------------------------------------------------------------------
+import os
+
+from backpack.json_utils import json_load, json_save
+from backpack.logger import get_logger
+
+log = get_logger('Python Backpack - UserSettings')
+
+
+class JsonUserSettings:
+    def __init__(self, folder: str, name: str) -> None:
+        """Manages saving/loading json file on local user folder.
+
+        Args:
+            folder (str): name of sub folder inside user path. Defaults to 'json_settings'.
+            name (str): name used for the json file. Defaults to 'user_data'.
+        """
+        self.filename = name
+        self.folder = folder
+        self._user_data = {}
+        self._verify_path()
+
+    @property
+    def filepath(self) -> str:
+        """Returns user filepath."""
+        path = os.path.join(self.os_user_folder, self.folder, f'{self.filename}.json')
+        return os.path.abspath(path)
+
+    @property
+    def os_user_folder(self) -> str:
+        """Returns os users home directory."""
+        return os.path.expanduser('~')
+
+    @property
+    def user_data(self) -> dict:
+        """Override this property to modify saving dict."""
+        return self._user_data
+
+    @user_data.setter
+    def user_data(self, v: dict) -> None:
+        self._user_data = v
+
+    def _verify_path(self) -> bool:
+        """Checks for target directory or make it."""
+        path = os.path.dirname(self.filepath)
+        if not os.path.exists(path):
+            os.makedirs(path)
+
+        return True
+
+    def save_settings(self, data: dict | None = None) -> bool:
+        """Saves a dictionary into a json file (os user path).
+
+        Args:
+            data (dict): info dictionary to save, if not provided,
+                saves instead local self.user_data property
+        Returns:
+            bool: True if the file was saved, otherwise False.
+        """
+        if data is None:
+            data = self.user_data
+
+        r = json_save(data, self.filepath)
+        if r:
+            log.info('json settings file saved! [%s]', self.filepath)
+        return r
+
+    def load_settings(self) -> dict | bool:
+        """Load json file from path and returns its contents."""
+        try:
+            return json_load(self.filepath)
+        except OSError:
+            return False