harp_apps.dashboard.settings

Inheritance diagram of harp_apps.dashboard.settings

class DashboardSettings[source]

Bases: Configurable

Root settings for the dashboard application.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

auth: BasicAuthSettings | None
devserver: DevserverSettings | None
enable_ui: bool
model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'auth': FieldInfo(annotation=Union[BasicAuthSettings, NoneType], required=False, default=None, description='Authentication settings for the dashboard.', discriminator='type'), 'devserver': FieldInfo(annotation=Union[DevserverSettings, NoneType], required=False, default_factory=DevserverSettings, description='Development server settings, only useful for internal frontend development.'), 'enable_ui': FieldInfo(annotation=bool, required=False, default=True, description='DEPRECATED – Whether to enable the dashboard UI.'), 'port': FieldInfo(annotation=int, required=False, default=4080, description='Port on which the dashboard application will be served.'), 'public_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Public URL of the dashboard application, used to generate absolute links, for example in notifications.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

port: int
public_url: str | None

Submodules