Skip to content

feat!: Make decorator return types more precise #1115

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

Jump to bottom
Merged
merged 1 commit into from
Jul 31, 2025
Merged

feat!: Make decorator return types more precise #1115

merged 1 commit into from
Jul 31, 2025

Conversation

@mark-koch
Copy link
Collaborator

@mark-koch mark-koch commented Jul 24, 2025

Closes #1114

Adds a new GuppyFunctionDefinition objects that is returned from the decorator for all kinds of function definitions (vanilla, comptime, wasm, custom, hugr_op, declare, overload).

As a drive-by, I also added a new CompiledHugrNodeDefinition ABC that is implemented by all definitions that compile to a Hugr node

BREAKING CHANGE: guppylang.tracing.object.GuppyDefinition moved to guppylang.defs.GuppyDefinition
BREAKING CHANGE: guppylang.tracing.object.TypeVarGuppyDefinition moved and renamed to guppylang.defs.GuppyTypeVarDefinition

@mark-koch mark-koch requested a review from ss2165 July 24, 2025 12:09
@mark-koch mark-koch requested a review from a team as a code owner July 24, 2025 12:09
mark-koch
mark-koch commented Jul 24, 2025
View reviewed changes
guppylang/decorator.py
mono_args = tuple(None for _ in checked_def.params)

compiled_def = ENGINE.compiled[obj.id, mono_args]
assert isinstance(compiled_def, CompiledFunctionDef | CompiledPytketDef)
Copy link
Collaborator Author

@mark-koch mark-koch Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were missing a lot of definition kinds in this assert. The new CompiledHugrNodeDef ABC makes this check more uniform

mark-koch
mark-koch commented Jul 24, 2025
View reviewed changes
guppylang/definition/traced.py
Comment on lines -52 to -56
def compile(self) -> FuncDefnPointer:
from guppylang.decorator import guppy

return guppy.compile_function(self)

Copy link
Collaborator Author

@mark-koch mark-koch Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

drive-by: This should have been deleted a while ago 😅

@codecov-commenter
Copy link

codecov-commenter commented Jul 24, 2025

Codecov Report

Attention: Patch coverage is 94.54545% with 6 lines in your changes missing coverage. Please review.

Project coverage is 92.42%. Comparing base (63854c5) to head (4257784).

Files with missing lines Patch % Lines
guppylang/defs.py 90.62% 3 Missing ⚠️
guppylang/definition/const.py 80.00% 1 Missing ⚠️
guppylang/definition/extern.py 80.00% 1 Missing ⚠️
guppylang/definition/traced.py 83.33% 1 Missing ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1115      +/-   ##
==========================================
+ Coverage   92.32%   92.42%   +0.09%     
==========================================
  Files         112      113       +1     
  Lines       11119    11154      +35     
==========================================
+ Hits        10266    10309      +43     
+ Misses        853      845       -8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cqc-alec cqc-alec requested review from cqc-alec and removed request for ss2165 July 30, 2025 14:52
cqc-alec
cqc-alec approved these changes Jul 30, 2025
View reviewed changes
Copy link
Contributor

@cqc-alec cqc-alec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mark-koch mark-koch enabled auto-merge July 30, 2025 15:43
@mark-koch mark-koch added this pull request to the merge queue Jul 31, 2025
Merged via the queue into main with commit c84e8b1 Jul 31, 2025
4 checks passed
@mark-koch mark-koch deleted the feat/better-defs branch July 31, 2025 09:54
This was referenced Jul 31, 2025
Closed
Merged
github-merge-queue bot pushed a commit that referenced this pull request Aug 4, 2025
@hugrbot @ss2165
chore: release guppylang 0.21.0 (#1135)
b95409e 
🤖 I have created a release *beep* *boop*
---


##
[0.21.0](guppylang-v0.20.0...guppylang-v0.21.0)
(2025-08-04)


### ⚠ BREAKING CHANGES

* All compiler-internal and non-userfacing functionality is moved into a
new `guppylang_internals` package
* `guppy.compile(foo)` and `guppy.check(foo)` replaced with
`foo.check()` and `foo.compile()`
* default HUGR output uses compressed binary encoding.
* `guppylang.tracing.object.GuppyDefinition` moved to
`guppylang.defs.GuppyDefinition`
`guppylang.tracing.object.TypeVarGuppyDefinition` moved and renamed to
`guppylang.defs.GuppyTypeVarDefinition`
* All `to_hugr` methods on types, arguments, and parameters now require
a `ToHugrContext` `CompileableDef.compile_outer` now requires a
`ToHugrContext` `guppy.hugr_op` now passes the compiler context to the
function generating the op `CheckedFunctionDef` now implements
`MonomorphizableDef` instead of `CompileableDef`
`CompilerContext.build_compiled_def` now requires an instantiation for
the definition's type parameters The `ToHugrContext` protocol now
requires two additional methods: `type_var_to_hugr` and
`const_var_to_hugr` `CompilerContext.{compiled, worklist}` and
`CompilationEngine.compiled` are now indexed by a tuple of `DefId` and
optional `PartiallyMonomorphizedArgs`
* comptime code that previously used constant integers outside i64 will
now fail to compile.
* Capturing closures are now disabled by default. Enabling them requires
calling `guppylang.enable_experimental_features()`, however note that
they are not supported throughout the stack.

### Features

* Add `Future` type
([#1075](#1075))
([5ad7673](5ad7673))
* add error when constant integer out of bounds
([#1084](#1084))
([eee77ae](eee77ae))
* Add guppy version metadata to hugr entrypoint
([#1039](#1039))
([0eafbd9](0eafbd9)),
closes [#1037](#1037)
* Add manual registration of extensions
([#1045](#1045))
([4b42936](4b42936))
* add qsystem op for measure leaked
([#1057](#1057))
([c555727](c555727))
* add selene via optional feature and use for testing
([#1081](#1081))
([cefc70e](cefc70e))
* Add support for V and Vdg.
([#1094](#1094))
([6b0d44a](6b0d44a))
* Allow indexing on tuples
([#1038](#1038))
([0e9097e](0e9097e)),
closes [#711](#711)
* Declare WASM modules in guppy
([#942](#942))
([e1240fb](e1240fb))
* Extend comptime arguments to arbitrary non-linear types
([#1110](#1110))
([384dd8c](384dd8c))
* Make decorator return types more precise
([#1115](#1115))
([c84e8b1](c84e8b1))
* set hugr entrypoint to compiled function
([#1063](#1063))
([16bd267](16bd267))
* store used extensions and versions in HUGR metadata
([#1049](#1049))
([a9a300c](a9a300c)),
closes [#1048](#1048)
* Support arbitrary const generics via monomorphisation
([#1033](#1033))
([bcf9865](bcf9865))
* Support Python 3.12 generic syntax
([#1051](#1051))
([ab2e118](ab2e118)),
closes [#823](#823)
* Top level compile + emulate Interface
([#1127](#1127))
([5e2f595](5e2f595))
* update to hugr-py v0.13
([#1083](#1083))
([8f071c8](8f071c8))
* use `core.` prefix for metadata keys
([#1055](#1055))
([2bf0d68](2bf0d68))


### Bug Fixes

* Allow array comprehension syntax in comptime functions
([#1068](#1068))
([da8f04a](da8f04a)),
closes [#1067](#1067)
* Allow struct redefinitions for Python < 3.13
([#1108](#1108))
([959a4e4](959a4e4)),
closes [#1107](#1107)
* Correctly detect
`[@Custom](https://github.com/custom)_guppy_decorator` in nested scopes
([#1086](#1086))
([678583c](678583c))
* Fix diagnostics rendering for comptime entrypoints
([#1099](#1099))
([fdd2676](fdd2676)),
closes [#1097](#1097)
* Fix frame lookup for Python 3.12 annotation scopes
([#1120](#1120))
([a69e489](a69e489)),
closes [#1116](#1116)
* Fix hugr conversion and bounds checks on numeric literals
([#1100](#1100))
([73d5e92](73d5e92))
* Fix Jupyter notebook diagnostic rendering
([#1109](#1109))
([6002474](6002474))
* Fix nested function definitions in Python 3.12
([#1064](#1064))
([090f920](090f920))
* Stop showing temporary variables in comptime diagnostics
([#1112](#1112))
([63854c5](63854c5)),
closes [#1111](#1111)
* support comptime entrypoint
([#1079](#1079))
([721e3dd](721e3dd))
* Turn capturing closures into experimental feature
([#1065](#1065))
([a959b18](a959b18))


### Documentation

* add docstrings for emulator module
([#1131](#1131))
([b33e065](b33e065))
* add quantum and qsystem gate definitions
([#912](#912))
([32a4bbc](32a4bbc))
* Fix docstrings
([#1128](#1128))
([0aded85](0aded85))
* Improve RNG docs
([#1043](#1043))
([8640f06](8640f06))
* replace `compile_module` usage in README
([#1041](#1041))
([03ccf3a](03ccf3a))
* Update guppy examples
([#1121](#1121))
([b994655](b994655))


### Code Refactoring

* Split up into `guppylang_internals` package
([#1126](#1126))
([81d50c0](81d50c0))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: Seyon Sivarajah <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ss2165 ss2165 ss2165 approved these changes

@cqc-alec cqc-alec cqc-alec approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Stop lying to mypy about decorator return types

5 participants

@mark-koch @codecov-commenter @ss2165 @cqc-alec