infra: update the pre-commit hook with linters #678

AbeCoull · 2023-08-18T19:09:02Z

Issue #, if available:

Description of changes:

Testing done:

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

I have read the CONTRIBUTING doc
I used the commit message format described in CONTRIBUTING
I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

I have added tests that prove my fix is effective or that my feature works (if appropriate)
I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

codecov · 2023-08-18T19:12:36Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (1ea24fb) 100.00% compared to head (170fbba) 100.00%.

❗ Current head 170fbba differs from pull request most recent head a06a217. Consider uploading reports for the commit a06a217 to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #678   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          122       122           
  Lines         8144      8144           
  Branches      1826      1826           
=========================================
  Hits          8144      8144

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

speller26 · 2023-08-26T20:57:26Z

.pre-commit-config.yaml

-  - id: tox
-    name: tox
-    stages: [push]
-    language: system
-    entry: tox
-    types: [python]
-    pass_filenames: false
-
-  - id: tox_integ_tests
-    name: tox integ tests
-    stages: [push]
-    language: system
-    entry: tox -e integ-tests
-    types: [python]
-    pass_filenames: false


Why remove these? We want the tests to pass before committing.

I debated keeping the unit-tests run but I am hesitant around keeping the integ-tests. As these require an AWS account, I am not sure we should expect these to be ran by all contributors.

Removing integ tests makes sense, but I think unit tests are still good to have.

.pre-commit-config.yaml

…into pre-commit

.pre-commit-config.yaml

.git-template/hooks/pre-commit

speller26 · 2023-09-06T18:05:48Z

tox.ini

@@ -41,6 +41,17 @@ commands =
    {[testenv:black]commands}
    {[testenv:flake8]commands}

+# Read only linter env
+[testenv:linters_check]


Why not also run isort -c?

Good call! I missed this as an option. I am also planning on using this test env here in our workflows: https://github.com/aws/amazon-braket-sdk-python/blob/main/.github/workflows/check-format.yml#L29. I shall add this check in for both.
Although, I have been eyeing up ruff a bit more recently to take on some of this work... out of scope for the PR.

codecov · 2023-09-13T18:46:06Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (687f706) 100.00% compared to head (c387d7b) 100.00%.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #678   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          122       122           
  Lines         8134      8134           
  Branches      1822      1822           
=========================================
  Hits          8134      8134

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

* feat: add Aria2 enum (#653) Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Cody Wang <[email protected]> * infra: bump actions/checkout from 3.6.0 to 4.0.0 (#696) Bumps [actions/checkout](https://github.com/actions/checkout) from 3.6.0 to 4.0.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@f43a0e5...3df4ab1) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * prepare release v1.55.0 * update development version to v1.55.1.dev0 * Revert "update: restricting parameter names to not collide with ones we use for OpenQASM generation. (#675)" (#701) This reverts commit b158736. * infra: update codeowner file to amazon-braket/braket-dev (#699) Co-authored-by: Abe Coull <[email protected]> * doc: Replace aws org with amazon-braket (#705) * prepare release v1.55.1 * update development version to v1.55.2.dev0 * doc: change the sphinx requirement to be greater than 7.0.0 (#704) Co-authored-by: Cody Wang <[email protected]> * doc: add code contributors to the readme (#703) Co-authored-by: Cody Wang <[email protected]> * doc: Remove trailing backquotes (#706) * infra: update the pre-commit hook with linters (#678) * infra: update the pre-commit hook with linters and secrets check Co-authored-by: Abe Coull <[email protected]> Co-authored-by: Cody Wang <[email protected]> * prepare release v1.55.1.post0 * update development version to v1.55.2.dev0 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: ashlhans <[email protected]> Co-authored-by: Cody Wang <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: ci <ci> Co-authored-by: Milan <[email protected]> Co-authored-by: Angela Guo <[email protected]> Co-authored-by: Abe Coull <[email protected]> Co-authored-by: Abe Coull <[email protected]>

* feat: add queue position for tasks (#299) * feat: add queue position for tasks * update docstring for queue_position * update docstrings * update package_name * update to enums and dataclass * test: add integ test for task queue_position (#300) * refactor: dataclass and file naming for queue info (#301) * refactor: dataclass and file naming for queue info * apply suggestions * update: task queue position after refactor (#309) * update: task queue position after refactor * add queue_position type hint details, change order of info * feat: queue position for hybrid jobs (#302) * feat: queue position for hybrid jobs * handle message return * add docstring changes * update docstring, and return None * add context in dataclass * update docstrings * indent fix * test: add integ test for jobs queue position (#310) * feat: queue position for hybrid jobs * handle message return * add docstring changes * update docstring, and return None * add context in dataclass * test: add integ test for jobs queue position * remove comment * minor fix * remove unnecessary branching * fix docstring merge * remove dataclass redefinition after merge * feat: queue depth for devices (#306) * feat: queue depth for devices (dataclass version) * add unit-test for queue depth * modify docstrings, remove helper funcs * add more info to docstrings * minor test edit * docstrings * indent * update QueuePriority to QueueType * test: add integ test for queue_depth (#311) * refactor: job and quantum_task keywords for queue_depth (#312) * refactor: job and quantum_task keywords for queue_depth * Update src/braket/aws/queue_information.py Co-authored-by: Kshitij Chhabra <[email protected]> --------- Co-authored-by: Kshitij Chhabra <[email protected]> * deps: update boto3 version for queue visibility (#319) * sync: public-main changes into feature/queue_visibility (#320) * feat: add Aria2 enum (#653) Co-authored-by: Viraj Chaudhari <[email protected]> Co-authored-by: Cody Wang <[email protected]> * infra: bump actions/checkout from 3.6.0 to 4.0.0 (#696) Bumps [actions/checkout](https://github.com/actions/checkout) from 3.6.0 to 4.0.0. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@f43a0e5...3df4ab1) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * prepare release v1.55.0 * update development version to v1.55.1.dev0 * Revert "update: restricting parameter names to not collide with ones we use for OpenQASM generation. (#675)" (#701) This reverts commit b158736. * infra: update codeowner file to amazon-braket/braket-dev (#699) Co-authored-by: Abe Coull <[email protected]> * doc: Replace aws org with amazon-braket (#705) * prepare release v1.55.1 * update development version to v1.55.2.dev0 * doc: change the sphinx requirement to be greater than 7.0.0 (#704) Co-authored-by: Cody Wang <[email protected]> * doc: add code contributors to the readme (#703) Co-authored-by: Cody Wang <[email protected]> * doc: Remove trailing backquotes (#706) * infra: update the pre-commit hook with linters (#678) * infra: update the pre-commit hook with linters and secrets check Co-authored-by: Abe Coull <[email protected]> Co-authored-by: Cody Wang <[email protected]> * prepare release v1.55.1.post0 * update development version to v1.55.2.dev0 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: ashlhans <[email protected]> Co-authored-by: Cody Wang <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: ci <ci> Co-authored-by: Milan <[email protected]> Co-authored-by: Angela Guo <[email protected]> Co-authored-by: Abe Coull <[email protected]> Co-authored-by: Abe Coull <[email protected]> * Revert "sync: public-main changes into feature/queue_visibility (#320)" This reverts commit be6460c. * update github script * minor fix --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Kshitij Chhabra <[email protected]> Co-authored-by: ashlhans <[email protected]> Co-authored-by: Cody Wang <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Milan <[email protected]> Co-authored-by: Angela Guo <[email protected]> Co-authored-by: Abe Coull <[email protected]> Co-authored-by: Abe Coull <[email protected]>

infra: update the pre-commit hook with linters and secrets check

17d7908

AbeCoull changed the title ~~infra: update the pre-commit hook with linters and secrets check~~ infra: update the pre-commit hook with linters Aug 18, 2023

AbeCoull marked this pull request as ready for review August 18, 2023 19:27

AbeCoull requested a review from a team as a code owner August 18, 2023 19:27

AbeCoull requested a review from krneta August 18, 2023 19:27

Abe Coull and others added 3 commits August 18, 2023 14:02

add a git commmit reminder

e95e93b

Merge branch 'main' into pre-commit

f6f4eae

Merge branch 'main' into pre-commit

291e6e4

speller26 reviewed Aug 26, 2023

View reviewed changes

AbeCoull and others added 2 commits August 28, 2023 11:09

Merge branch 'main' into pre-commit

9f06429

Merge branch 'main' into pre-commit

0d6502d

speller26 previously approved these changes Aug 28, 2023

View reviewed changes

speller26 reviewed Aug 31, 2023

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

Update .pre-commit-config.yaml

79fdcbf

speller26 dismissed their stale review via 79fdcbf August 31, 2023 20:19

speller26 and others added 5 commits August 31, 2023 14:19

Merge branch 'main' into pre-commit

c24164e

Merge branch 'main' into pre-commit

3e5db5d

make linters run as read only

2479899

Merge branch 'pre-commit' of github.com:aws/amazon-braket-sdk-python …

39e9ae4

…into pre-commit

Merge branch 'main' into pre-commit

d56d2e1

speller26 reviewed Sep 6, 2023

View reviewed changes

.pre-commit-config.yaml Outdated Show resolved Hide resolved

Update .pre-commit-config.yaml

170fbba

speller26 reviewed Sep 6, 2023

View reviewed changes

.git-template/hooks/pre-commit Outdated Show resolved Hide resolved

Update .git-template/hooks/pre-commit

a06a217

speller26 reviewed Sep 6, 2023

View reviewed changes

Abe Coull and others added 2 commits September 13, 2023 11:42

add isort check

6b7b045

Merge branch 'main' into pre-commit

14eccc8

AbeCoull requested a review from speller26 September 13, 2023 19:35

Merge branch 'main' into pre-commit

025fa0b

AbeCoull requested a review from a team as a code owner September 13, 2023 19:35

speller26 approved these changes Sep 14, 2023

View reviewed changes

Merge branch 'main' into pre-commit

c387d7b

AbeCoull merged commit 5ca2d16 into main Sep 15, 2023
28 checks passed

AbeCoull deleted the pre-commit branch September 15, 2023 13:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

infra: update the pre-commit hook with linters #678

infra: update the pre-commit hook with linters #678

AbeCoull commented Aug 18, 2023

codecov bot commented Aug 18, 2023 •

edited

Loading

speller26 Aug 26, 2023

AbeCoull Aug 28, 2023

speller26 Aug 28, 2023

speller26 Sep 6, 2023

AbeCoull Sep 6, 2023

codecov bot commented Sep 13, 2023 •

edited

Loading

infra: update the pre-commit hook with linters #678

infra: update the pre-commit hook with linters #678

Conversation

AbeCoull commented Aug 18, 2023

Merge Checklist

General

Tests

codecov bot commented Aug 18, 2023 • edited Loading

Codecov Report

speller26 Aug 26, 2023

Choose a reason for hiding this comment

AbeCoull Aug 28, 2023

Choose a reason for hiding this comment

speller26 Aug 28, 2023

Choose a reason for hiding this comment

speller26 Sep 6, 2023

Choose a reason for hiding this comment

AbeCoull Sep 6, 2023

Choose a reason for hiding this comment

codecov bot commented Sep 13, 2023 • edited Loading

Codecov Report

codecov bot commented Aug 18, 2023 •

edited

Loading

codecov bot commented Sep 13, 2023 •

edited

Loading