Skip to content

refactor(py)!: encapsulate dotpromptz internal modules behind private prefixes #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
huangjeff5 merged 10 commits into from
Oct 5, 2026
Merged

refactor(py)!: encapsulate dotpromptz internal modules behind private prefixes #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b7792e3
refactor(py): make dotpromptz internal modules private and standardiz…
huangjeff5 Oct 2, 2026
1b6079f
docs(py): polish code samples with numbered steps and inline return a…
huangjeff5 Oct 2, 2026
07687d7
feat(py): export standard prompt models, store protocols, and tool parts
huangjeff5 Oct 2, 2026
0238c0a
feat(py): export idiomatic functions, picoschema alias, and resolver …
huangjeff5 Oct 2, 2026
5bd66f2
docs(py): target root dotpromptz module for API reference and fix sto…
huangjeff5 Oct 2, 2026
8bdb112
refactor(py): remove internal package __init__.py files
huangjeff5 Oct 2, 2026
82108bc
chore(py): remove redundant picoschema alias export
huangjeff5 Oct 2, 2026
946dd6a
refactor(py): remove dead is_nullable assignment without behavior change
huangjeff5 Oct 2, 2026
a35d4a0
fix(py): keep published genkit imports working on dotpromptz
huangjeff5 Oct 2, 2026
c0a9ac2
docs(py): list removed dotpromptz submodules in changelog breaking ch…
huangjeff5 Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 16 additions & 96 deletions docs/api/python/dotpromptz.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,120 +6,40 @@ format—an executable prompt template format for Generative AI.
## Installation

```bash
pip install dotpromptz
uv add dotpromptz
```

## Quick Start

```python
from dotpromptz import Dotprompt
from dotpromptz.typing import DataArgument
from dotpromptz import DataArgument, Dotprompt

# Create a Dotprompt instance
# 1. Create a Dotprompt instance
dp = Dotprompt()

# Parse and render a prompt
# 2. Parse and render a prompt
source = '''
---
model: gemini-pro
model: googleai/gemini-flash-latest
input:
schema:
name: string
---
Hello, {{name}}!
'''

rendered = await dp.render(source, data=DataArgument(input={'name': 'World'}))
```

## Core Classes

### Dotprompt

::: dotpromptz.dotprompt.Dotprompt
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Parsing

::: dotpromptz.parse
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Picoschema

::: dotpromptz.picoschema
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Helpers
rendered = await dp.render(source, data=DataArgument(input={'name': 'Ada'}))

::: dotpromptz.helpers
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Resolvers

::: dotpromptz.resolvers
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Types

::: dotpromptz.typing
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Stores

::: dotpromptz.stores
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false

## Errors
# 3. Access rendered message
print(rendered.messages[0].content[0].text)
# => Hello, Ada!
```

::: dotpromptz.errors
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false
## API Reference

## Utilities
::: dotpromptz
options:
show_root_heading: false
members_order: source
heading_level: 3

::: dotpromptz.util
options:
show\_root\_heading: false
show\_source: true
members\_order: source
show\_docstring\_description: true
show\_docstring\_examples: false
4 changes: 4 additions & 0 deletions python/dotpromptz/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
### ⚠ BREAKING CHANGES

* **helpers:** `{{json ...}}` in prompt templates now raises `TypeError` (standard Python `json.dumps()` behavior) instead of `ValueError` when passed non-serializable objects.
* **api:** implementation modules moved behind private `_`-prefixed names; import from the `dotpromptz` root instead ([#626](https://github.com/google/dotprompt/pull/626)). `dotprompt`, `typing`, `stores`, `errors`, `helpers`, `parse`, `picoschema`, `resolvers`, and `util` remain as compatibility re-exports and will be removed in a future release. These 0.1.6 import paths no longer resolve:
* `dotpromptz.picoschema_reverse`: use `from dotpromptz import json_schema_to_picoschema`.
* `dotpromptz.adapters`, `dotpromptz.models`, `dotpromptz.validate`: removed with no public replacement.
* `dotpromptz.package_name()`: removed.

### Features

Expand Down
14 changes: 10 additions & 4 deletions python/dotpromptz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Here's an example of a Dotprompt file that extracts structured data from provide

```handlebars
---
model: googleai/gemini-2.5-pro
model: googleai/gemini-flash-latest
input:
schema:
text: string
Expand All @@ -62,7 +62,7 @@ present, omit that field from the output. Text:

This Dotprompt file:

1. Specifies the use of the `googleai/gemini-2.5-pro` model.
1. Specifies the use of the `googleai/gemini-flash-latest` model.
2. Defines an input schema expecting a `text` string.
3. Specifies that the output should be in JSON format.
4. Provides a schema for the expected output, including fields for name, age, and occupation.
Expand All @@ -78,15 +78,21 @@ Prompt input and runtime context are separate namespaces. Use `{{name}}` for
input and `{{@name}}` for context:

```python
from dotpromptz import Dotprompt
from dotpromptz.typing import DataArgument
from dotpromptz import DataArgument, Dotprompt

# 1. Initialize compiler
prompt = Dotprompt()

# 2. Render prompt with isolated input and context
result = await prompt.render(
'{{name}} is signed in as {{@name}}',
DataArgument(
input={'name': 'Ada'},
context={'name': 'admin'},
),
)

# 3. Access rendered output
print(result.messages[0].content[0].text)
# => Ada is signed in as admin
```
Loading
Loading