betty.requirement module¶
Provide an API that lets code express arbitrary requirements.
- class betty.requirement.AllRequirements[source]¶
Bases:
RequirementCollection
A requirement that is met if all of the given requirements are met.
- Parameters:
requirements (
betty.requirement.Requirement
|None
)
- __init__(*requirements: betty.requirement.Requirement | None)[source]¶
- Parameters:
requirements (
betty.requirement.Requirement
|None
)
- summary() betty.locale.Str [source]¶
Get the requirement’s human-readable summary.
- Return type:
- class betty.requirement.AnyRequirement[source]¶
Bases:
RequirementCollection
A requirement that is met if any of the given requirements are met.
- Parameters:
requirements (
betty.requirement.Requirement
|None
)
- __init__(*requirements: betty.requirement.Requirement | None)[source]¶
- Parameters:
requirements (
betty.requirement.Requirement
|None
)
- summary() betty.locale.Str [source]¶
Get the requirement’s human-readable summary.
- Return type:
- class betty.requirement.Requirement[source]¶
Bases:
Localizable
Express a requirement.
- details() betty.locale.Str | None [source]¶
Get the requirement’s human-readable additional details.
- Return type:
- localize(localizer: betty.locale.Localizer) str [source]¶
Localize
self
to a human-readable string.- Parameters:
localizer (
betty.locale.Localizer
)- Return type:
- reduce() betty.requirement.Requirement | None [source]¶
Remove unnecessary components of this requirement. :rtype:
betty.requirement.Requirement
|None
Collections can flatten unnecessary hierarchies.
Empty decorators or collections can ‘dissolve’ themselves and return None.
This function MUST NOT modify self.
- summary() betty.locale.Str [source]¶
Get the requirement’s human-readable summary.
- Return type:
- class betty.requirement.RequirementCollection[source]¶
Bases:
Requirement
Provide a collection of zero or more requirements.
- Parameters:
requirements (
betty.requirement.Requirement
|None
)
- __init__(*requirements: betty.requirement.Requirement | None)[source]¶
- Parameters:
requirements (
betty.requirement.Requirement
|None
)
- localize(localizer: betty.locale.Localizer) str [source]¶
Localize
self
to a human-readable string.- Parameters:
localizer (
betty.locale.Localizer
)- Return type:
- reduce() betty.requirement.Requirement | None [source]¶
Remove unnecessary components of this requirement. :rtype:
betty.requirement.Requirement
|None
Collections can flatten unnecessary hierarchies.
Empty decorators or collections can ‘dissolve’ themselves and return None.
This function MUST NOT modify self.
- exception betty.requirement.RequirementError[source]¶
Bases:
UserFacingError
,RuntimeError
Raised when a requirement is not met.
- Parameters:
requirement (
betty.requirement.Requirement
)
- __init__(requirement: betty.requirement.Requirement)[source]¶
- Parameters:
requirement (
betty.requirement.Requirement
)
- requirement() betty.requirement.Requirement [source]¶
Get the requirement this error is for.
- Return type: