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

reykit/ros.py

@@ -55,7 +55,7 @@ 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
         ----------

reykit/rrand.py

@@ -21,12 +21,12 @@ from threading import get_ident as threading_get_ident
 
 from .rexc import throw
 from .rnum import digits
-from .rtype import T, RBase, RConfigMeta
+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

@@ -18,11 +18,11 @@ from os.path import abspath as os_abspath
 
 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/rsys.py

@@ -57,11 +57,11 @@ from tkinter.filedialog import (
 )
 
 from .rexc import throw
-from .rtype import RBase, RConfigMeta
+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]:

reykit/rtable.py

@@ -15,7 +15,7 @@ from os.path import abspath as os_abspath
 from pandas import DataFrame, ExcelWriter, isnull
 from sqlalchemy.engine.cursor import CursorResult
 
-from .ros import RFile
+from .ros import File
 from .rtext import to_json, to_text
 from .rtime import time_to
 
@@ -416,7 +416,7 @@ def to_csv(
 
     # Handle parameter.
     data_df = to_df(data, fields)
-    rfile = RFile(path)
+    rfile = File(path)
     if rfile:
         header = False
     else:

reykit/rtask.py

@@ -31,24 +31,24 @@ from asyncio import (
 from aiohttp import ClientSession, ClientResponse
 
 from .rexc import throw, check_most_one, check_response_code
-from .rtime import randn, RTimeMark
-from .rtype import T, RBase
+from .rtime import randn, TimeMark
+from .rtype import T, Base
 from .rwrap import wrap_thread
 
 
 __all__ = (
-    'RThreadPool',
+    'ThreadPool',
     'async_run',
     'async_sleep',
     'async_wait',
     'async_request',
-    'RAsyncPool'
+    'AsyncPool'
 )
 
 
-class RThreadPool(RBase):
+class ThreadPool(Base):
     """
-    Rey's `thread pool` type.
+    Thread pool type.
 
     Attributes
     ----------
@@ -68,7 +68,7 @@ class RThreadPool(RBase):
         **kwargs: Any
     ) -> None:
         """
-        Build `thread pool` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -157,7 +157,7 @@ class RThreadPool(RBase):
         >>> b = (3, 4, 5)
         >>> c = (11, 12)
         >>> d = (13, 14, 15)
-        >>> thread_pool = RThreadPool(func, 0, z=0)
+        >>> thread_pool = ThreadPool(func, 0, z=0)
         >>> thread_pool.batch(a, b, c=c, d=d)
         (0, 1, 3) {'z': 0, 'c': 11, 'd': 13}
         (0, 2, 4) {'z': 0, 'c': 12, 'd': 14}
@@ -474,7 +474,7 @@ async def async_wait(
     """
 
     # Set parameter.
-    rtm = RTimeMark()
+    rtm = TimeMark()
     rtm()
 
     # Not set timeout.
@@ -669,9 +669,9 @@ async def async_request(
             return result
 
 
-class RAsyncPool(RBase):
+class AsyncPool(Base):
     """
-    Rey's `asynchronous pool` type.
+    Asynchronous pool type.
 
     Attributes
     ----------
@@ -690,7 +690,7 @@ class RAsyncPool(RBase):
         **kwargs: Any
     ) -> None:
         """
-        Build `asynchronous pool` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -779,7 +779,7 @@ class RAsyncPool(RBase):
         >>> b = (3, 4, 5)
         >>> c = (11, 12)
         >>> d = (13, 14, 15)
-        >>> async_pool = RAsyncPool(func, 0, z=0)
+        >>> async_pool = AsyncPool(func, 0, z=0)
         >>> async_pool.batch(a, b, c=c, d=d)
         (0, 1, 3) {'z': 0, 'c': 11, 'd': 13}
         (0, 2, 4) {'z': 0, 'c': 12, 'd': 14}

reykit/rtime.py

@@ -34,7 +34,7 @@ from .rnum import digits, to_number
 from .rrand import randn
 from .rre import search
 from .rstdout import echo
-from .rtype import T
+from .rtype import T, Base
 
 
 __all__ = (
@@ -44,7 +44,7 @@ __all__ = (
     'to_time',
     'sleep',
     'wait',
-    'RTimeMark'
+    'TimeMark'
 )
 
 
@@ -482,7 +482,7 @@ def wait(
     """
 
     # Set parameter.
-    rtm = RTimeMark()
+    rtm = TimeMark()
     rtm()
 
     # Not set timeout.
@@ -520,15 +520,15 @@ def wait(
     return rtm.total_spend
 
 
-class RTimeMark():
+class TimeMark(Base):
     """
-    Rey`s `time mark` type.
+    Time mark type.
     """
 
 
     def __init__(self) -> None:
         """
-        Build `time mark` instance attributes.
+        Build instance attributes.
         """
 
         # Record table.