artiq icon indicating copy to clipboard operation
artiq copied to clipboard

Improve the error shown when an RPC return value fails serialisation

Open mbirtwell opened this issue 2 years ago • 0 comments

ARTIQ Pull Request

Description of Changes

I've encountered failures with RPC return values failing to serialise from time to time. e.g. returning a different type than annotated from the RPC function. Making sure that the name of the RPC function called is included in the error makes tracking down the problem much easier.

Related Issue

Type of Changes

Type
:hammer: Refactoring

Steps (Choose relevant, delete irrelevant before submitting)

All Pull Requests

  • [x] Use correct spelling and grammar.
  • [ ] Update RELEASE_NOTES.rst if there are noteworthy changes, especially if there are changes to existing APIs.
  • [ ] Close/update issues.
  • [ ] Check the copyright situation of your changes and sign off your patches (git commit --signoff, see copyright).

Code Changes

  • [x] Run flake8 to check code style (follow PEP-8 style). flake8 has issues with parsing Migen/gateware code, ignore as necessary.
  • [x] Test your changes or have someone test them. Mention what was tested and how.

Git Logistics

  • [x] Split your contribution into logically separate changes (git rebase --interactive). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See tutorial.
  • [x] Write short & meaningful commit messages. Review each commit for messages (git show). Format:
    topic: description. < 50 characters total.
    
    Longer description. < 70 characters per line
    

Licensing

See copyright & licensing for more info. ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+.

mbirtwell avatar Sep 16 '22 09:09 mbirtwell