API文档

本文档包含用于FME对象python api的api（应用程序编程接口）文档。项目定义的pythonobjects的文档分为各个包的单独页面，模块，和班级。API文档还包括两个包含整个项目信息的部分：树图，和索引页。

对象文档

各程序包文档页面包含：

• 包的说明。
• 包中包含的模块和子包的列表。
• 包定义的类的摘要。
• 包定义的函数的摘要。
• 包定义的变量的摘要。
• 包定义的每个函数的详细描述。
• 包定义的每个变量的详细描述。

各模块文档页面包含：

• 模块说明。
• 模块定义的类的摘要。
• 模块定义的功能的摘要。
• 模块定义的变量的摘要。
• 模块定义的每个函数的详细描述。
• 模块定义的每个变量的详细描述。

各类文档页面包含：

• 类继承关系图。
• 已知子类的列表。
• 对类的描述。
• 类定义的方法的摘要。
• 类定义的实例变量的摘要。
• 类定义的类（静态）变量的摘要。
• 类定义的每个方法的详细描述。
• 类定义的每个实例变量的详细描述。
• 类定义的每个类（静态）变量的详细描述。

项目文件

这个树页面包含模块和类层次结构：

• 这个模块层次结构列出每个包和模块，将模块分组到包中。在最高层，在每个包裹里，模块和子包按字母顺序列出。
• 这个类层次结构列出每个类，按基类分组。如果一个类有多个基类，然后它将列在每个基类下。在最高层，在每一个基础阶级下，课程按字母顺序排列。

这个索引页面包含术语和标识符的索引：

• 这个术语索引列出由任何对象文档编制索引的每个术语。每学期，索引提供指向索引术语的每个位置的链接。
• 这个标识符索引列出每个包的（短）名称，模块，类，方法，功能，变量，和参数。对于每个标识符，索引提供了一个简短的描述，以及其文档的链接。

目录

目录占据了窗口左侧的两个框架。左上框显示项目内容，左下框显示模块内容：

这个项目内容框架包含项目定义的所有包和模块的列表。单击入口将在模块内容框中显示其内容。单击特定条目，标记为“一切”，将显示整个项目的内容。

这个模块内容框架包含每个子模块的列表，类，类型，例外情况，功能，以及由amodule或package定义的变量。单击条目将在API文档框架中显示其文档。点击模块名称，在框架顶部，将显示模块本身的文档。

“框架“和”无框架“顶部导航栏下面的按钮可用于控制是否显示目录。

导航栏

导航栏位于每页的顶部和底部。它指示您当前正在查看的页面类型，并允许您转到相关页面。下表介绍了导航栏上的标签。请注意，并非所有页面上都显示某些标签（如[父级]）。

“显示私人“和”隐藏私人“顶部导航栏下面的按钮可用于控制是否显示私人对象的文档。私有对象通常定义为其（短）名称以单个下划线开头的对象，但不要以下划线结尾。例如，“阿克斯“，”_ PPRINT公司“和“epydoc.epytext.\u标记化“私人物品；但是“再保险公司“，”_初始化__“和“类型“不是。但是，如果模块定义了_全部__“变量，然后，它的内容被用来决定哪些对象是私有的。

底部导航栏下面的时间戳指示每个页面上次更新的时间。