Skip to content
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.

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

feat: Package pydantic model for modules + extensions #1387

Merged
merged 3 commits into from
Aug 1, 2024
Merged

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented Aug 1, 2024

Closes #1358

@ss2165 ss2165 requested a review from a team as a code owner August 1, 2024 13:31
@ss2165 ss2165 requested a review from aborgna-q August 1, 2024 13:31
Copy link

codecov bot commented Aug 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.67%. Comparing base (dd1dc48) to head (672ca76).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1387   +/-   ##
=======================================
  Coverage   87.66%   87.67%           
=======================================
  Files         117      117           
  Lines       20279    20286    +7     
  Branches    17981    17981           
=======================================
+ Hits        17778    17786    +8     
+ Misses       1719     1718    -1     
  Partials      782      782           
Flag Coverage Δ
python 91.67% <100.00%> (+0.06%) ⬆️
rust 87.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Collaborator

@aborgna-q aborgna-q left a comment

Choose a reason for hiding this comment

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

👍

The linked issue mentions a spec update. Split that into a separate issue?


class Package(ConfiguredBaseModel):
modules: list[SerialHugr]
extensions: list[Extension]
Copy link
Collaborator

Choose a reason for hiding this comment

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

extensions is defined as required in the schema.
Can we have it default to an empty list?

    extensions: list[Extension] = Field(default_factory=list)

@ss2165
Copy link
Member Author

ss2165 commented Aug 1, 2024

The linked issue mentions a spec update. Split that into a separate issue?

yes, I think that should be done once we settle on hugr-model etc.

@ss2165 ss2165 enabled auto-merge August 1, 2024 13:55
@ss2165 ss2165 added this pull request to the merge queue Aug 1, 2024
Merged via the queue into main with commit 68cfac5 Aug 1, 2024
21 of 22 checks passed
@ss2165 ss2165 deleted the ss/package branch August 1, 2024 14:00
github-merge-queue bot pushed a commit that referenced this pull request Aug 12, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.6.0](hugr-py-v0.5.0...hugr-py-v0.6.0)
(2024-08-12)


### ⚠ BREAKING CHANGES

* **hugr-py:** Moved `hugr.get_serialization_version` to
`hugr.serialization.serial_hugr.serialization_version`
* **hugr-cli:** Cli validate command no longer has a mermaid option, use
`mermaid` sub-command instead.
* `TypeDefBound` uses struct-variants for serialization. `SignatureFunc`
now has variants for missing binary functions, and serializes in to a
new format that indicates expected binaries.

### Features

* `Package` pydantic model for modules + extensions
([#1387](#1387))
([68cfac5](68cfac5)),
closes [#1358](#1358)
* Define `Const` inline by default, and add a parameter to change the
parent ([#1404](#1404))
([3609736](3609736))
* **hugr-cli:** move mermaid to own sub-command
([#1390](#1390))
([77795b9](77795b9))
* **hugr-py:** add type_bound method to `Type`
([#1410](#1410))
([bd5ba47](bd5ba47)),
closes [#1365](#1365)
* **hugr-py:** Allow defining functions, consts, and aliases inside DFGs
([#1394](#1394))
([d554072](d554072))
* **hugr-py:** Reexport commonly used classes from the package root
([#1393](#1393))
([69925d0](69925d0))
* **py:** `Hugr.to_json` and `.load_json` helpers
([#1403](#1403))
([e7f9f4c](e7f9f4c))
* **py:** Allow pre-declaring a `Function`'s output types
([#1417](#1417))
([fa0f5a4](fa0f5a4))
* **py:** implement `iter` on `ToNode`
([#1399](#1399))
([e88910b](e88910b))
* **py:** Parametric int type helper, and arbitrary width int constants
([#1406](#1406))
([abd70c9](abd70c9))
* Serialised extensions
([#1371](#1371))
([31be204](31be204))


### Bug Fixes

* **py:** `Hugr.__iter__` returning `NodeData | None` instead of `Node`s
([#1401](#1401))
([c134584](c134584))
* **py:** Set output cont for Conditionals
([#1415](#1415))
([67bb8a0](67bb8a0))


### Documentation

* **hugr-py:** expand toctree
([#1411](#1411))
([aa81c9a](aa81c9a))
* **hugr-py:** remove multiversion + add justfile command
([#1381](#1381))
([dd1dc48](dd1dc48))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Define schema for "package" (HUGRS + extensions)
2 participants