dcc-bridge 1.0.0__py3-none-any.whl

dcc_bridge/__init__.py

@@ -0,0 +1,22 @@
+"""
+dcc-bridge: DCC Python 桥接核心包
+
+提供 DCC 端 TCP 服务端、通用 TCP 客户端、CLI 入口、DCC 适配器、
+代码执行、模块热重载、debugpy 调试集成等底层能力。
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1"
+
+from .client import DCCClient
+from .discovery import list_instances, get_instance, register_instance, unregister_instance
+
+__all__ = [
+    "__version__",
+    "DCCClient",
+    "list_instances",
+    "get_instance",
+    "register_instance",
+    "unregister_instance",
+]

dcc_bridge/__main__.py

@@ -0,0 +1,10 @@
+"""
+支持 `python -m dcc_bridge` 调用，转发到 CLI 主入口。
+"""
+
+from __future__ import annotations
+
+from dcc_bridge.cli.main import main
+
+if __name__ == "__main__":
+    main()

dcc_bridge/adapters/__init__.py

@@ -0,0 +1,27 @@
+"""
+DCC 适配器包
+
+包含各 DCC 软件的适配器实现。当前实现：
+- maya: MayaAdapter
+- max: MaxAdapter
+- painter: SubstancePainterAdapter（接口保留）
+"""
+
+from __future__ import annotations
+
+from .base import DCCAdapter, Logger
+from .maya import MayaAdapter
+from .max import MaxAdapter
+
+try:
+    from .painter import SubstancePainterAdapter
+except ImportError:
+    SubstancePainterAdapter = None  # type: ignore
+
+__all__ = [
+    "DCCAdapter",
+    "Logger",
+    "MayaAdapter",
+    "MaxAdapter",
+    "SubstancePainterAdapter",
+]

dcc_bridge/adapters/base.py

@@ -0,0 +1,126 @@
+"""
+DCC Adapter 基类
+所有 DCC Adapter 都应继承此类并实现特定逻辑
+"""
+
+from __future__ import annotations
+
+import sys
+import os
+from typing import Optional
+
+
+class Logger:
+    """通用日志类，各 DCC 可继承并覆盖"""
+
+    channel = "DCC Bridge"
+
+    @classmethod
+    def info(cls, message: str):
+        print(f"[INFO] {cls.channel}: {message}")
+
+    @classmethod
+    def warn(cls, message: str):
+        print(f"[WARN] {cls.channel}: {message}")
+
+    @classmethod
+    def error(cls, message: str):
+        print(f"[ERROR] {cls.channel}: {message}")
+
+
+class DCCAdapter:
+    """
+    DCC Adapter 基类
+
+    各 DCC 应继承此类并实现特定逻辑。
+    基类提供默认实现，确保服务端可以正常运行。
+    """
+
+    name: str = "unknown"
+    """DCC 名称，如 "maya", "3dsmax", "substance_painter" """
+
+    def get_logger(self) -> Logger:
+        """返回 DCC 特定的日志对象"""
+        return Logger
+
+    def get_python_path(self) -> str:
+        """
+        返回 DCC 的 Python 解释器路径
+
+        用于 debugpy 配置和 pip 安装。
+        默认返回 sys.executable，各 DCC 子类可覆盖此方法。
+        """
+        return sys.executable
+
+    def _on_connected(self, parent_window) -> None:
+        """
+        连接建立后的初始化回调
+
+        可用于执行 DCC 特定的初始化操作
+        """
+        logger = self.get_logger()
+        logger.info("DCC Bridge Server connected")
+
+        try:
+            try:
+                from PySide2.QtWidgets import QMessageBox
+            except ImportError:
+                from PySide6.QtWidgets import QMessageBox
+            QMessageBox.information(parent_window, "DCC Python", "DCC Bridge Server connected")
+
+        except:
+            logger.warn("PySide2/PySide6 not found, cannot show connection message box")
+
+    def add_sys_path(self, path: str) -> None:
+        """
+        将指定路径添加到 sys.path
+
+        Args:
+            path: 要添加的路径
+        """
+        if path not in sys.path:
+            sys.path.append(path)
+
+    def format_output(self, line: str) -> str:
+        """
+        可选：DCC 特定的输出格式化
+
+        Args:
+            line: 原始输出行
+
+        Returns:
+            格式化后的输出行
+        """
+        return line
+
+    def is_main_thread(self) -> bool:
+        """
+        检查当前是否在主线程中
+
+        默认返回 True（假设调用者已确保在主线程）
+
+        Returns:
+            True 如果在主线程，否则 False
+        """
+        return True
+
+    def ensure_main_thread(self) -> None:
+        """
+        确保在主线程中执行（如果需要）
+
+        默认实现不做任何操作
+        """
+        pass
+
+    def configure_debugpy(self, python_path: str) -> None:
+        """
+        配置 debugpy 的全局选项
+
+        默认调用 debugpy.configure(python=python_path)。
+        各 DCC 子类可覆盖此方法来避免特定 DCC 下的兼容性问题。
+
+        Args:
+            python_path: 用于启动子进程的 Python 解释器路径
+        """
+        import debugpy
+        debugpy.configure(python=python_path)

dcc_bridge/adapters/designer.py

@@ -0,0 +1,99 @@
+"""
+SubstanceDesigner Adapter
+实现 SubstanceDesigner 特定的日志、Python 路径和初始化逻辑
+"""
+
+from __future__ import annotations
+
+import sys
+import os
+
+from .base import DCCAdapter, Logger
+
+
+class SubstanceDesignerLogger(Logger):
+    """SubstanceDesigner 专用日志类"""
+
+    # channel = "SubstanceDesigner"
+
+    @classmethod
+    def info(cls, message: str):
+        super().info(message)
+
+    @classmethod
+    def warn(cls, message: str):
+        super().warn(message)
+
+    @classmethod
+    def error(cls, message: str):
+        super().error(message)
+
+
+class SubstanceDesignerAdapter(DCCAdapter):
+    """
+    SubstanceDesigner Adapter
+
+    实现 SubstanceDesigner 特定的逻辑，包括：
+    - 日志输出到 SubstanceDesigner 脚本编辑器
+    - Python 路径获取（python.exe）
+    - 初始化逻辑
+    """
+
+    name: str = "substance_designer"
+
+    def get_logger(self) -> Logger:
+        return SubstanceDesignerLogger
+
+    def get_python_path(self) -> str:
+        """
+        返回 SubstanceDesigner 的 Python 解释器路径（python.exe）
+
+        所有版本的SP的python解析器路径都位于根目录下的: "./plugins/pythonsdk/python.exe"
+        """
+        exe_dir = os.path.dirname(super().get_python_path())
+        exe_name = "python.exe" if sys.platform == "win32" else "python"
+        return os.path.join(exe_dir, "plugins", "pythonsdk", exe_name)
+
+    def on_connected(self) -> None:
+        try:
+            import sd
+            ctx = sd.getContext()
+            app = ctx.getSDApplication()
+            uimgr = app.getUIMgr()
+
+            # 兼容Pyside2/Pyside6 + 对应shiboken
+            try:
+                from PySide2.QtWidgets import QWidget
+                from shiboken2 import wrapInstance
+            except ImportError:
+                from PySide6.QtWidgets import QWidget
+                from shiboken6 import wrapInstance
+
+            ptr = uimgr.getMainWindowPtr()
+            parent_window = wrapInstance(int(ptr), QWidget)
+        except:
+            logger = self.get_logger()
+            logger.error("无法获取主窗口。substance_designer.ui 不可用。")
+            return
+        super()._on_connected(parent_window)
+
+    def add_sys_path(self, path: str) -> None:
+        super().add_sys_path(path)
+        logger = self.get_logger()
+        logger.info(f"Added to {self.name} sys.path: {path}")
+
+    def configure_debugpy(self, python_path: str) -> None:
+        """
+            SD 内置 Python 是打包冻结版（frozen modules），
+            debugpy 默认校验源码文件一致性，冻结内置库会触发断点失效警告，
+            两种解决思路：关闭冻结模块 / 跳过文件校验。
+
+            这里选择在脚本最顶部添加环境变量，提前关闭校验，从而屏蔽警告
+        Args:
+            python_path: 用于启动子进程的 Python 解释器路径
+        """
+        # 放在所有import最前面
+        import os
+        os.environ["PYDEVD_DISABLE_FILE_VALIDATION"] = "1"
+        import debugpy
+        debugpy.configure(python=python_path)

dcc_bridge/adapters/max.py

@@ -0,0 +1,84 @@
+"""
+3ds Max Adapter
+实现 3ds Max 特定的日志、Python 路径和初始化逻辑
+"""
+
+from __future__ import annotations
+
+import sys
+import os
+
+from .base import DCCAdapter, Logger
+
+
+class MaxLogger(Logger):
+    """3ds Max 专用日志类"""
+
+    # channel = "3ds Max"
+
+    @classmethod
+    def info(cls, message: str):
+        super().info(message)
+
+    @classmethod
+    def warn(cls, message: str):
+        super().warn(message)
+
+    @classmethod
+    def error(cls, message: str):
+        super().error(message)
+
+
+class MaxAdapter(DCCAdapter):
+    """
+    3ds Max Adapter
+
+    实现 3ds Max 特定的逻辑，包括：
+    - 日志输出到 3ds Max 脚本监听器
+    - Python 路径获取（3ds Max 自带的 Python）
+    - 初始化逻辑
+    """
+
+    name: str = "3dsmax"
+
+    def get_logger(self) -> Logger:
+        return MaxLogger
+
+    def get_python_path(self) -> str:
+        """
+        返回 3ds Max 的 Python 解释器路径
+
+        2021 及以上版本: <Max目录>\Python\python.exe
+        2020 及以下版本: <Max目录>\3dsmaxpy.exe
+        """
+        exe_dir = os.path.dirname(super().get_python_path())
+        try:
+            import pymxs
+            version = pymxs.runtime.maxVersion()
+            # 3ds Max 版本号: 2024=26000, 2023=25000, 2020=22000
+            if version[0] >= 22000:
+                return os.path.join(exe_dir, "Python", "python.exe")
+        except Exception:
+            pass
+        # 旧版本使用 3dsmaxpy.exe
+        exe_name = "3dsmaxpy.exe" if sys.platform == "win32" else "3dsmaxpy"
+        return os.path.join(exe_dir, exe_name)
+
+    def on_connected(self) -> None:
+        try:
+            import MaxPlus
+            parent_window = MaxPlus.GetQMaxMainWindow()
+        except:
+            try:
+                import qtmax
+                parent_window = qtmax.GetQMaxMainWindow()
+            except:
+                logger = self.get_logger()
+                logger.error("无法获取主窗口。MaxPlus 和 qtmax 都不可用。")
+                return
+        super()._on_connected(parent_window)
+
+    def add_sys_path(self, path: str) -> None:
+        super().add_sys_path(path)
+        logger = self.get_logger()
+        logger.info(f"Added to {self.name} sys.path: {path}")

dcc_bridge/adapters/maya.py

@@ -0,0 +1,79 @@
+"""
+Maya Adapter
+实现 Maya 特定的日志、Python 路径和初始化逻辑
+"""
+
+from __future__ import annotations
+
+import sys
+import os
+
+from .base import DCCAdapter, Logger
+
+
+class MayaLogger(Logger):
+    """Maya 专用日志类"""
+
+    # channel = "Maya"
+
+    @classmethod
+    def info(cls, message: str):
+        super().info(message)
+
+    @classmethod
+    def warn(cls, message: str):
+        super().warn(message)
+
+    @classmethod
+    def error(cls, message: str):
+        super().error(message)
+
+
+class MayaAdapter(DCCAdapter):
+    """
+    Maya Adapter
+
+    实现 Maya 特定的逻辑，包括：
+    - 日志输出到 Maya 脚本编辑器
+    - Python 路径获取（mayapy.exe，而非 maya.exe）
+    - 初始化逻辑
+    """
+
+    name: str = "maya"
+
+    def get_logger(self) -> Logger:
+        return MayaLogger
+
+    def get_python_path(self) -> str:
+        """
+        返回 Maya 的 Python 解释器路径（mayapy.exe）
+
+        Maya 中 sys.executable 是 maya.exe（主程序），
+        但 pip 和 debugpy 需要用 mayapy.exe（独立 Python 解释器）。
+        mayapy.exe 与 maya.exe 同在 bin 目录下。
+        """
+        exe_dir = os.path.dirname(super().get_python_path())
+        exe_name = "mayapy.exe" if sys.platform == "win32" else "mayapy"
+        return os.path.join(exe_dir, exe_name)
+
+    def on_connected(self) -> None:
+        try:
+            # 兼容Pyside2/Pyside6 + 对应shiboken
+            try:
+                from PySide2.QtWidgets import QWidget
+                from shiboken2 import wrapInstance
+            except ImportError:
+                from PySide6.QtWidgets import QWidget
+                from shiboken6 import wrapInstance
+            import maya.OpenMayaUI as omui
+            parent_window = wrapInstance(int(omui.MQtUtil.mainWindow()), QWidget)
+        except:
+            logger = self.get_logger()
+            logger.error("无法获取主窗口。maya.OpenMayaUI 不可用。")
+            return
+        super()._on_connected(parent_window)
+
+    def add_sys_path(self, path: str) -> None:
+        super().add_sys_path(path)
+        logger = self.get_logger()
+        logger.info(f"Added to {self.name} sys.path: {path}")

dcc_bridge/adapters/painter.py

@@ -0,0 +1,82 @@
+"""
+SubstancePainter Adapter
+实现 SubstancePainter 特定的日志、Python 路径和初始化逻辑
+"""
+
+from __future__ import annotations
+
+import sys
+import os
+
+from .base import DCCAdapter, Logger
+
+
+class SubstancePainterLogger(Logger):
+    """SubstancePainter 专用日志类"""
+
+    # channel = "SubstancePainter"
+
+    @classmethod
+    def info(cls, message: str):
+        try:
+            import substance_painter as sp
+            sp.logging.log(sp.logging.INFO, cls.channel, message)
+        except:
+            super().info(message)
+
+    @classmethod
+    def warn(cls, message: str):
+        try:
+            import substance_painter as sp
+            sp.logging.log(sp.logging.WARNING, cls.channel, message)
+        except:
+            super().warn(message)
+
+    @classmethod
+    def error(cls, message: str):
+        try:
+            import substance_painter as sp
+            sp.logging.log(sp.logging.ERROR, cls.channel, message)
+        except:
+            super().error(message)
+
+
+class SubstancePainterAdapter(DCCAdapter):
+    """
+    SubstancePainter Adapter
+
+    实现 SubstancePainter 特定的逻辑，包括：
+    - 日志输出到 SubstancePainter 脚本编辑器
+    - Python 路径获取（python.exe）
+    - 初始化逻辑
+    """
+
+    name: str = "substance_painter"
+
+    def get_logger(self) -> Logger:
+        return SubstancePainterLogger
+
+    def get_python_path(self) -> str:
+        """
+        返回 SubstancePainter 的 Python 解释器路径（python.exe）
+
+        所有版本的SP的python解析器路径都位于根目录下的: "./resources/pythonsdk/python.exe"
+        """
+        exe_dir = os.path.dirname(super().get_python_path())
+        exe_name = "python.exe" if sys.platform == "win32" else "python"
+        return os.path.join(exe_dir, "resources", "pythonsdk", exe_name)
+
+    def on_connected(self) -> None:
+        try:
+            import substance_painter.ui as sp_ui
+            parent_window = sp_ui.get_main_window()
+        except:
+            logger = self.get_logger()
+            logger.error("无法获取主窗口。substance_painter.ui 不可用。")
+            return
+        super()._on_connected(parent_window)
+
+    def add_sys_path(self, path: str) -> None:
+        super().add_sys_path(path)
+        logger = self.get_logger()
+        logger.info(f"Added to {self.name} sys.path: {path}")

dcc_bridge/cli/__init__.py

@@ -0,0 +1,10 @@
+"""
+dcc-bridge CLI 子包
+
+提供 `dcc` 命令行工具，用于：
+- 在 DCC 中执行代码/文件（dcc run）
+- 注入/移除 DCC 自启动脚本（dcc setup / unsetup）
+- 列出运行中的 DCC 实例（dcc list / status / ping）
+"""
+
+from __future__ import annotations

dcc_bridge/cli/cleanup.py

@@ -0,0 +1,114 @@
+"""
+dcc cleanup 子命令实现
+
+卸载前清理：
+1. 删除 ~/.dcc-bridge 用户数据目录（包含所有发现文件）
+2. 对所有已实现的 DCCSetup 子类执行 unsetup，移除自启动脚本
+"""
+from __future__ import annotations
+
+import importlib
+import os
+import pkgutil
+import shutil
+from typing import List, Type
+
+import click
+
+from ..discovery import get_user_data_dir
+from ..setup.base import DCCSetup
+
+
+def _discover_setup_classes() -> List[Type[DCCSetup]]:
+    """动态发现 dcc_bridge.setup 包下所有非抽象的 DCCSetup 子类"""
+    from .. import setup as setup_pkg
+
+    setup_classes: List[Type[DCCSetup]] = []
+    package_name = setup_pkg.__name__
+    package_path = setup_pkg.__path__  # type: ignore[attr-defined]
+
+    # 遍历 setup 包下的所有模块
+    for finder, module_name, is_pkg in pkgutil.iter_modules(
+        package_path, prefix=f"{package_name}."
+    ):
+        if module_name.endswith(".base") or is_pkg:
+            continue
+        try:
+            module = importlib.import_module(module_name)
+        except Exception:
+            continue
+
+        for attr_name in dir(module):
+            obj = getattr(module, attr_name)
+            if (
+                isinstance(obj, type)
+                and issubclass(obj, DCCSetup)
+                and obj is not DCCSetup
+                and getattr(obj, "dcc_type", "")
+            ):
+                setup_classes.append(obj)
+
+    return setup_classes
+
+
+@click.command(name="cleanup")
+@click.option("--yes", "-y", is_flag=True, help="Skip confirmation prompt.\n跳过确认提示。")
+@click.pass_context
+def cleanup(ctx, yes: bool) -> None:
+    """Clean up dcc-bridge data and auto-startup scripts (use before uninstall).
+
+    清理 dcc-bridge 数据与自启动脚本（卸载前使用）。
+    """
+    user_data_dir = get_user_data_dir()
+
+    # 先发现所有 setup 子类，用于确认提示
+    setup_classes = _discover_setup_classes()
+    dcc_names = [cls.dcc_type for cls in setup_classes]
+
+    if not yes:
+        click.echo("即将执行以下清理操作：")
+        click.echo(f"  1. 删除用户数据目录: {user_data_dir}")
+        if dcc_names:
+            click.echo(f"  2. 移除以下 DCC 的自启动脚本: {', '.join(dcc_names)}")
+        else:
+            click.echo("  2. 未发现可清理的 DCC 自启动脚本")
+        click.echo("")
+        if not click.confirm("确认继续？"):
+            click.echo("已取消")
+            ctx.exit(0)
+
+    # 1. 删除用户数据目录
+    if os.path.exists(user_data_dir):
+        try:
+            shutil.rmtree(user_data_dir)
+            click.echo(f"Removed user data directory: {user_data_dir}")
+        except OSError as e:
+            click.echo(f"Failed to remove user data directory: {e}", err=True)
+            ctx.exit(1)
+    else:
+        click.echo(f"User data directory not found: {user_data_dir}")
+
+    # 2. 对所有发现的 DCC 执行 unsetup
+    any_failed = False
+    for setup_cls in setup_classes:
+        dcc_type = setup_cls.dcc_type
+        try:
+            setup_instance = setup_cls()
+        except Exception as e:
+            click.echo(f"Failed to instantiate setup for {dcc_type}: {e}", err=True)
+            any_failed = True
+            continue
+
+        try:
+            success = setup_instance.unsetup()
+            if success:
+                click.echo(f"Unsetup succeeded for {dcc_type}")
+            else:
+                click.echo(f"Unsetup returned failure for {dcc_type} (may not be installed)", err=True)
+                any_failed = True
+        except Exception as e:
+            click.echo(f"Unsetup error for {dcc_type}: {e}", err=True)
+            any_failed = True
+
+    if any_failed:
+        ctx.exit(1)