Python: Add math example #156
Conversation
hillary-mutisya
requested review from
DanielRosenwasser,
umeshma,
steveluc and
pcdeadeasy
python/examples/math/program.py
Outdated
| JsonProgram = TypedDict("Program", {"@steps": list[FunctionCall]}) | ||
|
|
||
|
|
||
| async def evaluate_json_program(program: Mapping[str, Any], onCall: Callable[[str, list[Any]], Awaitable[Any]]) -> Any: |
There was a problem hiding this comment.
Can we use Dict[str, Any], I haven't seen Mapping being used as frequently?
Instead of list[Any] can we Change it to List[any]. Also for clarity, can we use type hints from the typing module like List, Dict instead of list, dict etc.
There was a problem hiding this comment.
As it turns out, the typing module's Dict, List, Set, Tuple, Type and other types are deprecated aliases for their lowercase siblings (https://docs.python.org/3/library/typing.html#deprecated-aliases). The guidance is to use the lowercase instances of these constructs for folks writing new code.
We're currently building on python 3.12. If we want to support conventions from previous python versions, we may need to pull in typing_extensions as a dependency. @DanielRosenwasser suggested this in another PR and I will be looking into this.
| async def evaluate_array(array: list[Any]) -> list[Any]: | ||
| return await asyncio.gather(*[evaluate_call(e) for e in array]) | ||
|
|
||
| async def evaluate_object(expr: FunctionCall): |
There was a problem hiding this comment.
would be good to define the return types expected for this function like maybe Union[List[str], ... , None]:
There was a problem hiding this comment.
Good call, I updated the methods to return Expression or Sequence[Expression]. This enables us to handle simple str, int, float etc. types, user-defined objects, callable types and more. JsonPrograms are very versatile.
|
|
||
|
|
||
| class TypeChatProgramValidator(TypeChatValidator[T]): | ||
| def __init__(self, py_type: type[T]): |
There was a problem hiding this comment.
The uppercase Type has been deprecated in favor of the lowercase type: https://docs.python.org/3/library/typing.html#typing.Type
There was a problem hiding this comment.
Might be mistaken, but I do think it should be type[T]
| return s | ||
|
|
||
|
|
||
| program_schema_text = ''' |
There was a problem hiding this comment.
Why not just generate this with python_type_to_typescript_schema so you have a single source of truth?
| async def evaluate_object(expr: FunctionCall): | ||
| if "@ref" in expr: | ||
| index = expr["@ref"] | ||
| if index < len(results): |
There was a problem hiding this comment.
You probably need to make sure expr is an int, and report otherwise, and report if it is out of bounds.
There was a problem hiding this comment.
I'd get rid of schemaV2, it's not used.
There was a problem hiding this comment.
Let's sync up on this. As I see it, the goal of the examples is to show devs how to use the library. In this case, the program APIs can be presented using the typeddict-of-callables approach (schema.py) or the protocol approach (schemav2.py). We support both approaches and the devs are free to choose either one. I'm going to add some Readme files that will explain how to switch between the different schema definitions
There was a problem hiding this comment.
I'd rename this to program_translator
This change adds a simple calculator example which uses JsonProgram for its schema. This is similar to the math example in the typescript implementation. Some changes: