oafuncs 0.0.97.14__py3-none-any.whl → 0.0.97.16__py3-none-any.whl

oafuncs/oa_date.py

@@ -13,40 +13,39 @@ SystemInfo: Windows 11
 Python Version: 3.12
 """
 
-
-
 import calendar
 import datetime
+from typing import List, Optional
 
-__all__ = ["get_days_in_month", "generate_hour_list", "adjust_time", "timeit"]
+__all__ = ["month_days", "hour_range", "adjust_time", "timeit"]
 
 
-def get_days_in_month(year, month):
+def month_days(year: int, month: int) -> int:
     return calendar.monthrange(year, month)[1]
 
 
-def generate_hour_list(start_date, end_date, interval_hours=6):
+def hour_range(start: str, end: str, interval: int = 6) -> List[str]:
     """
     Generate a list of datetime strings with a specified interval in hours.
 
     Args:
-        start_date (str): Start date in the format "%Y%m%d%H".
-        end_date (str): End date in the format "%Y%m%d%H".
-        interval_hours (int): Interval in hours between each datetime.
+        start (str): Start date in the format "%Y%m%d%H".
+        end (str): End date in the format "%Y%m%d%H".
+        interval (int): Interval in hours between each datetime.
 
     Returns:
         list: List of datetime strings in the format "%Y%m%d%H".
     """
-    date_s = datetime.datetime.strptime(start_date, "%Y%m%d%H")
-    date_e = datetime.datetime.strptime(end_date, "%Y%m%d%H")
+    date_s = datetime.datetime.strptime(start, "%Y%m%d%H")
+    date_e = datetime.datetime.strptime(end, "%Y%m%d%H")
     date_list = []
     while date_s <= date_e:
         date_list.append(date_s.strftime("%Y%m%d%H"))
-        date_s += datetime.timedelta(hours=interval_hours)
+        date_s += datetime.timedelta(hours=interval)
     return date_list
 
 
-def adjust_time(initial_time, amount, time_unit="hours", output_format=None):
+def adjust_time(initial_time: str, amount: int, time_unit: str = "hours", output_format: Optional[str] = None) -> str:
     """
     Adjust a given initial time by adding a specified amount of time.
 
@@ -91,22 +90,37 @@ def adjust_time(initial_time, amount, time_unit="hours", output_format=None):
             default_format = "%Y%m%d"
         return time_obj.strftime(default_format)
 
+
 class timeit:
     """
     A decorator to measure the execution time of a function.
 
     Usage:
-        @timeit
+        @timeit(log=True, print_time=True)
         def my_function():
             # Function code here
+
+    Args:
+        log (bool): Whether to log the execution time to a file. Defaults to False.
+        print_time (bool): Whether to print the execution time to the console. Defaults to True.
     """
-    def __init__(self, func):
+
+    def __init__(self, func, log: bool = False, print_time: bool = True):
         self.func = func
+        self.log = log
+        self.print_time = print_time
 
     def __call__(self, *args, **kwargs):
         start_time = datetime.datetime.now()
         result = self.func(*args, **kwargs)
         end_time = datetime.datetime.now()
         elapsed_time = (end_time - start_time).total_seconds()
-        print(f"Function '{self.func.__name__}' executed in {elapsed_time:.2f} seconds.")
-        return result
+
+        if self.print_time:
+            print(f"Function '{self.func.__name__}' executed in {elapsed_time:.2f} seconds.")
+
+        if self.log:
+            with open("execution_time.log", "a") as log_file:
+                log_file.write(f"{datetime.datetime.now()} - Function '{self.func.__name__}' executed in {elapsed_time:.2f} seconds.\n")
+
+        return result

oafuncs/oa_down/hycom_3hourly.py

@@ -40,7 +40,7 @@ from oafuncs.oa_nc import modify as modify_nc
 
 warnings.filterwarnings("ignore", category=RuntimeWarning, message="Engine '.*' loading failed:.*")
 
-__all__ = ["draw_time_range", "download", "how_to_use", "get_time_list"]
+__all__ = ["draw_time_range", "download"]
 
 
 def _get_initial_data():
@@ -278,7 +278,7 @@ def draw_time_range(pic_save_folder=None):
     plt.close()
 
 
-def get_time_list(time_s, time_e, delta, interval_type="hour"):
+def _get_time_list(time_s, time_e, delta, interval_type="hour"):
     """
     Description: get a list of time strings from time_s to time_e with a specified interval
     Args:
@@ -1029,7 +1029,7 @@ def _download_hourly_func(var, time_s, time_e, lon_min=0, lon_max=359.92, lat_mi
         _prepare_url_to_download(var, lon_min, lon_max, lat_min, lat_max, ymdh_time_s, None, depth, level, store_path, dataset_name, version_name, check)
     elif int(ymdh_time_s) < int(ymdh_time_e):
         print("Downloading a series of files...")
-        time_list = get_time_list(ymdh_time_s, ymdh_time_e, interval_hour, "hour")
+        time_list = _get_time_list(ymdh_time_s, ymdh_time_e, interval_hour, "hour")
         with Progress() as progress:
             task = progress.add_task(f"[cyan]{bar_desc}", total=len(time_list))
             if ftimes == 1:
@@ -1048,7 +1048,7 @@ def _download_hourly_func(var, time_s, time_e, lon_min=0, lon_max=359.92, lat_mi
                             _done_callback(feature, progress, task, len(time_list), counter_lock)
             else:
                 # new_time_list = get_time_list(ymdh_time_s, ymdh_time_e, 3 * ftimes, "hour")
-                new_time_list = get_time_list(ymdh_time_s, ymdh_time_e, interval_hour * ftimes, "hour")
+                new_time_list = _get_time_list(ymdh_time_s, ymdh_time_e, interval_hour * ftimes, "hour")
                 total_num = len(new_time_list)
                 if num_workers is None or num_workers <= 1:
                     # 串行方式
@@ -1097,7 +1097,7 @@ def download(var, time_s, time_e=None, lon_min=0, lon_max=359.92, lat_min=-80, l
     Returns:
         None
     """
-    from oafuncs.oa_data import pbar
+    from oafuncs.oa_tool import pbar
     from oafuncs.oa_cmap import get as get_cmap
     
     _get_initial_data()
@@ -1248,55 +1248,6 @@ def download(var, time_s, time_e=None, lon_min=0, lon_max=359.92, lat_min=-80, l
     print("[bold #ecdbfe]=" * mark_len)
 
 
-def how_to_use():
-    print("""
-    # 1. Choose the dataset and version according to the time:
-    # 1.1 Use function to query
-    You can use the function check_time_in_dataset_and_version(time_input=20241101) to find the dataset and version  according to the time.
-    Then, you can see the dataset and version in the output.
-    # 1.2 Draw a picture to see
-    You can draw a picture to see the time range of each dataset and version.
-    Using the function draw_time_range(pic_save_folder=None) to draw the picture.
-
-    # 2. Get the base url according to the dataset, version, var and year:
-    # 2.1 Dataset and version were found in step 1
-    # 2.2 Var: u, v, temp, salt, ssh, u_b, v_b, temp_b, salt_b
-    # 2.3 Year: 1994-2024(current year)
-
-    # 3. Get the query_dict according to the var, lon_min, lon_max, lat_min, lat_max, depth, level_num, time_str_ymdh:
-    # 3.1 Var: u, v, temp, salt, ssh, u_b, v_b, temp_b, salt_b
-    # 3.2 Lon_min, lon_max, lat_min, lat_max: float
-    # 3.3 Depth: 0-5000m, if you wanna get single depth data, you can set the depth
-    # 3.4 Level_num: 1-40, if you wanna get single level data, you can set the level_num
-    # 3.5 Time_str_ymdh: '2024110112', the hour normally is 00, 03, 06, 09, 12, 15, 18, 21, besides 1 hourly data
-    # 3.6 Use the function to get the query_dict
-    # 3.7 Note: If you wanna get the full depth or full level data, you can needn't set the depth or level_num
-
-    # 4. Get the submit url according to the dataset, version, var, year, query_dict:
-    # 4.1 Use the function to get the submit url
-    # 4.2 You can use the submit url to download the data
-
-    # 5. Download the data according to the submit url:
-    # 5.1 Use the function to download the data
-    # 5.2 You can download the data of single time or a series of time
-    # 5.3 Note: If you wanna download a series of data, you can set the ymdh_time_s and ymdh_time_e different
-    # 5.4 Note: The time resolution is 3 hours
-
-    # 6. Direct download the data:
-    # 6.1 Use the function to direct download the data
-    # 6.2 You can set the dataset_name and version_name by yourself
-    # 6.3 Note: If you do not set the dataset_name and version_name, the dataset and version will be chosen according to the download_time
-    # 6.4 Note: If you set the dataset_name and version_name, please ensure the dataset_name and version_name are correct
-    # 6.5 Note: If you just set one of the dataset_name and version_name, both the dataset and version will be chosen according to the download_time
-
-    # 7. Simple use:
-    # 7.1 You can use the function: download(var, ymdh_time_s, ymdh_time_e, lon_min=0, lon_max=359.92, lat_min=-80, lat_max=90,  depth=None, level_num=None, store_path=None, dataset_name=None, version_name=None)
-    # 7.2 You can download the data of single time or a series of time
-    # 7.3 The parameters you must set are var, ymdh_time_s, ymdh_time_e
-    # 7.4 Example: download('u', '2024110112', '2024110212', lon_min=0, lon_max=359.92, lat_min=-80, lat_max=90,  depth=None, level_num=None, store_path=None, dataset_name=None, version_name=None)
-    """)
-
-
 if __name__ == "__main__":
     download_dict = {
         "water_u": {"simple_name": "u", "download": 1},

oafuncs/oa_draw.py

@@ -13,7 +13,6 @@ SystemInfo: Windows 11
 Python Version: 3.11
 """
 
-
 import warnings
 
 import cartopy.crs as ccrs
@@ -21,16 +20,15 @@ import cartopy.feature as cfeature
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 import numpy as np
-import xarray as xr
 from cartopy.mpl.ticker import LatitudeFormatter, LongitudeFormatter
 from rich import print
 
-__all__ = ["fig_minus", "gif", "add_cartopy", "add_gridlines", "MidpointNormalize", "add_lonlat_unit", "contour", "contourf", "quiver"]
+__all__ = ["fig_minus", "gif", "add_cartopy", "add_gridlines", "MidpointNormalize", "add_lonlat_unit"]
 
 warnings.filterwarnings("ignore")
 
 
-def fig_minus(ax_x=None, ax_y=None, cbar=None, decimal=None, add_space=False):
+def fig_minus(ax_x: plt.Axes = None, ax_y: plt.Axes = None, cbar: mpl.colorbar.Colorbar = None, decimal: int = None, add_space: bool = False) -> plt.Axes | mpl.colorbar.Colorbar | None:
     """
     Description: 将坐标轴刻度中的负号替换为减号
 
@@ -76,7 +74,7 @@ def fig_minus(ax_x=None, ax_y=None, cbar=None, decimal=None, add_space=False):
 
 
 # ** 将生成图片/已有图片制作成动图
-def gif(image_list: list, gif_name: str, duration=200, resize=None):  # 制作动图，默认间隔0.2
+def gif(image_list: list[str], gif_name: str, duration: float = 200, resize: tuple[int, int] = None) -> None:  # 制作动图，默认间隔0.2
     """
     Description
         Make gif from images
@@ -125,7 +123,7 @@ def gif(image_list: list, gif_name: str, duration=200, resize=None):  # 制作
 
 
 # ** 转化经/纬度刻度
-def add_lonlat_unit(lon=None, lat=None, decimal=2):
+def add_lonlat_unit(lon: list[float] = None, lat: list[float] = None, decimal: int = 2) -> tuple[list[str], list[str]] | list[str]:
     """
     param        {*} lon : 经度列表
     param        {*} lat : 纬度列表
@@ -165,15 +163,16 @@ def add_lonlat_unit(lon=None, lat=None, decimal=2):
 
 
 # ** 添加网格线
-def add_gridlines(ax, xline=None, yline=None, projection=ccrs.PlateCarree(), color="k", alpha=0.5, linestyle="--", linewidth=0.5):
+def add_gridlines(ax: plt.Axes, xline: list[float] = None, yline: list[float] = None, projection: ccrs.Projection = ccrs.PlateCarree(), color: str = "k", alpha: float = 0.5, linestyle: str = "--", linewidth: float = 0.5) -> tuple[plt.Axes, mpl.ticker.Locator]:
     from matplotlib import ticker as mticker
+
     # add gridlines
     gl = ax.gridlines(crs=projection, draw_labels=True, linewidth=linewidth, color=color, alpha=alpha, linestyle=linestyle)
     gl.right_labels = False
     gl.top_labels = False
     gl.xformatter = LongitudeFormatter(zero_direction_label=False)
     gl.yformatter = LatitudeFormatter()
-    
+
     if xline is not None:
         gl.xlocator = mticker.FixedLocator(np.array(xline))
     if yline is not None:
@@ -183,7 +182,7 @@ def add_gridlines(ax, xline=None, yline=None, projection=ccrs.PlateCarree(), col
 
 
 # ** 添加地图
-def add_cartopy(ax, lon=None, lat=None, projection=ccrs.PlateCarree(), gridlines=True, landcolor="lightgrey", oceancolor="lightblue", cartopy_linewidth=0.5):
+def add_cartopy(ax: plt.Axes, lon: np.ndarray = None, lat: np.ndarray = None, projection: ccrs.Projection = ccrs.PlateCarree(), gridlines: bool = True, landcolor: str = "lightgrey", oceancolor: str = "lightblue", cartopy_linewidth: float = 0.5) -> None:
     # add coastlines
     ax.add_feature(cfeature.LAND, facecolor=landcolor)
     ax.add_feature(cfeature.OCEAN, facecolor=oceancolor)
@@ -219,139 +218,19 @@ class MidpointNormalize(mpl.colors.Normalize):
     nrom = MidpointNormalize(vmin=-2, vmax=1, vcenter=0)
     """
 
-    def __init__(self, vmin=None, vmax=None, vcenter=None, clip=False):
+    def __init__(self, vmin: float = None, vmax: float = None, vcenter: float = None, clip: bool = False) -> None:
         self.vcenter = vcenter
         super().__init__(vmin, vmax, clip)
 
-    def __call__(self, value, clip=None):
+    def __call__(self, value: np.ndarray, clip: bool = None) -> np.ma.MaskedArray:
         x, y = [self.vmin, self.vcenter, self.vmax], [0, 0.5, 1.0]
         return np.ma.masked_array(np.interp(value, x, y, left=-np.inf, right=np.inf))
 
-    def inverse(self, value):
+    def inverse(self, value: np.ndarray) -> np.ndarray:
         y, x = [self.vmin, self.vcenter, self.vmax], [0, 0.5, 1]
         return np.interp(value, x, y, left=-np.inf, right=np.inf)
 
 
-# -----------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-# ** 绘制填色图
-def contourf(data,x=None,y=None,cmap='coolwarm',show=True,store=None,cartopy=False):
-    """
-    Description: 绘制填色图
-
-    param {*} data : 二维数据
-    param {*} x : x轴坐标
-    param {*} y : y轴坐标
-    param {*} cmap : 颜色映射
-    param {*} show : 是否显示
-    param {*} store : 是否保存
-    param {*} cartopy : 是否使用cartopy
-
-    return {*}
-    """
-    data = np.array(data)
-    if x is None or y is None:
-        x = np.arange(data.shape[1])
-        y = np.arange(data.shape[0])
-    if cartopy:
-        fig, ax = plt.subplots(subplot_kw={'projection': ccrs.PlateCarree()})
-        add_cartopy(ax, lon=x, lat=y)
-        ax.contourf(x, y, data, transform=ccrs.PlateCarree(), cmap=cmap)
-    else:
-        plt.contourf(x, y, data, cmap=cmap)
-    plt.colorbar()
-    plt.savefig(store, dpi=600, bbox_inches="tight") if store else plt.show()
-    plt.close()
-
-
-# ** 绘制等值线图
-def contour(data, x=None, y=None, cmap="coolwarm", show=True, store=None, cartopy=False):
-    """
-    Description: 绘制等值线图
-
-    param {*} data : 二维数据
-    param {*} x : x轴坐标
-    param {*} y : y轴坐标
-    param {*} cmap : 颜色映射
-    param {*} show : 是否显示
-    param {*} store : 是否保存
-    param {*} cartopy : 是否使用cartopy
-
-    return {*}
-    """
-    data = np.array(data)
-    if x is None or y is None:
-        x = np.arange(data.shape[1])
-        y = np.arange(data.shape[0])
-    if cartopy:
-        fig, ax = plt.subplots(subplot_kw={"projection": ccrs.PlateCarree()})
-        add_cartopy(ax, lon=x, lat=y)
-        cr = ax.contour(x, y, data, transform=ccrs.PlateCarree(), cmap=cmap)
-    else:
-        cr = plt.contour(x, y, data, cmap=cmap)
-    plt.clabel(cr, inline=True, fontsize=10)
-    plt.savefig(store, dpi=600, bbox_inches="tight") if store else plt.show()
-    plt.close()
-
-
-# ** 绘制矢量场
-def quiver(u, v, lon, lat, picname=None, cmap="coolwarm", scale=0.25, width=0.002, x_space=5, y_space=5):
-    """
-    param        {*} u : 二维数据
-    param        {*} v : 二维数据
-    param        {*} lon : 经度, 1D or 2D
-    param        {*} lat : 纬度, 1D or 2D
-    param        {*} picname : 图片保存的文件名(含路径)
-    param        {*} cmap : 颜色映射，默认coolwarm
-    param        {*} scale : 箭头的大小 / 缩小程度
-    param        {*} width : 箭头的宽度
-    param        {*} x_space : x轴间隔
-    param        {*} y_space : y轴间隔
-    return       {*} 无返回值
-    """
-    # 创建新的网格位置变量(lat_c, lon_c)
-    if len(lon.shape) == 1 and len(lat.shape) == 1:
-        lon_c, lat_c = np.meshgrid(lon, lat)
-    else:
-        lon_c, lat_c = lon, lat
-
-    # 设置箭头的比例、颜色、宽度等参数
-    # scale = 0.25  # 箭头的大小 / 缩小程度
-    # color = '#E5D1FA'
-    # width = 0.002  # 箭头的宽度
-    # x_space = 1
-    # y_space = 1
-
-    # 计算矢量的大小
-    S = xr.DataArray(np.hypot(np.array(u), np.array(v)))
-
-    mean_S = S.nanmean()
-
-    # 使用 plt.quiver 函数绘制矢量图
-    # 通过设置 quiver 函数的 pivot 参数来指定箭头的位置
-    quiver_plot = plt.quiver(
-        lon_c[::y_space, ::x_space],
-        lat_c[::y_space, ::x_space],
-        u[::y_space, ::x_space],
-        v[::y_space, ::x_space],
-        S[::y_space, ::x_space],  # 矢量的大小，可以不要
-        pivot="middle",
-        scale=scale,
-        #  color=color, # 矢量的颜色，单色
-        cmap=cmap,  # 矢量的颜色，多色
-        width=width,
-    )
-    # plt.quiverkey(quiver_plot, X=0.90, Y=0.975, U=1, label='1 m/s', labelpos='E', fontproperties={'size': 10})
-    plt.quiverkey(quiver_plot, X=0.87, Y=0.975, U=mean_S, label=f"{mean_S:.2f} m/s", labelpos="E", fontproperties={"size": 10})
-    plt.colorbar(quiver_plot)
-    plt.xlabel("X")
-    plt.ylabel("Y")
-
-    plt.savefig(picname, bbox_inches="tight") if picname is not None else plt.show()
-    plt.clf()
-    plt.close()
-
-
 
 if __name__ == "__main__":
     pass

oafuncs/oa_file.py

@@ -21,7 +21,7 @@ import shutil
 
 from rich import print
 
-__all__ = ["find_file", "link_file", "copy_file", "rename_file", "make_folder", "clear_folder", "remove_empty_folder", "remove", "file_size", "mean_size", "make_dir", "replace_content", "move_file"]
+__all__ = ["find_file", "link_file", "copy_file", "rename_file", "move_file", "clear_folder", "remove_empty_folder", "remove", "file_size", "mean_size", "make_dir", "replace_content"]
 
 
 # ** 查找文件，支持通配符
@@ -157,7 +157,6 @@ def copy_file(src_pattern, dst):
         print(f"Copy and rename file or directory: {src_file} -> {dst_file}")
 
 
-
 # ** 移动文件或目录，支持通配符
 def move_file(src_pattern, dst):
     """
@@ -205,7 +204,6 @@ def move_file(src_pattern, dst):
         print(f"Move and rename file or directory: {src_file} -> {dst_file}")
 
 
-
 # ** 重命名文件，支持通配符
 def rename_file(directory, old_str, new_str):
     """
@@ -243,26 +241,6 @@ def rename_file(directory, old_str, new_str):
             print(f"Rename file: {old_path} -> {new_path}")
 
 
-# ** 创建子文件夹（可选清空）
-def make_folder(rootpath=None, folder_name=None, clear=False) -> str:
-    """
-    # 描述：创建子文件夹（可选清空）
-    # 使用示例
-    rootpath = r'E:\\Data\\2024\\09\\17'
-    folder_name = 'var1'
-    newpath = make_folder(rootpath, folder_name, clear=1)
-    param       {*} rootpath # 根目录
-    param       {*} folder_name # 文件夹名称
-    """
-    if rootpath is None:
-        rootpath = os.getcwd()
-    folder_path = os.path.join(str(rootpath), str(folder_name))
-    if clear:
-        shutil.rmtree(folder_path, ignore_errors=True)
-    os.makedirs(folder_path, exist_ok=True)
-    return folder_path
-
-
 # ** 创建路径
 def make_dir(directory):
     """