refactor!: Store function argument names in `FuncInput` #1286

mark-koch · 2025-10-03T14:07:33Z

It't a lot nicer to have the name of function arguments in the same object as the type an flags instead of the separate list we have at the moment - not adding the name was more of an oversight when we introduced FuncInput 😅

BREAKING CHANGE: FunctionType constructor no longer accepts the input_names argument. Instead, input names should be provided as an optional argument to FuncInput

hugrbot · 2025-10-03T14:08:25Z

This PR contains breaking changes to the public Python API.

Breaking changes summary

guppylang-internals/src/guppylang_internals/tys/ty.py:400: FunctionType.__init__(input_names):
Parameter was removed

guppylang-internals/src/guppylang_internals/tys/ty.py:400: FunctionType.__init__(params):
Positional parameter was moved
Details: position: from 4 to 3 (-1)

guppylang-internals/src/guppylang_internals/tys/ty.py:400: FunctionType.__init__(comptime_args):
Positional parameter was moved
Details: position: from 5 to 4 (-1)

github-actions · 2025-10-03T14:10:31Z

Bencher Report

Branch	refactor/input-names
Testbed	Linux

Click to view all benchmark results

Benchmark	Latency	Benchmark Result microseconds (µs) (Result Δ%)	Upper Boundary microseconds (µs) (Limit %)
tests/benchmarks/test_big_array.py::test_big_array_check	📈 view plot 🚷 view threshold	686,232.48 µs (-6.04%) Baseline: 730,376.70 µs	766,895.54 µs (89.48%)
tests/benchmarks/test_big_array.py::test_big_array_compile	📈 view plot 🚷 view threshold	1,589,160.78 µs (-32.99%) Baseline: 2,371,549.86 µs	2,490,127.35 µs (63.82%)
tests/benchmarks/test_big_array.py::test_big_array_executable	📈 view plot 🚷 view threshold	7,192,009.69 µs (-12.29%) Baseline: 8,199,667.52 µs	8,609,650.90 µs (83.53%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_check	📈 view plot 🚷 view threshold	48,017.71 µs (-37.16%) Baseline: 76,413.95 µs	80,234.65 µs (59.85%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_compile	📈 view plot 🚷 view threshold	85,463.57 µs (-1.83%) Baseline: 87,053.78 µs	91,406.46 µs (93.50%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_executable	📈 view plot 🚷 view threshold	589,873.15 µs (-6.44%) Baseline: 630,467.16 µs	661,990.52 µs (89.11%)
tests/benchmarks/test_prelude.py::test_import_guppy	📈 view plot 🚷 view threshold	24.87 µs (-2.58%) Baseline: 25.53 µs	26.80 µs (92.78%)

🐰 View full continuous benchmarking report in Bencher

github-actions · 2025-10-03T14:10:34Z

Bencher Report

Branch	refactor/input-names
Testbed	Linux

🚨 2 Alerts

Benchmark	Measure Units	View	Benchmark Result (Result Δ%)	Upper Boundary (Limit %)
tests/benchmarks/test_big_array.py::test_big_array_compile	hugr_nodes nodes x 1e3	📈 plot 🚷 threshold 🚨 alert (🔔)	6.59 x 1e3 (+14.98%) Baseline: 5.73 x 1e3	5.79 x 1e3 (113.84%)
tests/benchmarks/test_big_array.py::test_big_array_compile	hugr_bytes bytes x 1e3	📈 plot 🚷 threshold 🚨 alert (🔔)	142.66 x 1e3 (+5.00%) Baseline: 135.86 x 1e3	137.22 x 1e3 (103.96%)

Click to view all benchmark results

Benchmark	hugr_bytes	Benchmark Result bytes x 1e3 (Result Δ%)	Upper Boundary bytes x 1e3 (Limit %)	hugr_nodes	Benchmark Result nodes (Result Δ%)	Upper Boundary nodes (Limit %)
tests/benchmarks/test_big_array.py::test_big_array_compile	📈 view plot 🚷 view threshold 🚨 view alert (🔔)	142.66 x 1e3 (+5.00%) Baseline: 135.86 x 1e3	137.22 x 1e3 (103.96%)	📈 view plot 🚷 view threshold 🚨 view alert (🔔)	6,590.00 (+14.98%) Baseline: 5,731.50	5,788.81 (113.84%)
tests/benchmarks/test_ctrl_flow.py::test_many_ctrl_flow_compile	📈 view plot 🚷 view threshold	21.57 x 1e3 (-0.97%) Baseline: 21.78 x 1e3	22.00 x 1e3 (98.05%)	📈 view plot 🚷 view threshold	606.00 (-6.70%) Baseline: 649.50	656.00 (92.38%)

🐰 View full continuous benchmarking report in Bencher

codecov-commenter · 2025-10-03T14:12:04Z

Codecov Report

❌ Patch coverage is 92.85714% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 93.50%. Comparing base (fe85018) to head (4fb6328).

Files with missing lines	Patch %	Lines
...pylang-internals/src/guppylang_internals/tys/ty.py	90.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1286      +/-   ##
==========================================
- Coverage   93.51%   93.50%   -0.01%     
==========================================
  Files         123      123              
  Lines       11513    11520       +7     
==========================================
+ Hits        10766    10772       +6     
- Misses        747      748       +1

☔ 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.

croyzor · 2025-10-06T08:38:51Z

guppylang-internals/src/guppylang_internals/tys/printing.py


 def signature_to_str(name: str, sig: FunctionType) -> str:
    """Displays a function signature in Python syntax including the function name."""
-    assert sig.input_names is not None


this line shouldn't have to change

because input_names is a property of type Sequence[str] | None that returns None if any elements are unnamed...yes, true, but not necessarily that obvious . See comment on def input_names but maybe go with Craig ;)

acl-cqc

Thanks @mark-koch, looks like a good change :). A couple of queries but generally happy to approve

acl-cqc · 2025-10-13T16:16:59Z

guppylang-internals/src/guppylang_internals/tys/printing.py


 def signature_to_str(name: str, sig: FunctionType) -> str:
    """Displays a function signature in Python syntax including the function name."""
-    assert sig.input_names is not None


because input_names is a property of type Sequence[str] | None that returns None if any elements are unnamed...yes, true, but not necessarily that obvious . See comment on def input_names but maybe go with Craig ;)

acl-cqc · 2025-10-13T16:19:18Z

guppylang-internals/src/guppylang_internals/tys/ty.py


+    @cached_property
+    def input_names(self) -> Sequence[str] | None:
+        """Names of all inputs or `None` if there are unnamed inputs."""


Is it worth adding a def __post_init__ to check that either all have names or none have names? I'm not sure I see any cases where only some might be named....perhaps positional-only arguments??

acl-cqc · 2025-10-13T16:22:01Z

guppylang-internals/src/guppylang_internals/tys/ty.py


+    #: Name of this input, or `None` if it is an unnamed argument (e.g. inside a
+    #: higher-order `Callable` type)
+    name: str | None = field(default=None, compare=False)


Why compare=False? So function types are equal if one has names and the other does not? Not strictly correct - the former can be called with kwargs syntax whereas the latter does not - I'm not sure how much of that stays in guppy but if we do support that, it might be worth going to a more-full-blown FunctionType "generalizes" check allowing assignment of named to nameless but not the other way around?

Guppy currently doesn't support kwargs, so function names are irrelevant when it comes to calling. The same is also true when e.g. trying to unify to function types - we just ignore the names

Ah! Very good. In that case quite right. Maybe worth a # not exposed to caller here then

acl-cqc · 2025-10-13T16:24:29Z

guppylang-internals/src/guppylang_internals/checker/func_checker.py

+            inp.flags,
+            is_func_input=True,
        )
+        for i, inp in enumerate(func_ty.inputs)


Suggested change

for i, inp in enumerate(func_ty.inputs)

for arg, inp in zip(func_def.args.args, func_ty.inputs)

possibly with strict=True

mark-koch · 2025-10-28T17:49:23Z

Apologies, totally forgot about this PR 😅

mark-koch requested a review from a team as a code owner October 3, 2025 14:07

mark-koch requested a review from acl-cqc October 3, 2025 14:07

refactor!: Store function argument names in FuncInput

4fb6328

mark-koch force-pushed the refactor/input-names branch from 6e6e2c2 to 4fb6328 Compare October 3, 2025 14:52

croyzor reviewed Oct 6, 2025

View reviewed changes

acl-cqc reviewed Oct 13, 2025

View reviewed changes

mark-koch added 4 commits October 28, 2025 17:43

Check for unique names

cfca5c8

Use zip

5696145

Revert assert

15ee638

Ruff

ada28f5

mark-koch requested review from acl-cqc and croyzor October 28, 2025 17:49

	for i, inp in enumerate(func_ty.inputs)
	for arg, inp in zip(func_def.args.args, func_ty.inputs)

refactor!: Store function argument names in FuncInput #1286

Are you sure you want to change the base?

refactor!: Store function argument names in FuncInput #1286

Uh oh!

Conversation

mark-koch commented Oct 3, 2025

Uh oh!

hugrbot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚨 2 Alerts

Uh oh!

codecov-commenter commented Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

acl-cqc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mark-koch commented Oct 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

refactor!: Store function argument names in `FuncInput` #1286

refactor!: Store function argument names in `FuncInput` #1286

hugrbot commented Oct 3, 2025 •

edited

Loading

github-actions bot commented Oct 3, 2025 •

edited

Loading

github-actions bot commented Oct 3, 2025 •

edited

Loading

codecov-commenter commented Oct 3, 2025 •

edited

Loading