compile
¶
ASSISTANT_ROLE
module-attribute
¶
ASSISTANT_ROLE = MessageRole(ASSISTANT)
The assistant role with name not specified.
MaybeOneOrMany
module-attribute
¶
A type that can be either a single item, a sequence of items, or None.
OneOrMany
module-attribute
¶
A type that can be either a single item or a sequence of items.
SYSTEM_ROLE
module-attribute
¶
SYSTEM_ROLE = MessageRole(SYSTEM)
The system role with name not specified.
StrOrImg
module-attribute
¶
A type that can be either a string or an image.
String
module-attribute
¶
String = Union[StringFuture, str]
String is a type alias for StringFuture or str.
APPLCompiled
¶
APPLCompiled(
code: CodeType,
ast: AST,
original_func: Callable,
compile_info: Dict,
)
A compiled APPL function that can be called with context.
Parameters:
-
code
(CodeType
) –The compiled code object.
-
ast
(AST
) –The AST of the compiled code.
-
original_func
(Callable
) –The original function.
-
compile_info
(Dict
) –The compile information.
Source code in src/appl/core/compile.py
AddCtxToArgs
¶
Bases: ApplNodeTransformer
An AST node transformer that adds _ctx to the function arguments.
Source code in src/appl/core/compile.py
visit_FunctionDef
¶
visit_FunctionDef(node: FunctionDef) -> FunctionDef
Add _ctx to the function arguments if not present.
Source code in src/appl/core/compile.py
AddExecuteWrapper
¶
Bases: ApplNodeTransformer
An AST node transformer that adds the appl.execute wrapper to expression statements.
Source code in src/appl/core/compile.py
visit_Expr
¶
Add appl.execute wrapper to expression statements.
Source code in src/appl/core/compile.py
ApplNodeTransformer
¶
Bases: NodeTransformer
A base class for AST node transformers in APPL.
Source code in src/appl/core/compile.py
CallFuture
¶
CallFuture(
func: Callable,
*args: Any,
use_process: bool = False,
lazy_eval: bool = False,
**kwargs: Any
)
Bases: FutureValue
Represent a function call that may not be ready yet.
Parameters:
-
func
(Callable
) –The function to call.
-
*args
(Any
, default:()
) –The arguments of the function.
-
use_process
(bool
, default:False
) –Whether to use a process pool executor.
-
lazy_eval
(bool
, default:False
) –Whether to delay the start of the call until needed.
-
**kwargs
(Any
, default:{}
) –The keyword arguments of the function.
Source code in src/appl/core/types/futures.py
CallWithContext
¶
Bases: ApplNodeTransformer
An AST node transformer provides the context to function calls.
Source code in src/appl/core/compile.py
visit_Call
¶
Provide context (_ctx) to function calls that needs ctx.
Source code in src/appl/core/compile.py
CmpStringFuture
¶
CmpStringFuture(
a: StringFuture,
b: StringFuture,
op: Callable[[str, str], bool],
)
Bases: FutureValue
Represent a comparison between a StringFuture and another value.
Source code in src/appl/core/types/futures.py
ContentList
¶
Bases: BaseModel
Represent a list of contents containing text and images.
append
¶
append(content: StrOrImg) -> None
Append a content to the list.
If the last content is a string, it will be concatenated with the new content.
Source code in src/appl/core/types/content.py
extend
¶
get_contents
¶
get_contents() -> List[Dict[str, Any]]
Return the contents as a list of dictionaries.
Source code in src/appl/core/types/content.py
DedentTripleQuotedString
¶
Bases: CSTTransformer
A CST transformer that dedents triple-quoted strings in the source code.
leave_FormattedString
¶
leave_FormattedString(
original_node: FormattedString,
updated_node: FormattedString,
) -> FormattedString
Dedent triple-quoted formatted strings in the source code.
Source code in src/appl/core/compile.py
leave_SimpleString
¶
Dedent triple-quoted strings in the source code.
Source code in src/appl/core/compile.py
FutureValue
¶
Bases: ABC
Represents a value that may not be ready yet.
Image
¶
Bases: BaseModel
Represent an image in the message.
See the guide for more information about the detail level.
Source code in src/appl/core/types/content.py
from_file
classmethod
¶
Construct an image prompt from an image file.
from_image
classmethod
¶
Construct an image prompt from a PIL ImageFile.
Source code in src/appl/core/types/content.py
MessageRole
¶
RemoveApplDecorator
¶
Bases: ApplNodeTransformer
An AST node transformer that removes the ppl decorator.
Source code in src/appl/core/compile.py
visit_FunctionDef
¶
Remove the ppl decorator from the function definition.
Source code in src/appl/core/compile.py
ResponseType
¶
The type of generation response.
UNFINISHED
class-attribute
instance-attribute
¶
The response is not finished.
SplitString
¶
Bases: ApplNodeTransformer
An AST node transformer that splits the f-string into multiple parts.
Source code in src/appl/core/compile.py
visit_Expr
¶
visit_Expr(node: Expr) -> stmt
Split the f-string into multiple parts, so that we can add appl.execute wrapper to each part.
Source code in src/appl/core/compile.py
StringFuture
¶
StringFuture(content: Any = '', set_value: bool = False)
Bases: FutureValue
, BaseModel
StringFuture is a string that may not be ready yet.
Source code in src/appl/core/types/futures.py
from_list
classmethod
¶
from_list(content: List[Any]) -> StringFuture
join
¶
join(iterable: Iterable[StringFuture]) -> StringFuture
Concatenate any number of strings.
The StringFuture whose method is called is inserted in between each given StringFuture. The result is returned as a new StringFuture.
Source code in src/appl/core/types/futures.py
materialized
¶
materialized() -> StringFuture
appl_compile
¶
appl_compile(func: Callable) -> APPLCompiled
Compile an APPL function.
Source code in src/appl/core/compile.py
appl_dedent
¶
Dedent the source code.
Source code in src/appl/core/compile.py
dedent_triple_quoted_string
¶
Automatically dedent triple-quoted strings with in the code (with inspect.cleandoc).