search

XanaduAI / MrMustard

A differentiable bridge between phase space and Fock space
https://mrmustard.readthedocs.io/
Apache License 2.0
78 stars 27 forks source link

Restructuring Mr Mustard states.py, transformations.py and circuit_components_utils.py + pylint misc #444

Closed apchytr closed 3 months ago

apchytr commented 3 months ago

Context: Rather than keeping all our states in a states.py or transformations in a transformations.py for example we should separate out each class into an individual class.py file.

Description of the Change: Individual classes per file (with some exceptions depending on if it makes sense or not)

Benefits: Easier to see what is and isn't implemented from the file structure. Easier to see unit tests for classes. Ensures we don't run into the 'pylint: too complex' check.

Possible Drawbacks: Trade off is that we will have more .py files in our repo.

codecov[bot] commented 3 months ago

Codecov Report

Attention: Patch coverage is 99.66216% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.54%. Comparing base (51dae3d) to head (e625096).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #444 +/- ## =========================================== + Coverage 88.31% 88.54% +0.22% =========================================== Files 82 98 +16 Lines 6669 6799 +130 =========================================== + Hits 5890 6020 +130 Misses 779 779 ``` | [Files](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI) | Coverage Δ | | |---|---|---| | [mrmustard/lab\_dev/circuit\_components.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fcircuit_components.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvY2lyY3VpdF9jb21wb25lbnRzLnB5) | `95.77% <100.00%> (ø)` | | | [...stard/lab\_dev/circuit\_components\_utils/\_\_init\_\_.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fcircuit_components_utils%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvY2lyY3VpdF9jb21wb25lbnRzX3V0aWxzL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [...ustard/lab\_dev/circuit\_components\_utils/b\_to\_ps.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fcircuit_components_utils%2Fb_to_ps.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvY2lyY3VpdF9jb21wb25lbnRzX3V0aWxzL2JfdG9fcHMucHk=) | `100.00% <100.00%> (ø)` | | | [...mustard/lab\_dev/circuit\_components\_utils/b\_to\_q.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fcircuit_components_utils%2Fb_to_q.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvY2lyY3VpdF9jb21wb25lbnRzX3V0aWxzL2JfdG9fcS5weQ==) | `100.00% <100.00%> (ø)` | | | [...tard/lab\_dev/circuit\_components\_utils/trace\_out.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fcircuit_components_utils%2Ftrace_out.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvY2lyY3VpdF9jb21wb25lbnRzX3V0aWxzL3RyYWNlX291dC5weQ==) | `100.00% <100.00%> (ø)` | | | [mrmustard/lab\_dev/circuits.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fcircuits.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvY2lyY3VpdHMucHk=) | `92.25% <100.00%> (ø)` | | | [mrmustard/lab\_dev/states/\_\_init\_\_.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fstates%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvc3RhdGVzL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [mrmustard/lab\_dev/states/coherent.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fstates%2Fcoherent.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvc3RhdGVzL2NvaGVyZW50LnB5) | `100.00% <100.00%> (ø)` | | | [mrmustard/lab\_dev/states/displaced\_squeezed.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fstates%2Fdisplaced_squeezed.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvc3RhdGVzL2Rpc3BsYWNlZF9zcXVlZXplZC5weQ==) | `100.00% <100.00%> (ø)` | | | [mrmustard/lab\_dev/states/squeezed\_vacuum.py](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree&filepath=mrmustard%2Flab_dev%2Fstates%2Fsqueezed_vacuum.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI#diff-bXJtdXN0YXJkL2xhYl9kZXYvc3RhdGVzL3NxdWVlemVkX3ZhY3V1bS5weQ==) | `100.00% <100.00%> (ø)` | | | ... and [17 more](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI) | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI). Last update [51dae3d...e625096](https://app.codecov.io/gh/XanaduAI/MrMustard/pull/444?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=XanaduAI).