FileType
- class pyarts3.arts.FileType(*args, **kwargs)
A choice of file format types.
Valid options:
"ascii"
or"ASCII"
or"Ascii"
or"text"
: Save as ASCII"zascii"
or"ZASCII"
or"Zip"
or"zip"
: Save as zipped ASCII"binary"
or"BINARY"
or"Binary"
or"bin"
: Save as binary data
Overview
Method
Read variable from file.
Method
Saves variable to file.
Static Method
Create variable from file.
Static Method
Get a list of all options
Static Method
Get a list of all options as strings
Static Data
pyarts3.arts.FileType.ASCII
“ascii” (
FileType
)Static Data
pyarts3.arts.FileType.Ascii
“ascii” (
FileType
)Static Data
pyarts3.arts.FileType.BINARY
“binary” (
FileType
)Static Data
pyarts3.arts.FileType.Binary
“binary” (
FileType
)Static Data
pyarts3.arts.FileType.ZASCII
“zascii” (
FileType
)Static Data
pyarts3.arts.FileType.Zip
“zascii” (
FileType
)Static Data
pyarts3.arts.FileType.ascii
“ascii” (
FileType
)Static Data
pyarts3.arts.FileType.bin
“binary” (
FileType
)Static Data
pyarts3.arts.FileType.binary
“binary” (
FileType
)Static Data
pyarts3.arts.FileType.text
“ascii” (
FileType
)Static Data
pyarts3.arts.FileType.zascii
“zascii” (
FileType
)Static Data
pyarts3.arts.FileType.zip
“zascii” (
FileType
)Operator
self == other
Operator
Default object formatter.
Operator
self >= other
Operator
__getstate__(self) -> tuple[str]
Operator
self > other
Operator
Allows hashing
Operator
__init__(self, arg: str, /) -> None
Operator
self <= other
Operator
self < other
Operator
self != other
Operator
__repr__(self) -> str
Operator
__setstate__(self, arg: tuple[str], /) -> None
Operator
__str__(self) -> str
Constructors
- __init__(self) None
- __init__(self, arg: pyarts3.arts.FileType) None
- __init__(self, arg: str, /) None
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:
- 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.FileType
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
- get_options() list[pyarts3.arts.FileType]
Get a list of all options
Operators
- __eq__(self, arg: pyarts3.arts.FileType, /) bool
self == other
- __format__(format_spec, /)
Default object formatter.
Return str(self) if format_spec is empty. Raise TypeError otherwise.
- __ge__(self, arg: pyarts3.arts.FileType, /) bool
self >= other
- __gt__(self, arg: pyarts3.arts.FileType, /) bool
self > other
- __init__(self) None
- __init__(self, arg: pyarts3.arts.FileType) None
- __init__(self, arg: str, /) None
- __le__(self, arg: pyarts3.arts.FileType, /) bool
self <= other
- __lt__(self, arg: pyarts3.arts.FileType, /) bool
self < other
- __ne__(self, arg: pyarts3.arts.FileType, /) bool
self != other