ArrayOfString

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

A list of String

Workspace methods that can generate ArrayOfString

Workspace methods that require ArrayOfString

Overview

Method

append()

Append arg to the end of the list.

Method

clear()

Remove all items from list.

Method

count()

Return number of occurrences of arg.

Method

extend()

Extend self by appending elements from arg.

Method

index()

Return first occurence of value between start and end - defaults to full range

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

remove()

Remove first occurrence of arg.

Method

savexml()

Saves variable to file.

Static Method

fromxml()

Create variable from file.

Static Method

fromxmls()

Create variable from file.

Operator

__contains__()

Overloaded function.

Operator

__delitem__()

Overloaded function.

Operator

__eq__()

Overloaded function.

Operator

__format__()

__format__(self, arg: str, /) -> str

Operator

__ge__()

__ge__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

Operator

__getitem__()

Overloaded function.

Operator

__getstate__()

__getstate__(self) -> tuple[pyarts3.arts.ArrayOfString]

Operator

__gt__()

__gt__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

Operator

__hash__()

Return hash(self).

Operator

__init__()

Overloaded function.

Operator

__iter__()

Allows iter(self)

Operator

__le__()

__le__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

Operator

__len__()

Return the number of items in the list.

Operator

__lt__()

__lt__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

Operator

__ne__()

Overloaded function.

Operator

__repr__()

__repr__(self) -> str

Operator

__setitem__()

Overloaded function.

Operator

__setstate__()

__setstate__(self, arg: tuple[pyarts3.arts.ArrayOfString]) -> None

Operator

__str__()

__str__(self) -> str

Constructors

__init__(self) None
__init__(self, arg: pyarts3.arts.ArrayOfString) None
__init__(self, arg: collections.abc.Iterable[pyarts3.arts.String], /) None
__init__(self) None
__init__(self, arg: pyarts3.arts.ArrayOfString) None

Overloaded function.

  1. __init__(self) -> None

Default constructor

  1. __init__(self, arg: pyarts3.arts.ArrayOfString) -> None

Copy constructor

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

Construct from an iterable object

  1. __init__(self) -> None

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

Methods

append(self, value: str) None

Append arg to the end of the list.

clear(self) None

Remove all items from list.

count(self, arg: str, /) int

Return number of occurrences of arg.

extend(self, arg: pyarts3.arts.ArrayOfString, /) None

Extend self by appending elements from arg.

index(self, value: str, start: int = 0, end: int = 18446744073709551615) int

Return first occurence of value between start and end - defaults to full range

insert(self, arg0: int, arg1: str, /) None

Insert object arg1 before index arg0.

pop(self, index: int = -1) str

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

remove(self, arg: str, /) None

Remove first occurrence of arg.

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.ArrayOfString

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

fromxmls(files: pyarts3.arts.ArrayOfString) pyarts3.arts.ArrayOfString

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.

Returns:

artstype – The variable created from the file.

Return type:

T

Operators

__contains__(self, arg: str, /) bool
__contains__(self, arg: object, /) bool

Overloaded function.

  1. __contains__(self, arg: str, /) -> bool

Return true if arg is in the list.

  1. __contains__(self, arg: object, /) -> bool

Return false.

__delitem__(self, i: int) None
__delitem__(self, slice: slice) None

Overloaded function.

  1. __delitem__(self, i: int) -> None

Remove the i-th item from the list.

  1. __delitem__(self, slice: slice) -> None

Remove a slice of the list.

__eq__(self, arg: pyarts3.arts.ArrayOfString, /) bool
__eq__(self, arg: pyarts3.arts.ArrayOfString, /) bool

Overloaded function.

  1. __eq__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

self == other

  1. __eq__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

__format__(self, arg: str, /) str
__ge__(self, arg: pyarts3.arts.ArrayOfString, /) bool
__getitem__(self, i: int) str
__getitem__(self, slice: slice) pyarts3.arts.ArrayOfString

Overloaded function.

  1. __getitem__(self, i: int) -> str

Return the i-th item.

  1. __getitem__(self, slice: slice) -> pyarts3.arts.ArrayOfString

Return a slice of the list.

__getstate__(self) tuple[pyarts3.arts.ArrayOfString]
__gt__(self, arg: pyarts3.arts.ArrayOfString, /) bool
__hash__()

Return hash(self).

__init__(self) None
__init__(self, arg: pyarts3.arts.ArrayOfString) None
__init__(self, arg: collections.abc.Iterable[pyarts3.arts.String], /) None
__init__(self) None
__init__(self, arg: pyarts3.arts.ArrayOfString) None

Overloaded function.

  1. __init__(self) -> None

Default constructor

  1. __init__(self, arg: pyarts3.arts.ArrayOfString) -> None

Copy constructor

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

Construct from an iterable object

  1. __init__(self) -> None

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

__iter__(self) collections.abc.Iterator[str]

Allows iter(self)

__le__(self, arg: pyarts3.arts.ArrayOfString, /) bool
__len__(self) int

Return the number of items in the list.

__lt__(self, arg: pyarts3.arts.ArrayOfString, /) bool
__ne__(self, arg: pyarts3.arts.ArrayOfString, /) bool
__ne__(self, arg: pyarts3.arts.ArrayOfString, /) bool

Overloaded function.

  1. __ne__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

self != other

  1. __ne__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool

__repr__(self) str
__setitem__(self, i: int, value: str) None
__setitem__(self, slice: slice, value: pyarts3.arts.ArrayOfString) None

Overloaded function.

  1. __setitem__(self, i: int, value: str) -> None

Set the i-th item to value.

  1. __setitem__(self, slice: slice, value: pyarts3.arts.ArrayOfString) -> None

Set a slice of the list.

__setstate__(self, arg: tuple[pyarts3.arts.ArrayOfString]) None
__str__(self) str