Prelude

Apfel includes predefined namespace conveniences that make the library easier to use.

Package namespace

Some common utilities are re-exported from the top-level apfel package and can be imported directly.

Tip

The package namespace is properly typed. Prefer explicit imports from it instead of relying on the builtins namespace.

Builtins namespace

Some extremely common utilities are injected into Python’s builtins namespace as module-level side effects. They are available after importing apfel.

Caution

Use patched builtins only in a REPL or another interactive environment. They can confuse toolchains and collaborators.

If you use Pyright, follow its builtins extension documentation to enable autocompletion for these functions.

Catalog

Functions

Module	Function	Package	Builtins
core.common	apply	Yes	Yes
core.common	identity	Yes	Yes
core.common	imperative	Yes	Yes
core.common	not_none	Yes
core.common	pipe	Yes	Yes
core.common	todo	Yes	Yes
core.common	unimplemented	Yes	Yes
core.iter	itrt	Yes
container.maybe	just	Yes
container.maybe	nothing	Yes
container.maybe	some	Yes
container.result	ok	Yes
container.result	err	Yes
container.result	caught	Yes

Classes

Module	Class	Package	Builtins
core.iter	Iterator	Yes
container.maybe	Maybe	Yes
container.result	Result	Yes
container.once	Once	Yes
container.once	Lazy	Yes