nano-dev-utils 1.4.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

nano_dev_utils/common.py

@@ -61,7 +61,9 @@ def encode_dict(input_dict: dict) -> bytes:
     return b' '.join(str(v).encode() for v in input_dict.values())
 
 
-def str2file(content: AnyStr, filepath: str, mode: str = 'w', enc: str = 'utf-8') -> None:
+def str2file(
+    content: AnyStr, filepath: str, mode: str = 'w', enc: str = 'utf-8'
+) -> None:
     """Simply save file directly from any string content.
 
     Args:
@@ -86,32 +88,48 @@ def str2file(content: AnyStr, filepath: str, mode: str = 'w', enc: str = 'utf-8'
 
 
 class PredicateBuilder:
-    def build_predicate(self, allow: FilterSet, block: FilterSet) -> Callable[[str], bool]:
+    def build_predicate(
+        self, allow: FilterSet, block: FilterSet
+    ) -> Callable[[str], bool]:
         """Build a memory-efficient predicate function."""
         compile_patts = self.compile_patts
 
         allow_lits, allow_patts = compile_patts(allow)
         block_lits, block_patts = compile_patts(block)
 
-        flag = (1 if allow_lits or allow_patts else 0,
-                1 if block_lits or block_patts else 0)
+        flag = (
+            1 if allow_lits or allow_patts else 0,
+            1 if block_lits or block_patts else 0,
+        )
 
         match flag:  # (allow, block)
             case (0, 0):
                 return lambda name: True
 
             case (0, 1):
-                return partial(self._match_patt_with_lits,
-                               name_patts=block_patts, name_lits=block_lits, negate=True)
+                return partial(
+                    self._match_patt_with_lits,
+                    name_patts=block_patts,
+                    name_lits=block_lits,
+                    negate=True,
+                )
 
             case (1, 0):
-                return partial(self._match_patt_with_lits, name_patts=allow_patts,
-                               name_lits=allow_lits, negate=False)
+                return partial(
+                    self._match_patt_with_lits,
+                    name_patts=allow_patts,
+                    name_lits=allow_lits,
+                    negate=False,
+                )
 
             case (1, 1):
-                return partial(self._allow_block_predicate,
-                               allow_lits=allow_lits, allow_patts=allow_patts,
-                               block_lits=block_lits, block_patts=block_patts)
+                return partial(
+                    self._allow_block_predicate,
+                    allow_lits=allow_lits,
+                    allow_patts=allow_patts,
+                    block_lits=block_lits,
+                    block_patts=block_patts,
+                )
 
     @staticmethod
     def compile_patts(fs: FilterSet) -> tuple[set[str], list[re.Pattern]]:
@@ -119,7 +137,7 @@ class PredicateBuilder:
             return set(), []
         literals, patterns = set(), []
         for item in fs:
-            if "*" in item or "?" in item or "[" in item:
+            if '*' in item or '?' in item or '[' in item:
                 patterns.append(re.compile(fnmatch.translate(item)))
             else:
                 literals.add(item)
@@ -130,15 +148,27 @@ class PredicateBuilder:
         """Return True if name matches any compiled regex pattern."""
         return any(pat.fullmatch(name) for pat in patterns)
 
-    def _match_patt_with_lits(self, name: str, *, name_lits: set[str],
-                              name_patts: list[re.Pattern], negate: bool = False) -> bool:
+    def _match_patt_with_lits(
+        self,
+        name: str,
+        *,
+        name_lits: set[str],
+        name_patts: list[re.Pattern],
+        negate: bool = False,
+    ) -> bool:
         """Return True if name is in literals or matches any pattern."""
         res = name in name_lits or self._match_patts(name, name_patts)
         return not res if negate else res
 
-    def _allow_block_predicate(self, name: str,
-                               *, allow_lits: set[str], allow_patts: list[re.Pattern],
-                               block_lits: set[str], block_patts: list[re.Pattern]) -> bool:
+    def _allow_block_predicate(
+        self,
+        name: str,
+        *,
+        allow_lits: set[str],
+        allow_patts: list[re.Pattern],
+        block_lits: set[str],
+        block_patts: list[re.Pattern],
+    ) -> bool:
         """Return True if name is allowed and not blocked (block takes precedence)."""
         if name in block_lits or self._match_patts(name, block_patts):
             return False

nano_dev_utils/file_tree_display.py

@@ -3,7 +3,7 @@ import re
 
 from collections.abc import Generator
 from pathlib import Path
-from typing_extensions import LiteralString, Callable, Any
+from typing_extensions import Callable, Any
 
 from .common import str2file, FilterSet, PredicateBuilder
 
@@ -22,22 +22,23 @@ class FileTreeDisplay:
     visual representations of directories and files.
     Supports exclusion lists, configurable indentation, and custom prefix styles.
     """
+
     def __init__(
-            self,
-            root_dir: str | None = None,
-            filepath: str | None = None,
-            ignore_dirs: FilterSet = None,
-            ignore_files: FilterSet = None,
-            include_dirs: FilterSet = None,
-            include_files: FilterSet = None,
-            style: str = ' ',
-            indent: int = 2,
-            files_first: bool = False,
-            sort_key_name: str = 'natural',
-            reverse: bool = False,
-            custom_sort: Callable[[str], Any] | None = None,
-            save2file: bool = True,
-            printout: bool = False,
+        self,
+        root_dir: str | None = None,
+        filepath: str | None = None,
+        ignore_dirs: FilterSet = None,
+        ignore_files: FilterSet = None,
+        include_dirs: FilterSet = None,
+        include_files: FilterSet = None,
+        style: str = ' ',
+        indent: int = 2,
+        files_first: bool = False,
+        sort_key_name: str = 'natural',
+        reverse: bool = False,
+        custom_sort: Callable[[str], Any] | None = None,
+        save2file: bool = True,
+        printout: bool = False,
     ) -> None:
         """Initialize the FileTreeDisplay instance.
 
@@ -82,7 +83,9 @@ class FileTreeDisplay:
 
         self.pb = PredicateBuilder()
         self.dir_filter = self.pb.build_predicate(self.include_dirs, self.ignore_dirs)
-        self.file_filter = self.pb.build_predicate(self.include_files, self.ignore_files)
+        self.file_filter = self.pb.build_predicate(
+            self.include_files, self.ignore_files
+        )
 
     def init(self, *args, **kwargs) -> None:
         self.__init__(*args, **kwargs)
@@ -95,13 +98,16 @@ class FileTreeDisplay:
 
     def update_predicates(self):
         self.dir_filter = self.pb.build_predicate(self.include_dirs, self.ignore_dirs)
-        self.file_filter = self.pb.build_predicate(self.include_files, self.ignore_files)
+        self.file_filter = self.pb.build_predicate(
+            self.include_files, self.ignore_files
+        )
 
     @staticmethod
-    def _nat_key(name: str) -> list[int | LiteralString]:
+    def _nat_key(name: str) -> list[int | str | Any]:
         """Natural sorting key"""
-        return [int(part) if part.isdigit() else part.lower()
-                for part in _NUM_SPLIT(name)]
+        return [
+            int(part) if part.isdigit() else part.lower() for part in _NUM_SPLIT(name)
+        ]
 
     @staticmethod
     def _lex_key(name: str) -> str:
@@ -127,7 +133,7 @@ class FileTreeDisplay:
 
         tree_info = self.get_tree_info(iterator)
 
-        if self.save2file:
+        if self.save2file and filepath:
             str2file(tree_info, filepath)
             return filepath
 
@@ -141,8 +147,7 @@ class FileTreeDisplay:
         lines.extend(list(iterator))
         return '\n'.join(lines)
 
-    def build_tree(self, dir_path: str,
-                   prefix: str = '') -> Generator[str, None, None]:
+    def build_tree(self, dir_path: str, prefix: str = '') -> Generator[str, None, None]:
         """Yields formatted directory tree lines, using a recursive DFS.
         Intended order of appearance is with a preference to subdirectories first.
 
@@ -163,9 +168,10 @@ class FileTreeDisplay:
 
         if sort_key is None:
             if sort_key_name == 'custom':
-                raise ValueError("custom_sort function must be specified"
-                                 " when sort_key_name='custom'")
-            raise ValueError(f"Invalid sort key name: {sort_key_name}")
+                raise ValueError(
+                    "custom_sort function must be specified when sort_key_name='custom'"
+                )
+            raise ValueError(f'Invalid sort key name: {sort_key_name}')
 
         try:
             with os.scandir(dir_path) as entries:
@@ -181,7 +187,11 @@ class FileTreeDisplay:
                             append_file(name)
 
         except (PermissionError, OSError) as e:
-            msg = '[Permission Denied]' if isinstance(e, PermissionError) else '[Error reading directory]'
+            msg = (
+                '[Permission Denied]'
+                if isinstance(e, PermissionError)
+                else '[Error reading directory]'
+            )
             yield f'{next_prefix}{msg}'
             return
 

nano_dev_utils/timers.py

@@ -23,9 +23,12 @@ R = TypeVar('R')
 
 
 class Timer:
-    def __init__(self, precision: int = 4, verbose: bool = False):
+    def __init__(
+        self, precision: int = 4, verbose: bool = False, printout: bool = False
+    ):
         self.precision = precision
         self.verbose = verbose
+        self.printout = printout
 
     def init(self, *args, **kwargs) -> None:
         self.__init__(*args, **kwargs)
@@ -33,6 +36,9 @@ class Timer:
     def update(self, attrs: dict[str, Any]) -> None:
         update(self, attrs)
 
+    def res_formatter(self, elapsed_ns: float, *, precision: int = 4) -> str:
+        return self._duration_formatter(elapsed_ns, precision=precision)
+
     def timeit(
         self,
         iterations: int = 1,
@@ -53,12 +59,14 @@ class Timer:
         RP = ParamSpec('RP')
         RR = TypeVar('RR')
 
-        precision = self.precision
+        precision, verbose, printout = self.precision, self.verbose, self.printout
+        check_timeout = self._check_timeout
+        duration_formatter = self._duration_formatter
+        formatted_msg = self._formatted_msg
 
         def decorator(
             func: Callable[RP, RR] | Callable[RP, Awaitable[RR]],
         ) -> Callable[RP, Any]:
-            verbose = self.verbose
             if inspect.iscoroutinefunction(func):
                 async_func = cast(Callable[RP, Awaitable[RR]], func)
 
@@ -73,7 +81,7 @@ class Timer:
                         duration_ns = time.perf_counter_ns() - start_ns
                         total_elapsed_ns += duration_ns
 
-                        self._check_timeout(
+                        check_timeout(
                             func_name,
                             i,
                             duration_ns,
@@ -82,12 +90,14 @@ class Timer:
                             per_iteration,
                         )
                     avg_elapsed_ns = total_elapsed_ns / iterations
-                    duration_str = self._duration_formatter(avg_elapsed_ns, precision)
+                    duration_str = duration_formatter(avg_elapsed_ns, precision)
 
-                    msg = self._formatted_msg(
+                    msg = formatted_msg(
                         func_name, args, kwargs, duration_str, iterations, verbose
                     )
                     lgr.info(msg)
+                    if printout:
+                        print(msg)
                     return cast(RR, result)
 
                 return cast(Callable[RP, Awaitable[RR]], async_wrapper)
@@ -104,7 +114,7 @@ class Timer:
                         result = sync_func(*args, **kwargs)
                         duration_ns = time.perf_counter_ns() - start_ns
                         total_elapsed_ns += duration_ns
-                        self._check_timeout(
+                        check_timeout(
                             func_name,
                             i,
                             duration_ns,
@@ -113,11 +123,13 @@ class Timer:
                             per_iteration,
                         )
                     avg_elapsed_ns = total_elapsed_ns / iterations
-                    duration_str = self._duration_formatter(avg_elapsed_ns, precision)
-                    msg = self._formatted_msg(
+                    duration_str = duration_formatter(avg_elapsed_ns, precision)
+                    msg = formatted_msg(
                         func_name, args, kwargs, duration_str, iterations, verbose
                     )
                     lgr.info(msg)
+                    if printout:
+                        print(msg)
                     return cast(RR, result)
 
                 return cast(Callable[RP, RR], sync_wrapper)

{nano_dev_utils-1.4.0.dist-info → nano_dev_utils-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nano_dev_utils
-Version: 1.4.0
+Version: 1.4.1
 Summary: A collection of small Python utilities for developers.
 Project-URL: Homepage, https://github.com/yaronday/nano_utils
 Project-URL: Issues, https://github.com/yaronday/nano_utils/issues
@@ -26,9 +26,10 @@ This module provides a `Timer` class for measuring the execution time of code bl
 
 #### `Timer` Class
 
-* **`__init__(self, precision: int = 4, verbose: bool = False)`**: Initializes a `Timer` instance.
+* **`__init__(self, precision: int = 4, verbose: bool = False, printout: bool = False)`**: Initializes a `Timer` instance.
     * `precision`: The number of decimal places to record and display time durations. Defaults to 4.
     * `verbose`: Optionally displays the function's positional arguments (args) and keyword arguments (kwargs). Defaults to `False`.
+    * `printout`: Allows printing to console.
 
 * **`def timeit(
         self,
@@ -47,15 +48,22 @@ This module provides a `Timer` class for measuring the execution time of code bl
         * Records execution times
         * Handles timeout conditions
         * Calculates average execution time across iterations
-        * Prints the function name and execution time (with optional arguments)
+        * Logs the function name and execution time (with optional arguments)
         * Returns the result of the original function (unless timeout occurs)
 
 #### Example Usage:
 
 ```python
 import time
+import logging
 from nano_dev_utils import timer
 
+# This timer version uses a logger but also allows printing (if enabled), so it has to be configured in your app, for instance: 
+logging.basicConfig(filename='timer example.log',
+                    level=logging.INFO,  # DEBUG, WARNING, ERROR, CRITICAL
+                    format='%(asctime)s - %(levelname)s: %(message)s',
+                    datefmt='%d-%m-%Y %H:%M:%S')
+
 # Basic timing
 @timer.timeit()
 def my_function(a, b=10):
@@ -64,17 +72,15 @@ def my_function(a, b=10):
     return a + b
 
 timer.init(precision=6, verbose=True)
-'''
-Alternatively we could have used the `update` method as well: 
+'''Alternative options: 
+timer.update({'precision': 6, 'verbose': True})  # 1. Using update method  
 
-timer.update({'precision': 6, 'verbose': True})  
-
-The above config could be also achieved via explicit instantiation:
-
-from nano_dev_utils.timers import Timer
-timer = Timer(precision=6, verbose=True)
+from nano_dev_utils.timers import Timer  # 2. explicit instantiation
+timer = Timer(precision=6, verbose=True)  
 '''
 
+timer.update({'printout': True})  # allow printing to console
+
 # Advanced usage with timeout and iterations
 @timer.timeit(iterations=5, timeout=0.5, per_iteration=True)
 def critical_function(x):
@@ -151,7 +157,7 @@ import logging
 from nano_dev_utils import ports_release, PortsRelease
 
 
-# For configuration of logging level and format (supported already):  
+# configure the logger
 logging.basicConfig(filename='port release.log',
                     level=logging.INFO,  # DEBUG, WARNING, ERROR, CRITICAL 
                     format='%(asctime)s - %(levelname)s: %(message)s',
@@ -170,8 +176,9 @@ ports_release.release_all()
 
 ### `file_tree_display.py`
 
-This module provides a class-based utility for generating a visually structured directory tree.  
-It supports recursive traversal, customizable hierarchy styles, and exclusion patterns for directories and files.  
+This module provides a utility for generating a visually structured directory tree.  
+It supports recursive traversal, customizable hierarchy styles, and inclusion / exclusion  
+patterns for directories and files.  
 Output can be displayed in the console or saved to a file.
 
 
@@ -180,11 +187,12 @@ Output can be displayed in the console or saved to a file.
 - Recursively displays and logs directory trees
 - Efficient directory traversal
 - Blazing fast (see Benchmarks below)
-- Generates human-readable file tree structure
+- Generates human-readable file tree structure 
+- Supports including / ignoring specific directories or files via pattern matching
 - Customizable tree display output
 - Optionally saves the resulting tree to a text file
-- Supports ignoring specific directories or files via pattern matching
-- Handles permission and read/write errors gracefully
+- Lightweight, flexible and easily configurable
+
 
 ## Benchmarks
 
@@ -244,11 +252,13 @@ filepath = str(Path(target_path, filename))
 
 ftd = FileTreeDisplay(root_dir=root,
                       ignore_dirs=['.git', 'node_modules', '.idea'],
-                      ignore_files={'.gitignore', '*.toml'}, style='—',
+                      ignore_files=['.gitignore', '*.toml'], 
+                      style='—',
                       include_dirs=['src', 'tests', 'snapshots'],
                       filepath=filepath, 
                       sort_key_name='custom',
                       custom_sort=(lambda x: any(ext in x.lower() for ext in ('jpg', 'png'))),
+                      files_first=True,
                       reverse=True
                      )
 ftd.file_tree_display()

nano_dev_utils-1.4.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+nano_dev_utils/__init__.py,sha256=bJNCUyssMVyNmOey-god8A2kElC4nCR9B5DsdvUrKWw,1014
+nano_dev_utils/common.py,sha256=MsY5n9lSOjvEu0wGvmd2zQamFLLbtbjodZku5W9tuWE,5873
+nano_dev_utils/dynamic_importer.py,sha256=-Mh76366lI_mP2QA_jxiVfcKCHOHeukS_j4v7fTh0xw,1028
+nano_dev_utils/file_tree_display.py,sha256=RMd2l1FZgO__9EmCSKRkZ6s7tYpCx6Fe7e83fAxNxg0,8234
+nano_dev_utils/release_ports.py,sha256=yLWMMbN6j6kWtGTg-Nynn37-Q4b2rxkls9hs2sqeZjA,6081
+nano_dev_utils/timers.py,sha256=5Ci6IgdEfwIvRtQes4byab1GJowLdfnurUBUxorSgIc,7840
+nano_dev_utils-1.4.1.dist-info/METADATA,sha256=sfJDvXpotS86VX6o1XjnwFY3CDoTNUpJkDlLoOpFsGM,12133
+nano_dev_utils-1.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+nano_dev_utils-1.4.1.dist-info/licenses/LICENSE,sha256=Muenl7Bw_LdtHZtlOMAP7Kt97gDCq8WWp2605eDWhHU,1089
+nano_dev_utils-1.4.1.dist-info/RECORD,,

nano_dev_utils-1.4.0.dist-info/RECORD

@@ -1,10 +0,0 @@
-nano_dev_utils/__init__.py,sha256=bJNCUyssMVyNmOey-god8A2kElC4nCR9B5DsdvUrKWw,1014
-nano_dev_utils/common.py,sha256=bNgiaBP5kQUxfEUN3HYp1_TnwG-SRvsiqu67yAG5Y4o,5585
-nano_dev_utils/dynamic_importer.py,sha256=-Mh76366lI_mP2QA_jxiVfcKCHOHeukS_j4v7fTh0xw,1028
-nano_dev_utils/file_tree_display.py,sha256=0pfDr1QgyPJZbtl8mKNfJO0T3Jl2vUrwt8syVn_PhsI,8192
-nano_dev_utils/release_ports.py,sha256=yLWMMbN6j6kWtGTg-Nynn37-Q4b2rxkls9hs2sqeZjA,6081
-nano_dev_utils/timers.py,sha256=Ko2RR96-Sb6hIQAPxiwCUPAK2uwJ1dP_9Teym8lx_lo,7350
-nano_dev_utils-1.4.0.dist-info/METADATA,sha256=z4PfsxOWteGXmLuJS5MtivqCKox9LR6wUKTjhelw9_c,11642
-nano_dev_utils-1.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-nano_dev_utils-1.4.0.dist-info/licenses/LICENSE,sha256=Muenl7Bw_LdtHZtlOMAP7Kt97gDCq8WWp2605eDWhHU,1089
-nano_dev_utils-1.4.0.dist-info/RECORD,,