reykit 1.1.24__py3-none-any.whl → 1.1.26__py3-none-any.whl

reykit/{rcomm.py → rnet.py}

@@ -5,7 +5,7 @@
 @Time    : 2022-12-08 11:07:25
 @Author  : Rey
 @Contact : reyxbo@163.com
-@Explain : Network communication methods.
+@Explain : Network methods.
 """
 
 
@@ -30,10 +30,10 @@ from mimetypes import guess_type
 from filetype import guess as filetype_guess
 from datetime import datetime
 
-from .rexception import throw, check_response_code
-from .ros import RFile
-from .rregex import search
-from .rtype import RBase
+from .rexc import throw, check_response_code
+from .ros import File
+from .rre import search
+from .rtype import Base
 
 
 __all__ = (
@@ -44,9 +44,9 @@ __all__ = (
     'get_content_type',
     'request',
     'download',
-    'get_file_stream_time',
+    'compute_stream_time',
     'listen_socket',
-    'RRequestCache'
+    'RequestCache'
 )
 
 
@@ -276,7 +276,7 @@ def request(
             method = 'post'
     if files is None:
         if type(data) == str:
-            rfile = RFile(data)
+            rfile = File(data)
             data = rfile.bytes
             if 'Content-Disposition' not in headers:
                 file_name = rfile.name_suffix
@@ -291,7 +291,7 @@ def request(
             else:
                 item_data, item_headers = value, {}
             if type(item_data) == str:
-                rfile = RFile(item_data)
+                rfile = File(item_data)
                 data = rfile.bytes
                 item_headers.setdefault('filename', rfile.name_suffix)
             if type(item_data) == bytes:
@@ -381,18 +381,18 @@ def download(url: str, path: str | None = None) -> str:
         path = os_abspath(file_name)
 
     # Save.
-    rfile = RFile(path)
+    rfile = File(path)
     rfile(content)
 
     return path
 
 
-def get_file_stream_time(
+def compute_stream_time(
     file: str | bytes | int,
     bandwidth: float
 ) -> float:
     """
-    Get file stream transfer time, unit second.
+    Compute file stream transfer time, unit second.
 
     Parameters
     ----------
@@ -410,7 +410,7 @@ def get_file_stream_time(
     # Get parameter.
     match file:
         case str():
-            rfile = RFile(file)
+            rfile = File(file)
             file_size = rfile.size
         case bytes() | bytearray():
             file_size = len(file)
@@ -456,9 +456,9 @@ def listen_socket(
         handler(data)
 
 
-class RRequestCache(RBase):
+class RequestCache(Base):
     """
-    Rey's `requests cache` type.
+    Requests cache type.
     """
 
 
@@ -471,7 +471,7 @@ class RRequestCache(RBase):
         judge: Callable[[Response | OriginalResponse | CachedResponse], bool] | None = None
     ) -> None:
         """
-        Build `requests cache` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------

reykit/{rnumber.py → rnum.py}

@@ -11,7 +11,7 @@
 
 from typing import Any
 
-from .rexception import throw
+from .rexc import throw
 
 
 __all__ = (
@@ -119,7 +119,7 @@ def number_ch(number: int) -> str:
     """
 
     # Import.
-    from .rregex import sub_batch
+    from .rre import sub_batch
 
     # Set parameter.
     map_digit = {

reykit/ros.py

@@ -51,11 +51,11 @@ from docx.oxml.table import CT_Tbl
 from lxml.etree import ElementChildIterator
 from pdfplumber import open as pdfplumber_open
 
-from .rexception import throw
-from .rregex import search, sub
-from .rsystem import dos_command
+from .rexc import throw
+from .rre import search, sub
+from .rsys import dos_command
 from .rtext import to_json
-from .rtype import RBase
+from .rtype import Base
 
 
 __all__ = (
@@ -65,10 +65,10 @@ __all__ = (
     'get_file_str',
     'get_file_bytes',
     'read_toml',
-    'RFile',
-    'RFolder',
-    'RTempFile',
-    'RTempFolder',
+    'File',
+    'Folder',
+    'TempFile',
+    'TempFolder',
     'doc_to_docx',
     'extract_docx_content',
     'extract_pdf_content',
@@ -81,7 +81,6 @@ type FileText = str
 type FileData = bytes
 type FileStr = FilePath | FileText | TextIOBase
 type FileBytes = FilePath | FileData | BufferedIOBase
-type File = FileStr | FileBytes
 
 
 def get_md5(file: str | bytes) -> str:
@@ -102,7 +101,7 @@ def get_md5(file: str | bytes) -> str:
 
         ## Path.
         case str():
-            rfile = RFile(file)
+            rfile = File(file)
             file_bytes = rfile.bytes
 
         ## Bytes.
@@ -128,7 +127,7 @@ def create_folder(*paths: str, report: bool = False) -> None:
 
     # Create.
     for path in paths:
-        rfolder = RFolder(path)
+        rfolder = Folder(path)
         rfolder.create(report)
 
 
@@ -205,7 +204,7 @@ def get_file_str(file: FileStr) -> str:
 
             ## Path.
             if exist:
-                rfile = RFile(file)
+                rfile = File(file)
                 file_str = rfile.str
 
             ## String.
@@ -250,7 +249,7 @@ def get_file_bytes(file: FileBytes) -> bytes:
 
         ## Path.
         case str():
-            rfile = RFile(file)
+            rfile = File(file)
             file_bytes = rfile.bytes
 
         ## IO.
@@ -264,14 +263,14 @@ def get_file_bytes(file: FileBytes) -> bytes:
     return file_bytes
 
 
-def read_toml(path: str | RFile) -> dict[str, Any]:
+def read_toml(path: str | File) -> dict[str, Any]:
     """
     Read and parse TOML file.
     Treat nan as a None or null value.
 
     Parameters
     ----------
-    path : File path or RFile object.
+    path : File path or File object.
 
     Returns
     -------
@@ -283,11 +282,11 @@ def read_toml(path: str | RFile) -> dict[str, Any]:
 
         ## File path.
         case str():
-            rfile = RFile(path)
+            rfile = File(path)
             text = rfile.str
 
-        ## RFile object.
-        case RFile():
+        ## File object.
+        case File():
             text = rfile.str
 
     # Parse.
@@ -300,9 +299,9 @@ def read_toml(path: str | RFile) -> dict[str, Any]:
     return params
 
 
-class RFile(RBase):
+class File(Base):
     """
-    Rey's `file` type.
+    File type.
     """
 
 
@@ -311,7 +310,7 @@ class RFile(RBase):
         path: str
     ) -> None:
         """
-        Build `file` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -846,9 +845,9 @@ class RFile(RBase):
     __call__ = write
 
 
-class RFolder(RBase):
+class Folder(Base):
     """
-    Rey's `folder` type.
+    Folder type.
     """
 
 
@@ -857,7 +856,7 @@ class RFolder(RBase):
         path: str | None = None
     ) -> None:
         """
-        Build `folder` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -1220,9 +1219,9 @@ class RFolder(RBase):
     __call__ = paths
 
 
-class RTempFile(RBase):
+class TempFile(Base):
     """
-    Rey's `temporary file` type.
+    Temporary file type.
     """
 
 
@@ -1233,7 +1232,7 @@ class RTempFile(RBase):
         type_: Literal['str', 'bytes'] = 'bytes'
     ) -> None:
         """
-        Build `temporary file` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -1505,9 +1504,9 @@ class RTempFile(RBase):
     __call__ = write
 
 
-class RTempFolder(RBase):
+class TempFolder(Base):
     """
-    Rey's `temporary folder` type.
+    Temporary folder type.
     """
 
 
@@ -1516,7 +1515,7 @@ class RTempFolder(RBase):
         dir_: str | None = None
     ) -> None:
         """
-        Build `temporary folder` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -1857,10 +1856,9 @@ def doc_to_docx(
     DOCX file path.
     """
 
-
+    # Import.
     from win32com.client import Dispatch, CDispatch
 
-
     # Handle parameter.
     if save_path is None:
         pattern = '.[dD][oO][cC]'

reykit/{rrandom.py → rrand.py}

@@ -19,14 +19,14 @@ from random import Random
 from secrets import randbelow as secrets_randbelow
 from threading import get_ident as threading_get_ident
 
-from .rexception import throw
-from .rnumber import digits
-from .rtype import T, RBase, RConfigMeta
+from .rexc import throw
+from .rnum import digits
+from .rtype import T, Base, ConfigMeta
 
 
 __all__ = (
-    'RConfigRandom',
-    'RRandomSeed',
+    'ConfigRandom',
+    'RandomSeed',
     'randn',
     'randb',
     'randi',
@@ -35,37 +35,37 @@ __all__ = (
 )
 
 
-class RConfigRandom(RBase, metaclass=RConfigMeta):
+class ConfigRandom(Base, metaclass=ConfigMeta):
     """
-    Rey's `config random` type.
+    Config random type.
     """
 
     # RRandom.
-    _rrandom_dict: dict[int, RRandomSeed] = {}
+    _rrandom_dict: dict[int, RandomSeed] = {}
 
 
-class RRandomSeed(RBase):
+class RandomSeed(Base):
     """
-    Rey's `random seed` type, set random seed.
+    Random seed type. set random seed.
     If set, based on `random` package.
     If not set, based on `secrets` package.
 
     Examples
     --------
     Use active switch.
-    >>> RRandomSeed(seed)
+    >>> RandomSeed(seed)
     >>> randn()
-    >>> RRandomSeed()
+    >>> RandomSeed()
 
     Use `with` syntax.
-    >>> with RRandomSeed(seed):
+    >>> with RandomSeed(seed):
     >>>     randn()
     """
 
 
     def __init__(self, seed: int | float | str | bytes | bytearray | None = None) -> None:
         """
-        Build `random` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -85,7 +85,7 @@ class RRandomSeed(RBase):
 
             ## Record.
             thread_id = threading_get_ident()
-            RConfigRandom._rrandom_dict[thread_id] = self
+            ConfigRandom._rrandom_dict[thread_id] = self
 
 
     def __del__(self) -> None:
@@ -95,8 +95,8 @@ class RRandomSeed(RBase):
 
         # Delete.
         thread_id = threading_get_ident()
-        if thread_id in RConfigRandom._rrandom_dict:
-            del RConfigRandom._rrandom_dict[thread_id]
+        if thread_id in ConfigRandom._rrandom_dict:
+            del ConfigRandom._rrandom_dict[thread_id]
 
 
     def __enter__(self) -> Self:
@@ -221,7 +221,7 @@ def randn(
 
     ## No seed.
     thread_id = threading_get_ident()
-    rrandom = RConfigRandom._rrandom_dict.get(thread_id)
+    rrandom = ConfigRandom._rrandom_dict.get(thread_id)
     if rrandom is None:
         range_ = threshold_high - threshold_low + 1
         number = secrets_randbelow(range_)

reykit/rschedule.py

@@ -16,17 +16,17 @@ from apscheduler.schedulers.background import BackgroundScheduler
 from apscheduler.schedulers.blocking import BlockingScheduler
 from apscheduler.job import Job
 
-from .rtype import RBase
+from .rtype import Base
 
 
 __all__ = (
-    'RSchedule',
+    'Schedule',
 )
 
 
-class RSchedule(RBase):
+class Schedule(Base):
     """
-    Rey's `schedule` type.
+    Schedule type.
     """
 
 
@@ -38,7 +38,7 @@ class RSchedule(RBase):
         block: bool = False
     ) -> None:
         """
-        Build `schedule` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------

reykit/rstdout.py

@@ -5,24 +5,24 @@
 @Time    : 2023-10-01 14:47:47
 @Author  : Rey
 @Contact : reyxbo@163.com
-@Explain : Standard output methods.
+@Explain : Standard output and input methods.
 """
 
 
-from typing import Any, Literal, Final, Self
+from typing import Any, Literal, Final
 from collections.abc import Callable
 import sys
 from io import TextIOWrapper
 from os import devnull as os_devnull
 from os.path import abspath as os_abspath
 
-from .rsystem import get_first_notnull, get_name, get_stack_param
+from .rsys import get_first_notnull, get_name, get_stack_param
 from .rtext import to_text, add_text_frame
-from .rtype import RBase, RConfigMeta
+from .rtype import Base, ConfigMeta
 
 
 __all__ = (
-    'RConfigStdout',
+    'ConfigStdout',
     'beautify_text',
     'echo',
     'rinput',
@@ -34,9 +34,9 @@ __all__ = (
 )
 
 
-class RConfigStdout(RBase, metaclass=RConfigMeta):
+class ConfigStdout(Base, metaclass=ConfigMeta):
     """
-    Rey's `config standard output` type.
+    Config standard output type.
 
     Attributes
     ----------
@@ -81,16 +81,16 @@ def beautify_text(
         - `Literal[False]`: No title.
         - `str`: Use this value as the title.
     width : Text width.
-        - `None`: Use attribute `RConfigStdout.default_width`.
+        - `None`: Use attribute `ConfigStdout.default_width`.
         - `int`: Use this value.
     frame : Text frame type.
         - `Literal['full']`: Add beautiful four side frame and limit length.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
             When throw `exception`, then frame is `half` type.
         - `Literal['half']`: Add beautiful top and bottom side frame.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
         - `Literal['top']`: Add beautiful top side frame.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
         - `Literal['half_plain']`: Add plain top and bottom side frame.
         - `Literal['top_plain']`: Add plain top side frame.
 
@@ -112,10 +112,10 @@ def beautify_text(
         title = None
 
     ## Width.
-    width = get_first_notnull(width, RConfigStdout.default_width, default='exception')
+    width = get_first_notnull(width, ConfigStdout.default_width, default='exception')
 
     ## Frame.
-    if RConfigStdout.is_frame_plain:
+    if ConfigStdout.is_frame_plain:
         match frame:
             case 'full':
                 frame = 'half_plain'
@@ -153,16 +153,16 @@ def echo(
         - `Literal[False]`: No title.
         - `str`: Use this value as the title.
     width : Text width.
-        - `None`: Use attribute `RConfigStdout.default_width`.
+        - `None`: Use attribute `ConfigStdout.default_width`.
         - `int`: Use this value.
     frame : Text frame type.
         - `Literal['full']`: Add beautiful four side frame and limit length.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
             When throw `exception`, then frame is `half` type.
         - `Literal['half']`: Add beautiful top and bottom side frame.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
         - `Literal['top']`: Add beautiful top side frame.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
         - `Literal['half_plain']`: Add plain top and bottom side frame.
         - `Literal['top_plain']`: Add plain top side frame.
 
@@ -198,16 +198,16 @@ def rinput(
         - `Literal[False]`: No title.
         - `str`: Use this value as the title.
     width : Text width.
-        - `None`: Use attribute `RConfigStdout.default_width`.
+        - `None`: Use attribute `ConfigStdout.default_width`.
         - `int`: Use this value.
     frame : Text frame type.
         - `Literal['full']`: Add beautiful four side frame and limit length.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
             When throw `exception`, then frame is `half` type.
         - `Literal['half']`: Add beautiful top and bottom side frame.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
         - `Literal['top']`: Add beautiful top side frame.
-            When attribute `RConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
+            When attribute `ConfigStdout.is_frame_plain` is True, then frame is `top_plain` type.
         - `Literal['half_plain']`: Add plain top and bottom side frame.
         - `Literal['top_plain']`: Add plain top side frame.
     extra : Extra print text at the end.
@@ -236,10 +236,10 @@ def stop_print() -> None:
     """
 
     # Stop.
-    sys.stdout = RConfigStdout._io_null
+    sys.stdout = ConfigStdout._io_null
 
     # Update status.
-    RConfigStdout._stoped = True
+    ConfigStdout._stoped = True
 
 
 def start_print() -> None:
@@ -248,13 +248,13 @@ def start_print() -> None:
     """
 
     # Check.
-    if not RConfigStdout._stoped: return
+    if not ConfigStdout._stoped: return
 
     # Start.
-    sys.stdout = RConfigStdout._io_stdout
+    sys.stdout = ConfigStdout._io_stdout
 
     # Update status.
-    RConfigStdout._stoped = False
+    ConfigStdout._stoped = False
 
 
 def modify_print(preprocess: Callable[[str], str] | None) -> None:
@@ -288,15 +288,15 @@ def modify_print(preprocess: Callable[[str], str] | None) -> None:
 
         # Write.
         if type(__s) == str:
-            write_len = RConfigStdout._io_stdout_write(__s)
+            write_len = ConfigStdout._io_stdout_write(__s)
             return write_len
 
 
     # Modify.
-    RConfigStdout._io_stdout.write = write
+    ConfigStdout._io_stdout.write = write
 
     # Update status.
-    RConfigStdout._modified = True
+    ConfigStdout._modified = True
 
 
 def reset_print() -> None:
@@ -305,13 +305,13 @@ def reset_print() -> None:
     """
 
     # Check.
-    if not RConfigStdout._modified: return
+    if not ConfigStdout._modified: return
 
     # Reset.
-    RConfigStdout._io_stdout.write = RConfigStdout._io_stdout_write
+    ConfigStdout._io_stdout.write = ConfigStdout._io_stdout_write
 
     # Update status.
-    RConfigStdout._modified = False
+    ConfigStdout._modified = False
 
 
 def add_print_position() -> None:
@@ -343,7 +343,7 @@ def add_print_position() -> None:
 
         ## Compatible 'echo'.
         if (
-            stack_floor['filename'] == RConfigStdout._path_rstdout
+            stack_floor['filename'] == ConfigStdout._path_rstdout
             and stack_floor['name'] == 'echo'
         ):
             stack_floor = stack_params[-2]

reykit/{rsystem.py → rsys.py}

@@ -56,12 +56,12 @@ from tkinter.filedialog import (
     askdirectory as tkinter_askdirectory
 )
 
-from .rexception import throw
-from .rtype import RBase, RConfigMeta
+from .rexc import throw
+from .rtype import Base, ConfigMeta
 
 
 __all__ = (
-    'RConfigSystem',
+    'ConfigSystem',
     'add_env_path',
     'reset_env_path',
     'del_modules',
@@ -127,9 +127,9 @@ NetWorkInfo = TypedDict(
 ProcessInfo = TypedDict('ProcessInfo', {'create_time': datetime, 'id': int, 'name': str, 'ports': list[int] | None})
 
 
-class RConfigSystem(RBase, metaclass=RConfigMeta):
+class ConfigSystem(Base, metaclass=ConfigMeta):
     """
-    Rey's `config system` type.
+    Config system type.
     """
 
     # Added environment path.
@@ -153,7 +153,7 @@ def add_env_path(path: str) -> list[str]:
     abs_path = os_abspath(path)
 
     # Add.
-    RConfigSystem._add_env_paths.append(abs_path)
+    ConfigSystem._add_env_paths.append(abs_path)
     sys_path.append(abs_path)
 
     return sys_path
@@ -165,9 +165,9 @@ def reset_env_path() -> None:
     """
 
     # Delete.
-    for path in RConfigSystem._add_env_paths:
+    for path in ConfigSystem._add_env_paths:
         sys_path.remove(path)
-    RConfigSystem._add_env_paths = []
+    ConfigSystem._add_env_paths = []
 
 
 def del_modules(path: str) -> list[str]:
@@ -184,7 +184,7 @@ def del_modules(path: str) -> list[str]:
     """
 
     # Import.
-    from .rregex import search
+    from .rre import search
 
     # Set parameter.
     deleted_dict = {}