betty.sample module#

Samples are used to generate documentation about various parts of Betty.

class betty.sample.Samplable#

Bases: ABC

Allow a class to provide its own samples.

abstractmethod classmethod samples() → Samples[Self]#

Get the samples.

final class betty.sample.Sample#

Bases: Generic

A sample.

Samples are useful for generating documentation and tests.

__init__(subject: T, *, label: ResolvableLocalizable, description: ResolvableLocalizable | None = None, size: Size = Size.INTERMEDIATE)#
description: Final[Localizable | None]#

The sample’s human-readable long description.

label: Final[Localizable]#

The sample’s human-readable short label.

size: Final[Size]#

The sample size.

subject: Final[T]#

The sample subject.

exception betty.sample.SampleNotFound#

Bases: Exception

Raised when a sample could not be found.

final class betty.sample.Samples#

Bases: Generic[_SampleT]

A set of samples.

__init__(samples: Iterable[Callable[[], Sample[_SampleT]] | Samples[_SampleT] | type[Intersection[_SampleT, Samplable]]])#
get(preferred_size: Size = Size.INTERMEDIATE, /) → Sample[_SampleT]#

Get a sample.

final class betty.sample.Size#

Bases: IntEnum

A sample size indicator.

FULL = 3#
INTERMEDIATE = 2#
MINIMAL = 1#
__new__(value)#