API reference¶
Core (pkl)¶
| Name | |
|---|---|
Plugin |
Identity of a plugin. |
PluginTracker[P] |
current, require_current(), executing(plugin). |
Resource |
Protocol: release() -> None. |
ResourceRegistry[P] |
register, unregister, release, release_all, resources, plugins. |
PklError, NoCurrentPluginError |
Errors. |
pkl.tracking¶
| Name | |
|---|---|
ResourceTracker[P](plugins, registry, allow_orphans=False) |
current_owner(), track(resource). |
Tracked[P] |
Auto-registering base. Class keywords tracker=, allow_tracker_override=. owner, tracker, released, release(), with_tracker(tracker), executing_as_owner(); implement on_release(). |
UnboundResourceError, TrackerOverrideError |
Errors. |
pkl.events¶
event_decorator(tracker) builds the @event / @event(protected=True) decorator function.
Event[**Params](func, *, protected=True): subscribe, unsubscribe, on, +=, -=, subscriptions, call, emit.
protected limits invoking to the owner; subscribing is always open. Subscription (a Callback), EventPermissionError,
EventReleasedError.
pkl.dependencies¶
depends_on(registry, dependant, dependency) -> Dependency, require(tracker, dependency) (the executing plugin is the
dependant). Dependency: dependant, dependency, registry, active, unlink().
pkl.hosting¶
PluginHost[Q](plugins=None): a Tracked resource. plugins, registry(), tracker_for(registry, allow_orphans=False),
registries. HostedRegistry, HostReleasedError.
pkl.syscall¶
syscall(plugins, func).
pkl.timing¶
Timer(callback, delay, *, repeat=False), Timer.timeout(callback, delay), Timer.interval(callback, delay).
pkl.files¶
File(path), Directory(path), TempFile(*, suffix, prefix, dir), TempDirectory(*, suffix, prefix, dir).
pkl.modules¶
ModuleResource(name, path, *, package=False, replace=False) with module, name, path; ModuleAlreadyLoadedError.