refactor: clean up StrEnum

Thomas Middelburgrequested to merge
refactor/clean-str-enum into main

Explanation of changes

pyright was not accepting enum values if a parameter was type-hinted as a StrEnum -derived type. Since StrEnum is only part of the standard lib since python 3.11, we have this custom class, but the implementation is a bit non-standard. Usually you use mulitple inheritance from (str, Enum), not sure why this wasn't done before.

I still had to implement __str__ manually because it wasn't playing nice with qcodes in some cases (sometimes I got (e.g.) "TimeSource.FIRST" as a string, and sometimes just "first").

Merge checklist

See also merge request guidelines

  • Merge request has been reviewed (in-depth by a knowledgeable contributor), and is approved by a project maintainer.
  • New code is covered by unit tests (or N/A).
  • New code is documented and docstrings use numpydoc format (or N/A).
  • New functionality: considered making private instead of extending public API (or N/A).
  • Public API changed: added @deprecated and entry in deprecated code suggestions (or N/A).
  • Newly added/adjusted documentation and docstrings render properly (or N/A).
  • Pipeline fix or dependency update: post in #software-for-developers channel to merge main back in or update local packages (or N/A).
  • Tested on hardware (or N/A).
  • CHANGELOG.md for breaking changes and AUTHORS.md have been updated (or N/A).
  • Update Hardware backends documentation if backend interface change or N/A
  • Check whether performance is significantly affected by looking at the Performance metrics results.
  • Windows tests in CI pipeline pass (manually triggered by maintainers before merging).
    • Maintainers do not hit Auto-merge, we need to actively check as manual tests do not block pipeline

For reference, the issues workflow is described in the contribution guidelines.

Edited by Gábor Oszkár Dénes

Merge request reports