reykit 1.1.14__py3-none-any.whl → 1.1.16__py3-none-any.whl

reykit/rdata.py

@@ -10,11 +10,13 @@
 
 
 from typing import Any, TypedDict, Literal, overload
+from collections import defaultdict as Defaultdict, ChainMap
 from collections.abc import Callable, Iterable, Generator
+from itertools import chain as IChain
 
 from .rexception import check_least_one, check_most_one
 from .rsystem import is_iterable
-from .rtype import T
+from .rtype import T, KT, VT, RNull
 
 
 __all__ = (
@@ -24,6 +26,8 @@ __all__ = (
     'unique',
     'in_arrs',
     'objs_in',
+    'chain',
+    'default_dict',
     'RGenerator'
 )
 
@@ -279,6 +283,79 @@ def objs_in(arr: Iterable, *objs: Any, mode: Literal['or', 'and'] = 'or') -> boo
             return True
 
 
+@overload
+def chain(*iterables: dict[KT, VT]) -> ChainMap[KT, VT]: ...
+
+@overload
+def chain(*iterables: Iterable[T]) -> IChain[T]: ...
+
+def chain(*iterables: dict[KT, VT] | Iterable[T]) -> ChainMap[KT, VT] | IChain[T]:
+    """
+    Connect multiple iterables.
+
+    Parameters
+    ----------
+    iterables : Multiple iterables.
+        - `dict`: Connect to chain mapping.
+        - `Iterable`: Connect to chain.
+
+    Returns
+    -------
+    Chain instance.
+    """
+
+    # Dict.
+    if all(
+        [
+            isinstance(iterable, dict)
+            for iterable in iterables
+        ]
+    ):
+        data = ChainMap(*iterables)
+
+    # Other.
+    else:
+        data = IChain(*iterables)
+
+    return data
+
+
+def default_dict(default: Any = RNull, data: dict[KT, VT] | None = None) -> Defaultdict[KT, VT]:
+    """
+    Set `dict` instance, default value when key does not exist.
+
+    Parameters
+    ----------
+    default : Default value.
+        - `Type[RNull]`: Nest function self.
+        - `Callable`: Use call return value.
+    data : `dict` instance.
+        - `None`: Empty `dict`.
+    """
+
+    # Handle parameter.
+
+    ## Null.
+    if default == RNull:
+        default_factory = default_dict
+
+    ## Callable.
+    elif callable(default):
+        default_factory = default
+
+    ## Not callable.
+    else:
+        default_factory = lambda : default
+
+    if data is None:
+        data = {}
+
+    # Instance.
+    dict_set = Defaultdict(default_factory, data)
+
+    return dict_set
+
+
 class RGenerator(object):
     """
     Rey's `generator` type.

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/rimage.py

@@ -32,7 +32,7 @@ __all__ = (
     'encode_qrcode',
     'decode_qrcode',
     'compress_image',
-    'to_pimage',
+    'to_pil_image',
     'generate_captcha_image'
 )
 
@@ -187,13 +187,13 @@ def compress_image(
         rfile(content)
 
 
-def to_pimage(image: str | bytes) -> RImage:
+def to_pil_image(source: str | bytes) -> RImage:
     """
     Get `Image` instance of `PIL` package.
 
     Parameters
     ----------
-    image : Image source data.
+    source : Image source data.
         - `str`: Image file path.
         - `bytes`: Image bytes data.
 
@@ -203,12 +203,12 @@ def to_pimage(image: str | bytes) -> RImage:
     """
 
     # File path.
-    if image.__class__ == str:
-        pil_image = pil_open(image)
+    if source.__class__ == str:
+        pil_image = pil_open(source)
 
     # Bytes data.
-    if image.__class__ in (bytes, bytearray):
-        bytes_io = BytesIO(image)
+    if source.__class__ in (bytes, bytearray):
+        bytes_io = BytesIO(source)
         pil_image = pil_open(bytes_io)
 
     return pil_image

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/rmonkey.py

@@ -26,6 +26,23 @@ def monkey_patch_sqlalchemy_result_more_fetch():
     Returns
     -------
     Modified type.
+
+    Examples
+    --------
+    >>> result = connection.execute(sql)
+    >>> result.fetch_table()
+    >>> result.fetch_dict()
+    >>> result.fetch_list()
+    >>> result.fetch_df()
+    >>> result.fetch_json()
+    >>> result.fetch_text()
+    >>> result.fetch_sql()
+    >>> result.fetch_html()
+    >>> result.fetch_csv()
+    >>> result.fetch_excel()
+    >>> result.show()
+    >>> result.exist
+    >>> result.empty
     """
 
 
@@ -203,6 +220,12 @@ def monkey_patch_sqlalchemy_result_more_fetch():
 def monkey_patch_sqlalchemy_row_index_field():
     """
     Monkey patch of package `sqlalchemy`, add index by field method to `Row` object.
+
+    Examples
+    --------
+    >>> result = connection.execute(sql)
+    >>> for row in result:
+    ...     row['field']
     """
 
 
@@ -295,6 +318,11 @@ def monkey_path_pil_image_get_bytes():
     Returns
     -------
     Image object.
+
+    Examples
+    --------
+    >>> image = to_pil_image(source)
+    >>> image.get_bytes()
     """
 
 

reykit/rsystem.py

@@ -67,6 +67,8 @@ __all__ = (
     'dos_command',
     'dos_command_var',
     'block',
+    'is_class',
+    'is_instance',
     'is_iterable',
     'is_table',
     'is_number_str',
@@ -357,6 +359,44 @@ def block() -> None:
                 continue
 
 
+def is_class(obj: Any) -> bool:
+    """
+    Judge whether it is class.
+
+    Parameters
+    ----------
+    obj : Judge object.
+
+    Returns
+    -------
+    Judgment result.
+    """
+
+    # Judge.
+    judge = isinstance(obj, type)
+
+    return judge
+
+
+def is_instance(obj: Any) -> bool:
+    """
+    Judge whether it is instance.
+
+    Parameters
+    ----------
+    obj : Judge object.
+
+    Returns
+    -------
+    Judgment result.
+    """
+
+    # judge.
+    judge = not is_class(obj)
+
+    return judge
+
+
 def is_iterable(
     obj: Any,
     exclude_types: Iterable[type] = [str, bytes]

reykit/rtype.py

@@ -15,6 +15,8 @@ from collections.abc import Callable
 
 __all__ = (
     'T',
+    'KT',
+    'VT',
     'RStaticMeta',
     'RConfigMeta',
     'RNull',
@@ -22,7 +24,10 @@ __all__ = (
 )
 
 
-T = TypeVar('T')
+# Generic.
+T = TypeVar('T') # Any.
+KT = TypeVar('KT') # Any dictionary key.
+VT = TypeVar('VT') # Any dictionary value.
 
 
 class RStaticMeta(type):

{reykit-1.1.14.dist-info → reykit-1.1.16.dist-info}/METADATA

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

{reykit-1.1.14.dist-info → reykit-1.1.16.dist-info}/RECORD

@@ -1,12 +1,12 @@
 reykit/__init__.py,sha256=QwnhdUDSXgjXJQ4ClaeP9oKXUXyQOPj5sApwGCDrILc,848
 reykit/rall.py,sha256=mOFwHXZ4-BOkJ5Ptbm6lQc2zwNf_VqcqM6AYYnYPfoo,672
 reykit/rcomm.py,sha256=LgSLrpUokOgdRMYwuZj6JNvxDyvENwsiOd6ZHo67HBg,11444
-reykit/rdata.py,sha256=nCBZxD2fsDuFCDyfLLZZPYJPod4Xuv0aKplQDDUMvI8,8285
+reykit/rdata.py,sha256=ZiWiYAS9fP1e-VEWbsQAuvfrSabrc8GKGD3ikNg8jVo,9989
 reykit/remail.py,sha256=rK_hbqGeZh04DnVPtjODLsm_YfdrZ5L-Z6SbjplrfUc,6736
-reykit/rexception.py,sha256=ftXVdEVkU0B0HXbKjQTiJRJVVGbvhorwWtMiplpN9Zk,8118
-reykit/rimage.py,sha256=fQpIHX6Go3Jk_MDgsSDnZx27EZHumyGdgI9xyjP5lYQ,6275
-reykit/rlog.py,sha256=qhmATMv3_bJRaiuN9mo8hSf_95HH5Lw838aJFio98sg,25760
-reykit/rmonkey.py,sha256=RqhmKXabl11s2RJaGizpm00Q1yEkul1Je5uxw8_thUk,7584
+reykit/rexception.py,sha256=lxs3DWNsGn33YTpYHi6pm4rjjYFpqvYSKhkailxM638,8344
+reykit/rimage.py,sha256=VXlQFCZBjx1Mu18Au0Qmth9-u8dlIz0h8u_X100ImxA,6287
+reykit/rlog.py,sha256=EETnQNVADBvTyseVpL5uOKWL647ee6ZeAevBnTOOWF8,25764
+reykit/rmonkey.py,sha256=OAlLVvMszMDzersroVC9NjbD2GPnoPgWF4AHZ3v3-fk,8232
 reykit/rmultitask.py,sha256=vey2UiPcwP7XI8LiobcpRqA0FGUg_jAzBR9FmcuSHEk,23133
 reykit/rnumber.py,sha256=6x4FuRB-MTJheo6wbTUEaBarnew15jomlrneo3_Q2wg,3646
 reykit/ros.py,sha256=vrQw4WC2YebK1fucgyLk1PmoPBtgD_ONRzsSgIEJx8c,40682
@@ -14,17 +14,17 @@ reykit/rrandom.py,sha256=Av-neLmX3DXYPq-qzYY95CfXvOTvXcvtXr9Lrqd1wSU,9232
 reykit/rregex.py,sha256=XTlnDLior8yyncFdrTr9FsVlBcqMXvsWRfpmvQS-BR8,6089
 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/rsystem.py,sha256=xEgcse_4XbYB50USsVoh6yy3C5rHlnE1jKQdLdNOcPw,35364
 reykit/rtable.py,sha256=gXszf_9DE_5SMdNcxMX-xd4IpHGQVjGsN3NQIm7wVGY,12055
 reykit/rtext.py,sha256=whaKpVkd36yYVtCmZ1ptp_TVRL1v3f7Jab0vPXC8wXY,11089
 reykit/rtime.py,sha256=WYPmpz4ZyrqWVU0YrXAiZWLYbMZeZTX3XqTGwt-EE3g,17101
-reykit/rtype.py,sha256=hgZhDVqS86Di2DRzVdqyoT6BYob-P45IIFu-T35YYWE,2081
+reykit/rtype.py,sha256=bwo7cn-Z3qSYOop-ijPPJBGIUtzNV2pak37xTvrI3-Q,2208
 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.14.dist-info/METADATA,sha256=PB2A-2qKkg8JjOTft-UmK7BEdQrbwR_Zu9mxxCIR7Bs,1889
-reykit-1.1.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.1.14.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.1.14.dist-info/RECORD,,
+reykit-1.1.16.dist-info/METADATA,sha256=8eNvWo1IWjKKeob4ohB86MZWsjTQc8G-93smLGe2GoY,1889
+reykit-1.1.16.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.1.16.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.1.16.dist-info/RECORD,,