Changelog¶

All notable changes to gs_prompt_manager will be documented in this file. Only keep code changes here.

[0.0.9]¶

Brace escaping in prompt templates: \{ / \} render as literal braces and are excluded from variable auto-extraction and substitution, so a \{...\} token never becomes a required variable. Applies to get_prompt, __call__, and __str__.

Unused PromptBase._escape_braces helper (dead code implementing a conflicting double-brace convention)

Renamed prompt_pieces_available → variables, prompt_pieces_default_value → variable_defaults, prompt_predefine_value → macros throughout PromptBase (constructor params, instance attributes, abstract methods, and helpers)
Renamed abstract methods: set_prompt_pieces_available() → set_variables(), set_prompt_pieces_default_value() → set_variable_defaults(), set_prompt_predefine_value() → set_macros()
Renamed helpers: add_prompt_piece_default_value(piece, value) → add_variable_default(name, value), add_prompt_predefine_value(key, value) → add_macro(key, value), set_prompt_pieces_default_value_empty() → set_variable_defaults_empty()
get_prompt(prompt_pieces) / __call__(prompt_pieces) parameter renamed to variables
get_metadata() keys "default_prompt_pieces" → "variable_defaults" and "predefine_prompt_pieces" → "macros"
Renamed internal _check_default_prompt_pieces() → _check_variable_defaults()
Renamed PromptManager.prompt_objects → prompt_classes for clarity

PromptManager.__getattr__: attribute-style access for groups and prompts (manager.MyGroup, manager.MyPrompt); groups take priority over bare prompt instances
PromptManager.__dir__: includes group and prompt names in tab-completion

Tutorial Jupyter notebook (docs/tutorial.ipynb) covering every feature of the library end-to-end

Added Optional[...] return-type annotations to all set_* abstract methods on PromptBase so subclasses that return "..." no longer trigger Pylance / pyright reportIncompatibleMethodOverride warnings

PromptGroup system: bundle related variants (system / chat / pre / post / message / prompt) under a single named group, queryable via manager.get_prompt_group(name) with attribute, dict, and callable access (group.system(...), group["chat"])
@prompt_group decorator for explicit group assignment with optional explicit key
Auto-detection of group membership from class-name suffix (case-insensitive, with or without underscore)
PromptManager.get_prompt_group, get_prompt_group_names, get_prompt_groups

Removed the related_prompt system from PromptBase and PromptManager (superseded by PromptGroup)
get_metadata() no longer returns related_prompt_names

Fixed mutable default argument bug in PromptBase.__init__ that caused state to leak across instances when subclasses mutated default piece dicts in place

Fixed Python 3.8 and 3.9 compatibility by using Union[str, List[str]] instead of str | List[str] syntax
Fixed license field in pyproject.toml for compatibility with older setuptools versions
Removed conflicting license classifier from pyproject.toml