fix: DefFrame no longer attempts to serialize HARDWARE-OBJECT as json.

[MarquessV]

Description

Closes #1711

I also updated the docstring on get_calibration_program to warn about potentially surprising behavior with returning a cached reference.

Checklist

• [X] The PR targets the master branch
• [X] The above description motivates these changes.
• [X] The change is atomic and can be described by a single commit (your PR will be squashed on merge).
• [x] All changes to code are covered via unit tests.
• [X] Parameters and return values have type hints with PEP 484 syntax.
• [X] Functions and classes have useful Sphinx-style docstrings.
• [X] (Bugfix) The associated issue is referenced above using auto-close keywords.

[rigetti-githubbot]

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
7053	6186	88%	87%	🟢

New Files

No new covered files...

Modified Files

File	Coverage	Status
pyquil/api/_compiler.py	56%	🟢
pyquil/quilbase.py	93%	🟢
TOTAL	74%	🟢

updated for commit: 2a03a75 by action🐍

[notmgsk]

Isn't the example in #1711 a repro test case?

[MarquessV]

Isn't the example in #1711 a repro test case?

I copied it from an external report which doesn't include the specific frame they were trying to identify. I'm making the assumption that it was a json string, but I don't know for sure.