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

reykit/rdata.py

@@ -16,7 +16,7 @@ from itertools import chain as IChain
 
 from .rexc import check_least_one, check_most_one
 from .rsys import is_iterable
-from .rtype import T, KT, VT, RBase, Null
+from .rtype import T, KT, VT, Base, null
 
 
 __all__ = (
@@ -28,7 +28,7 @@ __all__ = (
     'objs_in',
     'chain',
     'default_dict',
-    'RGenerator'
+    'FunctionGenerator'
 )
 
 
@@ -320,14 +320,14 @@ def chain(*iterables: dict[KT, VT] | Iterable[T]) -> ChainMap[KT, VT] | IChain[T
     return data
 
 
-def default_dict(default: T = Null, data: dict[KT, VT] | None = None) -> Defaultdict[KT, VT | T]:
+def default_dict(default: T = null, data: dict[KT, VT] | None = None) -> Defaultdict[KT, VT | T]:
     """
     Set `dict` instance, default value when key does not exist.
 
     Parameters
     ----------
     default : Default value.
-        - `Literal[Null]`: Nest function self.
+        - `Literal[null]`: Nest function self.
         - `Callable`: Use call return value.
     data : `dict` instance.
         - `None`: Empty `dict`.
@@ -336,7 +336,7 @@ def default_dict(default: T = Null, data: dict[KT, VT] | None = None) -> Default
     # Handle parameter.
 
     ## Null.
-    if default == Null:
+    if default == null:
         default_factory = default_dict
 
     ## Callable.
@@ -356,9 +356,18 @@ def default_dict(default: T = Null, data: dict[KT, VT] | None = None) -> Default
     return dict_set
 
 
-class RGenerator(RBase):
+class FunctionGenerator(Base):
     """
-    Rey's `generator` type.
+    Function generator type.
+
+    Examples
+    --------
+    >>> func = lambda arg1, arg2: arg1 + arg2
+    >>> fgenerator = FunctionGenerator(func, 10)
+    >>> fgenerator.add(1)
+    >>> fgenerator.add(2)
+    >>> list(fgenerator)
+    [11, 12]
     """
 
 
@@ -369,7 +378,7 @@ class RGenerator(RBase):
         **kwargs: Any
     ) -> None:
         """
-        Build `generator` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------

reykit/remail.py

@@ -17,17 +17,17 @@ from email.mime.application import MIMEApplication
 from .rdata import unique
 from .rexc import throw
 from .ros import FileBytes, get_file_bytes
-from .rtype import RBase
+from .rtype import Base
 
 
 __all__ = (
-    'REmail',
+    'Email',
 )
 
 
-class REmail(RBase):
+class Email(Base):
     """
-    Rey's `email` type.
+    Email type.
     """
 
 
@@ -37,7 +37,7 @@ class REmail(RBase):
         password: str
     ) -> None:
         """
-        Build `email` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -108,7 +108,7 @@ class REmail(RBase):
         show_cc: list[str] | None
     ) -> str:
         """
-        create email content.
+        Create email content.
 
         Parameters
         ----------

reykit/rexc.py

@@ -17,12 +17,12 @@ from os.path import exists as os_exists
 from traceback import format_exc
 from warnings import warn as warnings_warn
 
-from .rtype import Null
+from .rtype import Base, null
 
 
 __all__ = (
-    'RError',
-    'RActiveError',
+    'Error',
+    'ActiveError',
     'throw',
     'warn',
     'catch_exc',
@@ -34,21 +34,21 @@ __all__ = (
 )
 
 
-class RError(Exception):
+class Error(Base, Exception):
     """
-    Rey `error` type.
+    Error type.
     """
 
 
-class RActiveError(RError):
+class ActiveError(Error):
     """
-    Rey's `active error` type.
+    Active error type.
     """
 
 
 def throw(
     exception: type[BaseException] = AssertionError,
-    value: Any = Null,
+    value: Any = null,
     *values: Any,
     text: str | None = None,
     frame: int = 2
@@ -78,7 +78,7 @@ def throw(
             text = text[0].lower() + text[1:]
 
     ## Value.
-    if value != Null:
+    if value != null:
         values = (value,) + values
 
         ### Name.

reykit/rimage.py

@@ -17,12 +17,12 @@ from PIL.Image import open as pil_open, LANCZOS
 from captcha.image import ImageCaptcha
 
 from .rmonkey import monkey_path_pil_image_get_bytes
-from .ros import RFile
+from .ros import File
 from .rrand import randchar
 
 
 __all__ = (
-    'RImage',
+    'Image',
     'encode_qrcode',
     'decode_qrcode',
     'compress_image',
@@ -33,7 +33,7 @@ __all__ = (
 
 # Monkey path.
 monkey_image_type = monkey_path_pil_image_get_bytes()
-RImage = monkey_image_type
+Image = monkey_image_type
 
 
 def encode_qrcode(text: str, path: str | None = None) -> bytes:
@@ -61,7 +61,7 @@ def encode_qrcode(text: str, path: str | None = None) -> bytes:
 
     # Save.
     if path is not None:
-        rfile = RFile(path)
+        rfile = File(path)
         rfile.write(file_bytes)
 
     return file_bytes
@@ -139,7 +139,7 @@ def compress_image(
 
     # Handle parameter.
     if type(input_image) == str:
-        rfile = RFile(input_image)
+        rfile = File(input_image)
         input_image = rfile.str
     now_size = len(input_image)
     if target_size < 1:
@@ -180,11 +180,11 @@ def compress_image(
 
     ## Save file and return path.
     else:
-        rfile = RFile(ouput_image)
+        rfile = File(ouput_image)
         rfile(content)
 
 
-def to_pil_image(source: str | bytes) -> RImage:
+def to_pil_image(source: str | bytes) -> Image:
     """
     Get `Image` instance of `PIL` package.
 
@@ -247,12 +247,12 @@ def generate_captcha_image(
     }
     default_kwargs.update(kwargs)
     icaptcha = ImageCaptcha(**default_kwargs)
-    image: RImage = icaptcha.generate_image(text)
+    image: Image = icaptcha.generate_image(text)
     file_bytes = image.get_bytes()
 
     # Save.
     if path is not None:
-        rfile = RFile(path)
+        rfile = File(path)
         rfile.write(file_bytes)
 
     return file_bytes

reykit/rlog.py

@@ -30,35 +30,35 @@ from logging.handlers import QueueHandler
 from concurrent_log_handler import ConcurrentRotatingFileHandler, ConcurrentTimedRotatingFileHandler
 
 from .rexc import throw, catch_exc
-from .ros import RFile
+from .ros import File
 from .rre import search, sub
-from .rstdout import RConfigStdout, modify_print, reset_print
+from .rstdout import ConfigStdout, modify_print, reset_print
 from .rsys import get_first_notnull, get_stack_param
 from .rtext import to_text
 from .rtime import now, time_to
-from .rtype import RBase, RConfigMeta
+from .rtype import Base, ConfigMeta
 from .rwrap import wrap_thread
 
 
 __all__ = (
-    'RConfigLog',
-    'RLog',
-    'RRecord'
+    'ConfigLog',
+    'Log',
+    'Record'
 )
 
 
-class RConfigLog(object, metaclass=RConfigMeta):
+class ConfigLog(Base, metaclass=ConfigMeta):
     """
-    Rey's `config log` type.
+    Config log type.
     """
 
     # Module path.
     path_rlog: Final[str] = os_abspath(__file__)
 
 
-class RLog(object):
+class Log(Base):
     """
-    Rey's `log` type.
+    Log type.
     """
 
     # Status.
@@ -90,7 +90,7 @@ class RLog(object):
         name: str = 'Log'
     ) -> None:
         """
-        Build `log` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -125,21 +125,21 @@ class RLog(object):
 
         ## Compatible '__call__'.
         if (
-            stack_param['filename'] == RConfigLog.path_rlog
+            stack_param['filename'] == ConfigLog.path_rlog
             and stack_param['name'] in ('debug', 'info', 'warning', 'error', 'critical')
         ):
             stack_param = stack_params[-2]
 
         ## Compatible 'print'.
         if (
-            stack_param['filename'] == RConfigLog.path_rlog
+            stack_param['filename'] == ConfigLog.path_rlog
             and stack_param['name'] == 'preprocess'
         ):
             stack_param = stack_params[-3]
 
         ## Compatible 'echo'.
         if (
-            stack_param['filename'] == RConfigStdout._path_rstdout
+            stack_param['filename'] == ConfigStdout._path_rstdout
             and stack_param['name'] == 'echo'
         ):
             stack_param = stack_params[-4]
@@ -347,7 +347,7 @@ class RLog(object):
     def get_filter(
         self,
         method: Callable[[LogRecord], bool]
-    ) -> Filter:
+    ):
         """
         Get filter.
 
@@ -362,9 +362,9 @@ class RLog(object):
 
 
         # Define.
-        class RFilter(Filter):
+        class _Filter(Base, Filter):
             """
-            Rey's filter type.
+            Filter type.
             """
 
 
@@ -389,7 +389,7 @@ class RLog(object):
                 return result
 
 
-        return RFilter
+        return _Filter
 
 
     def add_print(
@@ -938,9 +938,9 @@ class RLog(object):
     __call__ = log
 
 
-class RRecord(object):
+class Record(Base):
     """
-    Rey's `record` type.
+    Record type.
     """
 
 
@@ -949,7 +949,7 @@ class RRecord(object):
         path: str | None = '_rrecord'
     ) -> None:
         """
-        Build `record` instance attributes.
+        Build instance attributes.
 
         Parameters
         ----------
@@ -982,7 +982,7 @@ class RRecord(object):
 
         # To file.
         else:
-            rfile = RFile(self.path)
+            rfile = File(self.path)
 
             ## Convert.
             if type(value) != str:
@@ -1018,7 +1018,7 @@ class RRecord(object):
 
         # To file.
         else:
-            rfile = RFile(self.path)
+            rfile = File(self.path)
 
             ## Convert.
             if type(value) != str:

reykit/rmonkey.py

@@ -62,6 +62,7 @@ def monkey_patch_sqlalchemy_result_more_fetch():
         to_excel
     )
     from .rtime import time_to
+    from .rtype import Base
 
     # Fetch result as table in 'list[dict]' format.
     CursorResult.fetch_table = to_table
@@ -95,7 +96,7 @@ def monkey_patch_sqlalchemy_result_more_fetch():
 
 
     # Print result.
-    def method_show(self: RResult, limit: int | None = None) -> None:
+    def method_show(self: Result, limit: int | None = None) -> None:
         """
         Print result.
 
@@ -149,7 +150,7 @@ def monkey_patch_sqlalchemy_result_more_fetch():
 
     # Whether is exist.
     @property
-    def method_exist(self: RResult) -> bool:
+    def method_exist(self: Result) -> bool:
         """
         Judge whether is exist row.
 
@@ -169,7 +170,7 @@ def monkey_patch_sqlalchemy_result_more_fetch():
 
     # Whether is empty.
     @property
-    def method_empty(self: RResult) -> bool:
+    def method_empty(self: Result) -> bool:
         """
         Judge whether is empty row.
 
@@ -188,7 +189,7 @@ def monkey_patch_sqlalchemy_result_more_fetch():
 
 
     # Update annotations.
-    class RResult(CursorResult):
+    class Result(Base, CursorResult):
         """
         Update based on `CursorResult` object, for annotation return value.
         """
@@ -212,7 +213,7 @@ def monkey_patch_sqlalchemy_result_more_fetch():
         empty = method_empty
 
 
-    return RResult
+    return Result
 
 
 def monkey_patch_sqlalchemy_row_index_field():
@@ -322,6 +323,7 @@ def monkey_path_pil_image_get_bytes():
 
     from PIL.Image import Image
     from io import BytesIO
+    from reykit.rtype import Base
 
 
     # Define.
@@ -347,7 +349,7 @@ def monkey_path_pil_image_get_bytes():
 
 
     # Update annotations.
-    class RImage(Image):
+    class Image(Base, Image):
         """
         Update based on `Image` object, for annotation return value.
         """
@@ -359,4 +361,4 @@ def monkey_path_pil_image_get_bytes():
         get_bytes = method_get_bytes
 
 
-    return RImage
+    return Image

reykit/rnet.py

@@ -31,9 +31,9 @@ from filetype import guess as filetype_guess
 from datetime import datetime
 
 from .rexc import throw, check_response_code
-from .ros import RFile
+from .ros import File
 from .rre import search
-from .rtype import RBase
+from .rtype import Base
 
 
 __all__ = (
@@ -46,7 +46,7 @@ __all__ = (
     'download',
     '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,7 +381,7 @@ 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
@@ -410,7 +410,7 @@ def compute_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
         ----------