feat!: Comptime functions #727
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #727 +/- ##
========================================
Coverage 93.11% 93.12%
========================================
Files 74 82 +8
Lines 8632 9393 +761
========================================
+ Hits 8038 8747 +709
- Misses 594 646 +52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| Previous use occurred in | ||
| linear_copy6.py:15 |
There was a problem hiding this comment.
This line-break is a bug in diagnostics rendering. See #818
guppylang/tracing/function.py
Outdated
| # Type error in the return statement. For example, this happens if users | ||
| # try to return a struct with invalid field values | ||
| raise GuppyError(TracingReturnTypeError(node, str(err))) from None | ||
| except ValueError as err: |
There was a problem hiding this comment.
I'm confused as to why these are raising standard Python errors rather than guppy internal ones
There was a problem hiding this comment.
Errors from guppy_object_from_py can also surface to the user so they are not internal. We just catch them here since they ocurr while processing the function return, so we don't have a useful traceback
If you prefer, we could create a new user-facing GuppyComptimeError instead of using Python's builtin ValueError and TypeError?
| using `guppy_object_from_py`, updates the wires of any `GuppyObjects` contained in | ||
| `v` to the new wires specified by `obj`. | ||
|
|
||
| Also resets the used flag on any of those updated wires. |
There was a problem hiding this comment.
This corresponds to making a value available again after a borrow expires. I'll add this to the docstring
There was a problem hiding this comment.
is this done? I couldn't find it
guppylang/std/builtins.py
Outdated
| class array(Generic[_T, _n]): | ||
| class array(list[_T], Generic[_T, _n]): | ||
| """Class to import in order to use arrays.""" | ||
|
|
||
| def __init__(self, *args: Any): | ||
| pass | ||
| list.__init__(self, args) |
There was a problem hiding this comment.
include this as a comment in the code
| from guppylang.module import GuppyModule | ||
|
|
||
| import guppylang.decorator as decorator | ||
|
|
||
|
|
||
| # Regular expression to match the `~~~~~^^^~~~` highlights that are printed in | ||
| # tracebacks from Python 3.11 onwards. We strip those out so we can use the same golden | ||
| # files for Python 3.10 |
There was a problem hiding this comment.
Do you have another preferred solution? We could store multiple .err files for each Python version, but then each we make will need to run pytest --snapshot-update for all versions which would be annoying
| 10 | xs.pop() | ||
| | ^^^^^^^^^^^^ | ||
|
|
||
| Borrowed argument `xs` cannot be returned back to the caller. Expected it to |
There was a problem hiding this comment.
Suggest rephrasing something like "xs is borrowed so must be returned to the caller. ..."
There was a problem hiding this comment.
Maybe we should also mention that this return is happening implicitly. Otherwise, useres might get confused and try to return it themselves?
| | ^^^^^^^^^^^^^^ | ||
|
|
||
| Borrowed argument `xs` cannot be returned back to the caller. Cannot infer the | ||
| type of empty list |
There was a problem hiding this comment.
| type of empty list | |
| type of empty list. |
| @@ -3,4 +3,4 @@ Traceback (most recent call last): | |||
| module.compile() | |||
| File "$FILE", line 13, in test | |||
| foo(1, 2, 3, 4) | |||
| guppylang.error.GuppyComptimeError: Too many arguments: Expected 2, got 4 | |||
There was a problem hiding this comment.
what happened to the expected line
| using `guppy_object_from_py`, updates the wires of any `GuppyObjects` contained in | ||
| `v` to the new wires specified by `obj`. | ||
|
|
||
| Also resets the used flag on any of those updated wires. |
There was a problem hiding this comment.
is this done? I couldn't find it
Adds a new
guppy.comptimedecorator for functions that construct Hugr via tracing of the Python interpreter.The most important bits are in the new
guppylang.tracingmodule:state.pydefines the shared state that is maintained during tracingfunction.pycontains the main entry point for tracing of a function:trace_function. It also contains the logic for handling function calls during tracing:trace_callobject.pydefines the newGuppyObjectclass. This is the abstract representation of values that are not statically known (e.g. function inputs, outputs of called functions, etc.). It also contains theGuppyDefinitionclass which is the new object that is returned to users when they decorate a function.unpacking.pydefines the logic for turningGuppyObjectsrepresenting structured types into their Python equivalent and vice versa. For example, Guppy tuples are turned into Python tuples, Guppy arrays are turned into Python lists.Some more esoteric things:
builtins_mock.pycontains some metaclass hacks to mock builtin functionsint,float, andlento acceptGuppyObjectsfrozenlist.pyis an implementation of immutable lists. They are needed to prevent users from mutating function inputs to preserve Python semantics.util.pydefines the logic for dealing with exceptions and modifying tracebacks to hide internal compiler frames from the userOther changes:
execute_llvmRust library to support passing function inputs. This is to make testing of arithmetic functions easier.sys.excepthookon the caught exception in the test (seetests.error.util.run_error_test)tests.error.util.run_error_testto ignore those differencesFollow-ups:
py(...)expressions tocomptime(...)with comptime:blocksBREAKING CHANGE: Guppy decorators now return instances of
GuppyDefinitionCloses #751