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 arg to the end of the list.
Method
Remove all items from list.
Method
Return number of occurrences of arg.
Method
Extend self by appending elements from arg.
Method
Return first occurence of value between start and end - defaults to full range
Method
Insert object arg1 before index arg0.
Method
Remove and return item at index (default last).
Method
Read variable from file.
Method
Remove first occurrence of arg.
Method
Saves variable to file.
Static Method
Create variable from file.
Static Method
Create variable from file.
Operator
Overloaded function.
Operator
Overloaded function.
Operator
Overloaded function.
Operator
__format__(self, arg: str, /) -> str
Operator
__ge__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
Operator
Overloaded function.
Operator
__getstate__(self) -> tuple[pyarts3.arts.ArrayOfString]
Operator
__gt__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
Operator
Return hash(self).
Operator
Overloaded function.
Operator
Allows iter(self)
Operator
__le__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
Operator
Return the number of items in the list.
Operator
__lt__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
Operator
Overloaded function.
Operator
__repr__(self) -> str
Operator
Overloaded function.
Operator
__setstate__(self, arg: tuple[pyarts3.arts.ArrayOfString]) -> None
Operator
__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.
__init__(self) -> None
Default constructor
__init__(self, arg: pyarts3.arts.ArrayOfString) -> None
Copy constructor
__init__(self, arg: collections.abc.Iterable[pyarts3.arts.String], /) -> None
Construct from an iterable object
__init__(self) -> None
__init__(self, arg: pyarts3.arts.ArrayOfString) -> None
Methods
- 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
- 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:
- 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:
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:
- 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.
__contains__(self, arg: str, /) -> bool
Return true if arg is in the list.
__contains__(self, arg: object, /) -> bool
Return false.
- __delitem__(self, i: int) None
- __delitem__(self, slice: slice) None
Overloaded function.
__delitem__(self, i: int) -> None
Remove the i-th item from the list.
__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.
__eq__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
self == other
__eq__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
- __ge__(self, arg: pyarts3.arts.ArrayOfString, /) bool
- __getitem__(self, i: int) str
- __getitem__(self, slice: slice) pyarts3.arts.ArrayOfString
Overloaded function.
__getitem__(self, i: int) -> str
Return the i-th item.
__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.
__init__(self) -> None
Default constructor
__init__(self, arg: pyarts3.arts.ArrayOfString) -> None
Copy constructor
__init__(self, arg: collections.abc.Iterable[pyarts3.arts.String], /) -> None
Construct from an iterable object
__init__(self) -> None
__init__(self, arg: pyarts3.arts.ArrayOfString) -> None
- __iter__(self) collections.abc.Iterator[str]
Allows iter(self)
- __le__(self, arg: pyarts3.arts.ArrayOfString, /) bool
- __lt__(self, arg: pyarts3.arts.ArrayOfString, /) bool
- __ne__(self, arg: pyarts3.arts.ArrayOfString, /) bool
- __ne__(self, arg: pyarts3.arts.ArrayOfString, /) bool
Overloaded function.
__ne__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
self != other
__ne__(self, arg: pyarts3.arts.ArrayOfString, /) -> bool
- __setitem__(self, i: int, value: str) None
- __setitem__(self, slice: slice, value: pyarts3.arts.ArrayOfString) None
Overloaded function.
__setitem__(self, i: int, value: str) -> None
Set the i-th item to value.
__setitem__(self, slice: slice, value: pyarts3.arts.ArrayOfString) -> None
Set a slice of the list.
- __setstate__(self, arg: tuple[pyarts3.arts.ArrayOfString]) None