from promplate.chain import *#
promplate.chain.callback #
BaseCallback #
Bases: ProtocolSource code in
promplate/chain/callback.py
pre_process #
pre_process(context: ChainContext) -> Context | Awaitable[Context | None] | None
Source code in promplate/chain/callback.py
mid_process #
mid_process(context: ChainContext) -> Context | Awaitable[Context | None] | None
Source code in promplate/chain/callback.py
end_process #
end_process(context: ChainContext) -> Context | Awaitable[Context | None] | None
Source code in promplate/chain/callback.py
on_enter #
on_leave #
on_leave(node: Interruptible, context: ChainContext, config: Context) -> tuple[ChainContext, Context]
Callback #
Bases: BaseCallbackSource code in
promplate/chain/callback.py
__init__ #
__init__(*, pre_process: Process | AsyncProcess | None = None, mid_process: Process | AsyncProcess | None = None, end_process: Process | AsyncProcess | None = None, on_enter: Callable[[Interruptible, Context | None, Context], tuple[Context | None, Context]] | None = None, on_leave: Callable[[Interruptible, ChainContext, Context], tuple[ChainContext, Context]] | None = None)
Source code in promplate/chain/callback.py
pre_process #
mid_process #
end_process #
on_enter #
promplate.chain.node #
Process module-attribute #
Process = Callable[[ChainContext], Context | None]
AsyncProcess module-attribute #
AsyncProcess = Callable[[ChainContext], Awaitable[Context | None]]
Configurable #
Source code in promplate/llm/base.py
Complete #
AsyncGenerate #
Bases: Protocol
ChainContext #
Bases: SafeChainMapContextSource code in
promplate/chain/node.py
result deletable property writable #
__init__ #
__init__(least: MutableMapping | None = None, *maps: Mapping)
__new__ #
__new__(least: MutableMapping | None = None, *maps: Mapping)
Source code in promplate/chain/node.py
ensure classmethod #
AbstractNode #
Bases: ProtocolSource code in
promplate/chain/node.py
invoke #
invoke(context: Context | None = None, /, complete: Complete | None = None, **config) -> ChainContext
ainvoke async #
ainvoke(context: Context | None = None, /, complete: Complete | AsyncComplete | None = None, **config) -> ChainContext
stream #
stream(context: Context | None = None, /, generate: Generate | None = None, **config) -> Iterable[ChainContext]
astream #
astream(context: Context | None = None, /, generate: Generate | AsyncGenerate | None = None, **config) -> AsyncIterable[ChainContext]
Interruptible #
Bases: AbstractNode, ProtocolSource code in
promplate/chain/node.py107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
class Interruptible(AbstractNode, Protocol):
def _invoke(
self,
context: ChainContext,
/,
complete: Complete | None,
callbacks: list[BaseCallback],
**config,
): ...
async def _ainvoke(
self,
context: ChainContext,
/,
complete: Complete | AsyncComplete | None,
callbacks: list[BaseCallback],
**config,
): ...
def _stream(
self,
context: ChainContext,
/,
generate: Generate | None,
callbacks: list[BaseCallback],
**config,
) -> Iterable: ...
def _astream(
self,
context: ChainContext,
/,
generate: Generate | AsyncGenerate | None,
callbacks: list[BaseCallback],
**config,
) -> AsyncIterable: ...
callbacks: list[BaseCallback | type[BaseCallback]]
def enter(self, context: Context | None, config: Context):
callbacks: list[BaseCallback] = ensure_callbacks(self.callbacks)
for callback in callbacks:
context, config = callback.on_enter(self, context, config)
return context, config, callbacks
def leave(self, context: ChainContext, config: Context, callbacks: list[BaseCallback]):
for callback in reversed(callbacks):
context, config = callback.on_leave(self, context, config)
return context, config
def add_pre_processes(self, *processes: Process | AsyncProcess):
self.callbacks.extend(Callback(pre_process=i) for i in processes)
return self
def add_mid_processes(self, *processes: Process | AsyncProcess):
self.callbacks.extend(Callback(mid_process=i) for i in processes)
return self
def add_end_processes(self, *processes: Process | AsyncProcess):
self.callbacks.extend(Callback(end_process=i) for i in processes)
return self
def add_callbacks(self, *callbacks: BaseCallback | type[BaseCallback]):
self.callbacks.extend(callbacks)
return self
def pre_process(self, process: Process | AsyncProcess):
self.add_pre_processes(process)
return process
def mid_process(self, process: Process | AsyncProcess):
self.add_mid_processes(process)
return process
def end_process(self, process: Process | AsyncProcess):
self.add_end_processes(process)
return process
def callback(self, callback: BaseCallback | type[BaseCallback]):
self.add_callbacks(callback)
return callback
@staticmethod
def _apply_pre_processes(context: ChainContext, callbacks: list[BaseCallback]):
for callback in callbacks:
context |= cast(Context, callback.pre_process(context) or {})
@staticmethod
def _apply_mid_processes(context: ChainContext, callbacks: list[BaseCallback]):
for callback in callbacks:
context |= cast(Context, callback.mid_process(context) or {})
@staticmethod
def _apply_end_processes(context: ChainContext, callbacks: list[BaseCallback]):
for callback in reversed(callbacks):
context |= cast(Context, callback.end_process(context) or {})
@staticmethod
async def _apply_async_pre_processes(context: ChainContext, callbacks: list[BaseCallback]):
for callback in callbacks:
context |= cast(Context, await resolve(callback.pre_process(context)) or {})
@staticmethod
async def _apply_async_mid_processes(context: ChainContext, callbacks: list[BaseCallback]):
for callback in callbacks:
context |= cast(Context, await resolve(callback.mid_process(context)) or {})
@staticmethod
async def _apply_async_end_processes(context: ChainContext, callbacks: list[BaseCallback]):
for callback in reversed(callbacks):
context |= cast(Context, await resolve(callback.end_process(context)) or {})
def invoke(self, context=None, /, complete=None, **config) -> ChainContext:
context, config, callbacks = self.enter(context, config)
context = ChainContext.ensure(context)
try:
self._invoke(ChainContext(context, self.context), complete, callbacks, **config)
except Jump as jump:
context, config = self.leave(context, config, callbacks)
if jump.out_of is not None and jump.out_of is not self:
raise jump from None
if jump.into is not None:
jump.into.invoke(context, complete, **config)
else:
context, config = self.leave(context, config, callbacks)
return context
async def ainvoke(self, context=None, /, complete=None, **config) -> ChainContext:
context, config, callbacks = self.enter(context, config)
context = ChainContext.ensure(context)
try:
await self._ainvoke(ChainContext(context, self.context), complete, callbacks, **config)
except Jump as jump:
context, config = self.leave(context, config, callbacks)
if jump.out_of is not None and jump.out_of is not self:
raise jump from None
if jump.into is not None:
await jump.into.ainvoke(context, complete, **config)
else:
context, config = self.leave(context, config, callbacks)
return context
def stream(self, context=None, /, generate=None, **config) -> Iterable[ChainContext]:
context, config, callbacks = self.enter(context, config)
context = ChainContext.ensure(context)
try:
for _ in self._stream(ChainContext(context, self.context), generate, callbacks, **config):
yield context
except Jump as jump:
context, config = self.leave(context, config, callbacks)
if jump.out_of is not None and jump.out_of is not self:
raise jump from None
if jump.into is not None:
yield from jump.into.stream(context, generate, **config)
else:
context, config = self.leave(context, config, callbacks)
async def astream(self, context=None, /, generate=None, **config) -> AsyncIterable[ChainContext]:
context, config, callbacks = self.enter(context, config)
context = ChainContext.ensure(context)
try:
async for _ in self._astream(ChainContext(context, self.context), generate, callbacks, **config):
yield context
except Jump as jump:
context, config = self.leave(context, config, callbacks)
if jump.out_of is not None and jump.out_of is not self:
raise jump from None
if jump.into is not None:
async for i in jump.into.astream(context, generate, **config):
yield i
else:
context, config = self.leave(context, config, callbacks)
_context: Context | None
@property
def context(self):
if self._context is None:
self._context = {}
return self._context
@context.setter
def context(self, context: Context | None):
self._context = context
@context.deleter
def context(self):
self._context = None
callbacks instance-attribute #
callbacks: list[BaseCallback | type[BaseCallback]]
context deletable property writable #
enter #
Source code in promplate/chain/node.py
leave #
leave(context: ChainContext, config: Context, callbacks: list[BaseCallback])
add_pre_processes #
add_pre_processes(*processes: Process | AsyncProcess)
add_mid_processes #
add_mid_processes(*processes: Process | AsyncProcess)
add_end_processes #
add_end_processes(*processes: Process | AsyncProcess)
add_callbacks #
add_callbacks(*callbacks: BaseCallback | type[BaseCallback])
pre_process #
pre_process(process: Process | AsyncProcess)
mid_process #
mid_process(process: Process | AsyncProcess)
end_process #
end_process(process: Process | AsyncProcess)
callback #
callback(callback: BaseCallback | type[BaseCallback])
invoke #
invoke(context=None, /, complete=None, **config) -> ChainContext
Source code in promplate/chain/node.py
ainvoke async #
ainvoke(context=None, /, complete=None, **config) -> ChainContext
Source code in promplate/chain/node.py
stream #
stream(context=None, /, generate=None, **config) -> Iterable[ChainContext]
Source code in promplate/chain/node.py
astream async #
astream(context=None, /, generate=None, **config) -> AsyncIterable[ChainContext]
Source code in promplate/chain/node.py
Interruptable #
Bases: Interruptible, Protocol
Node #
Bases: Loader, InterruptibleSource code in
promplate/chain/node.py313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
class Node(Loader, Interruptible):
def __init__(
self,
template: Template | str,
partial_context: Context | None = None,
llm: LLM | None = None,
**config,
):
self.template = Template(template) if isinstance(template, str) else template
self._context = partial_context
self.callbacks: list[BaseCallback | type[BaseCallback]] = []
self.llm = llm
self.run_config = config
def _invoke(self, context, /, complete, callbacks, **config):
complete = cast(Complete, self.llm.complete if self.llm else complete)
assert complete is not None
prompt = self.render(context, callbacks)
context.result = complete(prompt, **(self.run_config | config))
self._apply_mid_processes(context, callbacks)
self._apply_end_processes(context, callbacks)
def _stream(self, context, /, generate, callbacks, **config):
generate = cast(Generate, self.llm.generate if self.llm else generate)
assert generate is not None
prompt = self.render(context, callbacks)
for result in accumulate(generate(prompt, **(self.run_config | config))):
context.result = result
self._apply_mid_processes(context, callbacks)
yield
self._apply_end_processes(context, callbacks)
async def _ainvoke(self, context, /, complete, callbacks, **config):
complete = cast(Complete | AsyncComplete, self.llm.complete if self.llm else complete)
assert complete is not None
prompt = await self.arender(context, callbacks)
context.result = await resolve(complete(prompt, **(self.run_config | config)))
await self._apply_async_mid_processes(context, callbacks)
await self._apply_async_end_processes(context, callbacks)
async def _astream(self, context, /, generate, callbacks, **config):
generate = cast(Generate | AsyncGenerate, self.llm.generate if self.llm else generate)
assert generate is not None
prompt = await self.arender(context, callbacks)
async for result in accumulate_any(generate(prompt, **(self.run_config | config))):
context.result = result
await self._apply_async_mid_processes(context, callbacks)
yield
await self._apply_async_end_processes(context, callbacks)
def render(self, context: Context | None = None, callbacks: list[BaseCallback] | None = None):
if callbacks is None:
callbacks = ensure_callbacks(self.callbacks)
context = ChainContext(context, self.context)
self._apply_pre_processes(context, callbacks)
return self.template.render(context)
async def arender(self, context: Context | None = None, callbacks: list[BaseCallback] | None = None):
if callbacks is None:
callbacks = ensure_callbacks(self.callbacks)
context = ChainContext(context, self.context)
await self._apply_async_pre_processes(context, callbacks)
return await self.template.arender(context)
def __str__(self):
return f"</{self.name}/>"
template instance-attribute #
template = Template(template) if isinstance(template, str) else template
callbacks instance-attribute #
callbacks: list[BaseCallback | type[BaseCallback]] = []
llm instance-attribute #
run_config instance-attribute #
__init__ #
__init__(template: Template | str, partial_context: Context | None = None, llm: LLM | None = None, **config)
Source code in promplate/chain/node.py
render #
render(context: Context | None = None, callbacks: list[BaseCallback] | None = None)
Source code in promplate/chain/node.py
arender async #
arender(context: Context | None = None, callbacks: list[BaseCallback] | None = None)
Source code in promplate/chain/node.py
Loop #
Bases: InterruptibleSource code in
promplate/chain/node.py
chain instance-attribute #
callbacks instance-attribute #
callbacks: list[BaseCallback | type[BaseCallback]] = []
__init__ #
__init__(chain: AbstractNode, partial_context: Context | None = None)
Chain #
Bases: InterruptibleSource code in
promplate/chain/node.py
callbacks instance-attribute #
callbacks: list[BaseCallback | type[BaseCallback]] = []
__init__ #
__init__(*nodes: AbstractNode, partial_context: Context | None = None)
__iadd__ #
__iadd__(chain: AbstractNode)
__iter__ #
Jump #
Bases: Exception
into instance-attribute #
out_of instance-attribute #
__init__ #
__init__(into: Interruptible | None = None, out_of: Interruptible | None = None)
ensure_callbacks #
ensure_callbacks(callbacks: list[BaseCallback | type[BaseCallback]]) -> list[BaseCallback]
promplate.chain.utils #
appender #
count_position_parameters #
resolve async #
async_accumulate async #
async_accumulate(async_iterable: AsyncIterable[str])
accumulate_any #
accumulate_any(any_iterable: Iterable[str] | AsyncIterable[str])