Contrib

This package provides support for the following BalderHub projects:

BalderHub Project balderhub-auth

Auth Setup Features

class balderhub.data.contrib.auth.setup_features.DataItemParamProvider(**kwargs)

Bases: UnresolvedResourceParameterConfig

Handles configuration and provides parameters for resolving resources for specific data items.

This is a setup-level feature implementation for the balderhub.auth.lib.scenario_features.client.UnresolvedResourceParameterConfig. It uses a defined ResolvingMode to specify how parameters should be selected out of the remote server feature balderhub.data.lib.scenario_features.InitialDataConfig.

ENFORCING_PARAMETERS = 0

specifies the minimum number of parameters to enforce when in ResolvingMode.MINIMUM. Must be greater than 0 for that mode.

class ResolvingMode(value)

Bases: Enum

Defines modes for resolving entities.

This class provides an enumeration of possible resolving modes that dictate how entities are retrieved or resolved.

class Server

Bases: VDevice

server vdevice holding the specified initial data configuration feature

get_parameters_for(resource_rule: ResourceRule) → list[balderhub.data.contrib.auth.utils.resource_for_specific_data_item.ResourceForSpecificDataItem.Parameter]

Returns a list of parameters that should be used to resolve the given unresolved resource rule.

Parameters:

resource_rule – the resource rule that contains the unresolved resource

Returns:

a list of parameters for resolving the unresolved resource

Auth Setup Factories

class balderhub.data.contrib.auth.setup_features.factories.AutoDataParamProviderFactory

Bases: AutoFeatureFactory

Represents a factory for creating parameter providers related to data items for auto-generated features.

The AutoDataParamProviderFactory is responsible for defining and constructing data item parameter providers dynamically for use with auto-generated features. It creates data item bounded setup-level features of balderhub.auth.contrib.data.setup_features.DataItemParamProvider.

Auth Utils

class balderhub.data.contrib.auth.utils.ResourceForSpecificDataItem(data_item_type: Type[SingleDataItem], **kwargs)

Bases: UnresolvedResource, ABC

This class represents an unresolved resource that is specific for a certain data item type.

class Parameter(data_item: SingleDataItem)

Bases: Parameter

The parameter class for the ResourceForSpecificDataItem class.

property data_item_type: Type[SingleDataItem]

returns the data item type of this resource

abstract get_resolved_resource(param: Parameter) → Resource

Resolves the resource with the given parameter.

Parameters:

param – the parameter for the unresolved resource

Returns:

the resolved resource