reykit 1.1.13__py3-none-any.whl → 1.1.15__py3-none-any.whl

reykit/rexception.py

@@ -20,7 +20,7 @@
 """
 
 
-from typing import Any, NoReturn
+from typing import Any, NoReturn, overload
 from types import TracebackType
 from collections.abc import Iterable
 from sys import exc_info as sys_exc_info
@@ -213,6 +213,12 @@ def catch_exc(
     return exc_report, exc_type, exc_instance, exc_traceback
 
 
+@overload
+def check_least_one(*values: None) -> NoReturn: ...
+
+@overload
+def check_least_one(*values: Any) -> None: ...
+
 def check_least_one(*values: Any) -> None:
     """
     Check that at least one of multiple values is not null, when check fail, then throw exception.
@@ -249,22 +255,23 @@ def check_most_one(*values: Any) -> None:
     """
 
     # Check.
-    none_count = 0
+    exist = False
     for value in values:
         if value is not None:
-            none_count += 1
-
-    # Throw exception.
-    if none_count > 1:
-        from .rsystem import get_name
-        vars_name = get_name(values)
-        if vars_name is not None:
-            vars_name_de_dup = list(set(vars_name))
-            vars_name_de_dup.sort(key=vars_name.index)
-            vars_name_str = ' ' + ' and '.join([f'"{var_name}"' for var_name in vars_name_de_dup])
-        else:
-            vars_name_str = ''
-        raise TypeError(f'at most one of parameters{vars_name_str} is not None')
+            if exist is True:
+
+                # Throw exception.
+                from .rsystem import get_name
+                vars_name = get_name(values)
+                if vars_name is not None:
+                    vars_name_de_dup = list(set(vars_name))
+                    vars_name_de_dup.sort(key=vars_name.index)
+                    vars_name_str = ' ' + ' and '.join([f'"{var_name}"' for var_name in vars_name_de_dup])
+                else:
+                    vars_name_str = ''
+                raise TypeError(f'at most one of parameters{vars_name_str} is not None')
+
+            exist = True
 
 
 def check_file_found(path: str) -> None:

reykit/rlog.py

@@ -998,7 +998,7 @@ class RRecord(object):
             rfile(value, True)
 
 
-    def is_record(
+    def is_recorded(
         self,
         value: Any
     ) -> bool:
@@ -1036,4 +1036,4 @@ class RRecord(object):
     __call__ = record
 
 
-    __contains__ = is_record
+    __contains__ = is_recorded

reykit/rmultitask.py

@@ -50,6 +50,11 @@ __all__ = (
 class RThreadPool(object):
     """
     Rey's `thread pool` type.
+
+    Attributes
+    ----------
+    Queue : Thread queue type.
+    Lock : Thread lock type.
     """
 
     Queue = QQueue
@@ -668,6 +673,11 @@ async def async_request(
 class RAsyncPool(object):
     """
     Rey's `asynchronous pool` type.
+
+    Attributes
+    ----------
+    Queue : asynchronous queue type.
+    Lock : asynchronous lock type.
     """
 
     Queue = AQueue

reykit/ros.py

@@ -195,26 +195,27 @@ def get_file_str(file: FileStr) -> str:
     File string data.
     """
 
+    # Get.
     match file:
 
-        # Path or string.
+        ## Path or string.
         case str():
             exist = os_exists(file)
 
-            # Path.
+            ## Path.
             if exist:
                 rfile = RFile(file)
                 file_str = rfile.str
 
-            # String.
+            ## String.
             else:
                 file_str = file
 
-        # IO.
+        ## IO.
         case TextIOBase():
             file_str = file.read()
 
-        # Throw exception.
+        ## Throw exception.
         case _:
             throw(TypeError, file)
 
@@ -237,24 +238,25 @@ def get_file_bytes(file: FileBytes) -> bytes:
     File bytes data.
     """
 
+    # Get.
     match file:
 
-        # Bytes.
+        ## Bytes.
         case bytes():
             file_bytes = file
         case bytearray():
             file_bytes = bytes(file)
 
-        # Path.
+        ## Path.
         case str():
             rfile = RFile(file)
             file_bytes = rfile.bytes
 
-        # IO.
+        ## IO.
         case BufferedIOBase():
             file_bytes = file.read()
 
-        # Throw exception.
+        ## Throw exception.
         case _:
             throw(TypeError, file)
 
@@ -366,12 +368,24 @@ class RFile(object):
 
 
     @overload
-    def __getattr__(self, name: Literal['open_r', 'open_w', 'open_a']) -> TextIO: ...
+    def r(self) -> TextIO: ...
 
     @overload
-    def __getattr__(self, name: Literal['open_rb', 'open_wb', 'open_ab']) -> BinaryIO: ...
+    def w(self) -> TextIO: ...
 
-    def __getattr__(self, name: Literal['open_r', 'open_w', 'open_a', 'open_rb', 'open_wb', 'open_ab']) -> TextIO | BinaryIO:
+    @overload
+    def a(self) -> TextIO: ...
+
+    @overload
+    def rb(self) -> BinaryIO: ...
+
+    @overload
+    def wb(self) -> BinaryIO: ...
+
+    @overload
+    def ab(self) -> BinaryIO: ...
+
+    def __getattr__(self, name: Literal['r', 'w', 'a', 'rb', 'wb', 'ab']) -> TextIO | BinaryIO:
         """
         Get attribute.
 
@@ -384,16 +398,8 @@ class RFile(object):
         IO object.
         """
 
-        if name in (
-            'open_r',
-            'open_w',
-            'open_a',
-            'open_rb',
-            'open_wb',
-            'open_ab'
-        ):
-            mode: Literal['r', 'w', 'a', 'rb', 'wb', 'ab']  = name[5:]
-            io = self.open(mode)
+        if name in ('r', 'w', 'a', 'rb', 'wb', 'ab'):
+            io = self.open(name)
             return io
 
 

reykit/rrandom.py

@@ -71,7 +71,7 @@ class RRandomSeed(object):
         ----------
         seed : Random seed.
             - `None`: Clear seed.
-            - `int | float | str | bytes | bytearray` : Set seed.
+            - `int | float | str | bytes | bytearray`: Set seed.
         """
 
         # Delete.

reykit/rschedule.py

@@ -27,6 +27,7 @@ class RSchedule(object):
     Rey's `schedule` type.
     """
 
+
     def __init__(
         self,
         max_workers: int = 10,

reykit/rstdout.py

@@ -37,6 +37,12 @@ __all__ = (
 class RConfigStdout(object, metaclass=RConfigMeta):
     """
     Rey's `config standard output` type.
+
+    Attributes
+    ----------
+        is_frame_plain : Whehter global use plain text frame type.
+            - `Literal[True]`: 'full' to 'half_plain', 'half' to 'half_plain', 'top' to 'top_plain', Other unchanged.
+        default_width : Global default text width.
     """
 
     # Module path.
@@ -78,15 +84,15 @@ def beautify_text(
         - `None`: Use attribute `RConfigStdout.default_width`.
         - `int`: Use this value.
     frame : Text frame type.
-        - `Literal[`full`]`: Add beautiful four side frame and limit length.
+        - `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 throw `exception`, then frame is `half` type.
-        - `Literal[`half`]`: Add beautiful top and bottom side frame.
+        - `Literal['half']`: Add beautiful top and bottom side frame.
             When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
-        - `Literal[`top`]`: Add beautiful top side frame.
+        - `Literal['top']`: Add beautiful top side frame.
             When attribute `RConfigStdout.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.
+        - `Literal['half_plain']`: Add plain top and bottom side frame.
+        - `Literal['top_plain']`: Add plain top side frame.
 
     Returns
     -------
@@ -150,15 +156,15 @@ def echo(
         - `None`: Use attribute `RConfigStdout.default_width`.
         - `int`: Use this value.
     frame : Text frame type.
-        - `Literal[`full`]`: Add beautiful four side frame and limit length.
+        - `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 throw `exception`, then frame is `half` type.
-        - `Literal[`half`]`: Add beautiful top and bottom side frame.
+        - `Literal['half']`: Add beautiful top and bottom side frame.
             When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
-        - `Literal[`top`]`: Add beautiful top side frame.
+        - `Literal['top']`: Add beautiful top side frame.
             When attribute `RConfigStdout.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.
+        - `Literal['half_plain']`: Add plain top and bottom side frame.
+        - `Literal['top_plain']`: Add plain top side frame.
 
     Returns
     -------
@@ -195,15 +201,15 @@ def rinput(
         - `None`: Use attribute `RConfigStdout.default_width`.
         - `int`: Use this value.
     frame : Text frame type.
-        - `Literal[`full`]`: Add beautiful four side frame and limit length.
+        - `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 throw `exception`, then frame is `half` type.
-        - `Literal[`half`]`: Add beautiful top and bottom side frame.
+        - `Literal['half']`: Add beautiful top and bottom side frame.
             When attribute `RConfigStdout.is_frame_plain` is True, then frame is `half_plain` type.
-        - `Literal[`top`]`: Add beautiful top side frame.
+        - `Literal['top']`: Add beautiful top side frame.
             When attribute `RConfigStdout.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.
+        - `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.
 
     Returns

reykit/rsystem.py

@@ -545,33 +545,34 @@ def get_stack_text(format_: Literal['plain', 'full'] = 'plain', limit: int = 2)
     Code stack text.
     """
 
+    # Get.
     match format_:
 
-        # Plain.
+        ## Plain.
         case 'plain':
             limit += 1
             stacks = format_stack(limit=limit)
 
-            ## Check.
+            ### Check.
             if len(stacks) != limit:
                 throw(value=limit)
 
-            ## Convert.
+            ### Convert.
             text = stacks[0]
             index_end = text.find(', in ')
             text = text[2:index_end]
 
-        # Full.
+        ## Full.
         case 'full':
             stacks = format_stack()
             index_limit = len(stacks) - limit
             stacks = stacks[:index_limit]
 
-            ## Check.
+            ### Check.
             if len(stacks) == 0:
                 throw(value=limit)
 
-            ## Convert.
+            ### Convert.
             stacks = [
                 stack[2:].replace('\n  ', '\n', 1)
                 for stack in stacks
@@ -579,7 +580,7 @@ def get_stack_text(format_: Literal['plain', 'full'] = 'plain', limit: int = 2)
             text = ''.join(stacks)
             text = text[:-1]
 
-        # Throw exception.
+        ## Throw exception.
         case _:
             throw(ValueError, format_)
 

reykit/rtime.py

@@ -153,9 +153,10 @@ def time_to(
     Converted text.
     """
 
+    # Convert.
     match obj:
 
-        # Type 'datetime'.
+        ## Type 'datetime'.
         case Datetime() | PTimestamp():
             if decimal:
                 format_ = '%Y-%m-%d %H:%M:%S.%f'
@@ -163,11 +164,11 @@ def time_to(
                 format_ = '%Y-%m-%d %H:%M:%S'
             text = obj.strftime(format_)
 
-        # Type 'date'.
+        ## Type 'date'.
         case Date():
             text = obj.strftime('%Y-%m-%d')
 
-        # Type 'time'.
+        ## Type 'time'.
         case Time():
             if decimal:
                 format_ = '%H:%M:%S.%f'
@@ -175,7 +176,7 @@ def time_to(
                 format_ = '%H:%M:%S'
             text = obj.strftime(format_)
 
-        # Type 'timedelta'.
+        ## Type 'timedelta'.
         case Timedelta() | PTimedelta():
             timestamp = obj.seconds + obj.microseconds / 1000_000
             if timestamp >= 0:
@@ -189,15 +190,15 @@ def time_to(
                 if obj.days != 0:
                     text = f'{obj.days}day ' + text
 
-            ## Throw exception.
+            ### Throw exception.
             elif raising:
                 throw(ValueError, obj)
 
-            ## Not raise.
+            ### Not raise.
             else:
                 return obj
 
-        # Type 'struct_time'.
+        ## Type 'struct_time'.
         case StructTime():
             if decimal:
                 format_ = '%Y-%m-%d %H:%M:%S.%f'
@@ -205,11 +206,11 @@ def time_to(
                 format_ = '%Y-%m-%d %H:%M:%S'
             text = time_strftime(format_, obj)
 
-        # Throw exception.
+        ## Throw exception.
         case _ if raising:
             throw(TypeError, obj)
 
-        # Not raise.
+        ## Not raise.
         case _:
             return obj
 
@@ -334,13 +335,14 @@ def to_time(
     Time object.
     """
 
+    # Convert.
     match obj:
 
-        # Type 'str'.
+        ## Type 'str'.
         case str():
             time_obj = text_to_time(obj)
 
-        # Type 'struct_time'.
+        ## Type 'struct_time'.
         case StructTime():
             time_obj = Datetime(
                 obj.tm_year,
@@ -351,7 +353,7 @@ def to_time(
                 obj.tm_sec
             )
 
-        # Type 'float'.
+        ## Type 'float'.
         case int() | float():
             int_len, _ = digits(obj)
             match int_len:
@@ -362,14 +364,14 @@ def to_time(
                 case _:
                     time_obj = None
 
-    # No time object.
+    ## No time object.
     if time_obj is None:
 
-        ## Throw exception.
+        ### Throw exception.
         if raising:
             throw(ValueError, obj)
 
-        ## Not raise.
+        ### Not raise.
         else:
             return obj
 

reykit/rtype.py

@@ -88,6 +88,10 @@ class RSingleton(object):
     """
     Rey's `singleton` type.
     When instantiated, method `__singleton__` will be called only once, and will accept arguments.
+
+    Attributes
+    ----------
+    _instance : Global singleton instance.
     """
 
     _instance: Self | None = None

{reykit-1.1.13.dist-info → reykit-1.1.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reykit
-Version: 1.1.13
+Version: 1.1.15
 Summary: Rey's kit method set.
 Project-URL: homepage, https://github.com/reyxbo/reykit/
 Author-email: Rey <reyxbo@163.com>

{reykit-1.1.13.dist-info → reykit-1.1.15.dist-info}/RECORD

@@ -3,28 +3,28 @@ reykit/rall.py,sha256=mOFwHXZ4-BOkJ5Ptbm6lQc2zwNf_VqcqM6AYYnYPfoo,672
 reykit/rcomm.py,sha256=LgSLrpUokOgdRMYwuZj6JNvxDyvENwsiOd6ZHo67HBg,11444
 reykit/rdata.py,sha256=nCBZxD2fsDuFCDyfLLZZPYJPod4Xuv0aKplQDDUMvI8,8285
 reykit/remail.py,sha256=rK_hbqGeZh04DnVPtjODLsm_YfdrZ5L-Z6SbjplrfUc,6736
-reykit/rexception.py,sha256=ftXVdEVkU0B0HXbKjQTiJRJVVGbvhorwWtMiplpN9Zk,8118
+reykit/rexception.py,sha256=lxs3DWNsGn33YTpYHi6pm4rjjYFpqvYSKhkailxM638,8344
 reykit/rimage.py,sha256=fQpIHX6Go3Jk_MDgsSDnZx27EZHumyGdgI9xyjP5lYQ,6275
-reykit/rlog.py,sha256=qhmATMv3_bJRaiuN9mo8hSf_95HH5Lw838aJFio98sg,25760
+reykit/rlog.py,sha256=EETnQNVADBvTyseVpL5uOKWL647ee6ZeAevBnTOOWF8,25764
 reykit/rmonkey.py,sha256=RqhmKXabl11s2RJaGizpm00Q1yEkul1Je5uxw8_thUk,7584
-reykit/rmultitask.py,sha256=sHmE2JXzPkDxeJGUjU7sg9PTDYjPQqSfAGlwO943K7Q,22929
+reykit/rmultitask.py,sha256=vey2UiPcwP7XI8LiobcpRqA0FGUg_jAzBR9FmcuSHEk,23133
 reykit/rnumber.py,sha256=6x4FuRB-MTJheo6wbTUEaBarnew15jomlrneo3_Q2wg,3646
-reykit/ros.py,sha256=6fHKCpxoWmCpxlRpGag5E-GzGsh0xt8YEmx9iqDvN_o,40780
-reykit/rrandom.py,sha256=TfQKYXRw379MMRIZYfjBtCkmsartA9thhDIG1fc3tM4,9233
+reykit/ros.py,sha256=vrQw4WC2YebK1fucgyLk1PmoPBtgD_ONRzsSgIEJx8c,40682
+reykit/rrandom.py,sha256=Av-neLmX3DXYPq-qzYY95CfXvOTvXcvtXr9Lrqd1wSU,9232
 reykit/rregex.py,sha256=XTlnDLior8yyncFdrTr9FsVlBcqMXvsWRfpmvQS-BR8,6089
-reykit/rschedule.py,sha256=7EH_6TdEhwV-T6YyBEGYEcy85I1vTSNutDci-e_veTY,5796
-reykit/rstdout.py,sha256=vSvD4QjYybNiGnowWLXRU6q1u9ERPjr8YTXgq82eYDU,9648
-reykit/rsystem.py,sha256=2upm4hWnYfeeIjqSgJAC3GJOcAiZt1JS3UXDs_pnMM0,34772
+reykit/rschedule.py,sha256=pYZq8gFOY46_ayRpW2gXsfybMZ7ULTNikLSwMuT_11M,5798
+reykit/rstdout.py,sha256=O-78in-_mQ-FJP869UikdHICefiF3Yb2M0fOBJ07wwk,9921
+reykit/rsystem.py,sha256=h_G3MoJ7yuIdR4_O_GjNumDPDUAb5BAhfqO3o4GWFAQ,34791
 reykit/rtable.py,sha256=gXszf_9DE_5SMdNcxMX-xd4IpHGQVjGsN3NQIm7wVGY,12055
 reykit/rtext.py,sha256=whaKpVkd36yYVtCmZ1ptp_TVRL1v3f7Jab0vPXC8wXY,11089
-reykit/rtime.py,sha256=L0WH6huXiNgrp1770f088ruoyovAgiB7I01pmBim9DY,17054
-reykit/rtype.py,sha256=AmelC4UQwO5n-dnRKo5fR4n5qEWz3d2yImTtdmvlONc,2003
+reykit/rtime.py,sha256=WYPmpz4ZyrqWVU0YrXAiZWLYbMZeZTX3XqTGwt-EE3g,17101
+reykit/rtype.py,sha256=hgZhDVqS86Di2DRzVdqyoT6BYob-P45IIFu-T35YYWE,2081
 reykit/rwrap.py,sha256=AJBYTDLHLGlMSiGIKoVkCsQk-Y4nDHWWFVCdnz5Bwdk,15222
 reykit/rzip.py,sha256=i6KkmeSWCnq025d-O1mbuCYezNRUhyY9OGVK0CRlNAM,3522
 reykit/rdll/__init__.py,sha256=vM9V7wSNno-WH9RrxgHTIgCkQm8LmBFoLFO8z7qovNo,306
 reykit/rdll/rdll_inject.py,sha256=bETl8tywtN1OiQudbA21u6GwBM_bqVX7jbiisNj_JBg,645
 reykit/rdll/rdll_inject_core.py,sha256=Trgh_pdJs_Lw-Y-0Kkn8kHr4BnilM9dBKnHnX25T_pM,5092
-reykit-1.1.13.dist-info/METADATA,sha256=Axe5egv2NzofmYvHClZPjYAs7Q9qgZ-Vlbcf5C-F6S0,1889
-reykit-1.1.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.1.13.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.1.13.dist-info/RECORD,,
+reykit-1.1.15.dist-info/METADATA,sha256=SvehW8tJ8L3WIlKIrLyA-lFi_pOwTlRKBxIDoIJghXA,1889
+reykit-1.1.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.1.15.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.1.15.dist-info/RECORD,,