-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
4286: API: Move command module into parametes and undocument r=jenshnielsen a=jenshnielsen To make this possible also move Function into Parameters where it more naturally belongs 4291: DoNd: Add support for per group experiment in do_nd r=jenshnielsen a=jenshnielsen Co-authored-by: Jens H. Nielsen <[email protected]> Co-authored-by: Jens Hedegaard Nielsen <[email protected]>
- Loading branch information
Showing
16 changed files
with
447 additions
and
371 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,146 +1,5 @@ | ||
| from typing import TYPE_CHECKING, Optional, Union, Callable, Any, Sequence, List | ||
| # left here for backwards compatibility | ||
| # but not part of the api officially | ||
| from qcodes.parameters import Function | ||
|
|
||
| from qcodes.utils.metadata import Metadatable | ||
| from qcodes.utils.command import Command | ||
| from qcodes.utils.validators import Validator, validate_all | ||
|
|
||
| if TYPE_CHECKING: | ||
| from .base import Instrument, InstrumentBase | ||
|
|
||
|
|
||
| class Function(Metadatable): | ||
| """ | ||
| Defines a function that an instrument can execute. | ||
| This class is meant for simple cases, principally things that | ||
| map to simple commands like ``*RST`` (reset) or those with just a few | ||
| arguments. | ||
| It requires a fixed argument count, and positional args | ||
| only. If your case is more complicated, you're probably better off | ||
| simply making a new method in your Instrument subclass definition. | ||
| The function validators.validate_all can help reduce boilerplate code | ||
| in this case. | ||
| You execute this function object like a normal function, or use its | ||
| .call method. | ||
| Note: | ||
| Parsers only apply if call_cmd is a string. The function form of | ||
| call_cmd should do its own parsing. | ||
| Args: | ||
| name: the local name of this function | ||
| instrument: an instrument that handles this | ||
| function. Default None. | ||
| call_cmd: command to execute on | ||
| the instrument: | ||
| - a string (with positional fields to .format, "{}" or "{0}" etc) | ||
| you can only use a string if an instrument is provided, | ||
| this string will be passed to instrument.write | ||
| - a function (with arg count matching args list) | ||
| args: list of Validator objects, one for | ||
| each arg to the Function | ||
| arg_parser: function to transform the input arg(s) | ||
| to encoded value(s) sent to the instrument. If there are multiple | ||
| arguments, this function should accept all the arguments in order, | ||
| and return a tuple of values. | ||
| return_parser: function to transform the response | ||
| from the instrument to the final output value. may be a | ||
| type casting function like `int` or `float`. If None (default), | ||
| will not wait for or read any response. | ||
| docstring: documentation string for the __doc__ | ||
| field of the object. The __doc__ field of the instance is used by | ||
| some help systems, but not all (particularly not builtin `help()`) | ||
| **kwargs: Arbitrary keyword arguments passed to parent class | ||
| """ | ||
| def __init__(self, name: str, | ||
| instrument: Optional['InstrumentBase'] = None, | ||
| call_cmd: Optional[Union[str, Callable[..., Any]]] = None, | ||
| args: Optional[Sequence[Validator[Any]]] = None, | ||
| arg_parser: Optional[Callable[..., Any]] = None, | ||
| return_parser: Optional[Callable[..., Any]] = None, | ||
| docstring: Optional[str] = None, | ||
| **kwargs: Any): | ||
| super().__init__(**kwargs) | ||
|
|
||
| self._instrument = instrument | ||
| self.name = name | ||
|
|
||
| if docstring is not None: | ||
| self.__doc__ = docstring | ||
| if args is None: | ||
| args = [] | ||
| self._set_args(args) | ||
| self._set_call(call_cmd, arg_parser, return_parser) | ||
|
|
||
| def _set_args(self, args: Sequence[Validator[Any]]) -> None: | ||
| for arg in args: | ||
| if not isinstance(arg, Validator): | ||
| raise TypeError('all args must be Validator objects') | ||
| self._args = args | ||
| self._arg_count = len(args) | ||
|
|
||
| def _set_call(self, call_cmd: Optional[Union[str, Callable[..., Any]]], | ||
| arg_parser: Optional[Callable[..., Any]], | ||
| return_parser: Optional[Callable[..., Any]]) -> None: | ||
| if self._instrument: | ||
| ask_or_write = self._instrument.write | ||
| if isinstance(call_cmd, str) and return_parser: | ||
| ask_or_write = self._instrument.ask | ||
| else: | ||
| ask_or_write = None | ||
|
|
||
| self._call = Command(arg_count=self._arg_count, cmd=call_cmd, | ||
| exec_str=ask_or_write, input_parser=arg_parser, | ||
| output_parser=return_parser) | ||
|
|
||
| def validate(self, *args: Any) -> None: | ||
| """ | ||
| Check that all arguments to this Function are allowed. | ||
| Args: | ||
| *args: Variable length argument list, passed to the call_cmd | ||
| """ | ||
| if self._instrument: | ||
| func_name = (getattr(self._instrument, 'name', '') or | ||
| str(self._instrument.__class__)) + '.' + self.name | ||
| else: | ||
| func_name = self.name | ||
|
|
||
| if len(args) != self._arg_count: | ||
| raise TypeError( | ||
| '{} called with {} args but requires {}'.format( | ||
| func_name, len(args), self._arg_count)) | ||
|
|
||
| validate_all(*zip(self._args, args), context='Function: ' + func_name) | ||
|
|
||
| def __call__(self, *args: Any) -> Any: | ||
| self.validate(*args) | ||
| return self._call(*args) | ||
|
|
||
| def call(self, *args: Any) -> Any: | ||
| """ | ||
| Call methods wraps __call__ | ||
| Args: | ||
| *args: argument to pass to Command __call__ function | ||
| """ | ||
| return self.__call__(*args) | ||
|
|
||
| def get_attrs(self) -> List[str]: | ||
| """ | ||
| Attributes recreated as properties in the RemoteFunction proxy. | ||
| Returns (list): __doc__, _args, and _arg_count get proxied | ||
| """ | ||
| return ['__doc__', '_args', '_arg_count'] | ||
| __all__ = ["Function"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.