ubii.proto package¶

ubii.proto.__protobuf__ = ProtoModule(package='ubii.proto.v1', marshal='ubii.proto.v1', manifest=frozenset({'StringList', 'TopicInputMapping', 'TopicOutputMapping', 'Error', 'Vector2List', 'ProcessingMode', 'Vector3', 'Vector4', 'Quaternion', 'Matrix3x2', 'TopicDataRecordList', 'HandGestureType', 'QuaternionList', 'TopicMuxList', 'Vector8', 'Success', 'KeyEvent', 'Object3DList', 'ComponentList', 'TopicOutputMappingList', 'TopicInputMappingList', 'Timestamp', 'DoubleList', 'ButtonEventType', 'Pose2D', 'TopicMux', 'MouseEvent', 'DeviceList', 'LockstepProcessingReply', 'Constants', 'Vector8List', 'SuccessList', 'Server', 'Image2D', 'ProcessingModule', 'Matrix4x4', 'FloatList', 'TopicDemuxList', 'MyoEvent', 'ServiceList', 'Vector3List', 'Object2DList', 'IOMapping', 'ModuleIO', 'Vector2', 'BoolList', 'SessionStatus', 'IOMappingList', 'Component', 'ErrorList', 'Int32List', 'Object2D', 'TopicDataRecord', 'LockstepProcessingRequest', 'Color', 'Vector4List', 'SessionList', 'Device', 'Session', 'TopicData', 'Client', 'TopicSubscription', 'ServiceReply', 'TouchEvent', 'Image2DList', 'TouchEventList', 'ClientList', 'TopicDemux', 'ProcessingModuleList', 'Pose3D', 'Service', 'Object3D', 'ServiceRequest'}))¶

Used by Proto Plus for Python to aggregate defined protobuf message in the same descriptor pool. You need to import this attribute in every module that extends an existing protobuf wrapper class using ubii.proto.ProtoMeta. In essence this is a named tuple with attributes package and marshal containing the name for the Marshal used by this package and manifest containing a set of all Message available from this module.

Example

You may want to create a extension to the wrapper around ubii.proto.Error to be able to raise the error as an exception:

from functools import lru_cache
from proto.marshal import Marshal
from proto.marshal.rules.message import MessageRule

import ubii.proto as ub
__protobuf__ = ub.__protobuf__


class BaseError(ub.Error, Exception, metaclass=ub.ProtoMeta):
    @classmethod
    @lru_cache
    def rule(cls):
        return MessageRule(ub.Error.pb(), cls)

    @property
    def args(self):
        return self.title, self.message, self.stack

class SessionRuntimeStopServiceError(BaseError):
    pass

class OtherError(BaseError):
    pass

class ErrorRule(MessageRule):
    def to_python(self, value, *, absent: bool | None = None):
        title = value.title or ''
        rule = None

        if title.startswith('SessionRuntimeStopService'):
            rule = SessionRuntimeStopServiceError.rule()
        elif title.startswith('Other'):
            rule = OtherError.rule()
        else:
            rule = BaseError.rule()

        return rule.to_python(value, absent=absent)

    def to_proto(self, value):
        return super().to_proto(value)

# register the new marshal rule to automatically convert errors

Marshal(name=__protobuf__.marshal).register(ub.Error.pb(), ErrorRule(ub.Error.pb(), BaseError))

ubii.proto.__proto_module__ = 'ubii.proto.v1'¶: The actual import path of the module that contains the autogenerated protobuf code. Users are supposed to import from ubii.proto instead.

ubii.proto.__proto_package__ = 'ubii.proto.v1'¶: The name used for the Marshal.

You can look for the package from ubii.proto.__proto_module__ inside the auto-generated documentation:

Utility¶

ubii.proto.util.ProtoMeta and ubii.proto.util.ProtoEncoder from ubii.proto.util are directly importable from ubii.proto

Submodules¶

ubii.proto.util module¶

Utility features to format protobuf messages and implement protobuf wrapper classes with custom behaviour.

ubii.proto.util.__imported_types__¶

module level dictionary caching imported types

Type: dict

ubii.proto.util.get_import_name(message_type: str)[source]¶

The .proto files declare a package name ‘ubii’, but this is not reflected in the python package. Instead the package is named ubii.proto, to not clash with different packages in the ubii namespace. The python files are generated from updated proto files, to produce the correct directory structure. The directory structure determines python package names see https://developers.google.com/protocol-buffers/docs/reference/python-generated#package

Parameters: message_type (str) – string describing the data type

ubii.proto.util.import_type(message_type: str, reimport=False)[source]¶

See the documentation of the ubii-msg-compiler at https://github.com/saggitar/ubii-msg-compiler for more information about updating the .proto files to generate a different package structure.

Parameters

message_type (str) – string describing the data type
reimport (bool) – If true force reimport of type

class ubii.proto.util.ProtoMeta(name, bases, attrs)[source]¶

Bases: abc.ABCMeta, proto.message.MessageMeta

This metaclass is used to inherit from Proto Plus for Python wrapper classes

Example

Make sure you import and set ubii.proto.__protobuf__ in every module which defines new Message types:

import ubii.proto as ub
__protobuf__ = ub.__protobuf__

class Fancy(ub.Component, metaclass=ub.ProtoMeta):
    @property
    def something_amazing(self)
        return "Wow"

class ubii.proto.util.ProtoEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶

Bases: json.encoder.JSONEncoder

Custom encoder to convert Protobuf Messages and Proto-Plus Messages to valid json.

format_options: Dict[str, bool] = {'including_default_value_fields': True, 'preserving_proto_field_name': False, 'use_integers_for_enums': True}¶: dictionary of default arguments passed to the proto.message.Message.to_dict() or google.protobuf.json_format.MessageToDict() calls which are used to convert the message object.

default(o)[source]¶

returns a serializable object for o, or calls the base implementation (to raise a TypeError).

Parameters: o (object) – (hopefully) serializable object, e.g. Protobuf message
Returns: dict – Dictionary representation of message using proto.message.Message.to_dict() or google.protobuf.json_format.MessageToDict()
Raises: TypeError – If object is not serializable as Protobuf Message of by json.JSONEncoder.default()

ubii.proto.util.patch_wrapper_class_repr(replacement='...', max_len=50) → None[source]¶

E.g. for documentation purposes it’s undesirable that the __repr__ method of proto.message.Message simply returns formatted json for the message object. For messages with many fields or long representation of field values this to much information.

This function simply monkeypatches the __repr__ method of proto.message.Message to replace output that is longer than max_len with replacement

Parameters

replacement – string used as replacement
max_len – shorter representations will not be converted

ubii.proto package¶

Message Types¶

Utility¶

Submodules¶

ubii.proto.util module¶

Navigation

Related Topics