Code quality and pylint improvements to `A` #11

nariman87 · 2022-04-06T00:54:50Z

Context for changes

Improvements:
- A large number of linting corrections were made to improve the overall pylint report. These were mostly minor but essential modifications including restructuring, re-coding, optimization, updating .pylintrc, adding .coveragerc. The code quality score is improved to A for the released version. Check "Files changed" for details.
- TODO comments have been removed exclusively from files with low code quality grades. The Dev team has created tickets to be actioned for all removed TODO comments on separate (private) FlamingPy boards.
- CONTRIBUTING.rst, code_of_conduct.md, and CHNAGLELOG.md were imported and modified from the StrawberryFields project. Dev team plans to extend these with customized details in future PRs.

Example usage and tests

Not Applicable

Performance results justifying changes

Not Applicable

Workflow actions and tests

Not Applicable

Expected benefits and drawbacks

Expected benefits:

Improving overall code quality score from B to A. Note the acceptable limit for all future PRs is now set at A.

Related Github issues

Not Applicable

Checklist and integration statements

My Python and C++ codes follow the coding and commenting styles of this project as indicated by existing files. Specifically, the changes conform to given black, docformatter and pylint configurations.
I have performed a self-review of these changes. I have checked my code and corrected misspellings to the best of my capacity. I have checked the codefactor score in the active branch and ensured it is A- or better. I also confirm that I have already merged other branches into this branch as required.
I have added context for corresponding changes in documentation and README.md as needed.
I have added new workflow CI tests for corresponding changes and these pass locally for me.
I have updated CHANGELOG.md following the template. I recognize that the developers may revisit CHANGELOG.md, the versioning, and create a Special Release including my changes.

* Update _version.py * Add IID Pauli noise model * Remove unused imports * Fix issue with linting * Add iid noise example to decoder.py Allow user to change between cv and dv noise examples. * Run black * No need to specify inner decoder for iid case * Run black on test_iid_noise * Remove uniform weight assign * Fix typos and change data function * Fix test docstring * Improve test * Add docstring to apply_noise * Update flamingpy/decoders/decoder.py * Update iid.py * Update flamingpy/noise/iid.py * Delete pauli.py * Update _version.py * Update docs; run black * Update _version.py Co-authored-by: Narimanium <25132802+nariman87@users.noreply.github.com> Co-authored-by: maxtremblay <m@xtremblay.ca> Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com> Co-authored-by: Maxime Tremblay <52462375+maxtremblay@users.noreply.github.com> Co-authored-by: maxtremblay <m@xtremblay.ca> Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

codecov · 2022-04-06T00:59:24Z

Codecov Report

Merging #11 (e42bc11) into main (b905698) will increase coverage by 2.18%.
The diff coverage is 97.11%.

@@            Coverage Diff             @@
##             main      #11      +/-   ##
==========================================
+ Coverage   91.57%   93.75%   +2.18%     
==========================================
  Files          32       32              
  Lines        1863     1841      -22     
==========================================
+ Hits         1706     1726      +20     
+ Misses        157      115      -42

Impacted Files	Coverage Δ
flamingpy/__init__.py	`94.28% <ø> (+2.85%)`	⬆️
flamingpy/codes/surface_code.py	`95.85% <95.83%> (-0.84%)`	⬇️
flamingpy/cv/ops.py	`89.01% <97.50%> (+1.90%)`	⬆️
flamingpy/_version.py	`100.00% <100.00%> (ø)`
flamingpy/cv/macro_reduce.py	`96.20% <100.00%> (ø)`
flamingpy/examples/decoding.py	`87.50% <100.00%> (ø)`
flamingpy/examples/gkp.py	`100.00% <100.00%> (ø)`
flamingpy/utils/viz.py	`87.71% <100.00%> (+0.10%)`	⬆️
flamingpy/benchmarks/matching.py	`100.00% <0.00%> (+2.32%)`	⬆️
flamingpy/benchmarks/decoding.py	`100.00% <0.00%> (+2.63%)`	⬆️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b905698...e42bc11. Read the comment docs.

…mingpy into code-quality-improv

.github/pull_request_template.md

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

README.md

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

ilan-tz · 2022-04-16T01:54:54Z

README.md



 ## Contribution

-We welcome new contributions -- simply fork the FlamingPy repository and make a pull request (PR) containing your contribution. All contributors to FlamingPy will be listed as authors on the releases. Users who contribute significantly to the code (new plugins, functionalities, etc.) may be listed on the arXiv preprints for FlamingPy. See our [release notes and changelogs](https://github.com/XanaduAI/flamingpy/releases) for more details.
+[See our CONTRIBUTING.rst](.github/CONTRIBUTING.rst) <!-- to be changed from relative paths to links -->


Could we / should we have the full text appear here, like it does in the SF readme?

Not possible, unfortunately, see this comment:

This is not possible to my knowledge and will not work. GitHub md does not support include rendering at all, not even for rst!!! And will likely never do. See here. There are third-party tools to merge files before sending them to GitHub (e.g. https://github.com/BurdetteLamar/markdown_helpe), but the results are the same, you have to manually render the file every time.

The best workaround currently is to include a link to the centralized file we want to keep. I just implemented that: so README and docs are linking to .github/CONTRIBUTING.rst (had to replace the .md with .rst for proper rendering in docs). How's that?

We have to either copy-paste manually or run a tool every time or add a link, which is a better solution in my view.

tests/unit/test_graphstates.py

flamingpy/cv/ops.py

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

flamingpy/codes/surface_code.py

nariman87 and others added 4 commits April 3, 2022 20:24

Update _version.py

9c79a7d

Update _version.py

7babdc5

Testing macro_reduce.py with generators

80f273b

nariman87 requested review from ilan-tz and maxtremblay as code owners April 6, 2022 00:54

nariman87 added 7 commits April 6, 2022 11:22

Updating macro_reduce.py

fbdf428

Updating macro_reduce.py

c042af3

Updating macro_reduce.py

a1dce14

Updating .pylintrc

f5184a2

Update pull_request_template.md

77879d8

Updating .pylintrc

2946c53

Updating .pylintrc

56507ca

nariman87 marked this pull request as draft April 6, 2022 07:44

nariman87 self-assigned this Apr 6, 2022

nariman87 added 9 commits April 6, 2022 19:20

Updating test_decoder.py

b7d6ea9

Update _version.py

d1ba75d

Updating test_decoder.py

1fd3519

Merge branch 'code-quality-improv' of https://github.com/XanaduAI/fla…

c336e8e

…mingpy into code-quality-improv

Merge branch 'main' into code-quality-improv

5162968

Running black ...

35ea0ac

Updating test_Decoder.py

f0641c7

Updating test_decoder.py

37171d8

Updating test_decoder.py

3bf578b

nariman87 added the chores Standard routines for open-source software projects label Apr 6, 2022

nariman87 added 4 commits April 6, 2022 21:52

Updating test_decoder.py ...

8ee93d4

Update .gitignore

6aa078b

Updating .pylintrc

3e8285c

Updating .pylintrc

828a788

ilan-tz reviewed Apr 16, 2022

View reviewed changes

.github/pull_request_template.md Outdated Show resolved Hide resolved

nariman87 and others added 2 commits April 16, 2022 11:50

Update .github/CONTRIBUTING.rst

7c337f0

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update .github/pull_request_template.md

2d091ab

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

ilan-tz reviewed Apr 16, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

0ca1f53

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

ilan-tz requested changes Apr 16, 2022

View reviewed changes

nariman87 and others added 15 commits April 16, 2022 12:48

Update tests/unit/test_graphstates.py

f423ecb

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

f0de882

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

268989c

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

64a28a5

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

394363c

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

05556f8

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

09f0cc7

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

1ac6063

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

6077a93

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

d53e405

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

435e9ee

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

341430a

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

3cc322e

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Update flamingpy/cv/ops.py

b13e35c

Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Running black ...

34f2390

nariman87 requested a review from ilan-tz April 16, 2022 03:06

nariman87 and others added 3 commits April 16, 2022 13:08

Update ops.py

3a523de

Update CHANGELOG.md

6d4610c

Update README.md

6349109

ilan-tz reviewed Apr 16, 2022

View reviewed changes

flamingpy/codes/surface_code.py Outdated Show resolved Hide resolved

ilan-tz reviewed Apr 16, 2022

View reviewed changes

flamingpy/codes/surface_code.py Outdated Show resolved Hide resolved

Modify SurfaceCode.generate_stabilizers slightly

e42bc11

ilan-tz approved these changes Apr 16, 2022

View reviewed changes

ilan-tz merged commit caf8d47 into main Apr 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Code quality and pylint improvements to `A` #11

Code quality and pylint improvements to `A` #11

nariman87 commented Apr 6, 2022 •

edited

Loading

codecov bot commented Apr 6, 2022 •

edited

Loading

ilan-tz Apr 16, 2022

nariman87 Apr 16, 2022

nariman87 Apr 16, 2022

Code quality and pylint improvements to A #11

Code quality and pylint improvements to A #11

Conversation

nariman87 commented Apr 6, 2022 • edited Loading

Context for changes

Example usage and tests

Performance results justifying changes

Workflow actions and tests

Expected benefits and drawbacks

Related Github issues

Checklist and integration statements

codecov bot commented Apr 6, 2022 • edited Loading

Codecov Report

ilan-tz Apr 16, 2022

Choose a reason for hiding this comment

nariman87 Apr 16, 2022

Choose a reason for hiding this comment

nariman87 Apr 16, 2022

Choose a reason for hiding this comment

Code quality and pylint improvements to `A` #11

Code quality and pylint improvements to `A` #11

nariman87 commented Apr 6, 2022 •

edited

Loading

codecov bot commented Apr 6, 2022 •

edited

Loading