_BaseParameter cached value: add set_cache method, make _save_val method useless, convert raw_value attribute to property

[astafan8]

Description

This is needed for setting the cached value of a parameter without calling the meat of it's set method (for example, without communicating to the instrument, in case the parameter is part of an instrument).

Use cases that this covers for sure:

• when initializing an instance of an instrument driver, this can be used to set the cached value of a parameter to a known default of an instrument for cases where instrument does not support querying that value, and only supports setting it to smth (good example, Keysight B1500 and its modules).
• resolves Feature request: set_latest #1222 , for DynaCool driver

ToDo/inventory:

• avoid code duplication of the wrap_set method in set_cached by refactoring -_from_value_to_raw_valueinto its own method and use both places (also refactor_from_raw_value_to_valuefromwrap_get`, just for fun)
• testing, testing, testing
• revise the name of the method - make it set_cache from set_latest
• add _update_cache_from method that is the only one that updates the _latest dictionary, and use it in wrap_get
• make necessary changes to DelegateParameter - a bug discovered where delegate.get_latest() does not forward the call to source.get_latest() which is a bug, issue Bug in DelegateParameter: get_latest and set_cache are not forwarded to source parameter #1782 created - fixing will happen in a separate PR.
• make necessary changes to ParameterWithSetpoints to support it - the're none, so nothing to do
• add docstrings
• mention somewhere in the documentation won't do in this PR since get_latest is also not mentioned anywhere
• link to github issues that this PR resolves
• don't use _save_val in qcodes infra, use set_cache or _update_cache_with instead; _save_val deprecation will follow in other PRs
• convert raw_value attribute to a property: on get it returns self._latest['raw_value'] and on set it only sets self._latest['raw_value']; deprecation, forbidding setting raw_value via the property, etc will follow in other PRs
• don't use raw_value property in parameter.py

Related tasks for other PRs:

• _save_val
  • remove using _save_val in all known drivers, try using pre-this-PR API for this, for example set; if not possible, then use set_cache and bump the dependent qcodes version
    • (Remove usage of _save_val in drivers and core qcodes #1790) (Use set_cache instead of _save_val and setting raw_value attribute in Keysight B1500 driver #1789) qcodes drivers
    • (Stanford Research SIM928: Refactor set_voltage to avoid use of _save_val QCoDeS/Qcodes_contrib_drivers#25) qcodes_contrib_drivers drivers
  • deprecate _save_val, and define qcodes version when it will be removed
  • remove _save_val
• raw_value
  • remove getting raw_value via raw_value attribute (well, now property) from all known instrument drivers - try to use existing API, for example, get_latest
    • (Avoid getting raw_value attribute of parameters in SR830 and partially Alazar #1788) qcodes drivers
    • qcodes_contrib_drivers - there seems to be none
  • remove setting raw_value via raw_value attribute from all known instrument drivers - try using pre-this-PR API for this, for example set; if not possible, then use set_cache and bump the dependent qcodes version
    • (Use set_cache instead of _save_val and setting raw_value attribute in Keysight B1500 driver #1789) qcodes drivers
    • qcodes_contrib_drivers - there seems to be none
  • deprecate setting raw_value via attribute, and define qcodes version when it will be removed
  • deprecate getting raw_value via attribute, and define qcodes version when it will be removed
  • remove raw_value altogether
• (Parameter.set_to: use get_latest, not _latest['value'] #1786) use get_latest() for _SetParamContext._original_value, not _latest[value]
• (Add get_raw_value to GetLatest of Parameter #1787) for consistency with get and get_timestamp, add get_raw_value method to GetLatest class thing that returns self._latest['raw_value']
• (_BaseParameter: add get_cache* API and use it in GetLatest and in snapshot_base #1791) add get_cache/get_cache_raw/get_cache_timestamp which aliases get_latest, and refactor the meat from get_latest to be used in those new methods, also make sure that parameter.get_latest gets the doctoring of GetLatest.get method
• add tests for roundtipping of values and raw values on the level of _from_* methods for hypothesis-generated values, parsers, and all the other stuff
• fix formatting of test_parameter.py, also use ONLY pytest there

[codecov]

Codecov Report

Merging #1757 into master will increase coverage by 0.04%.
The diff coverage is 97.18%.

@@            Coverage Diff             @@
##           master    #1757      +/-   ##
==========================================
+ Coverage   67.44%   67.48%   +0.04%     
==========================================
  Files         147      147              
  Lines       18487    18511      +24     
==========================================
+ Hits        12468    12493      +25     
+ Misses       6019     6018       -1

[astafan8]

@QCoDeS/core Let's start reviewing of this PR. Please have a look at the tests in order to find out if the captured behavior is the one that we want/like. Please also let know if ideologically/conceptually DelegateParameter and ParameterWithSetpointshave to implement something special with respect toset_cached` method (or if it's good as-is).

[jenshnielsen]

thanks, IMHO it's a bug in delegate parameter that get_latest on a delegate parameter does not always call get_latest on the parent parameter. This bug is made more obvious by this feature.

At a first glance I don't think there are any changes needed to parameterwithsetpoints

[astafan8]

@QCoDeS/core ready for review again - see the description for the scope and future todo (i'll either make PRs for them shortly after this merge or add cards to our board).

[jenshnielsen]

Only small comments for the code. Will have a look at the tests later