reykit 1.1.20__py3-none-any.whl → 1.1.21__py3-none-any.whl

reykit/rcomm.py

@@ -9,7 +9,7 @@
 """
 
 
-from typing import Any, Literal
+from typing import Any, Literal, TypedDict, NotRequired
 from collections.abc import Callable, Iterable
 from warnings import filterwarnings
 from os.path import abspath as os_abspath, isfile as os_isfile
@@ -17,12 +17,23 @@ from socket import socket as  Socket
 from urllib.parse import urlsplit as urllib_urlsplit, quote as urllib_quote, unquote as urllib_unquote
 from requests.api import request as requests_request
 from requests.models import Response
+from requests_cache import (
+    ALL_METHODS,
+    OriginalResponse,
+    CachedResponse,
+    install_cache as requests_cache_install_cache,
+    uninstall_cache as requests_cache_uninstall_cache,
+    is_installed as requests_cache_is_installed,
+    clear as requests_cache_clear
+)
 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
 
 
 __all__ = (
@@ -34,7 +45,21 @@ __all__ = (
     'request',
     'download',
     'get_file_stream_time',
-    'listen_socket'
+    'listen_socket',
+    'RRequestCache'
+)
+
+
+RequestCacheParameters = TypedDict(
+    'RequestCacheParameters',
+    {
+        'cache_name': str,
+        'backend': Literal['sqllite', 'memory'],
+        'expire_after': NotRequired[float | datetime],
+        'code': Iterable[int],
+        'method': Iterable[str],
+        'judge': NotRequired[Callable[[Response], bool]]
+    }
 )
 
 
@@ -429,3 +454,122 @@ def listen_socket(
         socket_conn, _ = socket.accept()
         data = socket_conn.recv(rece_size)
         handler(data)
+
+
+class RRequestCache(RBase):
+    """
+    Rey's `requests cache` type.
+    """
+
+
+    def __init__(
+        self,
+        path: str | None = 'cache.sqlite',
+        timeout: float | datetime | None = None,
+        codes: Iterable[int] | None = (200,),
+        methods: Iterable[str] | None = ('get', 'head'),
+        judge: Callable[[Response | OriginalResponse | CachedResponse], bool] | None = None
+    ) -> None:
+        """
+        Build `requests cache` instance attributes.
+
+        Parameters
+        ----------
+        path : Cache file path.
+            - `None`: Use memory cache.
+            - `str`: Use SQLite cache.
+        timeout : Cache timeout.
+            - `None`: Not timeout.
+            - `float`: Timeout seconds.
+            - `datetime`: Timeout threshold time.
+        codes : Cache response code range.
+            - `None`: All.
+        methods : Cache request method range.
+            - `None`: All.
+        judge : Judge function, `True` cache, `False` not cache.
+            - `None`: Not judgment.
+        """
+
+        # Build.
+        self.path = path
+        self.timeout = timeout
+        self.codes = codes
+        self.methods = methods
+        self.judge = judge
+
+
+    @property
+    def _start_params(self) -> RequestCacheParameters:
+        """
+        Get cache start parameters.
+
+        Returns
+        -------
+        Cache start parameters.
+        """
+
+        # Generate.
+        params = {}
+        if self.path is None:
+            params['cache_name'] = 'cache'
+            params['backend'] = 'memory'
+        else:
+            params['cache_name'] = self.path
+            params['backend'] = 'sqlite'
+        if self.timeout is not None:
+            params['expire_after'] = self.timeout
+        if self.codes is None:
+            params['allowable_codes'] = tuple(range(100, 600))
+        else:
+            params['allowable_codes'] = self.codes
+        if self.methods is None:
+            params['allowable_methods'] = ALL_METHODS
+        else:
+            params['allowable_methods'] = tuple([method.upper() for method in self.methods])
+        if self.judge is not None:
+            params['filter_fn'] = self.judge
+
+        return params
+
+
+    def start(self) -> None:
+        """
+        Start cache.
+        """
+
+        # Start.
+        requests_cache_install_cache(**self._start_params)
+
+
+    def stop(self) -> None:
+        """
+        Stop cache.
+        """
+
+        # Stop.
+        requests_cache_uninstall_cache()
+
+
+    @property
+    def started(self) -> bool:
+        """
+        Whether started.
+
+        Returns
+        -------
+        Result.
+        """
+
+        # Get.
+        result = requests_cache_is_installed()
+
+        return result
+
+
+    def clear(self) -> None:
+        """
+        Clear cache.
+        """
+
+        # Clear.
+        requests_cache_clear()

reykit/rdata.py

@@ -369,7 +369,7 @@ class RGenerator(RBase):
         **kwargs: Any
     ) -> None:
         """
-        Build `generator` attributes.
+        Build `generator` instance attributes.
 
         Parameters
         ----------

reykit/remail.py

@@ -37,7 +37,7 @@ class REmail(RBase):
         password: str
     ) -> None:
         """
-        Build `email` attributes.
+        Build `email` instance attributes.
 
         Parameters
         ----------

reykit/rlog.py

@@ -91,7 +91,7 @@ class RLog(object):
         name: str = 'Log'
     ) -> None:
         """
-        Build `log` attributes.
+        Build `log` instance attributes.
 
         Parameters
         ----------
@@ -901,9 +901,9 @@ class RLog(object):
         self.log(*messages, level=self.CRITICAL, **params)
 
 
-    def stop(self) -> None:
+    def pause(self) -> None:
         """
-        Stop record.
+        Pause record.
         """
 
         # Set level.
@@ -913,9 +913,9 @@ class RLog(object):
         self.stoped = True
 
 
-    def start(self) -> None:
+    def resume(self) -> None:
         """
-        Start record.
+        Resume record.
         """
 
         # Set level.
@@ -951,7 +951,7 @@ class RRecord(object):
         path: str | None = '_rrecord'
     ) -> None:
         """
-        Build `record` attributes.
+        Build `record` instance attributes.
 
         Parameters
         ----------

reykit/rmultitask.py

@@ -69,7 +69,7 @@ class RThreadPool(RBase):
         **kwargs: Any
     ) -> None:
         """
-        Build `thread pool` attributes.
+        Build `thread pool` instance attributes.
 
         Parameters
         ----------
@@ -691,7 +691,7 @@ class RAsyncPool(RBase):
         **kwargs: Any
     ) -> None:
         """
-        Build `asynchronous pool` attributes.
+        Build `asynchronous pool` instance attributes.
 
         Parameters
         ----------

reykit/ros.py

@@ -311,7 +311,7 @@ class RFile(RBase):
         path: str
     ) -> None:
         """
-        Build `file` attributes.
+        Build `file` instance attributes.
 
         Parameters
         ----------
@@ -857,7 +857,7 @@ class RFolder(RBase):
         path: str | None = None
     ) -> None:
         """
-        Build `folder` attributes.
+        Build `folder` instance attributes.
 
         Parameters
         ----------
@@ -1233,7 +1233,7 @@ class RTempFile(RBase):
         type_: Literal['str', 'bytes'] = 'bytes'
     ) -> None:
         """
-        Build `temporary file` attributes.
+        Build `temporary file` instance attributes.
 
         Parameters
         ----------
@@ -1516,7 +1516,7 @@ class RTempFolder(RBase):
         dir_: str | None = None
     ) -> None:
         """
-        Build `temporary folder` attributes.
+        Build `temporary folder` instance attributes.
 
         Parameters
         ----------

reykit/rrandom.py

@@ -65,7 +65,7 @@ class RRandomSeed(RBase):
 
     def __init__(self, seed: int | float | str | bytes | bytearray | None = None) -> None:
         """
-        Build `random` attributes.
+        Build `random` instance attributes.
 
         Parameters
         ----------

reykit/rschedule.py

@@ -38,7 +38,7 @@ class RSchedule(RBase):
         block: bool = False
     ) -> None:
         """
-        Build `schedule` attributes.
+        Build `schedule` instance attributes.
 
         Parameters
         ----------

reykit/rtime.py

@@ -528,7 +528,7 @@ class RTimeMark():
 
     def __init__(self) -> None:
         """
-        Build `time mark` attributes.
+        Build `time mark` instance attributes.
         """
 
         # Record table.

{reykit-1.1.20.dist-info → reykit-1.1.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reykit
-Version: 1.1.20
+Version: 1.1.21
 Summary: Rey's kit method set.
 Project-URL: homepage, https://github.com/reyxbo/reykit/
 Author-email: Rey <reyxbo@163.com>
@@ -28,6 +28,7 @@ Requires-Dist: python-docx
 Requires-Dist: pyzbar
 Requires-Dist: qrcode
 Requires-Dist: requests
+Requires-Dist: requests-cache
 Requires-Dist: tqdm
 Requires-Dist: urwid
 Requires-Dist: varname

{reykit-1.1.20.dist-info → reykit-1.1.21.dist-info}/RECORD

@@ -1,30 +1,30 @@
 reykit/__init__.py,sha256=QwnhdUDSXgjXJQ4ClaeP9oKXUXyQOPj5sApwGCDrILc,848
 reykit/rall.py,sha256=mOFwHXZ4-BOkJ5Ptbm6lQc2zwNf_VqcqM6AYYnYPfoo,672
-reykit/rcomm.py,sha256=LgSLrpUokOgdRMYwuZj6JNvxDyvENwsiOd6ZHo67HBg,11444
-reykit/rdata.py,sha256=ZHYQhMFS8kNnAmFPIDysOUnG_SUQOveFZ018S47QIh4,9996
-reykit/remail.py,sha256=SvjGC80BojMrLoaHiVltDvpeD-S5zDsrRxU2oascl3I,6761
+reykit/rcomm.py,sha256=nFe9YKVB8BeR9PWOdjZfRX6KTSN6rp90OmS_YoUXcwM,15138
+reykit/rdata.py,sha256=Kn_YoH3Rv6yBUmnIRmyZzjwChRvUIgeyKF8hGRo2pas,10005
+reykit/remail.py,sha256=K8ueN0oP9iBJuFHYbFwyTn4AKoQm2Sf1lvmLpQYXoBQ,6770
 reykit/rexception.py,sha256=X56Ma9PtywVYAc38PmmMTlIxORYFy8Sz9e2bmm3j32M,8337
 reykit/rimage.py,sha256=VXlQFCZBjx1Mu18Au0Qmth9-u8dlIz0h8u_X100ImxA,6287
-reykit/rlog.py,sha256=8dCfDhKXZ1a534AhVx2dE9-TalZ7K5863t7ZwPzGIaU,25771
+reykit/rlog.py,sha256=LijFdEqHX_HH1FAVLPJlR_SldAPeQ1_S8DmroWOiYyU,25793
 reykit/rmonkey.py,sha256=OAlLVvMszMDzersroVC9NjbD2GPnoPgWF4AHZ3v3-fk,8232
-reykit/rmultitask.py,sha256=nhuYRI8OCB5pNuolWd1L-_ioKB7OXJAysCKVxu55UxI,23138
+reykit/rmultitask.py,sha256=IMQGP_sDquptigjdEpzf2P-wfXSESsF2yjbEEo_2NN4,23156
 reykit/rnumber.py,sha256=6x4FuRB-MTJheo6wbTUEaBarnew15jomlrneo3_Q2wg,3646
-reykit/ros.py,sha256=R5Md2IKfQ3NaVh_2KeLWNAWRBU1GOm38RUmVO5KLpVs,40704
-reykit/rrandom.py,sha256=qIq239IY9YkbJY74Gzc5ayiis_ugoS6nmAx_pD0RJKE,9237
+reykit/ros.py,sha256=udTroOHAQ0cNu7Ksepyj3iPCSj8lE42RMq02qqTzbbg,40740
+reykit/rrandom.py,sha256=4lTBL3IMhcurFeMOXaML_W7Q4xU4_HOW-si-13IrV3A,9246
 reykit/rregex.py,sha256=XTlnDLior8yyncFdrTr9FsVlBcqMXvsWRfpmvQS-BR8,6089
-reykit/rschedule.py,sha256=cdHn9F453KabFPvPeeT_WcpDSsdXPmIEgB2wMgHuKt4,5825
+reykit/rschedule.py,sha256=XkQ6xNxcJQjomNvbfTTMyo0KIbk0y3Dp0xq_HOCScJQ,5834
 reykit/rstdout.py,sha256=E6wyze9fGcR1wEatD5gIcsPF_qsJ1SG5VkKWKSns944,9927
 reykit/rsystem.py,sha256=PpzB2oppZODh5YUUDV_8Ap3eJWa2cRU9tRBcSxlTiyw,35370
 reykit/rtable.py,sha256=gXszf_9DE_5SMdNcxMX-xd4IpHGQVjGsN3NQIm7wVGY,12055
 reykit/rtext.py,sha256=whaKpVkd36yYVtCmZ1ptp_TVRL1v3f7Jab0vPXC8wXY,11089
-reykit/rtime.py,sha256=WYPmpz4ZyrqWVU0YrXAiZWLYbMZeZTX3XqTGwt-EE3g,17101
+reykit/rtime.py,sha256=1FC7JU-9t9dORUBUEzeVEvS73h7LDL9W8qTm9PZDscU,17110
 reykit/rtype.py,sha256=O7iI_sJ1Bfl_ZiP29IHqEE3v3PfJRpeA5M6ukEdZSMk,2317
 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.20.dist-info/METADATA,sha256=YkSAzXGZzT9KNE05cSvC59dKWwyRg065ZUCMHUuvw8s,1889
-reykit-1.1.20.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.1.20.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.1.20.dist-info/RECORD,,
+reykit-1.1.21.dist-info/METADATA,sha256=2BWrKZ6PCEYzHRYsJnBpZrjvJXVaTY_ieVJn--8CzF0,1919
+reykit-1.1.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.1.21.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.1.21.dist-info/RECORD,,