Skip to content

Add _from_json functionality for pybamm.sign#4517

Merged
kratman merged 4 commits into
pybamm-team:developfrom
pipliggins:add-from-json-sign
Oct 15, 2024
Merged

Add _from_json functionality for pybamm.sign#4517
kratman merged 4 commits into
pybamm-team:developfrom
pipliggins:add-from-json-sign

Conversation

@pipliggins
Copy link
Copy Markdown
Contributor

@pipliggins pipliggins commented Oct 15, 2024

Description

_from_json in pybamm.Sign was previously labelled as NotImplemented; #4394 identified this as a mistake as the pybamm.Sign class should be able to be de/serialised. This PR adds that functionality in.

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ nox -s quick).

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.42%. Comparing base (d48f8c6) to head (c5f2efe).
Report is 160 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4517      +/-   ##
===========================================
- Coverage    99.42%   99.42%   -0.01%     
===========================================
  Files          301      299       -2     
  Lines        22736    22715      -21     
===========================================
- Hits         22605    22584      -21     
  Misses         131      131              

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

@pipliggins pipliggins marked this pull request as ready for review October 15, 2024 13:30
Copy link
Copy Markdown
Member

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@kratman kratman merged commit fb81f21 into pybamm-team:develop Oct 15, 2024
pkalbhor pushed a commit to pkalbhor/PyBaMM that referenced this pull request Nov 15, 2024
* Add _from_json functionality for Sign + test

* Update changelog

---------

Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>
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.

3 participants