GoesSoftware.SuperSDK.Python 7.18.0

SuperSDK.Python

SuperSDK Python 进程桥接库，适用于 .NET 9 / Avalonia 桌面应用。 无需额外 Python 包（仅标准库），new GzPythonWrapper() 自动完成进程启动与连接。

内置 GzPyConsoleCtrl Avalonia 控件，一行 AXAML 即可展示实时日志、状态、心跳 —— 不需要在 ViewModel 中声明任何额外字段。

安装

dotnet add package GoesSoftware.SuperSDK.Python

就这么简单

ViewModel — 只需暴露 Wrapper 本身

using ReactiveUI;
using SuperSDK.Python;

public class MainWindowViewModel : ReactiveObject
{
    private MyWrapper? _py;
    public  MyWrapper? Py { get => _py; private set => this.RaiseAndSetIfChanged(ref _py, value); }

    // 启动
    private Task StartAsync()
    {
        if (Py != null) return Task.CompletedTask;
        Py = new MyWrapper();          // 自动启动 Python 进程
        return Task.CompletedTask;
    }

    // 释放
    private async Task ReleaseAsync()
    {
        var py = Py; Py = null;
        if (py != null) await Task.Run(() => py.Dispose());
    }
}

AXAML — 直接绑定到 Wrapper 属性

<Window xmlns="https://github.com/avaloniaui"
        xmlns:pyctrl="clr-namespace:SuperSDK.Python.Controls;assembly=SuperSDK.Python">

    
    <TextBlock Text="{Binding Py.Status,        FallbackValue=未启动}"/>
    <TextBlock Text="{Binding Py.LastHeartbeat, FallbackValue=-}"/>

    
    <pyctrl:GzPyConsoleCtrl WrapperId="{Binding Py.Id}" Height="200"/>

</Window>

就是这样。 ViewModel 不需要 PyStatus、PyHeartbeat、PyWrapperId 等任何中转属性。 GzPythonWrapper 实现了 INotifyPropertyChanged，Avalonia 绑定引擎直接感知其变化。

自定义 Wrapper（继承 GzPythonWrapper）

Python 侧（PythonScripts/my_service.py）：

from gz_sdk import rpc_method, gz_service, publish

@gz_service
class MyService:
    @rpc_method                         # ← 必须加，gz_service 只注册此装饰器标记的方法
    def process(self, params):
        req_id = params.get("__request_id")
        publish(data="处理中 50%", request_id=req_id)
        publish(data="处理完成",   request_id=req_id)

C# 侧（MyWrapper.cs）：

using SuperSDK.Python;

public class MyWrapper : GzPythonWrapper
{
    public Task<GzResult> ProcessAsync(string input)
        => CallAsync("process", new { P1 = input });
}

csproj（必须将 PythonScripts 嵌入 DLL）：

<ItemGroup>
  <EmbeddedResource Include="PythonScripts\**\*.py" />
</ItemGroup>

基类约定会在启动时沿继承链扫描各程序集的 PythonScripts/ 嵌入资源，自动解包到 Python 工作目录，无需任何 override。

结果通过 GzPythonLogMsg（level = Progress）自动送达 GzPyConsoleCtrl，无需手动处理。

事件订阅（Python → C#）

Python 调用 publish() 推送的事件，除了自动显示在 GzPyConsoleCtrl 外，也可以在 C# 中主动订阅：

// 订阅 "progress" 事件（publish() / publish_event("progress", ...) 推送）
py.Subscribe("progress", msg =>
{
    Console.WriteLine($"[{msg.RequestId}] {msg.Data}");
});

// 订阅自定义命名事件（publish_event("done", ...) 推送）
py.Subscribe("done", msg =>
{
    Console.WriteLine("任务完成！");
});

// 订阅心跳（每 10 秒由 gz_core.py 自动推送）
py.Subscribe("heartbeat", msg =>
{
    Console.WriteLine($"心跳: {msg.Data}");
});

GzEventMessage 字段：

多库继承

可以创建多层继承链，每层程序集各自在 PythonScripts/ 放脚本，运行时自动合并：

SpecialWrapper : BaseWrapper : GzPythonWrapper

启动时，ScriptSources 沿继承链向上扫描：

• 提取 SpecialWrapper 所在程序集的 PythonScripts/*.py
• 提取 BaseWrapper 所在程序集的 PythonScripts/*.py
• 基类 GzPythonWrapper 的 gz_core.py / gz_sdk.py 始终包含

三份脚本最终在同一 Python 工作目录中，相互 import 完全正常。每层程序集的 csproj 都需要声明 <EmbeddedResource Include="PythonScripts\**\*.py" />。

调用 Python 方法

var result = await py.CallAsync("process", new { P1 = "input" });

if (result.Success)
    Console.WriteLine($"请求已提交，ID: {result.RequestId}");
else
    Console.WriteLine(result.Error);

GzResult 字段：

GzPyConsoleCtrl 属性

控件无主题属性，始终跟随全局主题，调用 SuperApp.ToggleTheme() 即可，无需配置。

API 参考

实例属性与方法

可重写的虚属性

要求

• .NET 9+
• Python 3.8+（推荐 3.14，仅使用标准库，无需 pip 安装任何包）