On this page

CookSettings

symbolica.community.idenso Class

CookSettings(*, mode: Optional[CookMode] = None, source: Optional[CookSourceFilter] = None, output_tags: Optional[Sequence[str]] = None, preserve_tags: bool = False)

Immutable configuration for cooking symbolic functions and index payloads.

Constructor

#

Configure how functions are selected, encoded, and tagged when cooked.

Tags must be fully namespaced Symbolica tags, for example idenso::cooked. Selecting ReversibleEncoding changes only the encoding; use reversible() to also select the conventional idenso::cooked output tag. mode=None selects CookMode.FlattenedSymbol.

Parameters

NameTypeDefaultDescription
modeOptional[CookMode]None—
sourceOptional[CookSourceFilter]None—
output_tagsOptional[Sequence[str]]None—
preserve_tagsboolFalse—

Member details

mode

Property · read-only
#
mode: CookMode

Symbol-encoding mode.

source_filter

Property · read-only
#
source_filter: CookSourceFilter

Function occurrences selected for cooking.

output_tags

Property · read-only
#
output_tags: list[str]

Explicit tags attached to newly created cooked symbols.

preserve_tags

Property · read-only
#
preserve_tags: bool

Whether matching input tags are preserved on cooked symbols.

flattened

Static method
#
flattened() -> CookSettings

Cook all functions into readable flattened names.

indices

Static method
#
indices() -> CookSettings

Cook only nested function payloads inside representation indices and preserve tags.

reversible

Static method
#
reversible() -> CookSettings

Cook all functions into stable symbols that can be restored by uncook.