-
Notifications
You must be signed in to change notification settings - Fork 39
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
Replace toml with tomllib & tomli #857
Conversation
Hello. You may have forgotten to update the changelog!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Ali
Co-authored-by: Amintor Dusko <87949283+AmintorDusko@users.noreply.github.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #857 +/- ##
===========================================
- Coverage 92.20% 59.50% -32.70%
===========================================
Files 93 24 -69
Lines 11376 2146 -9230
===========================================
- Hits 10489 1277 -9212
+ Misses 887 869 -18 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we want to use tomlkit
over toml
again? Seems like we'll favor tomlkit
so could you update the PR's title?
We initially aimed to transition away from using We now use |
@maliasadi, why the exception for Windows? |
@AmintorDusko cibuildwheel on Windows expects toml polices to parse the |
Thanks @maliasadi for the nice work. I'm wondering if it works with arm64? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks @maliasadi .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job!
Before submitting
Please complete the following checklist when submitting a PR:
All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to the
tests
directory!All new functions and code must be clearly commented and documented.
If you do make documentation changes, make sure that the docs build and
render correctly by running
make docs
.Ensure that the test suite passes, by running
make test
.Add a new entry to the
.github/CHANGELOG.md
file, summarizing thechange, and including a link back to the PR.
Ensure that code is properly formatted by running
make format
.When all the above are checked, delete everything above the dashed
line and fill in the pull request template.
Context:
Prefer
tomlkit
overtoml
for building Lightning wheels, and choosetomli
andtomllib
overtoml
when installing the package.Description of the Change:
Benefits:
tomli
andtomllib
(for python > 3.10) provides a read-only, lightweight and fast toml parser compare totoml
tomlkit
gets regular updates and provides support for all the toml updates and new standards.toml
hasn't been updated since Oct 2020.Possible Drawbacks:
Related GitHub Issues:
[sc-71707]