reykit 1.2.1__py3-none-any.whl → 1.2.3__py3-none-any.whl

reykit/__init__.py

@@ -30,5 +30,4 @@ rtask : Multi task methods.
 rtext : Text methods.
 rtime : Time methods.
 rwrap : Decorators.
-rzip : File compress methods.
 """

reykit/rall.py

@@ -29,4 +29,3 @@ from .rtask import *
 from .rtext import *
 from .rtime import *
 from .rwrap import *
-from .rzip import *

reykit/rdata.py

@@ -15,6 +15,9 @@ from collections.abc import Callable, Iterable, Generator, AsyncGenerator
 from itertools import chain as IChain
 from decimal import Decimal
 from json import dumps as json_dumps
+from jwt import encode as jwt_encode, decode as jwt_decode
+from jwt.exceptions import InvalidTokenError
+from bcrypt import gensalt as bcrypt_gensalt, hashpw as bcrypt_hashpw, checkpw as bcrypt_checkpw
 
 from .rbase import T, KT, VT, Base, Null, check_least_one, check_most_one, is_iterable
 
@@ -29,7 +32,11 @@ __all__ = (
     'objs_in',
     'chain',
     'default_dict',
-    'FunctionGenerator'
+    'FunctionGenerator',
+    'encode_jwt',
+    'decode_jwt',
+    'hash_bcrypt',
+    'is_hash_bcrypt'
 )
 
 
@@ -545,3 +552,104 @@ class FunctionGenerator(Base):
         agenerator = await self.agenerator()
 
         return agenerator
+
+
+def encode_jwt(json: dict[str, Any], key: str | bytes) -> str:
+    """
+    Encode JSON data to JWT token, based on `HS256`.
+
+    Parameters
+    ----------
+    json : JSON data.
+    key : Key.
+
+    Returns
+    -------
+    Token.
+    """
+
+    # Parameter.
+    if type(key) != str:
+        key = str(key)
+    algorithm = 'HS256'
+
+    # Encode.
+    token = jwt_encode(json, key, algorithm=algorithm)
+
+    return token
+
+
+def decode_jwt(token: str | bytes, key: str| bytes) -> dict[str, Any] | None:
+    """
+    Decode JWT token to JSON data, based on `HS256`. When decode error, then return `None`.
+
+    Parameters
+    ----------
+    token : JWT token.
+    key : Key.
+
+    Returns
+    -------
+    JSON data or null.
+    """
+
+    # Parameter.
+    algorithm = 'HS256'
+
+    # Decode.
+    try:
+        json = jwt_decode(token, key, algorithms=algorithm)
+    except InvalidTokenError:
+        return
+
+    return json
+
+
+def hash_bcrypt(password: str | bytes) -> bytes:
+    """
+    Get hash password, based on algorithm `bcrypt`.
+
+    Parameters
+    ----------
+    password: Password.
+
+    Returns
+    -------
+    Hashed password.
+    """
+
+    # Parameter.
+    if type(password) != bytes:
+        password = bytes(password)
+
+    # Hash.
+    salt = bcrypt_gensalt()
+    password_hash = bcrypt_hashpw(password, salt)
+
+    return password_hash
+
+
+def is_hash_bcrypt(password: str | bytes, password_hash: str | bytes) -> bool:
+    """
+    Whether is match password and hashed password.
+
+    Parameters
+    ----------
+    password: Password.
+    password_hash : Hashed password.
+
+    Returns
+    -------
+    Judgment result.
+    """
+
+    # Parameter.
+    if type(password) != bytes:
+        password = bytes(password)
+    if type(password_hash) != bytes:
+        password_hash = bytes(password_hash)
+
+    # Judge.
+    result = bcrypt_checkpw(password, password_hash)
+
+    return result

reykit/rimage.py

@@ -212,7 +212,7 @@ def to_pil_image(source: str | bytes) -> Image:
 
 
 def generate_captcha_image(
-    text: int | str | None = None,
+    text: int | str = 5,
     path: str | None = None,
     **kwargs: Any
 ) -> bytes:
@@ -222,7 +222,6 @@ def generate_captcha_image(
     Parameters
     ----------
     text : Text, contains digits and Uppercase letters and lowercase letters.
-        - `None`: Random five characters.
         - `int`: Given length Random characters.
         - `str`: Given characters.
     path : File save path.
@@ -235,7 +234,6 @@ def generate_captcha_image(
     """
 
     # Parameter.
-    text = text or 5
     if type(text) == int:
         text = randchar(text, False)
 

reykit/ros.py

@@ -14,11 +14,12 @@ if TYPE_CHECKING:
     from _typeshed import OpenTextMode, OpenBinaryMode
 from io import TextIOBase, BufferedIOBase
 from os import (
+    getcwd as os_getcwd,
     walk as os_walk,
     listdir as os_listdir,
     makedirs as os_makedirs,
     renames as os_renames,
-    remove as os_remove
+    remove as os_remove,
 )
 from os.path import (
     join as os_join,
@@ -40,7 +41,6 @@ from pathlib import Path
 from hashlib import md5 as hashlib_md5
 from tomllib import loads as tomllib_loads
 from json import JSONDecodeError
-from filetype import guess as filetype_guess
 from tempfile import TemporaryFile, TemporaryDirectory
 
 from .rbase import Base, throw
@@ -63,6 +63,8 @@ __all__ = (
     'TempFile',
     'TempFolder',
     'FileStore',
+    'compress',
+    'decompress',
     'doc_to_docx',
     'extract_docx_content',
     'extract_pdf_content',
@@ -2105,6 +2107,97 @@ class FileStore(Base):
         return path
 
 
+def compress(
+    path: str,
+    build_dir: str | None = None,
+    overwrite: bool = True
+) -> None:
+    """
+    Compress file or folder.
+
+    Parameters
+    ----------
+    path : File or folder path.
+    build_dir : Build directory.
+        - `None`: Work directory.
+        - `str`: Use this value.
+    overwrite : Whether to overwrite.
+    """
+
+    from zipfile import ZipFile, ZIP_DEFLATED
+
+    # Parameter.
+    build_dir = Folder(build_dir).path
+    if overwrite:
+        mode = 'w'
+    else:
+        mode = 'x'
+    is_file = os_isfile(path)
+    if is_file:
+        file = File(path)
+        obj_name = file.name_suffix
+    else:
+        folder = Folder(path)
+        obj_name = folder.name
+    build_name = obj_name + '.zip'
+    build_path = join_path(build_dir, build_name)
+
+    # Compress.
+    with ZipFile(build_path, mode, ZIP_DEFLATED) as zip_file:
+
+        ## File.
+        if is_file:
+            zip_file.write(file.path, file.name_suffix)
+
+        ## Folder.
+        else:
+            dir_path_len = len(folder.path)
+            dirs = os_walk(folder.path)
+            for folder_name, sub_folders_name, files_name in dirs:
+                for sub_folder_name in sub_folders_name:
+                    sub_folder_path = join_path(folder_name, sub_folder_name)
+                    zip_path = sub_folder_path[dir_path_len:]
+                    zip_file.write(sub_folder_path, zip_path)
+                for file_name in files_name:
+                    file_path = join_path(folder_name, file_name)
+                    zip_path = file_path[dir_path_len:]
+                    zip_file.write(file_path, zip_path)
+
+
+def decompress(
+    obj_path: str,
+    build_dir: str | None = None,
+    password: str | None = None
+) -> None:
+    """
+    Decompress compressed object.
+
+    Parameters
+    ----------
+    obj_path : Compressed object path.
+    build_dir : Build directory.
+        - `None`: Work directory.
+        - `str`: Use this value.
+    passwrod : Unzip Password.
+        - `None`: No Unzip Password.
+        - `str`: Use this value.
+    """
+
+    from zipfile import ZipFile, is_zipfile
+
+    # Check object whether can be decompress.
+    is_support = is_zipfile(obj_path)
+    if not is_support:
+        raise AssertionError('file format that cannot be decompressed')
+
+    # Parameter.
+    build_dir = build_dir or os_getcwd()
+
+    # Decompress.
+    with ZipFile(obj_path) as zip_file:
+        zip_file.extractall(build_dir, pwd=password)
+
+
 def doc_to_docx(path: str, save_path: str | None = None) -> str:
     """
     Convert `DOC` file to `DOCX` file.

reykit/rrand.py

@@ -313,7 +313,7 @@ def randi(
 
 
 def randchar(
-    length: int,
+    length: int = 32,
     punctuation: bool = True
 ) -> str:
     """

{reykit-1.2.1.dist-info → reykit-1.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: reykit
-Version: 1.2.1
+Version: 1.2.3
 Summary: Kit method set.
 Project-URL: homepage, https://github.com/reyxbo/reykit/
 Author-email: Rey <reyxbo@163.com>
@@ -16,6 +16,7 @@ Keywords: kit,rey,reyxbo,tool
 Requires-Python: >=3.12
 Requires-Dist: aiohttp
 Requires-Dist: apscheduler
+Requires-Dist: bcrypt
 Requires-Dist: captcha
 Requires-Dist: concurrent-log-handler
 Requires-Dist: filetype
@@ -23,6 +24,7 @@ Requires-Dist: pandas
 Requires-Dist: pdfplumber
 Requires-Dist: pillow
 Requires-Dist: psutil
+Requires-Dist: pyjwt
 Requires-Dist: pymem
 Requires-Dist: python-docx
 Requires-Dist: pyzbar

{reykit-1.2.1.dist-info → reykit-1.2.3.dist-info}/RECORD

@@ -1,15 +1,15 @@
-reykit/__init__.py,sha256=5oKzVHvTmotJB08LhrMFQO3tFVFy7JuqXMn9PqnJEH8,779
-reykit/rall.py,sha256=-gxGRcEcK7zTcA66DgGLw46QuDsJcdda6NQA_Xuyq8w,619
+reykit/__init__.py,sha256=Garu_XWuCXSp2a8rXviXcndlDi03vtwx9IDgIYycTw0,748
+reykit/rall.py,sha256=Oljb0rwJyCrC6LhGLxpPizdB6MhxoZ9DOOnWM1sQC4o,598
 reykit/rbase.py,sha256=snRdHOMTdsaWFYDQ5sTIcdJRybNcMarlz59EErbrepA,20897
-reykit/rdata.py,sha256=j3BBeWKMIwowjC-W_5wkJxIWvVlZsqt1mYMKuQbaPG0,11323
+reykit/rdata.py,sha256=Z3_ZwWcibaFes_IRoRt_Z9hUKiricm0-vtyKxhA4Itw,13579
 reykit/remail.py,sha256=DE4sxfJEXNu6MiBJKUsWXqvBrIOJNmnm_1lnGL0tZec,6693
-reykit/rimage.py,sha256=z-cjI_MgEbUhuKgIbvDS_e2fy2CrnBhr_FS6D8XuAg0,6124
+reykit/rimage.py,sha256=yzrvZdYm9A08DjXq9nBRFti6k48o1rVJHv5-V9cnb74,6049
 reykit/rlog.py,sha256=yBArs48wl509v4q7e1vHbE3E_Bqi3VHEV-Iuw2Y58f8,25649
 reykit/rmonkey.py,sha256=PBA19EqlJHI9FxT8C4-t59RlyAfwfhX7xV9ZJ3PegWo,7894
 reykit/rnet.py,sha256=UlzkOttGxZPld8WCzbjbx-NUziPEj-n82mHH48zKBsA,17953
 reykit/rnum.py,sha256=WNtvKSS-MkgmudIqDR8Xv4WIdNLyEPIO0jz5ukL3cXg,3603
-reykit/ros.py,sha256=quDCZfqpYtZRgyK2wtscm92oPm3PaKoBqDBAaM29HV8,47714
-reykit/rrand.py,sha256=nH0e4wRiLba7Tg6pRyn7qnPrzIXdlJxm7e4S1EqsBLQ,8549
+reykit/ros.py,sha256=VEwR1Yv4mozzQRPra4t1da3e8H4b0uYX4wsbeSV__4E,50276
+reykit/rrand.py,sha256=12HD-g4gyg1jI5qnd8vd7xFsprwOXITNsprhqt3VwZU,8554
 reykit/rre.py,sha256=fVSTKa31lmeZCKhvbgRmDLA4KTLkLBgAYox-HQXs2d8,6001
 reykit/rschedule.py,sha256=H7JQbX3kVFetmGS2EZ_216NnZj-ilGl6h1MusIx8ZWk,12288
 reykit/rstdout.py,sha256=YEKP8-OcCSk8TTtChgqTkO7NSnJ5LOb77d2qiE_3vLI,8081
@@ -19,10 +19,9 @@ reykit/rtask.py,sha256=yKhsAhoMfJ99LQbKB-xc8bmP7mehC60aroK49X5N-_4,29242
 reykit/rtext.py,sha256=cf3a0uGmdr2ucKjGzYkQFkUPdixKJW1c82FPDdmRzwM,13227
 reykit/rtime.py,sha256=3UPpUK027TY1Wgf5bzwCQo1N4ZceZ2YtcZzM9I8Q9Qg,17766
 reykit/rwrap.py,sha256=lOKBhSqx8V_PcsdipPP4SaiGXXcpfaEhO_qEGSySEkw,15065
-reykit/rzip.py,sha256=vYw17toqg-DbMjvycluohU9zVX73uYYqQGAp_b21pA8,3433
 reykit/rdll/__init__.py,sha256=mewj06HHIzzW6oreQAz-6in2zYwNJ4-d1eWWL7CPQgc,685
 reykit/rdll/rdll_core.py,sha256=zBmOyxD6LkbNIadXmFHLJinj-6UFko8D6w5d7hYA7vU,5077
-reykit-1.2.1.dist-info/METADATA,sha256=B4vGbMbYqdLF4jOsZuO8Y3PUzijGQAT0aPmqpeSw17A,1880
-reykit-1.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-reykit-1.2.1.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
-reykit-1.2.1.dist-info/RECORD,,
+reykit-1.2.3.dist-info/METADATA,sha256=3Fa13n3d5_hWAhm3VfS5UlR8ili7qrEmG88L7betruI,1923
+reykit-1.2.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+reykit-1.2.3.dist-info/licenses/LICENSE,sha256=UYLPqp7BvPiH8yEZduJqmmyEl6hlM3lKrFIefiD4rvk,1059
+reykit-1.2.3.dist-info/RECORD,,

reykit/rzip.py

@@ -1,135 +0,0 @@
-# !/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-"""
-@Time    : 2023-01-19
-@Author  : Rey
-@Contact : reyxbo@163.com
-@Explain : File compress methods.
-"""
-
-
-from zipfile import ZipFile, is_zipfile, ZIP_DEFLATED
-from os import getcwd as os_getcwd, walk as os_walk
-from os.path import isfile as os_isfile
-
-from .ros import File, Folder, join_path
-
-
-__all__ = (
-    'compress',
-    'decompress',
-    'zip'
-)
-
-
-def compress(
-    path: str,
-    build_dir: str | None = None,
-    overwrite: bool = True
-) -> None:
-    """
-    Compress file or folder.
-
-    Parameters
-    ----------
-    path : File or folder path.
-    build_dir : Build directory.
-        - `None`: Work directory.
-        - `str`: Use this value.
-    overwrite : Whether to overwrite.
-    """
-
-    # Parameter.
-    build_dir = Folder(build_dir).path
-    if overwrite:
-        mode = 'w'
-    else:
-        mode = 'x'
-    is_file = os_isfile(path)
-    if is_file:
-        file = File(path)
-        obj_name = file.name_suffix
-    else:
-        folder = Folder(path)
-        obj_name = folder.name
-    build_name = obj_name + '.zip'
-    build_path = join_path(build_dir, build_name)
-
-    # Compress.
-    with ZipFile(build_path, mode, ZIP_DEFLATED) as zip_file:
-
-        ## File.
-        if is_file:
-            zip_file.write(file.path, file.name_suffix)
-
-        ## Folder.
-        else:
-            dir_path_len = len(folder.path)
-            dirs = os_walk(folder.path)
-            for folder_name, sub_folders_name, files_name in dirs:
-                for sub_folder_name in sub_folders_name:
-                    sub_folder_path = join_path(folder_name, sub_folder_name)
-                    zip_path = sub_folder_path[dir_path_len:]
-                    zip_file.write(sub_folder_path, zip_path)
-                for file_name in files_name:
-                    file_path = join_path(folder_name, file_name)
-                    zip_path = file_path[dir_path_len:]
-                    zip_file.write(file_path, zip_path)
-
-
-def decompress(
-    obj_path: str,
-    build_dir: str | None = None,
-    password: str | None = None
-) -> None:
-    """
-    Decompress compressed object.
-
-    Parameters
-    ----------
-    obj_path : Compressed object path.
-    build_dir : Build directory.
-        - `None`: Work directory.
-        - `str`: Use this value.
-    passwrod : Unzip Password.
-        - `None`: No Unzip Password.
-        - `str`: Use this value.
-    """
-
-    # Check object whether can be decompress.
-    is_support = is_zipfile(obj_path)
-    if not is_support:
-        raise AssertionError('file format that cannot be decompressed')
-
-    # Parameter.
-    build_dir = build_dir or os_getcwd()
-
-    # Decompress.
-    with ZipFile(obj_path) as zip_file:
-        zip_file.extractall(build_dir, pwd=password)
-
-
-def zip(
-    obj_path: str,
-    build_dir: str | None = None
-) -> None:
-    """
-    Automatic judge and compress or decompress object.
-
-    Parameters
-    ----------
-    obj_path : File or folder or compressed object path.
-    output_path : Build directory.
-        - `None`: Work directory.
-        - `str`: Use this value.
-    """
-
-    # Judge compress or decompress.
-    is_support = is_zipfile(obj_path)
-
-    # Execute.
-    if is_support:
-        decompress(obj_path, build_dir)
-    else:
-        compress(obj_path, build_dir)