recurvedata-lib 0.1.487__py2.py3-none-any.whl

recurvedata/utils/date_time.py

@@ -0,0 +1,464 @@
+import datetime
+from typing import Union
+
+import croniter
+import dateutil.parser
+import pendulum
+
+from recurvedata.utils.registry import register_func
+
+_tz_utc = pendulum.timezone("utc")
+_tz_local = pendulum.local_timezone()
+
+_DATELIKE = Union[str, datetime.datetime, datetime.date, pendulum.DateTime, pendulum.Date]
+_DATE_OR_DATETIME = Union[datetime.datetime, datetime.date]
+_TZ_TYPE = Union[datetime.tzinfo, str]
+
+
+def utcnow() -> datetime.datetime:
+    """Current datetime in UTC timezone, naive format (without timezone info).
+    e.g. datetime.datetime(2022, 10, 8, 9, 52, 13, 489857)
+    """
+    return datetime.datetime.utcnow()
+
+
+def utcnow_aware() -> datetime.datetime:
+    """Current datetime in UTC timezone, aware format (with timezone info).
+    e.g. datetime.datetime(2022, 10, 8, 9, 52, 13, 489857, tzinfo=tzutc())
+    """
+    return datetime.datetime.utcnow().replace(tzinfo=_tz_utc)
+
+
+def now() -> datetime.datetime:
+    """Current datetime in local timezone, naive format (without timezone info).
+    e.g. datetime.datetime(2022, 10, 8, 17, 52, 13, 489857)
+    """
+    return datetime.datetime.now()
+
+
+def now_aware() -> datetime.datetime:
+    """Current datetime in local timezone, naive format (with timezone info).
+    e.g. datetime.datetime(2022, 10, 8, 17, 52, 13, 489857, tzinfo=tzlocal())
+    """
+    return datetime.datetime.now(tz=_tz_local)
+
+
+def _ensure_datetime(dttm: _DATELIKE) -> datetime.datetime:
+    """Convert a date-like value to a datetime.datetime object, leave the timezone info as-is
+
+    >>> _ensure_datetime('2022-09-10')
+    datetime.datetime(2022, 9, 10, 0, 0)
+    >>> _ensure_datetime('2022-09-10 08:00:00+00:00')
+    datetime.datetime(2022, 9, 10, 8, 0, tzinfo=tzutc())
+    >>> _ensure_datetime(datetime.datetime(2022, 9, 10))
+    datetime.datetime(2022, 9, 10, 0, 0)
+    >>> _ensure_datetime(pendulum.parse('2022-09-10 08:00:00+00:00'))
+    datetime.datetime(2022, 9, 10, 8, 0, tzinfo=Timezone('+00:00'))
+    """
+    if isinstance(dttm, pendulum.DateTime):
+        return datetime.datetime.fromtimestamp(dttm.timestamp(), dttm.tz)
+    if isinstance(dttm, datetime.datetime):
+        return dttm
+    if isinstance(dttm, datetime.date):
+        return datetime.datetime.combine(dttm, datetime.time.min)
+    if isinstance(dttm, str):
+        return dateutil.parser.parse(dttm)
+    raise TypeError(f"unsupported type {type(dttm)}")
+
+
+@register_func
+def to_pendulum(dttm: _DATELIKE) -> pendulum.DateTime:
+    """Convert a date-like value into pendulum.DateTime, timezone will be set to UTC by default
+
+    >>> to_pendulum('2022-09-10')
+    DateTime(2022, 9, 10, 0, 0, 0, tzinfo=Timezone('UTC'))
+    >>> to_pendulum('2022-09-10 12:12:12')
+    DateTime(2022, 9, 10, 12, 12, 12, tzinfo=Timezone('UTC'))
+    >>> to_pendulum('2022-09-10 12:12:12+08:00')
+    DateTime(2022, 9, 10, 12, 12, 12, tzinfo=Timezone('+08:00'))
+    >>> to_pendulum(datetime.datetime(2022, 9, 10))
+    DateTime(2022, 9, 10, 0, 0, 0, tzinfo=Timezone('UTC'))
+    """
+    return pendulum.instance(_ensure_datetime(dttm))
+
+
+def as_local_datetime(dt: _DATELIKE) -> datetime.datetime:
+    """Convert a date-like value into local timezone, ignore the original timezone
+
+    Note those tests only work well in timezon Asia/Shanghai
+    >>> as_local_datetime('2022-09-10')
+    datetime.datetime(2022, 9, 10, 0, 0, tzinfo=Timezone('Asia/Shanghai'))
+    >>> as_local_datetime('2022-09-10 12:12:12+08:00')
+    datetime.datetime(2022, 9, 10, 12, 12, 12, tzinfo=Timezone('Asia/Shanghai'))
+    >>> as_local_datetime(pendulum.parse('2022-09-10 08:00:00+00:00'))
+    datetime.datetime(2022, 9, 10, 8, 0, tzinfo=Timezone('Asia/Shanghai'))
+    """
+    return _ensure_datetime(dt).replace(tzinfo=_tz_local)
+
+
+def _ensure_tz(tz_or_name: _TZ_TYPE) -> datetime.tzinfo:
+    if isinstance(tz_or_name, str):
+        return pendulum.timezone(tz_or_name)
+    return tz_or_name
+
+
+def astimezone(dt: _DATELIKE, tz: Union[str, datetime.tzinfo]) -> datetime.datetime:
+    """Convert or set timezone
+
+    >>> astimezone('2022-09-10 08:00:00', 'Asia/Shanghai')
+    datetime.datetime(2022, 9, 10, 8, 0, tzinfo=Timezone('Asia/Shanghai'))
+    >>> astimezone('2022-09-10 08:00:00+08:00', 'Asia/Shanghai')
+    datetime.datetime(2022, 9, 10, 8, 0, tzinfo=Timezone('Asia/Shanghai'))
+    >>> astimezone('2022-09-10 08:00:00', 'UTC')
+    datetime.datetime(2022, 9, 10, 0, 0, tzinfo=Timezone('UTC'))
+    >>> astimezone('2022-09-10 08:00:00+00:00', 'Asia/Shanghai')
+    datetime.datetime(2022, 9, 10, 16, 0, tzinfo=Timezone('Asia/Shanghai'))
+    """
+    return _ensure_datetime(dt).astimezone(_ensure_tz(tz))
+
+
+@register_func
+def convert_tz(dt: _DATELIKE, source: _TZ_TYPE, to: _TZ_TYPE) -> datetime.datetime:
+    """Convert timezone.
+
+    >>> convert_tz('2022-09-10 08:00:00', 'Asia/Shanghai', 'UTC')
+    datetime.datetime(2022, 9, 10, 0, 0, tzinfo=Timezone('UTC'))
+    >>> convert_tz('2022-09-10 00:00:00', 'UTC', 'Asia/Shanghai')
+    datetime.datetime(2022, 9, 10, 8, 0, tzinfo=Timezone('Asia/Shanghai'))
+    >>> convert_tz('2022-09-10 00:00:00', 'Europe/Paris', 'Asia/Shanghai')
+    datetime.datetime(2022, 9, 10, 6, 0, tzinfo=Timezone('Asia/Shanghai'))
+    """
+    return _ensure_datetime(dt).replace(tzinfo=_ensure_tz(source)).astimezone(_ensure_tz(to))
+
+
+def local_to_utc(dt: _DATELIKE) -> datetime.datetime:
+    """Convert a datetime from local to utc
+
+    >>> local_to_utc('2022-09-10 08:00:00')
+    datetime.datetime(2022, 9, 10, 0, 0, tzinfo=Timezone('UTC'))
+    >>> local_to_utc('2022-09-10 08:00:00+08:00')
+    datetime.datetime(2022, 9, 10, 0, 0, tzinfo=Timezone('UTC'))
+    """
+    return convert_tz(dt, source=_tz_local, to=_tz_utc)
+
+
+def utc_to_local(dt: _DATELIKE) -> datetime.datetime:
+    """Convert a datetime from utc to local
+
+    >>> utc_to_local('2022-09-10 08:00:00')
+    datetime.datetime(2022, 9, 10, 16, 0, tzinfo=Timezone('Asia/Shanghai'))
+    >>> utc_to_local('2022-09-10 08:00:00+00:00')
+    datetime.datetime(2022, 9, 10, 16, 0, tzinfo=Timezone('Asia/Shanghai'))
+    """
+    return convert_tz(dt, source=_tz_utc, to=_tz_local)
+
+
+def truncate_second(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **second** resolution
+
+    >>> truncate_second(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 10, 8, 1, 2)
+    """
+    return truncate(dttm, "second")
+
+
+def truncate_minute(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **minute** resolution
+
+    >>> truncate_minute(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 10, 8, 1)
+    """
+    return truncate(dttm, "minute")
+
+
+def truncate_hour(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **hour** resolution
+
+    >>> truncate_hour(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 10, 8, 0)
+    """
+    return truncate(dttm, "hour")
+
+
+def truncate_day(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **date** resolution
+
+    >>> truncate_day(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 10, 0, 0)
+    """
+    return truncate(dttm, "day")
+
+
+def truncate_week(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **week** resolution, which is the first day of week (Monday)
+
+    >>> truncate_week(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 5, 0, 0)
+    """
+    dttm = truncate(dttm, "day")
+    return dttm - datetime.timedelta(days=dttm.isoweekday() - 1)
+
+
+def truncate_month(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **month** resolution, which is the first day of month
+
+    >>> truncate_month(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 1, 0, 0)
+    """
+    return truncate(dttm, "month")
+
+
+def truncate_half_month(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **half-week** resolution
+
+    >>> truncate_half_month(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 1, 0, 0)
+    >>> truncate_half_month(datetime.datetime(2022, 9, 20, 8, 1, 2, 1234))
+    datetime.datetime(2022, 9, 15, 0, 0)
+    """
+
+    dttm = truncate_day(dttm)
+    if dttm.day >= 15:
+        return dttm.replace(day=15)
+    return dttm.replace(day=1)
+
+
+def truncate_quarter(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **quater** resolution
+
+    >>> truncate_quarter(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 7, 1, 0, 0)
+    """
+    dttm = truncate(dttm, "month")
+
+    month = dttm.month
+    if 1 <= month <= 3:
+        return dttm.replace(month=1)
+    elif 4 <= month <= 6:
+        return dttm.replace(month=4)
+    elif 7 <= month <= 9:
+        return dttm.replace(month=7)
+    elif 10 <= month <= 12:
+        return dttm.replace(month=10)
+
+
+def truncate_half_year(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **half-year** resolution
+
+    >>> truncate_half_year(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 7, 1, 0, 0)
+    >>> truncate_half_year(datetime.datetime(2022, 4, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 1, 1, 0, 0)
+    """
+    dttm = truncate(dttm, "month")
+    if 1 <= dttm.month <= 6:
+        return dttm.replace(month=1)
+    return dttm.replace(month=7)
+
+
+def truncate_year(dttm: _DATELIKE) -> datetime.datetime:
+    """Truncate a datetime to **year** resolution
+
+    >>> truncate_year(datetime.datetime(2022, 9, 10, 8, 1, 2, 1234))
+    datetime.datetime(2022, 1, 1, 0, 0)
+    """
+    return truncate(dttm, "year")
+
+
+_PERIODS = {
+    "second": dict(microsecond=0),
+    "minute": dict(microsecond=0, second=0),
+    "hour": dict(microsecond=0, second=0, minute=0),
+    "day": dict(
+        microsecond=0,
+        second=0,
+        minute=0,
+        hour=0,
+    ),
+    "month": dict(microsecond=0, second=0, minute=0, hour=0, day=1),
+    "year": dict(microsecond=0, second=0, minute=0, hour=0, day=1, month=1),
+}
+_ODD_PERIODS = {"week": truncate_week, "quarter": truncate_quarter, "half_year": truncate_half_year}
+
+
+def truncate(dttm: _DATELIKE, truncate_to="day") -> datetime.datetime:
+    dttm = _ensure_datetime(dttm)
+    if truncate_to in _PERIODS:
+        return dttm.replace(**_PERIODS[truncate_to])
+
+    if truncate_to not in _ODD_PERIODS:
+        raise ValueError(
+            "truncate_to not valid. Valid periods: {}".format(
+                ", ".join(list(_PERIODS.keys()) + list(_ODD_PERIODS.keys()))
+            )
+        )
+    return _ODD_PERIODS[truncate_to](dttm)
+
+
+@register_func
+def date_add(dttm: _DATE_OR_DATETIME, days: int) -> _DATE_OR_DATETIME:
+    """Add a specified number of days to a datetime
+
+    >>> date_add(datetime.datetime(2022, 10, 8), 6)
+    datetime.datetime(2022, 10, 14, 0, 0)
+    >>> date_add(datetime.datetime(2022, 10, 8, 10), 6)
+    datetime.datetime(2022, 10, 14, 10, 0)
+    >>> date_add(datetime.datetime(2022, 10, 8), -6)
+    datetime.datetime(2022, 10, 2, 0, 0)
+    """
+    return dttm + datetime.timedelta(days=days)
+
+
+@register_func
+def month_start(dttm: _DATELIKE) -> datetime.datetime:
+    """Get the first day of month, equivalent to `truncate_month`
+
+    >>> month_start(datetime.datetime(2022, 10, 8))
+    datetime.datetime(2022, 10, 1, 0, 0)
+    """
+    return truncate_month(dttm)
+
+
+@register_func
+def month_end(dttm: _DATELIKE) -> datetime.datetime:
+    """Get the last day of month
+
+    >>> month_end(datetime.datetime(2022, 10, 8))
+    datetime.datetime(2022, 10, 31, 0, 0)
+    """
+    dt = to_pendulum(dttm).last_of("month")
+    return datetime.datetime(dt.year, dt.month, dt.day)
+
+
+def _get_last_month(dttm: _DATELIKE) -> datetime.datetime:
+    return month_start(dttm) - datetime.timedelta(days=1)
+
+
+def last_month_start(dttm: _DATELIKE) -> datetime.datetime:
+    """Get the first day of last month
+
+    >>> last_month_start(datetime.datetime(2022, 10, 8))
+    datetime.datetime(2022, 9, 1, 0, 0)
+    """
+    return month_start(_get_last_month(dttm))
+
+
+def last_month_end(dttm: _DATELIKE) -> datetime.datetime:
+    """Get the last day of last month
+
+    >>> last_month_end(datetime.datetime(2022, 10, 8))
+    datetime.datetime(2022, 9, 30, 0, 0)
+    """
+    return month_start(dttm) - datetime.timedelta(days=1)
+
+
+def _get_last_week(dttm: _DATELIKE) -> datetime.datetime:
+    return truncate_week(dttm) - datetime.timedelta(days=7)
+
+
+def last_week_start(dttm: _DATELIKE) -> datetime.datetime:
+    """Get the first day (Monday) of last week
+
+    >>> last_week_start(datetime.datetime(2022, 10, 8))
+    datetime.datetime(2022, 9, 26, 0, 0)
+    """
+    return truncate_week(dttm) - datetime.timedelta(days=7)
+
+
+def last_week_end(dttm: _DATELIKE) -> datetime.datetime:
+    """Get the first day (Sunday) of last week
+
+    >>> last_week_end(datetime.datetime(2022, 10, 8))
+    datetime.datetime(2022, 10, 2, 0, 0)
+    """
+    return truncate_week(dttm) - datetime.timedelta(days=1)
+
+
+def round_time_resolution(dt: datetime.datetime, cron_spec: str) -> datetime.datetime:
+    """Truncate a datetime value according to crontab spec, infer the time interval and return the value of `truncate_x`
+
+    >>> dt = datetime.datetime(2022, 10, 8, 10, 23, 45)
+    >>> round_time_resolution(dt, '15 * * * *')  # hourly, equivalent to `truncate_hour`
+    datetime.datetime(2022, 10, 8, 10, 0)
+    >>> round_time_resolution(dt, '0 4 * * *')  # daily, equivalent to `truncate_day`
+    datetime.datetime(2022, 10, 8, 0, 0)
+    >>> round_time_resolution(dt, '0 17 * * TUE')  # weekly, equivalent to `truncate_week`
+    datetime.datetime(2022, 10, 3, 0, 0)
+    >>> round_time_resolution(dt, '0 13 12 * *')  # monthly, equivalent to `truncate_month`
+    datetime.datetime(2022, 10, 1, 0, 0)
+    """
+    if not cron_spec or cron_spec == "@once":
+        return dt
+
+    # 这种 schedule interval 会自动处理成整点/自然日/周一/月初
+    if cron_spec in ["@hourly", "@daily", "@weekly", "@monthly"]:
+        return dt
+
+    dt = dt.replace(second=0, microsecond=0)
+
+    # 根据两个 schedule 日期的时间差来反推
+    cron = croniter.croniter(cron_spec, start_time=datetime.datetime.now())
+    prev_run = cron.get_prev(datetime.datetime)
+    next_run = cron.get_next(datetime.datetime)
+    interval = next_run - prev_run
+
+    if interval < datetime.timedelta(hours=1):
+        return dt
+
+    # 每隔 N 个小时（一天内）
+    if interval < datetime.timedelta(days=1):
+        return truncate_hour(dt)
+
+    # 每天
+    if interval == datetime.timedelta(days=1):
+        return truncate_day(dt)
+
+    # 每周
+    if interval == datetime.timedelta(days=7):
+        return truncate_week(dt)
+
+    # 每月，粗暴的把相隔天数是 28~31 当作一个月
+    if 28 <= interval.days <= 31:
+        return truncate_month(dt)
+
+    return dt
+
+
+def month_range(start_date: _DATELIKE, end_date: _DATELIKE) -> list[str]:
+    """Get the first day of all months between start_date and end_date
+
+    >>> month_range('2022-01-02', '2022-05-20')
+    ['2022-01-01', '2022-02-01', '2022-03-01', '2022-04-01', '2022-05-01']
+    """
+    start_date = to_pendulum(start_date).replace(day=1)
+    end_date = to_pendulum(end_date).replace(day=1)
+    return [x.date().isoformat() for x in pendulum.interval(start_date, end_date).range("months")]
+
+
+@register_func
+def day_range(start_date: _DATELIKE, end_date: _DATELIKE) -> list[str]:
+    """Get all dates between start_date and end_date
+
+    >>> day_range('2022-01-02', '2022-01-07')
+    ['2022-01-02', '2022-01-03', '2022-01-04', '2022-01-05', '2022-01-06', '2022-01-07']
+    """
+    start_date = to_pendulum(start_date)
+    end_date = to_pendulum(end_date)
+    return [x.date().isoformat() for x in pendulum.interval(start_date, end_date).range("days")]
+
+
+def to_local_datetime(value: str) -> datetime.datetime:
+    return astimezone(value, _tz_local)
+
+
+# exports as public
+tz_utc = _tz_utc
+tz_local = _tz_local
+ensure_datetime = _ensure_datetime
+ensure_tz = _ensure_tz
+DATELIKE = _DATELIKE
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod()

recurvedata/utils/dispatch.py

@@ -0,0 +1,114 @@
+#  Copyright 2021 Collate
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#  http://www.apache.org/licenses/LICENSE-2.0
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+"""
+Helper that implements custom dispatcher logic
+"""
+
+from functools import update_wrapper
+from types import MappingProxyType
+from typing import Any, Callable, NamedTuple, Optional, Type, TypeVar
+
+from pydantic import BaseModel
+
+T = TypeVar("T", bound=BaseModel)
+
+
+class Register(NamedTuple):
+    add: Callable
+    get: Callable
+
+
+def enum_register():
+    """
+    Helps us register custom function for enum values
+    """
+    registry = {}
+
+    def add(name: str) -> Callable:
+        def inner(fn: Callable) -> Callable:
+            registry[name] = fn
+            return fn
+
+        return inner
+
+    def get(name: str) -> Optional[Callable]:
+        return registry.get(name, None)
+
+    return Register(add, get)
+
+
+def class_register():
+    """
+    Helps us register custom functions for classes based on their name
+    """
+    registry = {}
+
+    def add(entity_type: Type[T]):
+        def inner(fn):
+            _name = entity_type.__name__
+            registry[_name] = fn
+            return fn
+
+        return inner
+
+    def get(entity_type: Type[T]) -> Optional[Callable]:
+        return registry.get(entity_type.__name__, None)
+
+    return Register(add, get)
+
+
+def valuedispatch(func) -> Callable:
+    """Value dispatch for methods and functions
+
+    Args:
+        func (_type_): function to run
+
+    Returns:
+        Callable: wrapper
+    """
+
+    registry = {}
+
+    def _is_valid_dispatch(value):
+        return isinstance(value, str)
+
+    def dispatch(value: str) -> Callable:
+        try:
+            impl = registry[value]
+        except KeyError:
+            impl = registry[object]
+        return impl
+
+    def register(value, func=None) -> Callable:
+        if _is_valid_dispatch(value):
+            if func is None:
+                return lambda f: register(value, f)
+        else:
+            raise TypeError(f"Invalid first argument to register(). {value} is not a string.")
+
+        registry[value] = func
+        return func
+
+    def wrapper(*args, **kwargs) -> Any:
+        if not args:
+            raise TypeError(f"{func_name} requires at least 1 argument")
+        if isinstance(args[0], (str, bytes)):
+            return dispatch(str(args[0]))(*args, **kwargs)
+        return dispatch(args[1])(*args, **kwargs)
+
+    func_name = getattr(func, "__name__", "method value dispatch")
+    registry[object] = func
+    wrapper.register = register
+    wrapper.dispatch = dispatch
+    wrapper.registry = MappingProxyType(registry)  # making registry read only
+    update_wrapper(wrapper, func)
+    return wrapper

recurvedata/utils/email_util.py

@@ -0,0 +1,104 @@
+import logging
+import os
+import re
+from typing import Any, Union
+
+try:
+    import emails
+except ImportError:
+    pass
+logger = logging.getLogger(__name__)
+_default_html = """<div><includetail><div style="font:Verdana normal 14px;color:#000;">
+        <div style="position:relative;"><blockquote style="margin-Top: 0px; margin-Bottom: 0px; margin-Left: 0.5em">
+        <div class="FoxDiv20190108121908737768">
+        <div id="mailContentContainer" style=" font-size: 14px; padding: 0px; height: auto; min-height: auto ; ">
+        {content}
+        </div>
+        </div></blockquote>
+        </div></div>"""
+
+
+def send_email(
+    mail_to: Union[str, list[str], tuple[str, ...]],
+    subject: str,
+    html: str = None,
+    content: str = None,
+    cc: Union[str, list[str], tuple[str, ...]] = None,
+    bcc: Union[str, list[str], tuple[str, ...]] = None,
+    files: Union[str, list[str], tuple[str, ...], dict[str, str]] = None,
+    mail_from: str = "noreply",
+    reply_to: str = None,
+    smtp_config: dict[str, Any] = None,
+) -> bool:
+    """
+    Sends an email.
+
+    Args:
+        mail_to: The recipient of the email. Example: 'e1@example.com' or ['e1@example.com', 'e2@example.com'].
+        subject: The subject of the email.
+        html: The content of the email with special requirements such as font or background color.
+        content: The content of the email in plain text format.
+        cc: The CC recipients.
+        bcc: The BCC recipients.
+        files: The list of attachments. Example:
+          '/data/tmp.txt' or ['/data/tmp_1.txt', '/data/tmp_2.txt'] or
+          {'category_data.txt':'/data/tmp_1.txt', 'brand_data.txt':'/data/tmp_2.txt'}.
+        mail_from: The displayed sender of the email. Default is 'RecurveData SERVICE'.
+        reply_to: The default recipient when replying. Default is 'itservice@recurvedata.com'.
+        smtp_config: The SMTP server for sending the email.
+
+    Returns:
+        True if the email was sent successfully, False otherwise.
+    """
+
+    if not any((html, content)):
+        raise ValueError("At least one of HTML and content is not empty！")
+
+    if isinstance(files, (list, tuple)):
+        attach_files = [(file, os.path.basename(file)) for file in files]
+    elif isinstance(files, dict):
+        attach_files = [(files[file_name], file_name) for file_name in files]
+    elif isinstance(files, str):
+        attach_files = [(files, os.path.basename(files))]
+    elif not files:
+        attach_files = []
+    else:
+        raise ValueError("The parameter files is only support list、dict or string")
+
+    for file_path, _ in attach_files:
+        if not os.path.exists(file_path):
+            raise ValueError(f"The attachment file does not exist! --- {file_path} ")
+        if os.path.isdir(file_path):
+            raise ValueError(f"Send directory are not supported, please send after compression！--- {file_path}")
+
+    if not html and content:
+        html_content = ""
+        for line in content.split("\n"):
+            line = line.replace("\t", " " * 4)
+            if line:
+                result = re.match(r"\s+", line)
+                space = result.group(0) if result else ""
+                html_content += f'<div style="margin-Left: {len(space)}em">{line.strip()}</div>'
+            else:
+                html_content += "<div><br></div>"
+        html = _default_html.format(content=html_content)
+    message = emails.Message(
+        subject=subject,
+        cc=cc,
+        bcc=bcc,
+        text="Build passed: {{ project_name }} ...",
+        mail_from=(mail_from, smtp_config.get("user")),
+        html=html,
+        headers={"reply-to": reply_to},
+    )
+
+    for file, file_name in attach_files:
+        message.attach(data=open(file, "rb"), filename=file_name)
+    response = message.send(to=mail_to, smtp=smtp_config)
+    if response.status_code == 250:
+        return True
+    logger.error(
+        f"send email from {message.mail_from} to {mail_to}, "
+        f"status_code:{response.status_code}, error_msg:{response._exc}"
+    )
+    return False