ArrayOfBlock

class pyarts3.arts.ArrayOfBlock(*args, **kwargs)

A list of blocks

Overview

Method	append()	Append arg to the end of the list.
Method	appendxml()	Append variable from file.
Method	clear()	Remove all items from list.
Method	extend()	Extend self by appending elements from arg.
Method	extendxml()	Extend variable from file.
Method	insert()	Insert object arg1 before index arg0.
Method	pop()	Remove and return item at index (default last).
Method	readxml()	Read variable from file.
Method	savexml()	Saves variable to file.
Static Method	fromxml()	Create variable from file.
Static Method	fromxmls()	Create variable from file.
Operator	__delitem__()	__delitem__(self, arg: slice, /) -> None
Operator	__eq__()	Return self==value.
Operator	__format__()	Default object formatter.
Operator	__ge__()	Return self>=value.
Operator	__getitem__()	__getitem__(self, arg: slice, /) -> pyarts3.arts.ArrayOfBlock
Operator	__gt__()	Return self>value.
Operator	__hash__()	Return hash(self).
Operator	__init__()	Overloaded function.
Operator	__iter__()	__iter__(self) -> collections.abc.Iterator[pyarts3.arts.Block]
Operator	__le__()	Return self<=value.
Operator	__len__()	__len__(self) -> int
Operator	__lt__()	Return self<value.
Operator	__ne__()	Return self!=value.
Operator	__repr__()	__repr__(self) -> str
Operator	__setitem__()	__setitem__(self, arg0: slice, arg1: pyarts3.arts.ArrayOfBlock, /) -> None
Operator	__str__()	Return str(self).

Constructors

__init__(self) → None

__init__(self, arg: ArrayOfBlock) → None

__init__(self, arg: Iterable[Block], /) → None

__init__(self) → None

__init__(self, arg: ArrayOfBlock) → None

Overloaded function.

1. __init__(self) -> None

Default constructor

2. __init__(self, arg: pyarts3.arts.ArrayOfBlock) -> None

Copy constructor

3. __init__(self, arg: collections.abc.Iterable[pyarts3.arts.Block], /) -> None

Construct from an iterable object

4. __init__(self) -> None

5. __init__(self, arg: pyarts3.arts.ArrayOfBlock) -> None

Methods

append(self, arg: Block, /) → None

Append arg to the end of the list.

appendxml(self, file: str) → str

Append variable from file.

The content of the file is added to the existing variable.

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

clear(self) → None

Remove all items from list.

extend(self, arg: ArrayOfBlock, /) → None

Extend self by appending elements from arg.

extendxml(self, file: str) → str

Extend variable from file.

The content of the file is added to the existing variable.

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

insert(self, arg0: int, arg1: Block, /) → None

Insert object arg1 before index arg0.

pop(self, index: int = -1) → Block

Remove and return item at index (default last).

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) → ArrayOfBlock

Create variable from file.

Parameters:

file (str) – A file that can be read

Raises:

RuntimeError – For any failure to read.

fromxmls(files: ArrayOfString) → ArrayOfBlock

Create variable from file.

Like fromxml() but for split/multiple files.

Parameters:

files (list[str]) – A list of files that can be read

Raises:

RuntimeError – For any failure to read.

Operators

__delitem__(self, arg: int, /) → None

__delitem__(self, arg: slice, /) → None

__eq__(value, /)

Return self==value.

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(value, /)

Return self>=value.

__getitem__(self, arg: int, /) → Block

__getitem__(self, arg: slice, /) → ArrayOfBlock

__gt__(value, /)

Return self>value.

__hash__()

Return hash(self).

__init__(self) → None

__init__(self, arg: ArrayOfBlock) → None

__init__(self, arg: Iterable[Block], /) → None

__init__(self) → None

__init__(self, arg: ArrayOfBlock) → None

Overloaded function.

1. __init__(self) -> None

Default constructor

2. __init__(self, arg: pyarts3.arts.ArrayOfBlock) -> None

Copy constructor

3. __init__(self, arg: collections.abc.Iterable[pyarts3.arts.Block], /) -> None

Construct from an iterable object

4. __init__(self) -> None

5. __init__(self, arg: pyarts3.arts.ArrayOfBlock) -> None

__iter__(self) → Iterator[Block]

__le__(value, /)

Return self<=value.

__len__(self) → int

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

__repr__(self) → str

__setitem__(self, arg0: int, arg1: Block, /) → None

__setitem__(self, arg0: slice, arg1: ArrayOfBlock, /) → None

__str__()

Return str(self).