betty.entities.file_reference module

Data types to reference files on disk.

final class betty.entities.file_reference.FileReference

Bases: Entity

The file-reference entity plugin.

Plugin ID	file-reference
Class	FileReference
Configuration	not configurable

__init__(referee: ToOneAssociate[Self, HasFileReferences], file: ToOneAssociate[Self, File], *, id: ResolvableMachineName | None = None, focus: FocusArea | None = None)

file

The referenced file.

focus

The area within the 2-dimensional representation of the file to focus on.

This can be used to locate where faces are in a photo, or a specific article in a newspaper scan, for example.

referee

The entity that references the file.