实现代码

实现代码接收已解析的语法，然后执行所请求的操作。 代码 (无论是以 Python， R 还是 Java 编写) 必须包含名为 Run 的函数，该函数具有接受已解析语法的单个自变量。

下面的代码样本中显示了示例 MYORG GETURL EXCEL 扩展命令的 Python 模块的内容 (在上一节中进行了讨论)。 该代码包含 spssaux 和 extension Python 模块的 import 语句，这些模块由代码使用，并随 SPSS® Statistics一起安装。 根据以下内容中描述的命名约定的要求， Python 模块本身必须命名为 MYORG_GETURL_EXCEL.py。

该模块包含两个函数: Run 和 geturlexcel。 Run 函数采用已解析的语法，对其进行验证，抽取关键字的值，然后调用 geturlexcel 以实现所请求的操作。 将实现代码分为 Run 函数 (用于处理提交的语法) 和主实现函数 (用于执行请求的操作) 是 IBM® SPSS创建的所有扩展命令的常规功能。

import spssaux
from extension import Template, Syntax, processcmd
         
def Run(args):
    oobj = Syntax([
        Template("URL", subc="",  ktype="literal", var="url", islist=True),
        Template("FILETYPE", subc="OPTIONS", ktype="str", var="filetype", vallist=["xls","xlsx"]),
        Template("SHEETNUMBER", subc="OPTIONS", ktype="int", var="sheetnumber"),
        Template("READNAMES", subc="OPTIONS", ktype="str", var="readnames", vallist=["on","off"])])
    args = args[args.keys()[0]]
    processcmd(oobj, args, geturlexcel)

def geturlexcel(url, filetype="xls", sheetnumber=1, readnames="ON"):
    kwargs = {}
    url = "".join(url)
    kwargs["filetype"] = filetype
    kwargs["sheetid"] = sheetnumber 
    kwargs["readnames"] = readnames
    spssaux.openDataFileFromUrl(url, **kwargs)

Run 函数使用 Template 类， Syntax 类和 processcmd 函数。 这些函数设计为一起使用，并极大地简化了使用解析语法 (包含在 Run 函数的 args 参数中) 的任务。

• Template 类指定如何处理扩展命令的语法中的特定关键字。 每个子命令的每个关键字都必须具有 Template 类的关联实例。
  • Template 类构造函数的第一个自变量是关键字的名称。
  • 自变量 subc 指定包含关键字的子命令的名称。 如果该关键字属于匿名子命令，那么可以省略自变量 subc 或将其设置为空字符串，如此处针对 URL 关键字所示。
  • 自变量 ktype 指定关键字的类型，例如关键字是指定变量名，字符串还是浮点数。
  • 自变量 var 指定实现函数 (在此示例中为geturlexcel ) 的自变量的名称，该实现函数接收为关键字指定的值。
  • 用于 FILETYPE 和 READNAMES的自变量 vallist指定关键字的允许值列表。 对于在 Template 构造函数中指定为 ktype="str" 的关键字，在验证之前会将该关键字的已提交值转换为小写，因此允许的值列表以小写形式指定。
• Syntax 类验证 Template 对象指定的语法。 类是使用一个或多个 Template 对象的序列进行实例化的，如本示例中所示。
• processcmd 函数从提交的语法中抽取关键字的值，然后调用实现函数以执行所请求的操作。
  • processcmd 函数的第一个自变量是命令的 Syntax 对象。
  • 对于 Python，解析的语法将传递到具有单个顶级条目的复杂嵌套 Python 字典中的 Run 函数。 processcmd 的第二个自变量是此顶级条目，由表达式 args[args.keys()[0]]提供。
  • processcmd 的第三个自变量是实现函数的名称。 Template 对象指定的关键字值将作为一组关键字参数传递到实现函数。 在此示例中，将使用以下特征符来调用实现函数 geturlexcel :

    
    geturlexcel(URL=<URL>,filetype=<FILETYPE>,sheetnumber=<SHEETNUMBER>,readnames=<READNAMES>)
    

    其中 URL 是为 URL 关键字指定的值，其他关键字也是如此。

    注：

    • 如果在实现函数中发生 Python 异常，那么将禁止 Python 回溯，但会显示错误消息。 要显示回溯，请将 SPSS_EXTENSIONS_RAISE 环境变量设置为 "true"。
    • 如果实现函数的特征符没有参数的缺省值，那么如果提交的语法不包含参数的值，那么将发生错误。

geturlexcel 函数接收为所提交语法中的关键字指定的值，然后打开所请求的 Excel 文件。 该函数从随 SPSS Statistics一起安装的 spssaux 模块调用 openDataFileFromUrl 函数以打开该文件。

随 SPSS Statistics一起安装的 extension 模块提供了 Template 类， Syntax 类和 processcmd 函数的帮助。 您可以在导入 extension 模块后从 help(extension) 访问帮助。