QuotaConfig

class gafaelfawr.config.QuotaConfig(**data)

Bases: BaseModel

Quota configuration.

Parameters:

data (Any)

Attributes Summary

model_config

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

Methods Summary

calculate_quota(groups)

Calculate user's quota given their group membership.

Attributes Documentation

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

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

Methods Documentation

calculate_quota(groups)

Calculate user’s quota given their group membership.

Parameters:

groups (set[str]) – Group membership of the user.

Returns:

Quota information for that user or None if no quotas apply. If the user bypasses quotas, a Quota model with quotas set to None or an empty dictionary is returned rather than None.

Return type:

Quota or None