tensorbay.utility.name

NameMixin, SortedNameList and NameList.

NameMixin is a mixin class for instance which has immutable name and mutable description.

SortedNameList is a sorted sequence class which contains NameMixin. It is maintained in sorted order according to the ‘name’ of NameMixin.

NameList is a list of named elements, supports searching the element by its name.

class tensorbay.utility.name.NameMixin(name, description='')

Bases: tensorbay.utility.attr.AttrsMixin, tensorbay.utility.repr.ReprMixin

A mixin class for instance which has immutable name and mutable description.

Parameters

• name (str) – Name of the class.

• description (str) – Description of the class.

Return type

None

name

Name of the class.

class tensorbay.utility.name.NameList(values=())

Bases: tensorbay.utility.user.UserSequence[tensorbay.utility.name._T]

NameList is a list of named elements, supports searching the element by its name.

keys()

Get all element names.

Returns

A tuple containing all elements names.

Return type

Tuple[str, …]

append(value)

Append element to the end of the NameList.

Parameters

value (tensorbay.utility.name._T) – Element to be appended to the NameList.

Raises

KeyError – When the name of the appending object already exists in the NameList.

Return type

None

class tensorbay.utility.name.SortedNameList

Bases: tensorbay.utility.user.UserSequence[tensorbay.utility.name._T]

SortedNameList is a sorted sequence which contains element with name.

It is maintained in sorted order according to the ‘name’ attr of the element.

add(value)

Store element in name sorted list.

Parameters

value (tensorbay.utility.name._T) – The element needs to be added to the list.

Raises

KeyError – If the name of the added value exists in the list.

Return type

None

keys()

Get all element names.

Returns

A tuple containing all elements names.

Return type

Tuple[str, …]