pyhorn 0.9.0

安装

pip install pyhorn

概述

可以通过mhclient的方法访问来自rest端点的数据 对象。在许多情况下，响应数据被封装在其他类中，以便 可以使用对象表示法访问数据的各种属性。例如， 有关matterhorn工作流的数据可以使用 client.workflows（）访问 方法。返回值将是endpoints.workflow.workflow 对象的列表。 这些对象的 操作属性将为您提供 端点.工作流.工作流操作 对象。等等。

对于接受一组关键字参数的方法，需要 kwargs直接从matterhorn端点映射。换句话说，如果你 要知道要将哪些kwargs用于mhclient.workflows（） ，请检查相应的 在rest api文档中的条目位于 http://matterhorn.example.edu/docs.html？path=/workflow

• 端点（） -/info/components.json
• me（） -/info/me.json
• 工作流（**kwargs） -/workflow/instances.json
• 工作流（实例id） -/workflow/instance/{id}.json
• 集（**kwargs） -/集/集.json
• 插曲（插曲id） -/插曲/插曲.json
• 用户操作（**kwargs） -/usertracking/actions.json
• agents（） -/capture admin/agents.json
• 代理（代理名称） -/capture-admin/agents/{agent-name}.json
• hosts（） -/services/hosts.json
• 作业（作业id） -/services/job/{job id}.json
• 搜索集（**kwargs） -/search/sception.json
• 搜索插曲（插曲id） -/search/插曲.json
• statistics（） -/services/statistics.json

示例用法

创建客户端界面…

>>>frompyhornimportMHClient>>>client=MHClient('http://matterhorn.example.edu','user','passwd')

user/pass组合应该用于rest api用户，通常是 "matterhorn_system_account"用户。可以创建和使用客户机 没有用户/过程组合的对象（省略构造函数参数），但是请求 仅适用于不需要验证的终结点（例如，事件搜索）

默认请求超时为5秒。将timeout=n传递给mhclient 构造器使用其他东西。

获取可用终结点的列表…

>>>client.endpoints()[{u'description':u'Capture Agent Admin REST Endpoint',u'docs':u'http://matterhorn.example.edu80/capture-admin/docs',u'path':u'/capture-admin',u'type':u'org.opencastproject.capture.admin',u'version':u'1.4.4',u'wadl':u'http://matterhorn.example.edu80/capture-admin/?_wadl&_type=xml'},{u'description':u'EpisodeService REST Endpoint',u'docs':u'http://matterhorn.example.edu80/episode/docs',u'path':u'/episode',u'type':u'org.opencastproject.episode',u'version':u'1.4.4',u'wadl':u'http://matterhorn.example.edu80/episode/?_wadl&_type=xml'},...

获取当前工作流实例的列表…

>>>wfs=client.workflows()>>>forwfinwfs:printwf.id+": "+wf.state1646:STOPPED1649:STOPPED1651:STOPPED1655:STOPPED4211:SUCCEEDED14479:SUCCEEDED14486:SUCCEEDED441:STOPPED445:STOPPED...

…或者仅仅是成功者…

>>>wfs=client.workflows(state="SUCCEEDED")

…或特定实例的操作…

>>>wf=client.workflow(instance_id=1646)>>>ops=wf.operations>>>foropinops:printop.id+": "+op.stateapply-acl:SUCCEEDEDtag:SUCCEEDEDtag:SUCCEEDEDinspect:SUCCEEDEDprepare-av:SUCCEEDEDprepare-av:SUCCEEDEDcompose:SUCCEEDEDcompose:SUCCEEDED...

获取当前配置的列表红色捕获代理

>>>cas=client.agents()>>>forcaincas:printca.name+": "+ca.stateepiphan001:unknownepiphan002:unknownewave001:idleewave002:idlencast001:idlencast002:shutting_down

端点对象包装器

pyhorn试图使matterhorn api响应更易于使用 通过将json响应数据包装在一组提供简单访问的类中 通过对象属性和关联数据的自动"解引用"。

定义了以下端点数据类：

• 工作流程
• 工作流操作
• 服务工作
• 插曲
• 媒体包
• 媒体跟踪
• 捕获代理
• 用户操作
• 搜索

这些只是初始设置，因为它们代表了我需要处理的数据 在其他促使创建pyhorn的项目中。这是微不足道的 添加其他包装类。拉请求欢迎！

属性访问

端点数据类继承自 pyhorn.endpoints.base.endpointobj 。这个 json响应数据存储在一个 \u raw 属性中，并通过 通过重写 .getattr>.一个简单的例子：

>>>frompyhorn.endpoints.baseimportEndpointObj>>>obj=EndpointObj({"foo":"bar","baz":[1,2,3]},client)>>>obj.foobar>>>obj.baz[1,2,3]>>>obj.abcTraceback......AttributeError:responsedatafor<class'pyhorn.endpoints.base.EndpointObj'> has no key 'abc'

>>>obj=EndpointObj({"foo":{"bar":{"baz":1}}})>>>obj.raw_get("foo.bar.baz")1

pip install pyhorn