reykit 1.1.52__py3-none-any.whl → 1.1.54__py3-none-any.whl

reykit/remail.py

@@ -16,7 +16,7 @@ from email.mime.application import MIMEApplication
 
 from .rbase import Base, throw
 from .rdata import unique
-from .ros import FileBytes, get_file_bytes
+from .ros import FileBytes, read_file_bytes
 
 
 __all__ = (
@@ -236,7 +236,7 @@ class Email(Base):
 
         ## Attachment.
         for file_name, file_source in attachment.items():
-            file_bytes = get_file_bytes(file_source)
+            file_bytes = read_file_bytes(file_source)
             attachment[file_name] = file_bytes
 
         # Create email.

reykit/ros.py

@@ -50,17 +50,19 @@ from .rsys import run_cmd
 
 
 __all__ = (
-    'get_path',
+    'format_path',
+    'join_path',
     'get_md5',
     'make_dir',
     'find_relpath',
-    'get_file_str',
-    'get_file_bytes',
+    'read_file_str',
+    'read_file_bytes',
     'read_toml',
     'File',
     'Folder',
     'TempFile',
     'TempFolder',
+    'FileCache',
     'doc_to_docx',
     'extract_docx_content',
     'extract_pdf_content',
@@ -71,13 +73,13 @@ __all__ = (
 type FilePath = str
 type FileText = str
 type FileData = bytes
-type FileStr = FilePath | FileText | TextIOBase
-type FileBytes = FilePath | FileData | BufferedIOBase
+type FileSourceStr = FilePath | FileText | TextIOBase
+type FileSourceBytes = FilePath | FileData | BufferedIOBase
 
 
-def get_path(path: str | None = None) -> str:
+def format_path(path: str | None = None) -> str:
     """
-    resolve relative path and replace to forward slash `/`.
+    Resolve relative path and replace to forward slash `/`.
 
     Parameters
     ----------
@@ -86,13 +88,13 @@ def get_path(path: str | None = None) -> str:
 
     Returns
     -------
-    Handled path.
+    Formatted path.
     """
 
     # Handle parameter.
     path = path or ''
 
-    # Handle.
+    # Format.
     path_obj = Path(path)
     path_obj = path_obj.resolve()
     path = path_obj.as_posix()
@@ -100,6 +102,28 @@ def get_path(path: str | None = None) -> str:
     return path
 
 
+def join_path(*paths: str) -> str:
+    """
+    Join path and resolve relative path and replace to forward slash `/`.
+
+    Parameters
+    ----------
+    paths : Paths.
+
+    Returns
+    -------
+    Joined and formatted path.
+    """
+
+    # Join.
+    path = os_join(*paths)
+
+    # Format.
+    path = format_path(path)
+
+    return path
+
+
 def get_md5(data: str | bytes) -> str:
     """
     Get MD5 value.
@@ -183,14 +207,14 @@ def find_relpath(abspath: str, relpath: str) -> str:
     for _ in range(level):
         folder_path, _ = os_split(folder_path)
     relpath = relpath[level + strip_n:]
-    path = os_join(folder_path, relpath)
+    path = join_path(folder_path, relpath)
 
     return path
 
 
-def get_file_str(source: FileStr) -> str:
+def read_file_str(source: FileSourceStr) -> str:
     """
-    Get file string data.
+    Read file string data.
 
     Parameters
     ----------
@@ -231,9 +255,9 @@ def get_file_str(source: FileStr) -> str:
     return file_str
 
 
-def get_file_bytes(source: FileBytes) -> bytes:
+def read_file_bytes(source: FileSourceBytes) -> bytes:
     """
-    Get file bytes data.
+    Read file bytes data.
 
     Parameters
     ----------
@@ -324,7 +348,7 @@ class File(Base):
         """
 
         # Set attribute.
-        self.path = get_path(path)
+        self.path = format_path(path)
 
 
     @overload
@@ -512,7 +536,7 @@ class File(Base):
         """
 
         # Get parameter.
-        move_path = os_join(self.dir, name)
+        move_path = join_path(self.dir, name)
 
         # Move.
         self.move(move_path)
@@ -525,7 +549,7 @@ class File(Base):
         Remove file.
         """
 
-        # Copy.
+        # Remove.
         try:
             os_remove(self.path)
 
@@ -854,7 +878,7 @@ class Folder(Base):
         """
 
         # Set attribute.
-        self.path = get_path(path)
+        self.path = format_path(path)
 
 
     def paths(
@@ -887,21 +911,21 @@ class Folder(Base):
             match target:
                 case 'all':
                     targets_path = [
-                        os_join(path, file_name)
+                        join_path(path, file_name)
                         for path, folders_name, files_name in obj_walk
                         for file_name in files_name + folders_name
                     ]
                     paths.extend(targets_path)
                 case 'file':
                     targets_path = [
-                        os_join(path, file_name)
+                        join_path(path, file_name)
                         for path, _, files_name in obj_walk
                         for file_name in files_name
                     ]
                     paths.extend(targets_path)
-                case 'all' | 'folder':
+                case 'folder':
                     targets_path = [
-                        os_join(path, folder_name)
+                        join_path(path, folder_name)
                         for path, folders_name, _ in obj_walk
                         for folder_name in folders_name
                     ]
@@ -913,17 +937,17 @@ class Folder(Base):
             match target:
                 case 'all':
                     for name in names:
-                        target_path = os_join(self.path, name)
+                        target_path = join_path(self.path, name)
                         paths.append(target_path)
                 case 'file':
                     for name in names:
-                        target_path = os_join(self.path, name)
+                        target_path = join_path(self.path, name)
                         is_file = os_isfile(target_path)
                         if is_file:
                             paths.append(target_path)
                 case 'folder':
                     for name in names:
-                        target_path = os_join(self.path, name)
+                        target_path = join_path(self.path, name)
                         is_dir = os_isdir(target_path)
                         if is_dir:
                             paths.append(target_path)
@@ -934,7 +958,7 @@ class Folder(Base):
     @overload
     def search(
         self,
-        pattern: str,
+        pattern: str = '',
         target: Literal['all', 'file', 'folder'] = 'all',
         recursion: bool = False
     ) -> str | None: ...
@@ -942,7 +966,7 @@ class Folder(Base):
     @overload
     def search(
         self,
-        pattern: str,
+        pattern: str = '',
         target: Literal['all', 'file', 'folder'] = 'all',
         recursion: bool = False,
         *,
@@ -951,7 +975,7 @@ class Folder(Base):
 
     def search(
         self,
-        pattern: str,
+        pattern: str = '',
         target: Literal['all', 'file', 'folder'] = 'all',
         recursion: bool = False,
         first: bool = True
@@ -1010,9 +1034,9 @@ class Folder(Base):
         """
 
         # Join.
-        join_path = os_join(self.path, path)
+        path = join_path(self.path, path)
 
-        return join_path
+        return path
 
 
     def make(self, report: bool = False) -> None:
@@ -1069,7 +1093,7 @@ class Folder(Base):
         """
 
         # Get parameter.
-        move_path = os_join(self.dir, name)
+        move_path = join_path(self.dir, name)
 
         # Move.
         self.move(move_path)
@@ -1286,7 +1310,7 @@ class TempFile(Base):
             suffix=suffix,
             dir=dir_
         )
-        self.path = get_path(self.file.name)
+        self.path = format_path(self.file.name)
 
 
     def read(self) -> bytes | str:
@@ -1563,7 +1587,7 @@ class TempFolder(Base):
 
         # Set attribute.
         self.folder = TemporaryDirectory(dir=dir_)
-        self.path = get_path(self.folder.name)
+        self.path = format_path(self.folder.name)
 
 
     def paths(
@@ -1596,21 +1620,21 @@ class TempFolder(Base):
             match target:
                 case 'all':
                     targets_path = [
-                        os_join(path, file_name)
+                        join_path(path, file_name)
                         for path, folders_name, files_name in obj_walk
                         for file_name in files_name + folders_name
                     ]
                     paths.extend(targets_path)
                 case 'file':
                     targets_path = [
-                        os_join(path, file_name)
+                        join_path(path, file_name)
                         for path, _, files_name in obj_walk
                         for file_name in files_name
                     ]
                     paths.extend(targets_path)
                 case 'all' | 'folder':
                     targets_path = [
-                        os_join(path, folder_name)
+                        join_path(path, folder_name)
                         for path, folders_name, _ in obj_walk
                         for folder_name in folders_name
                     ]
@@ -1622,17 +1646,17 @@ class TempFolder(Base):
             match target:
                 case 'all':
                     for name in names:
-                        target_path = os_join(self.path, name)
+                        target_path = join_path(self.path, name)
                         paths.append(target_path)
                 case 'file':
                     for name in names:
-                        target_path = os_join(self.path, name)
+                        target_path = join_path(self.path, name)
                         is_file = os_isfile(target_path)
                         if is_file:
                             paths.append(target_path)
                 case 'folder':
                     for name in names:
-                        target_path = os_join(self.path, name)
+                        target_path = join_path(self.path, name)
                         is_dir = os_isdir(target_path)
                         if is_dir:
                             paths.append(target_path)
@@ -1643,7 +1667,7 @@ class TempFolder(Base):
     @overload
     def search(
         self,
-        pattern: str,
+        pattern: str = '',
         target: Literal['all', 'file', 'folder'] = 'all',
         recursion: bool = False
     ) -> str | None: ...
@@ -1651,7 +1675,7 @@ class TempFolder(Base):
     @overload
     def search(
         self,
-        pattern: str,
+        pattern: str = '',
         target: Literal['all', 'file', 'folder'] = 'all',
         recursion: bool = False,
         *,
@@ -1660,7 +1684,7 @@ class TempFolder(Base):
 
     def search(
         self,
-        pattern: str,
+        pattern: str = '',
         target: Literal['all', 'file', 'folder'] = 'all',
         recursion: bool = False,
         first: bool = True
@@ -1719,7 +1743,7 @@ class TempFolder(Base):
         """
 
         # Join.
-        join_path = os_join(self.path, path)
+        join_path = join_path(self.path, path)
 
         return join_path
 
@@ -1906,6 +1930,156 @@ class TempFolder(Base):
     __add__ = __radd__ = join
 
 
+class FileCache(Base):
+    """
+    File cache type.
+    """
+
+
+    def __init__(self, path: str = 'cache') -> None:
+        """
+        Build instance attributes.
+
+        Parameters
+        ----------
+        path : Root directory path.
+        """
+
+        # Set attribute.
+        self.folder = Folder(path)
+
+        # Make directory.
+        self.__make_dir()
+
+
+    def __make_dir(self) -> None:
+        """
+        Make cache directory and subdirectories.
+        """
+
+        # Make.
+        chars = '0123456789abcdef'
+
+        ## Root.
+        paths = [self.folder.path]
+
+        ## Second layer.
+        paths.extend(
+            [
+                self.folder + char
+                for char in chars
+            ]
+        )
+
+        ## Third layer.
+        paths.extend(
+            [
+                self.folder + f'{char}/{char_sub}'
+                for char in chars
+                for char_sub in chars
+            ]
+        )
+
+        make_dir(*paths)
+
+
+    def index(self, md5: str, name: str | None = None, copy: bool = False) -> str | None:
+        """
+        Index file from cache directory.
+
+        Parameters
+        ----------
+        md5 : File md5 value.
+        name : File name.
+            - `None`: Use md5 value.
+        copy : Do you want to copy file when exist md5 value file and not exist file name.
+
+        Returns
+        -------
+        File path or not exist.
+        """
+
+        # Handle parameter.
+        if name is None:
+            name = md5
+
+        # Not exist md5.
+        md5_relpath = f'{md5[0]}/{md5[1]}/{md5}'
+        if md5_relpath not in self.folder:
+            return
+
+        # Exist md5.
+        file_relpath = f'{md5_relpath}/{name}'
+        file_path = self.folder + file_relpath
+
+        ## Exist file.
+        if file_path in self.folder:
+            return file_path
+
+        ## Copy file.
+        elif copy:
+            md5_path = self.folder + md5_relpath
+            md5_folder = Folder(md5_path)
+            md5_file_path = md5_folder.search(target='file')
+            file = File(md5_file_path)
+            file.copy(file_path)
+            return file_path
+
+
+    def store(self, source: FileSourceBytes, name: str | None = None, delete: bool = False) -> str:
+        """
+        Store file to cache directory.
+
+        Parameters
+        ----------
+        source : Source file path or file data.
+        name : File name.
+            - `None`: Use md5 value.
+        delete : When source is file path, whether delete original file.
+
+        Returns
+        -------
+        Store file path.
+        """
+
+        # Handle parameter.
+        file_bytes = read_file_bytes(source)
+        file_md5 = get_md5(file_bytes)
+        if name is None:
+            name = file_md5
+        delete = delete and type(source) == str
+
+        # Exist.
+        path = self.index(file_md5, name)
+        if path is not None:
+
+            ## Delete.
+            if delete:
+                file = File(source)
+                file.remove()
+
+            return path
+
+        # Store.
+        md5_relpath = f'{file_md5[0]}/{file_md5[1]}/{file_md5}'
+        md5_path = self.folder + md5_relpath
+        folder = Folder(md5_path)
+        folder.make()
+        path = folder + name
+
+        ## Delete.
+        if delete:
+            file = File(source)
+            file.move(path)
+
+        ## Make.
+        else:
+            file = File(path)
+            file(file_bytes)
+
+        return path
+
+
 def doc_to_docx(path: str, save_path: str | None = None) -> str:
     """
     Convert `DOC` file to `DOCX` file.

reykit/rzip.py

@@ -11,9 +11,9 @@
 
 from zipfile import ZipFile, is_zipfile, ZIP_DEFLATED
 from os import getcwd as os_getcwd, walk as os_walk
-from os.path import join as os_join, isfile as os_isfile
+from os.path import isfile as os_isfile
 
-from .ros import File, Folder
+from .ros import File, Folder, join_path
 
 
 __all__ = (
@@ -54,7 +54,7 @@ def compress(
         folder = Folder(path)
         obj_name = folder.name
     build_name = obj_name + '.zip'
-    build_path = os_join(build_dir, build_name)
+    build_path = join_path(build_dir, build_name)
 
     # Compress.
     with ZipFile(build_path, mode, ZIP_DEFLATED) as zip_file:
@@ -69,11 +69,11 @@ def compress(
             dirs = os_walk(folder.path)
             for folder_name, sub_folders_name, files_name in dirs:
                 for sub_folder_name in sub_folders_name:
-                    sub_folder_path = os_join(folder_name, sub_folder_name)
+                    sub_folder_path = join_path(folder_name, sub_folder_name)
                     zip_path = sub_folder_path[dir_path_len:]
                     zip_file.write(sub_folder_path, zip_path)
                 for file_name in files_name:
-                    file_path = os_join(folder_name, file_name)
+                    file_path = join_path(folder_name, file_name)
                     zip_path = file_path[dir_path_len:]
                     zip_file.write(file_path, zip_path)
 

{reykit-1.1.52.dist-info → reykit-1.1.54.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reykit
-Version: 1.1.52
+Version: 1.1.54
 Summary: Kit method set.
 Project-URL: homepage, https://github.com/reyxbo/reykit/
 Author-email: Rey <reyxbo@163.com>

{reykit-1.1.52.dist-info → reykit-1.1.54.dist-info}/RECORD

@@ -2,13 +2,13 @@ reykit/__init__.py,sha256=V86CHqPAAVkooVx3_QIOKpDIFVneQCTTSwfJ-uWgBno,788
 reykit/rall.py,sha256=7Hip02YOkIDm3_xkoSDjvvYV2LhdBV2r4UKzWWnIfIo,628
 reykit/rbase.py,sha256=KPSMPMenmzsA50Q84r0DOXv4Ei-hbp06HXnCB46dsP4,22121
 reykit/rdata.py,sha256=DqxoWkbN3WqGZ5FC9VRlhXAwpTGebv1M5VSeOeR2YnQ,10308
-reykit/remail.py,sha256=s7TXbLgEWEqNoeM42c6FpPufB2LajHgQuahfZri3urQ,6706
+reykit/remail.py,sha256=9r4UEBhd43MzHPtGVQe3QyxLjGO7BINt9WtHvWhSLTs,6708
 reykit/rimage.py,sha256=Dj2ZK0Qprmu0WGLjaMnJgjbT39o1YxqyD8e9pAe3kl0,6151
 reykit/rlog.py,sha256=jgnI8jFSGw0WcD8SSVmUCkomLXY8uoXdwJMUyB2ED4U,25587
 reykit/rmonkey.py,sha256=9-NvBM4phThKTHpqTSPlPGfJWcoDSp4EVl8x3xHJacg,7951
 reykit/rnet.py,sha256=15yrZTMET4cdimbslMk9O8HO9ofMtvfo1dZgLd4Bafw,16938
 reykit/rnum.py,sha256=PhG4V_BkVfCJUsbpMDN1umGZly1Hsus80TW8bpyBtyY,3653
-reykit/ros.py,sha256=vrzs2biU6qZhNqvwV4iJn7MvJF1vdeblJ6pbjIh12dc,42955
+reykit/ros.py,sha256=mhlwA8fmVURNH5eJbSnE9AN_9c44nH04GQaVBMigp-U,47033
 reykit/rrand.py,sha256=imysGSoQH4O0yq45EILYYdow_280LDqYioE4Sm-L4_U,8938
 reykit/rre.py,sha256=4DVxy28dl5zn6_II8-cgr7E2nVPH5QJIJVB4o7Vsf1A,6078
 reykit/rschedule.py,sha256=_nrfrXYxlFAKCDbM8ibTTb60zNDlHxyE310cv-A19Kw,5799
@@ -19,10 +19,10 @@ reykit/rtask.py,sha256=d3Fs-_ZB-uHtzz7zyI2aAmiQv3NcIvWrco6x10jFuzc,22842
 reykit/rtext.py,sha256=gkmA849MBHjchvY4apUTQpkFs13vcmyK_hIwucH2A84,12849
 reykit/rtime.py,sha256=xBpXItHRSmftec1ZzqVRTkMNb6gmFx0A8TaUd5nmiy8,16974
 reykit/rwrap.py,sha256=x4CzSndSdSv_e8lLbLifvC_v2ogWHD42-tDhwsq_DzQ,15317
-reykit/rzip.py,sha256=TU18pEpbr2T7zWFzxkcZPjN5gudw-FArusf55qeNDCo,3453
+reykit/rzip.py,sha256=cG1PbY5dlMRNEIBzOytxF2crjr1yWLMmswR_klh_4Ek,3453
 reykit/rdll/__init__.py,sha256=WrJ_8jp_hbn2nl1osrR3buZMsmAGRVY6HfQdhDoJpSM,698
 reykit/rdll/rdll_core.py,sha256=o6-rKcTQgxZQe0kD3GnwyNb3KL9IogzgCQNOmYLMm7A,5086
-reykit-1.1.52.dist-info/METADATA,sha256=FaLppu0Wz58YqO4tAD2RzT_acfSws0pUXYq4GD7FC0I,1872
-reykit-1.1.52.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.1.52.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.1.52.dist-info/RECORD,,
+reykit-1.1.54.dist-info/METADATA,sha256=KnsGv5u0b7ZUBwEkGsieQ6yTp6tkPukiX_rurAkxoVk,1872
+reykit-1.1.54.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.1.54.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.1.54.dist-info/RECORD,,