geoh5py.groups package

Submodules

geoh5py.groups.container_group module

class geoh5py.groups.container_group.ContainerGroup(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.groups.group.Group

The type for the basic Container group.

classmethod default_type_uid() → uuid.UUID[source]

geoh5py.groups.custom_group module

class geoh5py.groups.custom_group.CustomGroup(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.groups.group.Group

A custom group, for an unlisted Group type.

classmethod default_type_uid() → Union[uuid.UUID, NoneType][source]

geoh5py.groups.drillhole_group module

class geoh5py.groups.drillhole_group.DrillholeGroup(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.groups.group.Group

The type for the group containing drillholes.

classmethod default_type_uid() → uuid.UUID[source]

geoh5py.groups.giftools_group module

class geoh5py.groups.giftools_group.GiftoolsGroup(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.groups.group.Group

The type for a GIFtools group.

classmethod default_type_uid() → uuid.UUID[source]

geoh5py.groups.group module

class geoh5py.groups.group.Group(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.shared.entity.Entity

Base Group class

abstract classmethod default_type_uid() → Union[uuid.UUID, NoneType][source]
property entity_type
classmethod find_or_create_type(workspace: 'workspace.Workspace', \*\*kwargs)geoh5py.groups.group_type.GroupType[source]

geoh5py.groups.group_type module

class geoh5py.groups.group_type.GroupType(workspace: workspace.Workspace, **kwargs)[source]

Bases: geoh5py.shared.entity_type.EntityType

property allow_delete_content

bool: [True] Allow to delete the group geoh5py.shared.entity.Entity.children.

property allow_move_content

bool: [True] Allow to move the group geoh5py.shared.entity.Entity.children.

static create_custom(workspace: "'workspace.Workspace'", \*\*kwargs) → ’GroupType’[source]

Creates a new instance of GroupType for an unlisted custom Group type with a new auto-generated UUID.

classmethod find_or_create(workspace: "'workspace.Workspace'", entity_class, \*\*kwargs) → ’GroupType’[source]

Find or creates an EntityType with given UUID that matches the given Group implementation class.

Parameters
  • workspace – An active Workspace class

  • entity_class – An Group implementation class.

Returns

A new instance of GroupType.

geoh5py.groups.notype_group module

class geoh5py.groups.notype_group.NoTypeGroup(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.groups.group.Group

A group with no type.

classmethod default_type_uid() → uuid.UUID[source]

geoh5py.groups.property_group module

class geoh5py.groups.property_group.PropertyGroup(**kwargs)[source]

Bases: object

Group for properties not registered to the workspace

property association
property attribute_map
Returns

Mapping between attribute names used in database and geoh5py

property name
property parent

The parent of an object in the workspace :return: The parent entity

property properties
property property_group_type
property uid

geoh5py.groups.root_group module

class geoh5py.groups.root_group.RootGroup(group_type: geoh5py.groups.group_type.GroupType, **kwargs)[source]

Bases: geoh5py.groups.notype_group.NoTypeGroup

The type for the workspace root group.

property parent

Parental entity of root is always None

Module contents