编程参考

CGTeamWork python client for humans.

cgtwq.login(account, password)

Login on server.

参数

• account (str) – Account name.

• password (str) – Password.

引发

ValueError – When login fail.

返回

Account information.

返回类型

AccountInfo

cgtwq.get_account(token=None)

Get account from token.

参数

token (str) – Server token

返回

Account name.

返回类型

str

cgtwq.get_account_id(token=None)

Get account id from token.

参数

token (str) – Server token

返回

Account id.

返回类型

str

class cgtwq.DesktopClient(socket_url=None)

Communicate with a CGTeamWork official GUI clients.

call(controller, method, **kwargs)

Call method on the cgteamwork client.

参数

• controller (str) – Client defined controller name.

• method (str) – Client defined method name on the controller.

• **kwargs – Client defined method keyword arguments.

返回

Received data.

返回类型

dict or str

connect()

Update module config from desktop client.

current_select()

Get current selection from client.

返回

Current selection.

返回类型

Selection

static executable()

Get a cgteamwork client executable.

返回

Executable path.

返回类型

text_type

is_logged_in()

Check if client is logged in.

返回

True if client is logged in.

返回类型

bool

is_running()

Check if client is running.

返回

True if client is running.

返回类型

bool

refresh(database, module)

Refresh specified view in client if matched view is opened.

参数

• database (text_type) – Database of view.

• module (text_type) – Module of view.

refresh_selected(database, module)

Refresh selected part of specified view in client if matched view is opened.

参数

• database (text_type) – Database of view.

• module (text_type) – Module of view.

selection()

Get current selection from client.

返回

Current selection.

返回类型

Selection

server_http()

Server http current using by client.

server_ip(max_age=5)

Cached server ip.

start()

Start client if not running.

token(max_age=2)

Cached client token.

class cgtwq.Database(name)

Database on server.

call(*args, **kwargs)

Call on this database.

create_field(sign, type_, name=None, label=None)

Create new field in the module.

参数

• sign (str) – Field sign

• type_ (str) – Field type, see core.FIELD_TYPES.

• name (str, optional) – Defaults to None. Field english name.

• label (str, optional) – Defaults to None. Field chinese name.

delete_field(field_id)

Delete field in the module.

参数

id_ (str) – Field id.

filter(*filters)

Filter modules in this database.

参数

*filters (FilterList, Filter) – Filters for server.

返回

Modules

返回类型

tuple[Module]

get_data(key, is_user=True)

Get additional data set in this database.

参数

• key (text_type) – Data key.

• is_user (bool, optional) – Defaults to True.

• is_user is True, this data will be user specific. (If) –

返回

Data value.

返回类型

text_type

get_field(filters)

Get one field in the database.

filters (Filter or FilterList): Filter.

返回

Field information.

返回类型

FieldMeta

get_fields(filters=None)

Get fields in the database.

filters (Filter or FilterList, optional): Defaults to None. Filter.

返回

Field information.

返回类型

tuple[FieldMeta]

get_fileboxes(filters=None, id_=None)

Get fileboxes in this database.

参数

• filters (FilterList, optional) – Defaults to None. Filters to get filebox.

• id_ (text_type, optional) – Defaults to None. Filebox id.

引发

• ValueError – Not enough arguments.

• ValueError – No matched filebox.

返回

namedtuple for (‘id’, ‘pipeline_id’, ‘title’)

返回类型

tuple[FileBoxCategoryInfo]

get_pipelines(*filters)

Get piplines from database.

参数

*filters (FilterList) – Filter to get pipeline.

返回

namedtuple for (‘id’, ‘name’, ‘module’)

返回类型

tuple[PipelineInfo]

get_software(name)

Get software path for this database.

参数

name (text_type) – Software name.

返回

Path set in 系统设置 -> 软件设置.

返回类型

path

module(name, module_type='task')

Get module in the database.

modules()

All modules in this database.

返回

Modules

返回类型

tuple[Module]

set_data(key, value, is_user=True)

Set additional data in this database.

参数

• key (text_type) – Data key.

• value (text_type) – Data value

• is_user (bool, optional) – Defaults to True.

• is_user is True, this data will be user specific. (If) –

property token

User token.

class cgtwq.Field

Data base field name for filter.

contains(value)

Represents value in data item list.

has(value)

Represents data has value in it.

in_(value)

Represents matched data in value list.

in_namespace(namespace)

Get a new Field instance in the namespace.

参数

namespace (str) – Default namespace for keys.

返回

Field

class cgtwq.Filter(key, value, operator=None)

CGTeamWork style filter.

classmethod from_list(obj)

Create filter instance from a list.

参数

obj (list) – A list match [key, operater, value].

引发

ValueError – can not convert obj to filter.

返回

Filter

in_namespace(namespace)

Get a new Filter instance in the namespace.

参数

namespace (str) – Default namespace for keys.

返回

Filter

class cgtwq.FilterList(list_)

CGTeamWork style filter list.

classmethod from_arbitrary_args(*filters)

Create filterlist from arbitrary arguments.

返回

FilterList

in_namespace(namespace)

Create new FilterList instance in the namespace.

参数

namespace (str) – Default namespace for keys.

返回

FilterList

class cgtwq.Message

CGTeamWork style message, support image.

dumps()

Dump data to string in server defined format.

classmethod load(data)

Create message from data.

upload_images(folder, token)

Upload contianed images to server. will replace items in self.image.

class cgtwq.Module(name, database, module_type='task')

Module(Database table) in database.

call(*args, **kwargs)

Call on this module.

count(*filters, **kwargs)

Count matched entity in database.

参数

• \*filters (FilterList, Filter) – Filters for server.

• **kwargs – namespace (str, optional): Default field namespace.

返回

Count value.

返回类型

int

count_history(filters)

Count history records in the module.

参数

filters (Filter or FilterList) – History filters.

返回

Records count.

返回类型

int

create(kwargs=None, **data)

Create entry from data.

参数

• kwargs (dict) –

• Any] (**data[str,) – Data to create a entry.

**data:

namespace (str, optional): Default field namespace.

create_field(sign, type_, name=None, label=None)

Create new field in the module.

参数

• sign (str) – Field sign

• type_ (str) – Field type, see core.FIELD_TYPES.

• name (str, optional) – Defaults to None. Field english name.

• label (str, optional) – Defaults to None. Field chinese name.

delete_field(id_)

Delete field in the module.

参数

id_ (str) – Field id.

distinct(*filters, **kwargs)

Get distinct value in the module.

参数

• *filters (FilterList, Filter) – Filters for server.

• **kwargs –

**kwargs:

key: Distinct key, defaults to field of first filter. namespace (str, optional): Default field namespace.

返回

tuple

fields()

Get fields in this module.

filter(*filters, **kwargs)

Create selection with filter on this module.

参数

• *filters (FilterList, Filter) – Filters for server.

• **kwargs –

**kwargs:

namespace (str, optional): Default field namespace.

返回

Created selection.

返回类型

Selection

flow()

Workflow of the module.

format_field(name)

Formatted field name for this module.

参数

name (text_type) – Short field name.

返回

Full field name, for server.

返回类型

text_type

format_filters(filters)

Format field name in filters.

参数

filters (FilterList, Filter) – Format target.

返回

Formatted filters.

返回类型

FilterList

get_history(filters)

Get history record from the module.

filters (Filter or FilterList): History filters.

返回

History records.

返回类型

tuple[HistoryInfo]

pipelines()

All pipeline in this module.

返回

namedtuple for (‘id’, ‘name’, ‘module’).

返回类型

tuple[Pipeline]

select(*id_list)

Create selection on this module.

参数

*id_list (text_type) – Id list to select.

返回

Created selection.

返回类型

Selection

property token

User token.

undo_history(history)

Undo a history.

参数

history (HistoryInfo) – History information.

class cgtwq.PluginMeta(uuid)

CGTeamWork plug-in metadata.

fetch(token=None)

Fetch plugin data from server.

classmethod filter(filters=None, token=None)

Filter plugins from server.

参数

• filters (Filter or FilterList, optional) – Defaults to None. Plugin filter

• token (str, optional) – Defaults to None. User token.

返回

Matched plug-ins.

返回类型

list[Plugin]

classmethod from_info(info)

Initialize Plugin object from info.

参数

info (PluginInfo) – Plugin information.

返回

Plugin

get_argument(key, token=None)

Get argument information.

参数

• key (str) – Argument key.

• token (str, optional) – Defaults to None. User token.

返回

Plug-in argument information.

返回类型

PluginArgumentInfo

set_argument(key, value=None, description=None, token=None)

Set argument data.

参数

• key (str) – Data key.

• value (any, optional) – Defaults to None. Data value.

• description (str, optional) – Defaults to None. Argument description.

• token (str, optional) – Defaults to None. User token.

set_fields(token=None, **data)

Set field data for the plug-in.

参数

• token (str, optional) – Defaults to None. User token.

• **data – Field name as key, Value as value.

class cgtwq.ResultSet(roles, data, module)

Database query result.

column(field)

Get a column from field name.

参数

field (text_type) – Field name.

返回

Column data.

返回类型

tuple

class cgtwq.Entry(module, id_)

A selection that only has one item.

get_fields(*fields, **kwargs)

Get multiple fields.

返回

Result fields with exactly same order with fields.

返回类型

tuple

related(*filters)

Select related entries.

参数

*filters – Pipeline filters.

返回

Selection

class cgtwq.Selection(module, *id_list)

Selection with all feature.

引发

EmptySelection – when selection size is 0.

call(*args, **kwargs)

Call on this selection.

count(*filters)

Count matched entity in the selection.

参数

*filters (Filter,FilterList) – Filters.

返回

Count value.

返回类型

int

delete()

Delete the selected item on database.

distinct(*filters, **kwargs)

Get distinct value in the selection.

参数

• *filters (FilterList, Filter) – Filters for server.

• **kwargs –

**kwargs:

key: Distinct key, defaults to field of first filter.

返回

tuple

filter(*filters)

Filter selection again.

参数

*filters (Filter,FilterList) – Additional filters.

返回

Filtered selection.

返回类型

Selection

classmethod from_data(**kwargs)

Get selection from dictionary-like data.

参数

**kwargs – database(str): Database name. module(str): Module name. module_type(str): Module type. id_list(list): Id list.

get_fields(*fields, **kwargs)

Get field information for the selection.

参数

• *fields – Server defined field sign.

• **kwargs –

**kwargs:

namespace (str, optional): Default namespace for key.

返回

Optimized tuple object contains fields data.

返回类型

ResultSet

get_folder(*sign_list)

Get signed folder path.

参数

sign_list (six.text_type) – Sign name defined in CGTeemWork: 项目设置 -> 目录文件 -> 标识

返回

Server returned path dictionary.

id as key, path as value.

返回类型

dict

get_image(field='image')

Get imageinfo used on the field.

参数

field (six.text_type) – Defaults to ‘image’, Server defined field name,

返回

Image information.

返回类型

set[ImageInfo]

has_permission_on_status(field)

Return if user has permission to edit field.

参数

field (str) – Field name.

返回

bool

set_fields(kwargs=None, **data)

Set field data for the selection.

参数

• kwargs (dict) –

• **data – Field name as key, Value as value.

kwargs:

namespace (str, optional): Default namespace for key.

set_image(path, field='image')

Set image for the field.

参数

• field (six.text_type) – Defaults to ‘image’, Server defined field name,

• path (six.text_type) – File path.

返回

Uploaded image.

返回类型

ImageInfo

submit(pathnames=(), filenames=(), note='')

Submit file to task, then change status to Check.

参数

• pathnames (tuple, optional) – Defaults to (). Server pathnames.

• filenames (tuple, optional) – Defaults to (). Local filenames.

• note (str, optional) – Defaults to “”. Submit note.

to_entries()

Convert selection to entries.

返回

Entries.

返回类型

tuple[Entry]

to_entry()

Convert selection to one entry.

引发

ValueError – Not exactly one selected item.

返回

Entry.

返回类型

Entry

property token

User token.

exception cgtwq.AccountError(owner='', current='')

Indicate account not match.

exception cgtwq.AccountNotFoundError

Indicate account not found.

exception cgtwq.CGTeamWorkException

Base exception class for CGTeamWork.

exception cgtwq.IDError

Indicate can’t specify shot id on cgtw.

exception cgtwq.LoginError

Indicate not logged in.

exception cgtwq.PasswordError

Indicate password not correct.

exception cgtwq.PermissionError

Indicate sufficient permission.

exception cgtwq.PrefixError

Indicate no shot match the prefix.

exception cgtwq.SignError

Indicate can’t found matched sign.

exception cgtwq.EmptySelection

Indicate no entry match the criteria.