oafuncs 0.0.97.15__py3-none-any.whl → 0.0.97.17__py3-none-any.whl

oafuncs/oa_tool.py

@@ -1,83 +1,119 @@
-#!/usr/bin/env python
-# coding=utf-8
-"""
-Author: Liu Kun && 16031215@qq.com
-Date: 2025-04-04 20:17:42
-LastEditors: Liu Kun && 16031215@qq.com
-LastEditTime: 2025-04-04 20:17:45
-FilePath: \\Python\\My_Funcs\\OAFuncs\\oafuncs\\oa_tool.py
-Description:
-EditPlatform: vscode
-ComputerInfo: XPS 15 9510
-SystemInfo: Windows 11
-Python Version: 3.12
-"""
-from typing import Iterable
+from typing import Any, Iterable, List, Optional, Union
+
+from rich import print
 
 __all__ = ["PEx", "email", "pbar"]
 
+
 class PEx:
     """
-    PEx 封装了 ParallelExecutor，
-    并将其方法全部委托，使得直接调用 PEx 的方法能够达到与 ParallelExecutor 相同的效果。
+    PEx wraps ParallelExecutor and delegates all its methods,
+    allowing direct calls to PEx methods to achieve the same effect as ParallelExecutor.
 
-    示例:
-        # 创建 PEx 实例
+    Example:
+        # Create a PEx instance
         executor = PEx(max_workers=4)
 
-        # 使用 run 方法执行并行任务
+        # Use the run method to execute parallel tasks
         result = executor.run(lambda x: x * x, [(i,) for i in range(5)])
-        print(result)  # 输出: [0, 1, 4, 9, 16]
+        print(result)  # Output: [0, 1, 4, 9, 16]
     """
 
     try:
         from ._script.parallel import ParallelExecutor
     except ImportError:
-        raise ImportError("ParallelExecutor could not be imported. Ensure the module '_script.parallel' exists and is accessible.")
+        raise ImportError("[red]ParallelExecutor could not be imported. Ensure the module '_script.parallel' exists and is accessible.[/red]")
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
         """
-        初始化 PEx 实例，内部创建一个 ParallelExecutor 实例。
+        Initialize a PEx instance, internally creating a ParallelExecutor instance.
 
-        参数:
-            *args: 传递给 ParallelExecutor 的位置参数。
-            **kwargs: 传递给 ParallelExecutor 的关键字参数。
+        Args:
+            *args: Positional arguments passed to ParallelExecutor.
+            **kwargs: Keyword arguments passed to ParallelExecutor.
         """
         self.executor = self.ParallelExecutor(*args, **kwargs)
 
-    def __getattr__(self, attr):
+    def __getattr__(self, attr: str) -> Any:
         """
-        将所有未定义的属性访问委托给内部的 ParallelExecutor 实例。
+        Delegate all undefined attribute access to the internal ParallelExecutor instance.
 
-        参数:
-            attr (str): 要访问的属性名称。
+        Args:
+            attr (str): The name of the attribute to access.
 
-        返回:
-            对应属性的值。
+        Returns:
+            Any: The value of the corresponding attribute.
         """
         return getattr(self.executor, attr)
 
 
-def email(title="Title", content=None, send_to="16031215@qq.com"):
+def email(title: str = "Title", content: Optional[str] = None, send_to: str = "10001@qq.com") -> None:
+    """
+    Send an email using the specified title, content, and recipient.
+
+    Args:
+        title (str): The title of the email. Defaults to "Title".
+        content (Optional[str]): The content of the email. Defaults to None.
+        send_to (str): The recipient's email address. Defaults to "10001@qq.com".
+    """
     from ._script.email import send
+
+    print(f"[green]Sending email to {send_to} with title: {title}[/green]")
     send(title, content, send_to)
 
 
-def pbar(iterable: Iterable, description: str = "Working ...", color: str = "cyan", cmap: str = None, lupdate_interval: float = 0.1, bar_length: int = None, **kwargs) -> Iterable:
+def pbar(
+    iterable: Iterable = range(100),
+    description: str = "Working...",
+    total: Optional[float] = None,
+    completed: float = 0,
+    color: Any = "cyan",
+    cmap: Union[str, List[str], None] = None,
+    update_interval: float = 0.1,
+    bar_length: Optional[int] = None,
+    speed_estimate_period: float = 30.0,
+    next_line: bool = False,
+) -> Any:
     """
-    快速创建进度条的封装函数
-    :param iterable: 可迭代对象
-    :param prefix: 进度条前缀
-    :param color: 基础颜色
-    :param cmap: 渐变色名称
-    :param kwargs: 其他ColorProgressBar支持的参数
-
-    example:
-    from oafuncs.oa_data import pbar
-    from time import sleep
-    for i in pbar(range(100), prefix="Processing", color="green", cmap="viridis"):
-        sleep(0.1)
+    Convenience function to return a ColorProgressBar object.
+
+    Args:
+        iterable (Iterable): The iterable to track progress for. Defaults to range(100).
+        description (str): Description text for the progress bar. Defaults to "Working...".
+        total (Optional[float]): Total number of iterations. Defaults to None.
+        completed (float): Number of completed iterations. Defaults to 0.
+        color (Any): Color of the progress bar. Defaults to "cyan".
+        cmap (Union[str, List[str], None]): Color map for the progress bar. Defaults to None.
+        update_interval (float): Interval for updating the progress bar. Defaults to 0.1.
+        bar_length (Optional[int]): Length of the progress bar. Defaults to None.
+        speed_estimate_period (float): Period for speed estimation. Defaults to 30.0.
+        next_line (bool): Whether to move to the next line after completion. Defaults to False.
+
+    Returns:
+        Any: An instance of ColorProgressBar.
+    
+    Example:
+        >>> for i in pbar(range(10), description="Processing"):
+        ...     time.sleep(0.1)
+        >>> for i in pbar(range(10), description="Processing", color="green"):
+        ...     time.sleep(0.1)
+        >>> for i in pbar(range(10), description="Processing", cmap=["red", "green"]):
+        ...     time.sleep(0.1)
+        >>> for i in pbar(range(10), description="Processing", cmap="viridis"):
+        ...     time.sleep(0.1)
     """
     from ._script.cprogressbar import ColorProgressBar
 
-    return ColorProgressBar(iterable=iterable, description=description, color=color, cmap=cmap, update_interval=lupdate_interval, bar_length=bar_length, **kwargs)
+    print(f"[blue]{description}[/blue]")
+    return ColorProgressBar(
+        iterable=iterable,
+        description=description,
+        total=total,
+        completed=completed,
+        color=color,
+        cmap=cmap,
+        update_interval=update_interval,
+        bar_length=bar_length,
+        speed_estimate_period=speed_estimate_period,
+        next_line=next_line,
+    )

{oafuncs-0.0.97.15.dist-info → oafuncs-0.0.97.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oafuncs
-Version: 0.0.97.15
+Version: 0.0.97.17
 Summary: Oceanic and Atmospheric Functions
 Home-page: https://github.com/Industry-Pays/OAFuncs
 Author: Kun Liu

{oafuncs-0.0.97.15.dist-info → oafuncs-0.0.97.17.dist-info}/RECORD

@@ -1,28 +1,29 @@
 oafuncs/__init__.py,sha256=T_-VtnWWllV3Q91twT5Yt2sUapeA051QbPNnBxmg9nw,1456
-oafuncs/oa_cmap.py,sha256=6ggMt0ilzG_qTayIGzR57gQmViXXWYEM6S0jr1PWzNQ,6565
-oafuncs/oa_data.py,sha256=j_z4dOgugqyxc9STMTMZ0hKA46RyWgNtJeVWFaC8LPc,12141
-oafuncs/oa_date.py,sha256=MP-8eP_ASQFpHQjmB_MTSBjg46JQ1_UeLn_Ub6RSPLU,4464
-oafuncs/oa_draw.py,sha256=Lk0wMTyhPBgVNMWkbOLJFjajhYRB0Be4l7jx9ti3qUQ,8794
-oafuncs/oa_file.py,sha256=HqbB0kumd--71tMQZJUTBruNNtsGOotg77w-C7yBa0k,16524
-oafuncs/oa_help.py,sha256=loyzTbjU_0VpSIBvAEUA_tqxG8MVsO0xFE_2hgQ3zMw,4188
-oafuncs/oa_nc.py,sha256=1TIH892HmBbZKOjoW7XtP60T3lL0Tjhyq5yOWd12C1U,10423
-oafuncs/oa_python.py,sha256=tSRSFeTm4TicSzZeyUhlMWUy8rSrKGTRv4CqbrwfF64,4141
-oafuncs/oa_tool.py,sha256=8B2cyZ4l3XrWbDMkMKAlvWaiQGP_FKLKVJaqbu6G4uU,2782
+oafuncs/oa_cmap.py,sha256=DimWT4Bg7uE5Lx8hSw1REp7whpsR2pFRStAwk1cowEM,11494
+oafuncs/oa_data.py,sha256=0AbQ8_7vf9ecZaui6hmUjubkWRJxs4TGcdhJaPdbmP8,10958
+oafuncs/oa_date.py,sha256=KqU-bHtC74hYsf6VgiA3i2vI__q_toOVR-whFy4cYP8,5523
+oafuncs/oa_draw.py,sha256=9hchfs7kyBo_On1FA5jliSoAwpsjEXNUIC9C20D9ugw,15050
+oafuncs/oa_file.py,sha256=goF5iRXJFFCIKhIjlkCnYYt0EYlJb_4r8AeYNZ0-SOk,16209
+oafuncs/oa_help.py,sha256=_4AZgRDq5Or0vauNvq5IDDHIBoBfdOQtzak-mG1wwAw,4537
+oafuncs/oa_nc.py,sha256=StkcZZYo6FKANuPcq7OaIKoBKj5HuFwHsrZRVKa4ULw,10489
+oafuncs/oa_python.py,sha256=NkopwkYFGSEuVljnTBvXCl6o2CeyRNBqRXSsUl3euEE,5192
+oafuncs/oa_tool.py,sha256=8y0X3KXNLbYchr5hBHCwhdsA_1VDEnzsZVqcM5sNeog,4484
 oafuncs/_data/OAFuncs.png,sha256=y1_x-mUP3gFjcy6m8FqfvQO_HgjzPhQKfXjnSHjslZE,3436152
 oafuncs/_data/hycom_3hourly.png,sha256=azt_uPcXtl_8CSKRLLPCIf5pPrcxMiOzvoFQnwb0zUo,12411415
-oafuncs/_script/cprogressbar.py,sha256=bDIb99JqCHwIZKsrRXLfqiArTuNUuG9GyestphJM43I,15491
+oafuncs/_script/cprogressbar.py,sha256=wRU3SFPFtMI7ER26tTzg223kVKNo5RDWE9CzdIgUsuE,15771
 oafuncs/_script/email.py,sha256=lL4HGKrr524-g0xLlgs-4u7x4-u7DtgNoD9AL8XJKj4,3058
 oafuncs/_script/netcdf_merge.py,sha256=_EPF9Xj4HOVC9sZpi1lt62-Aq6pMlgsgwaajEBLhW6g,5092
-oafuncs/_script/netcdf_modify.py,sha256=kjdAOb1iy57u8nDN-eEFTti149vfhGMY-36v-b2FtII,4224
+oafuncs/_script/netcdf_modify.py,sha256=sGRUYNhfGgf9JV70rnBzw3bzuTRSXzBTL_RMDnDPeLQ,4552
 oafuncs/_script/netcdf_write.py,sha256=KZ0ui2nvTujAciLKx4bwQHLEkH1R3P8hCzd7BysJ0D4,5288
 oafuncs/_script/parallel.py,sha256=FS9FgaByq2yb9j6nL-Y0xP1VLvp4USMLBFMRsJDoqeQ,21848
 oafuncs/_script/parallel_example_usage.py,sha256=uLvE7iwkMn9Cyq6-wk5_RpbQk7PXM9d16-26lTknW9s,2646
 oafuncs/_script/plot_dataset.py,sha256=zkSEnO_-biyagorwWXPoihts_cwuvripzEt-l9bHJ2E,13989
-oafuncs/_script/replace_file_concent.py,sha256=eCFZjnZcwyRvy6b4mmIfBna-kylSZTyJRfgXd6DdCjk,5982
+oafuncs/_script/replace_file_content.py,sha256=eCFZjnZcwyRvy6b4mmIfBna-kylSZTyJRfgXd6DdCjk,5982
 oafuncs/oa_down/User_Agent-list.txt,sha256=pazxSip8_lphEBOPHG902zmIBUg8sBKXgmqp_g6j_E4,661062
 oafuncs/oa_down/__init__.py,sha256=kRX5eTUCbAiz3zTaQM1501paOYS_3fizDN4Pa0mtNUA,585
-oafuncs/oa_down/hycom_3hourly.py,sha256=YtRgz4b7MBd2VjpPU-jIyvYn-PYQDgO20jHUMdxEyi0,64471
-oafuncs/oa_down/idm.py,sha256=6eKsbGZ91_187_jJawUc6lqKRdUTse6EfUJnlaSl5mo,1903
+oafuncs/oa_down/hycom_3hourly.py,sha256=F3g14LJG3IfXO7gtH5nOVLvz68frVmtIypikZYDrc3M,52909
+oafuncs/oa_down/hycom_3hourly_20250407.py,sha256=DQd_NmQgmSqu7jsrfpDB7k23mkUEy9kyWs-dLUg7GDw,64472
+oafuncs/oa_down/idm.py,sha256=gZHyUJMyd9zgzZGksI-BuNuouK_JGjxQZniUgUFENPs,1801
 oafuncs/oa_down/literature.py,sha256=2bF9gSKQbzcci9LcKE81j8JEjIJwON7jbwQB3gDDA3E,11331
 oafuncs/oa_down/test_ua.py,sha256=0IQq3NjqfNr7KkyjS_U-a4mYu-r-E7gzawwo4IfEa6Y,10851
 oafuncs/oa_down/user_agent.py,sha256=TsPcAxFmMTYAEHRFjurI1bQBJfDhcA70MdHoUPwQmks,785
@@ -35,8 +36,8 @@ oafuncs/oa_sign/__init__.py,sha256=QKqTFrJDFK40C5uvk48GlRRbGFzO40rgkYwu6dYxatM,5
 oafuncs/oa_sign/meteorological.py,sha256=8091SHo2L8kl4dCFmmSH5NGVHDku5i5lSiLEG5DLnOQ,6489
 oafuncs/oa_sign/ocean.py,sha256=xrW-rWD7xBWsB5PuCyEwQ1Q_RDKq2KCLz-LOONHgldU,5932
 oafuncs/oa_sign/scientific.py,sha256=a4JxOBgm9vzNZKpJ_GQIQf7cokkraV5nh23HGbmTYKw,5064
-oafuncs-0.0.97.15.dist-info/licenses/LICENSE.txt,sha256=rMtLpVg8sKiSlwClfR9w_Dd_5WubTQgoOzE2PDFxzs4,1074
-oafuncs-0.0.97.15.dist-info/METADATA,sha256=x5VvCFth9kK0pT_sNmMq4xublar8wHVWkP3vJShEqdg,4226
-oafuncs-0.0.97.15.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-oafuncs-0.0.97.15.dist-info/top_level.txt,sha256=bgC35QkXbN4EmPHEveg_xGIZ5i9NNPYWqtJqaKqTPsQ,8
-oafuncs-0.0.97.15.dist-info/RECORD,,
+oafuncs-0.0.97.17.dist-info/licenses/LICENSE.txt,sha256=rMtLpVg8sKiSlwClfR9w_Dd_5WubTQgoOzE2PDFxzs4,1074
+oafuncs-0.0.97.17.dist-info/METADATA,sha256=FtLHP3YreXpw-Zz4d-jjrQYXJ3MxSr5UcSjvpGsAEi0,4226
+oafuncs-0.0.97.17.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+oafuncs-0.0.97.17.dist-info/top_level.txt,sha256=bgC35QkXbN4EmPHEveg_xGIZ5i9NNPYWqtJqaKqTPsQ,8
+oafuncs-0.0.97.17.dist-info/RECORD,,