graviti.portex.register#

The portex type register related classes.

Module Contents#

Classes#

ContainerRegister

The class decorator to connect portex type and the data container.

ExternalContainerRegister

The class decorator to connect portex external type and the data container.

ExternalElementResgister

The class decorator to connect portex external type and the element class.

PyArrowConversionRegister

Register the Portex type to set the conversion from PyArrow to Portex.

Attributes#

STANDARD_URL

graviti.portex.register.STANDARD_URL = https://github.com/Project-OpenBytes/portex-standard[source]#
class graviti.portex.register.ContainerRegister(*portex_types)[source]#

The class decorator to connect portex type and the data container.

Parameters

portex_types (Type[graviti.portex.base.PortexType]) – The portex types needs to be connected.

class graviti.portex.register.ExternalContainerRegister(url, revision, *names)[source]#

The class decorator to connect portex external type and the data container.

Parameters

  • url (str) – The git repo url of the external package.

  • revision (str) – The git repo revision (tag/commit) of the external package.

  • name – The portex external type name.

  • names (str) –

class graviti.portex.register.ExternalElementResgister(url, revision, *names)[source]#

The class decorator to connect portex external type and the element class.

Parameters

  • url (str) – The git repo url of the external package.

  • revision (str) – The git repo revision (tag/commit) of the external package.

  • name – The portex external type name.

  • names (str) –

class graviti.portex.register.PyArrowConversionRegister(*pyarrow_type_ids)[source]#

Register the Portex type to set the conversion from PyArrow to Portex.

Parameters

pyarrow_type_ids (int) – The id of the corresponding PyArrow types.