ipa-python-kit 0.1.3.dev1__tar.gz → 1.0.0__tar.gz

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: ipa-python-kit
-Version: 0.1.3.dev1
+Version: 1.0.0
 Summary: kit for python
 Author-email: xdewx <present150608@sina.com>
 Keywords: python,kit,lib,util
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: deprecated>=1.3.1
 Requires-Dist: pint>=0.21.1
@@ -43,7 +43,15 @@ Requires-Dist: ipa-python-kit[visualization]; extra == "all"
 Provides-Extra: des
 Requires-Dist: simpy>=4.1.1; extra == "des"
 
-# pyproject-tmpl
+# ipa-python-kit
+
+## usage
+
+`import ipa`
+
+or
+
+`from ipa.xx import yy`
 
 ## features
 
@@ -58,16 +66,19 @@ Requires-Dist: simpy>=4.1.1; extra == "des"
 
 ## introduction
 
-the project uses `src-layout`, includes `sdk` (for publish) and `biz` (for business logic).
-`sdk` is designed for publish and no need to rename, we use file/folder mapping `mylib=src/sdk` in `pyproject.toml`.
+the project uses `src-layout`, includes `my_sdk` (for publish) and `biz` (for business logic).
+
+~~`sdk` is designed for publish and no need to rename, we use file/folder mapping `my_sdk=src/sdk` in `pyproject.toml`.~~
+
+feel free to rename `my_sdk` to `[the name you want]` in the whole project for your own use or publish.
 
 ### dev
 
 before you start:
 
 1. must run `./scripts/setup`
-1. just replace `mylib` with `[the name you want]` in the whole project
-1. remember to `uv pip install -e .[all]` to make sure `mylib` is available in development.
+1. replace `my_sdk` with `[the name you want]` in the whole project
+1. ~~remember to `uv pip install -e .[all]` to make sure `my_sdk` is available in development.~~
 
 ### unit test
 

ipa_python_kit-1.0.0/README.md

@@ -0,0 +1,55 @@
+# ipa-python-kit
+
+## usage
+
+`import ipa`
+
+or
+
+`from ipa.xx import yy`
+
+## features
+
+1. pytest
+2. pre-commit
+3. darker for code format
+4. ruff for lint
+5. commitlint for commit message format
+6. typer for cli
+7. sqlmodel for database ORM
+8. alembic for database migration
+
+## introduction
+
+the project uses `src-layout`, includes `my_sdk` (for publish) and `biz` (for business logic).
+
+~~`sdk` is designed for publish and no need to rename, we use file/folder mapping `my_sdk=src/sdk` in `pyproject.toml`.~~
+
+feel free to rename `my_sdk` to `[the name you want]` in the whole project for your own use or publish.
+
+### dev
+
+before you start:
+
+1. must run `./scripts/setup`
+1. replace `my_sdk` with `[the name you want]` in the whole project
+1. ~~remember to `uv pip install -e .[all]` to make sure `my_sdk` is available in development.~~
+
+### unit test
+
+`uv run -m pytest`
+
+### run cli
+
+`uv run main.py --help`
+
+### release sdk
+
+1. `cp .pypirc.example .pypirc`
+2. replace your token in `.pypirc`
+3. `git tag vx.y.z`
+4. `./scripts/publish`
+
+### build executable file
+
+`./scripts/build`

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/main.py

@@ -6,7 +6,7 @@ from typer import Typer
 # TODO: i don't want to add this manually, but i have no idea how to do it automatically at present
 sys.path.append(str(Path(__file__).parent / "src"))
 
-print(sys.path)
+# print(sys.path)
 
 cmd = Typer()
 
@@ -26,5 +26,12 @@ def setup_db():
     setup_database()
 
 
+@cmd.command()
+def version():
+    from ipa.version import __version__
+
+    print(__version__)
+
+
 if __name__ == "__main__":
     cmd()

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/main.spec

@@ -2,7 +2,7 @@
 
 datas=[
     ("src/conf","conf"),
-    ("src/sdk","ipa"),
+    ("src/ipa","ipa"),
     ("src/biz","biz"),
     ("alembic","alembic"),
     ("alembic.ini","."),

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/pyproject.toml

@@ -8,7 +8,7 @@ description = "kit for python"
 authors = [{ name = "xdewx", email = "present150608@sina.com" }]
 keywords = ["python", "kit", "lib", "util"]
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 
 dependencies = [
     "deprecated>=1.3.1",
@@ -26,10 +26,7 @@ hmr = ["python-hmr>=0.3.0", "watchfiles>=0.24.0"]
 date = ["python-dateutil>=2.9.0.post0"]
 websocket = ["websockets>=13.1"]
 visualization = ["matplotlib>=3.7.5", "pyecharts>=2.0.9"]
-orm = [
-    "alembic>=1.14.1",
-    "sqlmodel>=0.0.29",
-]
+orm = ["alembic>=1.14.1", "sqlmodel>=0.0.29"]
 network = ["networkx>=3.1"]
 
 all = [
@@ -75,7 +72,7 @@ local_scheme = "no-local-version"
 
 # SDK实现方式2：通过自动发现打包模块，结合sdk重命名，可以支持代码提示
 [tool.setuptools.packages]
-find = {where = ["src"], include = ["ipa"]}
+find = { where = ["src"], include = ["ipa"] }
 
 [tool.uv]
 index = [

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/ruff.toml

@@ -12,14 +12,14 @@ ignore = [
     "F401",
     "F403",
     "F405",
-    "F841",    # 未使用的变量
-    "E741",    # 变量名有歧义
+    # "F841",    # 未使用的变量
+    # "E741",    # 变量名有歧义
     "E722",    # except
     "E501",    # 行长度太长
     "E402",    # import不在顶部
     "PLR2004", # 魔法值
     "PLW1641", # 未实现hash方法
     "RUF012",  # docs必须前缀加个r
-    "PLC0415", # top level import
-    "PLR0913", # 函数参数过多
-]
+    "PLC0415", # top-level import
+    "PLR0913", # too many arguments
+]

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/biz/__init__.py

@@ -1,5 +1,7 @@
+from ipa.decorator import deprecated
 from ipa.math import add
 
 
+@deprecated("use ipa.math.add instead")
 def demo_biz_add(a: int, b: int) -> int:
     return add(a, b)

ipa_python_kit-1.0.0/src/ipa/app/__init__.py

@@ -0,0 +1,57 @@
+__doc__ = """
+配置模块
+包含一些全局配置
+"""
+
+
+import logging
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Optional
+
+
+class IAppConfig(ABC):
+    """
+    应用配置接口
+    """
+
+    @abstractmethod
+    def get_runtime_root_dir(self, *args, **kwargs) -> Optional[Path]:
+        pass
+
+    def get_root_dir(self, *args, **kwargs) -> Optional[Path]:
+        """
+        此方法只是一个别名，返回与get_runtime_root_dir相同的结果
+        """
+        return self.get_runtime_root_dir(*args, **kwargs)
+
+    # @abstractmethod
+    # def get_user_data_root_dir(self, *args, **kwargs) -> Optional[Path]:
+    #     pass
+
+    @abstractmethod
+    def get_logs_dir(self, *args, **kwargs) -> Optional[Path]:
+        pass
+
+    @abstractmethod
+    def get_config_dir(self, *args, **kwargs) -> Optional[Path]:
+        pass
+
+    @abstractmethod
+    def get_data_dir(self, *args, **kwargs) -> Optional[Path]:
+        pass
+
+    def get_temp_dir(self, *args, **kwargs) -> Optional[Path]:
+        raise NotImplementedError()
+
+    def get_middleware_dir(self, *args, **kwargs) -> Optional[Path]:
+        raise NotImplementedError()
+
+    def get_extension_dir(self, *args, **kwargs) -> Optional[Path]:
+        raise NotImplementedError()
+
+    def get_app_logger(self, *args, **kwargs) -> logging.Logger:
+        raise NotImplementedError()
+
+    def get_sidecar_dir(self, *args, **kwargs) -> Optional[Path]:
+        raise NotImplementedError()

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/data_type/unitable.py

@@ -196,15 +196,15 @@ class Time(QuantifiedValue):
     pass
 
 
-def get_time(l: Length, v: Speed):
+def get_time(length: Length, v: Speed):
     """
     距离/速度=时间
     TODO：处理单位
     """
-    assert l.value is not None, "length is not specified"
+    assert length.value is not None, "length is not specified"
     assert v.value is not None, "speed is not specified"
     assert v.value != 0, "speed cannot be zero"
-    return abs(l.value / v.value)
+    return abs(length.value / v.value)
 
 
 def get_time_3d(delta_distance: Point, v: ThreeDimensionalVelocity):

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/datetime/core.py

@@ -2,11 +2,6 @@ from datetime import datetime
 from enum import Enum
 from typing import Union
 
-try:
-    import pandas
-except ImportError:
-    pandas = None
-
 from dateutil.parser import parse
 
 
@@ -35,8 +30,13 @@ def parse_datetime(date_str: str):
     if not date_str:  # 处理空值
         return None
 
-    if pandas and isinstance(date_str, (pandas.Timestamp)):
-        return date_str.to_pydatetime()
+    try:
+        import pandas as pd
+
+        if isinstance(date_str, (pd.Timestamp)):
+            return date_str.to_pydatetime()
+    except ImportError:
+        pass
 
     if isinstance(date_str, (datetime)):
         return date_str

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/func/dict.py

@@ -2,7 +2,7 @@ __doc__ = """
 字典工具类
 """
 
-from typing import Any, Callable, Dict, Iterable, Tuple, Union
+from typing import Any, Dict, Iterable, Optional, Tuple, TypeVar, Union
 
 cn_en_dict = dict(
     半径="radius",
@@ -32,24 +32,33 @@ def remove_key_not_in(dc: dict, keys: Iterable[Any], delete_value: bool = False)
     Args:
         delete_value: 是否同时del value
     """
+    keys_removed = []
     for key in list(dc.keys()):
         if key not in keys:
             v = dc.pop(key, None)
             if delete_value and v is not None:
                 del v
+                keys_removed.append(key)
+    return keys_removed
 
 
-def get_the_first_existent_key(obj: dict, *keys, default=None) -> Tuple[Any, Any]:
+K = TypeVar("K")
+V = TypeVar("V")
+
+
+def get_the_first_existent_key(
+    obj: Dict[K, V], *keys: K, default: Optional[V] = None
+) -> Tuple[Optional[K], Optional[V]]:
     """
     获取第一个存在的key的值
 
     Args:
-        obj (dict): 输入的字典，键名可能是中文或其他形式。
-        keys (Iterable[Any]): 要查找的键名列表。
-        default (Any, optional): 如果没有找到任何键，返回的默认值。默认值为None。
+        obj (Dict[K,V]):  输入的字典，键名可能是中文或其他形式。
+        keys (Iterable[K]): 要查找的键名列表。
+        default (V, optional): 如果没有找到任何键，返回的默认值。默认值为None。
 
     Returns:
-        (Tuple[Any, Any]): 第一个存在的键值对，键为存在的键名，值为对应的值。如果没有找到任何键，返回(None, default)。
+        (Tuple[K, V]): 第一个存在的键值对，键为存在的键名，值为对应的值。如果没有找到任何键，返回(None, default)。
     """
     for key in keys:
         if key in obj:

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/network/__init__.py

@@ -1,10 +1,12 @@
 from typing import Any, Dict, List, Literal, Optional, Union
 
-from ..data_type import Point
+from ipa.data_type import Point
 
 Grid2 = List[List[Point]]
 Grid3 = List[Grid2]
 
+from ipa.func import get_the_first_existent_key
+
 
 def to_grid(
     points: List[Point], include_x=True, include_y=True, include_z=False, **kwargs
@@ -133,7 +135,20 @@ def nx_digraph_to_graph(
 
     links = []
     for u, v, attrs in G.edges(data=True):
-        links.append(opts.GraphLink(source=str(u), target=str(v)))
+        _, label = get_the_first_existent_key(attrs, "label", "name", "id")
+        links.append(
+            opts.GraphLink(
+                source=str(u),
+                target=str(v),
+                label_opts=opts.LabelOpts(
+                    is_show=False, position="middle", formatter=label, font_size=15
+                ),
+                emphasis_label_opts=opts.LabelOpts(
+                    is_show=True,
+                ),
+                linestyle_opts=opts.LineStyleOpts(),
+            )
+        )
 
     graph = (
         Graph()
@@ -143,6 +158,7 @@ def nx_digraph_to_graph(
             links=links,
             layout=layout,
             is_draggable=True,
+            edge_symbol=graph_opts.pop("edge_symbol", ["circle", "arrow"]),
             **graph_opts,
         )
         .set_global_opts(
@@ -164,6 +180,8 @@ def nx_digraph_to_tree(
     color_key: str = "color",
     default_name: str = "node",
     virtual_root_id: Optional[str] = None,
+    initial_tree_depth: int | None = None,
+    tooltip_opts=opts.TooltipOpts(trigger="item", formatter="{b}"),
 ) -> Tree:
     """
     将树状结构的 networkx.DiGraph 转换为 Pyecharts Tree 图表
@@ -196,6 +214,7 @@ def nx_digraph_to_tree(
     def build_node(current: Any) -> Dict[str, Any]:
         attrs = G.nodes.get(current, {})
         node = {
+            "nodeAttrs": attrs,
             "name": attrs.get(name_key, str(current) or default_name),
             "itemStyle": {"color": attrs[color_key]} if color_key in attrs else {},
         }
@@ -207,7 +226,7 @@ def nx_digraph_to_tree(
     tree = Tree().set_global_opts(
         # datazoom_opts=opts.DataZoomOpts(orient="vertical"),# not work
         title_opts=opts.TitleOpts(title=title),
-        tooltip_opts=opts.TooltipOpts(trigger="item", formatter="{b}"),
+        tooltip_opts=tooltip_opts,
     )
     for root in roots:
         tree_data = [build_node(root)]
@@ -221,6 +240,7 @@ def nx_digraph_to_tree(
                 vertical_align="middle",
                 horizontal_align="right",
             ),
+            initial_tree_depth=initial_tree_depth,
         )
 
     return tree

ipa_python_kit-1.0.0/src/ipa/pkg/__init__.py

@@ -0,0 +1,99 @@
+import inspect
+import logging
+from importlib import import_module
+from types import ModuleType
+from typing import Callable, List, Optional, Set, Tuple, Type, TypeVar
+
+
+def try_import(path: str):
+    """
+    支持以x.y.z的方式导入模块或模块内的属性
+    Args:
+        path: 模块路径或属性路径
+    Returns:
+        导入的模块或属性, 如果导入失败则返回None
+    """
+    try:
+        return import_module(path)
+    except ModuleNotFoundError:
+        tmps = path.split(".")
+        assert len(tmps) > 1, f"unexpected path: {path}"
+        module = try_import(".".join(tmps[0:-1]))
+        return getattr(module, tmps[-1], None)
+    except Exception as e:
+        logging.warning("failed to import %s: %s", path, e)
+        return None
+
+
+def try_import(path: str):
+    """
+    支持以x.y.z的方式导入模块或模块内的属性
+    Args:
+        path: 模块路径或属性路径
+    Returns:
+        导入的模块或属性, 如果导入失败则返回None
+    """
+    try:
+        return import_module(path)
+    except ModuleNotFoundError:
+        tmps = path.split(".")
+        assert len(tmps) > 1, f"unexpected path: {path}"
+        module = try_import(".".join(tmps[0:-1]))
+        return getattr(module, tmps[-1], None)
+    except Exception as e:
+        logging.warning("failed to import %s: %s", path, e)
+        return None
+
+
+T = TypeVar("T")
+
+
+def is_subclass_of(
+    child: Type[T], parent: Type[T], include_parent: bool = True
+) -> bool:
+    """
+    判断child是否是parent的子类
+    Args:
+        child: 子类
+        parent: 父类
+        include_parent: 父类本身是否视为子类
+    Returns:
+        是否是子类
+    """
+    if (not include_parent) and (child is parent):
+        return False
+    return inspect.isclass(child) and issubclass(child, parent)
+
+
+def collect_subclass_of(
+    parent: Type[T], _from: ModuleType, include_parent: bool = False
+):
+    """
+    收集所有子类
+    Args:
+        parent: 父类
+        _from: 模块
+        include_parent: 父类本身是否视为子类
+    Returns:
+        所有子类的(名称,类,全路径)元组
+    """
+
+    def predicate(child):
+        return is_subclass_of(child=child, parent=parent, include_parent=include_parent)
+
+    name_class_map: List[Tuple[str, T]] = inspect.getmembers(_from, predicate=predicate)
+    return name_class_map
+
+
+def get_class_full_path(cls) -> str:
+    """
+    获取类的全路径表示（模块路径.类名）
+
+    参数:
+        cls: 目标类（需传入类本身，而非实例）
+
+    返回:
+        str: 类的全路径，格式为 "模块路径.类名"
+    """
+    # __qualname__ 获取类的限定名（含嵌套关系，如 "OuterClass.InnerClass"）
+    return f"{cls.__module__}.{cls.__qualname__}"

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/pkg/hot_reload.py

@@ -2,7 +2,6 @@ import logging
 from importlib import import_module
 from typing import Callable, Optional, Set, Tuple
 
-import hmr
 from watchfiles import Change, PythonFilter, awatch
 
 
@@ -13,10 +12,13 @@ def try_hot_reload(name, package: Optional[str] = None):
         name: 模块名
         package: 包名
     """
-
     try:
         hmlib = import_module(name=name, package=package)
+        assert hmlib, f"failed to import module: {package}.{name}"
         logging.info("shall reload: %s", hmlib)
+        # TODO: exclude怎么用
+        import hmr
+
         hmr.reload(hmlib)
     except Exception as e:
         logging.warning("failed to reload: %s", e)

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/pydantic/core/__init__.py

@@ -45,6 +45,7 @@ def rename_keys_by_field_name(m: Type[BaseModel], data: dict):
         2. 如果有多个别名，以最后一个别名为准
     """
     for name, f in m.model_fields.items():
+        # TODO: 是否可能因为集合的无序性导致不一致问题
         aliases = collect_field_aliases(f)
         for alias in aliases:
             if alias in data:

ipa_python_kit-1.0.0/src/ipa/version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '1.0.0'
+__version_tuple__ = version_tuple = (1, 0, 0)
+
+__commit_id__ = commit_id = 'g33579e931'

{ipa_python_kit-0.1.3.dev1 → ipa_python_kit-1.0.0}/src/ipa/websocket/core/__init__.py

@@ -1,7 +1,6 @@
 import asyncio
-from typing import Union
+from typing import TypeAlias, Union
 
-import fastapi
 import websockets
 from websockets.asyncio.client import connect
 
@@ -11,15 +10,19 @@ try:
 except:
     from websockets import ClientConnection, ServerConnection
 
+try:
+    from fastapi import WebSocket
+except:
+    WebSocket: TypeAlias = None
 
-WebSocketConnection = Union[ServerConnection, fastapi.WebSocket, ClientConnection]
+WebSocketConnection = Union[ServerConnection, WebSocket, ClientConnection]
 
 
 def is_websocket_closed(conn: WebSocketConnection):
     """
     判断WebSocket连接是否已关闭
     """
-    if isinstance(conn, fastapi.WebSocket):
+    if isinstance(conn, WebSocket):
         from starlette.websockets import WebSocketState
 
         return conn.client_state == WebSocketState.DISCONNECTED
@@ -34,7 +37,7 @@ def is_websocket_closed(conn: WebSocketConnection):
 async def send_text(conn: WebSocketConnection, data: str):
     if isinstance(conn, ServerConnection):
         await conn.send(data)
-    elif isinstance(conn, fastapi.WebSocket):
+    elif isinstance(conn, WebSocket):
         await conn.send_text(data)
     else:
         raise NotImplementedError(
@@ -45,7 +48,7 @@ async def send_text(conn: WebSocketConnection, data: str):
 def get_close_code(conn: WebSocketConnection):
     if isinstance(conn, ServerConnection):
         return conn.close_code
-    elif isinstance(conn, fastapi.WebSocket):
+    elif isinstance(conn, WebSocket):
         return None
 
 
@@ -55,7 +58,7 @@ def parse_client_info(connection: WebSocketConnection):
     """
     if isinstance(connection, ServerConnection):
         client_ip, client_port = connection.transport.get_extra_info("peername")
-    elif isinstance(connection, fastapi.WebSocket):
+    elif isinstance(connection, WebSocket):
         client_ip, client_port = connection.client.host, connection.client.port
     else:
         client_ip, client_port = None, None