file-groups 0.3.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

file_groups/__init__.py

@@ -1,6 +1,6 @@
 """Set __version__ property."""
 
-from importlib.metadata import version  # type: ignore
+from importlib.metadata import version
 
 
 __version__ = version("file_groups")

file_groups/config_files.py

@@ -26,7 +26,7 @@ class ProtectConfig():
     """Hold global (site or user) protect config."""
     protect_recursive: set[re.Pattern]
 
-    def __json__(self):
+    def __json__(self) -> dict[str, Any]:
         return {
             ProtectConfig.__name__: {
                 "protect_recursive": [str(pat) for pat in self.protect_recursive],
@@ -41,13 +41,13 @@ class DirConfig(ProtectConfig):
     config_dir: Path|None
     config_files: list[str]
 
-    def is_protected(self, ff: FsPath):
+    def is_protected(self, ff: FsPath) -> re.Pattern|None:
         """If ff id protected by a regex pattern then return the pattern, otherwise return None."""
 
         # _LOG.debug("ff '%s'", ff)
         for pattern in itertools.chain(self.protect_local, self.protect_recursive):
             if os.sep in str(pattern):
-                # _LOG.debug("Pattern '%s' has path sep", pattern)
+                # _LOG.debug("re.Pattern '%s' has path sep", pattern)
                 assert os.path.isabs(ff), f"Expected absolute path, got '{ff}'"
 
                 # Search against full path
@@ -68,7 +68,7 @@ class DirConfig(ProtectConfig):
 
         return None
 
-    def __json__(self):
+    def __json__(self) -> dict[str, Any]:
         return {
             DirConfig.__name__: super().__json__()[ProtectConfig.__name__] | {
                 "protect_local": [str(pat) for pat in self.protect_local],
@@ -159,7 +159,7 @@ class ConfigFiles():
 
     def __init__(  # pylint: disable=too-many-positional-arguments,too-many-arguments
             self, protect: Sequence[re.Pattern] = (),
-            ignore_config_dirs_config_files=False, ignore_per_directory_config_files=False, remember_configs=True,
+            ignore_config_dirs_config_files: bool = False, ignore_per_directory_config_files: bool =False, remember_configs: bool =True,
             app_dirs: Sequence[AppDirs]|None = None,
             *,
             config_file: Path|None = None,

file_groups/groups.py

@@ -35,14 +35,14 @@ class _Group():
     num_directories: int = 0
     num_directory_symlinks: int = 0
 
-    def add_entry_match(self, entry: DirEntry):
+    def add_entry_match(self, entry: DirEntry) -> None:
         """Abstract, but abstract and dataclass does not work with mypy. https://github.com/python/mypy/issues/500"""
 
 @dataclass
 class _IncludeMatchGroup(_Group):
     include: re.Pattern|None = None
 
-    def add_entry_match(self, entry: DirEntry):
+    def add_entry_match(self, entry: DirEntry) -> None:
         if not self.include:
             self.files[entry.path] = entry
             return
@@ -58,7 +58,7 @@ class _IncludeMatchGroup(_Group):
 class _ExcludeMatchGroup(_Group):
     exclude: re.Pattern|None = None
 
-    def add_entry_match(self, entry: DirEntry):
+    def add_entry_match(self, entry: DirEntry) -> None:
         if not self.exclude:
             self.files[entry.path] = entry
             return
@@ -169,7 +169,7 @@ class FileGroups():
 
         checked_dirs: set[str] = set()
 
-        def handle_entry(abs_dir_path: str, group: _Group, other_group: _Group, dir_config: DirConfig, entry: DirEntry):
+        def handle_entry(abs_dir_path: str, group: _Group, other_group: _Group, dir_config: DirConfig, entry: DirEntry) -> None:
             """Put entry in  the correct group. Call 'find_group' if entry is a directory."""
             if group.typ is GroupType.MAY_WORK_ON:
                 # Check for match against configured protect patterns, if match, then the file must got to protect group instead
@@ -207,7 +207,7 @@ class FileGroups():
             _LOG.debug("find %s - entry name: %s", group.typ.name, entry.name)
             group.add_entry_match(entry)
 
-        def find_group(abs_dir_path: str, group: _Group, other_group: _Group, parent_conf: DirConfig|None):
+        def find_group(abs_dir_path: str, group: _Group, other_group: _Group, parent_conf: DirConfig|None) -> None:
             """Recursively find all files belonging to 'group'"""
             _LOG.debug("find %s: %s", group.typ.name, abs_dir_path)
             if abs_dir_path in checked_dirs:
@@ -238,7 +238,7 @@ class FileGroups():
             else:
                 find_group(any_dir, self.may_work_on, self.must_protect, parent_conf)
 
-    def dump(self):
+    def dump(self) -> None:
         """Log collected files. This may be A LOT of output for large directories."""
 
         log = _LOG.getChild("dump")
@@ -280,7 +280,7 @@ class FileGroups():
 
         log.log(lvl, "")
 
-    def stats(self):
+    def stats(self) -> None:
         """Log collection numbers."""
         log = _LOG.getChild("stats")
         lvl = logging.INFO

file_groups/handler.py

@@ -2,13 +2,12 @@ import os
 from pathlib import Path
 import shutil
 import re
-from contextlib import contextmanager
 import logging
 from typing import Sequence
 
 from .groups import FileGroups
 from .config_files import ConfigFiles
-
+from .types import FsPath
 
 _LOG = logging.getLogger(__name__)
 
@@ -35,7 +34,7 @@ class FileHandler(FileGroups):
             protect_exclude: re.Pattern|None = None, work_include: re.Pattern|None = None,
             config_files: ConfigFiles|None = None,
             dry_run: bool,
-            delete_symlinks_instead_of_relinking=False):
+            delete_symlinks_instead_of_relinking: bool =False):
         super().__init__(
             protect_dirs_seq=protect_dirs_seq, work_dirs_seq=work_dirs_seq,
             protect_exclude=protect_exclude, work_include=work_include,
@@ -55,7 +54,7 @@ class FileHandler(FileGroups):
         self.num_moved = 0
         self.num_relinked = 0
 
-    def reset(self):
+    def reset(self) -> None:
         """Reset internal housekeeping of deleted/renamed/moved files.
 
         This makes it possible to do a 'dry_run' and an actual run without collecting files again.
@@ -69,7 +68,7 @@ class FileHandler(FileGroups):
         self.num_moved = 0
         self.num_relinked = 0
 
-    def _no_symlink_check_registered_delete(self, delete_path: str):
+    def _no_symlink_check_registered_delete(self, delete_path: str) -> None:
         """Does a registered delete without checking for symlinks, so that we can use this in the symlink handling."""
         assert isinstance(delete_path, str)
         assert os.path.isabs(delete_path), f"Expected absolute path, got '{delete_path}'"
@@ -84,7 +83,7 @@ class FileHandler(FileGroups):
         if delete_path in self.may_work_on.symlinks:
             self.deleted_symlinks.add(delete_path)
 
-    def _handle_single_symlink_chain(self, symlnk_path: str, keep_path):
+    def _handle_single_symlink_chain(self, symlnk_path: str, keep_path: str|FsPath|None) -> None:
         """TODO doc - Symlink will only be deleted if it is in self.may_work_on.files."""
 
         assert os.path.isabs(symlnk_path), f"Expected an absolute path, got '{symlnk_path}'"
@@ -141,8 +140,12 @@ class FileHandler(FileGroups):
 
         self.num_relinked += 1
 
-    def _fix_symlinks_to_deleted_or_moved_files(self, from_path: str, to_path):
-        """Any symlinks pointing to 'from_path' will be change to point to 'to_path'"""
+    def _fix_symlinks_to_deleted_or_moved_files(self, from_path: str, to_path: str|FsPath|None) -> None:
+        """Any symlinks pointing to 'from_path' will be change to point to 'to_path' or deleted.
+
+        If 'to_path' is None then delete full chains of symlinks in 'may_work_on' dirs.
+        """
+
         _LOG.debug("_fix_symlinks_to_deleted_or_moved_files(self, %s, %s)", from_path, to_path)
 
         for symlnk in self.must_protect.symlinks_by_abs_points_to.get(from_path, ()):
@@ -153,13 +156,13 @@ class FileHandler(FileGroups):
             _LOG.debug("_fix_symlinks_to_deleted_or_moved_files, may_work_on symlink: '%s'.", symlnk)
             self._handle_single_symlink_chain(os.fspath(symlnk), to_path)
 
-    def registered_delete(self, delete_path: str, corresponding_keep_path) -> Path|None:
+    def registered_delete(self, delete_path: str, corresponding_keep_path: str|FsPath|None) -> Path|None:
         """Return `corresponding_keep_path` as absolute Path"""
         self._no_symlink_check_registered_delete(delete_path)
         self._fix_symlinks_to_deleted_or_moved_files(delete_path, corresponding_keep_path)
         return Path(corresponding_keep_path).absolute() if corresponding_keep_path else None
 
-    def _registered_move_or_rename(self, from_path: str, to_path, *, is_move) -> Path:
+    def _registered_move_or_rename(self, from_path: str, to_path: str|FsPath, *, is_move: bool) -> Path:
         """Return `to_path` as absolute Path"""
         assert isinstance(from_path, str)
         assert os.path.isabs(from_path), f"Expected absolute path, got '{from_path}'"
@@ -189,20 +192,18 @@ class FileHandler(FileGroups):
         self._fix_symlinks_to_deleted_or_moved_files(from_path, to_path)
         return res
 
-    def registered_move(self, from_path: str, to_path) -> Path:
+    def registered_move(self, from_path: str, to_path: str|FsPath) -> Path:
         """Return `to_path` as absolute Path"""
         return self._registered_move_or_rename(from_path, to_path, is_move=True)
 
-    def registered_rename(self, from_path: str, to_path) -> Path:
+    def registered_rename(self, from_path: str, to_path: str|FsPath) -> Path:
         """Return `to_path` as absolute Path"""
         return self._registered_move_or_rename(from_path, to_path, is_move=False)
 
-    @contextmanager
-    def stats(self):
+    def stats(self) -> None:
         log = _LOG.getChild("stats")
         lvl = logging.INFO
         if not log.isEnabledFor(lvl):
-            yield
             return
 
         prefix = ''
@@ -218,10 +219,3 @@ class FileHandler(FileGroups):
         log.log(lvl, "%srenamed: %s", prefix, self.num_renamed)
         log.log(lvl, "%smoved: %s", prefix, self.num_moved)
         log.log(lvl, "%srelinked: %s", prefix, self.num_relinked)
-
-        try:
-            yield
-
-        finally:
-            if self.dry_run:
-                log.log(lvl, "*** DRY RUN ***")

file_groups/handler_compare.py

@@ -29,7 +29,7 @@ class FileHandlerCompare(FileHandler):
             protect_exclude: re.Pattern|None = None, work_include: re.Pattern|None = None,
             config_files: ConfigFiles|None = None,
             dry_run: bool,
-            delete_symlinks_instead_of_relinking=False):
+            delete_symlinks_instead_of_relinking: bool = False):
         super().__init__(
             protect_dirs_seq=protect_dirs_seq, work_dirs_seq=work_dirs_seq,
             protect_exclude=protect_exclude, work_include=work_include,

file_groups/types.py

@@ -1,6 +1,5 @@
 from os import DirEntry
 from pathlib import Path
-from typing import Union
 
 
-FsPath = Union[DirEntry, Path]
+FsPath = DirEntry|Path

{file_groups-0.3.1.dist-info → file_groups-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: file_groups
-Version: 0.3.1
+Version: 0.4.0
 Summary: Group files into 'protect' and 'work_on' and provide operations for safe delete/move and symlink handling.
 Home-page: https://github.com/lhupfeldt/file_groups.git
 Author: Lars Hupfeldt Nielsen
@@ -14,9 +14,8 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt
 Requires-Dist: appdirs>=1.4.4

file_groups-0.4.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+file_groups/__init__.py,sha256=FAl1D2-Fm2nQgXdM1rttTymLby24pN3ogmbS5dri770,111
+file_groups/compare_files.py,sha256=38EfZzpEpj0wH7SUruPxgyF_W8eqCbIjG6yUOx8hcFA,434
+file_groups/config_files.py,sha256=-sEyPkcds9gZEVvIJVnhWqXk9H4X20w_TT8BQg3_xzM,14101
+file_groups/groups.py,sha256=fMn85U2QPF39sgYzma806XgtUOozOsA-CUNRjB2mC5I,11433
+file_groups/handler.py,sha256=QerrcMtLEzl5NUOpwX2QbbngBUl8ssfYemcbGbaV208,10156
+file_groups/handler_compare.py,sha256=zVRHdqP-2Z7u3D2jQ_6_HLF3SOUk0mSyJ7xiS5Y0Hig,2182
+file_groups/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+file_groups/types.py,sha256=IEDtGNxhQhQaWn8sTHn5-jbpM-dbba7wiIfaud1XSXc,74
+file_groups-0.4.0.dist-info/LICENSE.txt,sha256=NZc9ictLEwfoL4ywpAbLbd-n02KETGHLYQU820TJD_Q,1494
+file_groups-0.4.0.dist-info/METADATA,sha256=hCMNdysRiHy14tnW7TKa4vxO0BKBRO_RlMHdISRDJe4,1510
+file_groups-0.4.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+file_groups-0.4.0.dist-info/top_level.txt,sha256=mAdRf0R2TA8tpH7ftHzXP7VMRhw07p7B2mI8QKpDnjU,12
+file_groups-0.4.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+file_groups-0.4.0.dist-info/RECORD,,

{file_groups-0.3.1.dist-info → file_groups-0.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

file_groups-0.3.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-file_groups/__init__.py,sha256=XBp5563xhTer1vQY-DpKRvViAvlHaZqx9GrINiGqbeI,127
-file_groups/compare_files.py,sha256=38EfZzpEpj0wH7SUruPxgyF_W8eqCbIjG6yUOx8hcFA,434
-file_groups/config_files.py,sha256=VwRmZYEemKQawYI43qV9XhvPyI7ouaDjjadhc74wqNs,14021
-file_groups/groups.py,sha256=Lt8QlAET8032t9OXcq9cmzLy27tZsYTnLAaGilzEtcM,11377
-file_groups/handler.py,sha256=NmYfmPLGXgPsGxM9uR2r8aS3cI-8S7D5-8884EoGA1M,10083
-file_groups/handler_compare.py,sha256=qbGHwT0FSvfnWtAnjYi4px6V5xIM2cStm0soflwYAi4,2174
-file_groups/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-file_groups/types.py,sha256=giq3H58RuKpS6b7sjxnzP-sN1Xr4VTQ-rG4brLP5qMI,107
-file_groups-0.3.1.dist-info/LICENSE.txt,sha256=NZc9ictLEwfoL4ywpAbLbd-n02KETGHLYQU820TJD_Q,1494
-file_groups-0.3.1.dist-info/METADATA,sha256=wSlWiFxs8yMgFvY6jN3pWIBGBVbbneRhyMQM5tNcoPw,1561
-file_groups-0.3.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-file_groups-0.3.1.dist-info/top_level.txt,sha256=mAdRf0R2TA8tpH7ftHzXP7VMRhw07p7B2mI8QKpDnjU,12
-file_groups-0.3.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-file_groups-0.3.1.dist-info/RECORD,,