PackSpec#

class scikitplot.cleanprompt.PackSpec(name, version, summary, requires=(), fields=(), patterns=(), code=CodeSpec(column_keywords=(), column_methods=(), dtype_roles=()), source='<builtin>')[source]#

One validated pack.

Parameters:

namestr

Unique pack name.

versionint

The pack’s own version, bumped when its rules change meaning.

summarystr

One line, shown by cleanprompt packs.

requirestuple of str

Packs this one builds on.

fieldstuple of FieldSpec

Field rules.

patternstuple of PatternSpec

Value-shape rules, every one already checked against its examples.

codeCodeSpec

Column-naming sites for code artefacts.

sourcestr

Where it was loaded from.

Parameters:

• name (str)

• version (int)

• summary (str)

• requires (tuple[str, ...])

• fields (tuple[FieldSpec, ...])

• patterns (tuple[PatternSpec, ...])

• code (CodeSpec)

• source (str)

Notes

Developer notes. Frozen and hashable. source is excluded from equality, so the same pack loaded from a built-in and from a user file compares equal — which is what lets a catalog merge treat an identical redefinition as harmless and a different one as a conflict.

code: CodeSpec = CodeSpec(column_keywords=(), column_methods=(), dtype_roles=())[source]#

field_index()[source]#

Return normalised field name to its rule.

Returns:

dict

One entry per name of every field.

Return type:

dict[str, FieldSpec]

fields: tuple[FieldSpec, ...] = ()#

name: str[source]#

patterns: tuple[PatternSpec, ...] = ()#

requires: tuple[str, ...] = ()#

source: str = '<builtin>'#

summary: str[source]#

version: int[source]#