Source objects is the common interface for all things that come out of the database. There are two types of source objects:
Whatever object you have in hand that comes from the database, they will at least provide a minimal useful set of API methods and properties.
Plugins can subclass source objects to come up with their own source
objects if needed. In addition to that there is a special source object
VirtualSourceObject which is more useful for plugin usage.
Most plugins will not have source objects that actually originate on the
file system. This means that their "source" is entirely virtual. Because
this is a very common situation there is a base class, the
VirtualSourceObject which plugins can subclass. The constructor takes one
argument which is the source record the virtual source lives below. Virtual
sources are separated from the records they belong to with an at sign (
in the path. The part after the at sign is called the “virtual path”.
For instance in the below example the canonical path for the object would be
the record's path +
@source. So if the record was
/hello then the
path would be
/hello@source. The true base record it belongs to can be
referenced from the record property.
from lektor.sourceobj import VirtualSourceObject from lektor.utils import build_url class Source(VirtualSourceObject): @property def path(self): return self.record.path + '@source' @property def source_content(self): with open(self.record.source_filename) as f: return f.read().decode('utf-8') @property def url_path(self): return build_url([self.record.url_path, 'source.txt'])
The alt the source object corresponds to if available.
Indicates if the record is a page or attachment.
Indicates that a record can be discovered via .children
Indicates if the object is hidden or not.
The inverse of is_discoverable.
Indicates if the object is visible or not.
The parent object for this source object.
The path in the source tree of the source object.
A reference to the associated base record.
Returns the filename of the source file.