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

fix(hugr-py): more ruff lints + fix some typos #1246

Merged
merged 3 commits into from
Jul 1, 2024
Merged

fix(hugr-py): more ruff lints + fix some typos #1246

merged 3 commits into from
Jul 1, 2024

Conversation

ss2165
Copy link
Member

@ss2165 ss2165 commented Jul 1, 2024

import ruff.toml from guppylang

  • turn on more lints
  • mostly auto fixes, mostly import sorting

add a config file for typos tool https://github.com/crate-ci/typos?tab=readme-ov-file

  • we could consider adding this to CI/pre-commit but don't want to do a big repo-wide change right now
  • I used cli typos tool with cargo install typos-cli

coverage is not happy because most of the fixes are in TYPE_CHECKING import blocks or unraised exceptions

ss2165 added 2 commits July 1, 2024 10:26
import ruff.toml from guppylang

turn on more lints

mostly auto fixes, mostly import sorting
add a config file for `typos` tool https://github.com/crate-ci/typos?tab=readme-ov-file

we could consider adding this to CI/pre-commit but don't want to do a big repo-wide change right now
@ss2165 ss2165 requested a review from a team as a code owner July 1, 2024 09:44
@ss2165 ss2165 requested review from aborgna-q and croyzor and removed request for aborgna-q July 1, 2024 09:44
@ss2165 ss2165 changed the title fix: fix some typos fix(hugr-py): fix some typos Jul 1, 2024
Copy link

codecov bot commented Jul 1, 2024

Codecov Report

Attention: Patch coverage is 69.07216% with 30 lines in your changes missing coverage. Please review.

Project coverage is 86.91%. Comparing base (4c6c8cd) to head (5b53d26).
Report is 1 commits behind head on main.

Current head 5b53d26 differs from pull request most recent head fb8251a

Please upload reports for the commit fb8251a to get more accurate results.

Files Patch % Lines
hugr-py/src/hugr/cond_loop.py 40.00% 6 Missing ⚠️
hugr-py/src/hugr/dfg.py 0.00% 6 Missing ⚠️
hugr-py/src/hugr/ops.py 60.00% 4 Missing ⚠️
hugr-py/src/hugr/cfg.py 62.50% 3 Missing ⚠️
hugr-py/src/hugr/node_port.py 62.50% 3 Missing ⚠️
hugr-py/src/hugr/exceptions.py 0.00% 2 Missing ⚠️
hugr-py/src/hugr/function.py 50.00% 2 Missing ⚠️
hugr-py/src/hugr/hugr.py 75.00% 2 Missing ⚠️
hugr-py/src/hugr/serialization/serial_hugr.py 83.33% 1 Missing ⚠️
hugr-py/src/hugr/serialization/tys.py 95.65% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1246      +/-   ##
==========================================
- Coverage   87.00%   86.91%   -0.09%     
==========================================
  Files         100       99       -1     
  Lines       19000    19023      +23     
  Branches    17015    17015              
==========================================
+ Hits        16530    16533       +3     
- Misses       1693     1713      +20     
  Partials      777      777              
Flag Coverage Δ
python 90.58% <69.07%> (-0.90%) ⬇️

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.

**kwargs,
):
config = config or ConfigDict()
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems worse?

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like it's this lint: https://docs.astral.sh/ruff/rules/function-call-in-default-argument/
It seems we can add exceptions, but I can live with this convention

Copy link
Member Author

Choose a reason for hiding this comment

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

python generally doesn't like functions being called in the arguments, taking none then calling the default function inside the body is the preferred pattern

https://docs.astral.sh/ruff/rules/function-call-in-default-argument/

Copy link
Contributor

Choose a reason for hiding this comment

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

By convention, I'd expect nullary constructors like MyStruct() to be benign and more acceptable to put here than an arbitrary function. Maybe too much c++ brain...

Copy link
Contributor

@croyzor croyzor left a comment

Choose a reason for hiding this comment

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

The changes look good but the PR title is wack imo. It's mostly applying lints + a couple of typos

@ss2165 ss2165 changed the title fix(hugr-py): fix some typos fix(hugr-py): more ruff lints + fix some typos Jul 1, 2024
@ss2165 ss2165 added this pull request to the merge queue Jul 1, 2024
@ss2165 ss2165 removed this pull request from the merge queue due to a manual request Jul 1, 2024
@ss2165 ss2165 enabled auto-merge July 1, 2024 10:22
@ss2165 ss2165 added this pull request to the merge queue Jul 1, 2024
Merged via the queue into main with commit f158384 Jul 1, 2024
18 checks passed
@ss2165 ss2165 deleted the ss/more-ruff branch July 1, 2024 10:25
github-merge-queue bot pushed a commit that referenced this pull request Jul 3, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.3.0](hugr-py-v0.2.1...hugr-py-v0.3.0)
(2024-07-03)


### ⚠ BREAKING CHANGES

* * `add_child_op`(`_with_parent`), etc., gone; use
`add_child_node`(`_with_parent`) with an (impl Into-)OpType.
    * `get_nodetype` gone - use `get_optype`.
    * `NodeType` gone - use `OpType` directly. 
    * Various (Into<)Option<ExtensionSet> params removed from builder
    methods especially {cfg_,dfg_}builder.
    * `input_extensions` removed from serialization schema.
* the Signature class is gone, but it's not clear how or why you might
have been using it...
* TailLoop node and associated builder functions now require specifying
an ExtensionSet; extension/validate.rs deleted; some changes to Hugrs
validated/rejected when the `extension_inference` feature flag is turned
on
* Type::validate takes extra bool (allow_rowvars); renamed
{FunctionType, PolyFuncType}::(validate=>validate_var_len).

### Features

* Allow "Row Variables" declared as List&lt;Type&gt;
([#804](#804))
([3ea4834](3ea4834))
* **hugr-py:** add builders for Conditional and TailLoop
([#1210](#1210))
([43569a4](43569a4))
* **hugr-py:** add CallIndirect, LoadFunction, Lift, Alias
([#1218](#1218))
([db09193](db09193)),
closes [#1213](#1213)
* **hugr-py:** add values and constants
([#1203](#1203))
([f7ea178](f7ea178)),
closes [#1202](#1202)
* **hugr-py:** automatically add state order edges for inter-graph edges
([#1165](#1165))
([5da06e1](5da06e1))
* **hugr-py:** builder for function definition/declaration and call
([#1212](#1212))
([af062ea](af062ea))
* **hugr-py:** builder ops separate from serialised ops
([#1140](#1140))
([342eda3](342eda3))
* **hugr-py:** CFG builder
([#1192](#1192))
([c5ea47f](c5ea47f)),
closes [#1188](#1188)
* **hugr-py:** define type hierarchy separate from serialized
([#1176](#1176))
([10f4c42](10f4c42))
* **hugr-py:** only require input type annotations when building
([#1199](#1199))
([2bb079f](2bb079f))
* **hugr-py:** python hugr builder
([#1098](#1098))
([23408b5](23408b5))
* **hugr-py:** store children in node weight
([#1160](#1160))
([1cdaeed](1cdaeed)),
closes [#1159](#1159)
* **hugr-py:** ToNode interface to treat builders as nodes
([#1193](#1193))
([1da33e6](1da33e6))
* Validate Extensions using hierarchy, ignore input_extensions, RIP
inference ([#1142](#1142))
([8bec8e9](8bec8e9))


### Bug Fixes

* Add some validation for const nodes
([#1222](#1222))
([c05edd3](c05edd3))
* **hugr-py:** more ruff lints + fix some typos
([#1246](#1246))
([f158384](f158384))
* **py:** get rid of pydantic config deprecation warnings
([#1084](#1084))
([52fcb9d](52fcb9d))


### Documentation

* **hugr-py:** add docs link to README
([#1259](#1259))
([d2a9148](d2a9148))
* **hugr-py:** build and publish docs
([#1253](#1253))
([902fc14](902fc14))
* **hugr-py:** docstrings for builder
([#1231](#1231))
([3e4ac18](3e4ac18))


### Code Refactoring

* Remove "Signature" from hugr-py
([#1186](#1186))
([65718f7](65718f7))
* Remove NodeType and input_extensions
([#1183](#1183))
([ea5213d](ea5213d))

---
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: hugrbot <[email protected]>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants