py-applescript 项目教程

py-applescript 项目教程

py-applescript An easy-to-use Python wrapper for NSAppleScript, allowing Python scripts to communicate with AppleScripts and AppleScriptable applications. 项目地址: https://gitcode.com/gh_mirrors/py/py-applescript

1. 项目介绍

py-applescript 是一个易于使用的 Python 包装器，用于 NSAppleScript，允许 Python 脚本与 AppleScript 和 AppleScriptable 应用程序进行通信。该项目的主要特点包括：

• 支持从源代码编译或从磁盘加载脚本。
• 标准 run 处理程序和用户定义的处理程序可以带参数或不带参数调用。
• 参数和结果值自动在常见的 Python 类型和 AppleScript 类型之间转换。
• 编译后的脚本是持久的，处理程序可以多次调用，顶级属性保持其状态。
• 避免了对旧版 appscript 库、有缺陷的 Scripting Bridge 框架或有限的 osascript 可执行文件的依赖。

2. 项目快速启动

安装

要安装 py-applescript 包，请按照以下步骤操作：

1. 克隆项目仓库：

   git clone https://github.com/rdhyee/py-applescript.git
   

2. 进入项目目录并运行安装命令：

   cd py-applescript
   python setup.py install
   

使用示例

以下是一个简单的示例，展示如何使用 py-applescript 运行 AppleScript 脚本：

import applescript

# 创建一个 AppleScript 实例
script = applescript.AppleScript('say "Hello, AppleScript"')

# 运行脚本
script.run()

3. 应用案例和最佳实践

应用案例

案例1：调用 AppleScript 处理程序

假设你有一个 AppleScript 脚本，其中包含一个用户定义的处理程序 foo，你可以通过 py-applescript 调用它：

import applescript

# 创建一个 AppleScript 实例
script = applescript.AppleScript('''
on foo()
    return "foobar"
end foo
''')

# 调用用户定义的处理程序
result = script.call('foo')
print(result)  # 输出: "foobar"

案例2：传递参数并获取返回值

你可以向 AppleScript 处理程序传递参数，并获取返回值：

import applescript

# 创建一个 AppleScript 实例
script = applescript.AppleScript('''
on run(arg1, arg2)
    return arg1 & " " & arg2
end run
''')

# 调用 run 处理程序并传递参数
result = script.run('Hello', 'World')
print(result)  # 输出: "Hello World"

最佳实践

• 错误处理：在调用 AppleScript 处理程序时，始终处理可能的 ScriptError 异常。
• 持久化脚本状态：利用 AppleScript 的持久化特性，确保脚本状态在多次调用之间保持一致。
• 类型映射：了解 Python 和 AppleScript 之间的类型映射，确保传递和返回的值符合预期。

4. 典型生态项目

py-applescript 可以与其他 macOS 自动化工具和框架结合使用，例如：

• Automator：通过 Automator 工作流与 AppleScript 集成，实现复杂的自动化任务。
• JXA (JavaScript for Automation)：虽然 py-applescript 主要用于 AppleScript，但 JXA 提供了另一种自动化 macOS 的方式，两者可以结合使用。
• PyObjC：py-applescript 依赖于 PyObjC，因此可以与 PyObjC 的其他功能结合使用，进一步扩展 macOS 自动化能力。

通过这些生态项目的结合，py-applescript 可以实现更复杂的 macOS 自动化任务，满足不同场景的需求。

py-applescript An easy-to-use Python wrapper for NSAppleScript, allowing Python scripts to communicate with AppleScripts and AppleScriptable applications. 项目地址: https://gitcode.com/gh_mirrors/py/py-applescript