Loading...
墨滴

小摩托

2021/12/04  阅读:44  主题:橙心

Ftrack Api 入门教程01

安装 Ftrack python 库

安装 Ftrack python 库比较简单,只需要执行下面的命令,即可完成安装 Ftrack python 库以及相关依赖的安装。

pip install ftrack-python-api

这里建议使用最新版的Ftrack python 库,旧版的库会存在内存泄露等严重bug。

理解Session

要想使用 api 去操作 ftrack,需要先去初始化出一个 session 对象。这个 session 对象存储了登录状态,使得每次操作 ftrack 都是在登录的前提下激进行的。如果你用过 requestsSession 对象,那么你可以理解为他们是一个东西,而且 ftrack 的 Session 内部其实也用的requests.Ssssion

初始化Session

ftrack 的 Session 有三个必填的参数,server_urlapi_userapi_key

我们可以在初始化的时候手动去指定这三个参数。

import ftrack_api

session = ftrack_api.Session(
 server_url='https://mycompany.ftrackapp.com',
  api_user='martin',
 api_key='7545384e-a653-11e1-a82c-f22c11dd25eq'
)

server_url: 就是你 ftrack 的网页地址。这里要特别说明一下,网址的结尾最好不要加 /。因为在请求时,会自动拼接一个 /api,如果在 server_url 地址多加一个/,就变成了一个错误的路由,从而导致可能报错。

api_user: 就是我们 ftrack 登录时的用户名。

api_key: 这个 key 我们可以点击右上角头像 -> 我的账户 -> 个人 API Key看到。

当然,除了手动出入这三个变量以外,我们还可以通过环境变量的方式来指定这三个参数。

  • FTRACK_SERVER
  • FTRACK_API_USER
  • FTRACK_API_KEY

当我们指定好这三个环境变量时,只需要我们直接初始化对象即可。

import ftrack_api

session = ftrack_api.Session()

Session初始化做了什么

session初始化时做了以下的一些操作:

  • 初始化用于存储 Entity 的缓存对象。

  • 准备用于请求的 requests.Ssssion 对象。

  • 向服务器请求服务器基础信息,这一步其实主要用来验证上面的三个参数是否正确。

  • 初始化 event hub,以及加载插件,如果如果初始化 Session 时设置了 auto_connect_event_hub=True,则开始连接事件。(事件这部分我们后面会讲)

小摩托

2021/12/04  阅读:44  主题:橙心

作者介绍

小摩托