Method

class pyarts3.arts.Method(*args, **kwargs)

The method class of ARTS

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
`str`	`name`	The name of the method.
`Wsv` or `None`	`val`	The value (if any) of a set method.
Operator	`__eq__()`	Return self==value.
Operator	`__format__()`	__format__(self, arg: str, /) -> str
Operator	`__ge__()`	Return self>=value.
Operator	`__getstate__()`	Helper for pickle.
Operator	`__gt__()`	Return self>value.
Operator	`__hash__()`	Return hash(self).
Operator	`__init__()`	Overloaded function.
Operator	`__le__()`	Return self<=value.
Operator	`__lt__()`	Return self<value.
Operator	`__ne__()`	Return self!=value.
Operator	`__repr__()`	__repr__(self) -> str
Operator	`__str__()`	__str__(self) -> str

Constructors

__init__(self) → None

__init__(self, arg: pyarts3.arts.Method) → None

__init__(self, name: str, args: pyarts3.arts.ArrayOfString, kwargs: collections.abc.Mapping[str, str]) → None

__init__(self, name: str, wsv: object) → None

Overloaded function.

__init__(self) -> None
__init__(self, arg: pyarts3.arts.Method) -> None
__init__(self, name: str, args: pyarts3.arts.ArrayOfString, kwargs: collections.abc.Mapping[str, str]) -> None

A named method with args and kwargs

__init__(self, name: str, wsv: object) -> None

A method that sets a workspace variable

Methods

readxml(self, file: str) → str

Read variable from file.

Parameters:: file (str) – A file that can be read.
Raises:: RuntimeError – For any failure to read.
Returns:: file – The file path found (may differ from input due to environment variables).
Return type:: str

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → str

Saves variable to file.

Parameters:

file (str) – The path to which the file is written. Note that several of the options might modify the name or write more files.
type (str, optional) – Type of file to save. See FileType for options. Defaults is “ascii”.
clobber (bool, optional) – Overwrite existing files or add new file with modified name? Defaults is True.

Raises:

RuntimeError – For any failure to write.

Returns:

file – The file saved. May differ from input.

Return type:

str

Static Methods

fromxml(file: str) → pyarts3.arts.Method

Create variable from file.

Parameters:: file (str) – A file that can be read
Raises:: RuntimeError – For any failure to read.
Returns:: artstype – The variable created from the file.
Return type:: T

Attributes

name: str: The name of the method.

val: Wsv | None: The value (if any) of a set method.

Operators

__eq__(value, /): Return self==value.

__format__(self, arg: str, /) → str

__ge__(value, /): Return self>=value.

__getstate__(): Helper for pickle.

__gt__(value, /): Return self>value.

__hash__(): Return hash(self).

__init__(self) → None