FileType

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

A choice of file format types.

Overview

Method	`readxml()`	Read variable from file.
Method	`savexml()`	Saves variable to file.
Static Method	`fromxml()`	Create variable from file.
Static Method	`get_options()`	Get a list of all options
Static Method	`get_options_as_strings()`	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	`__eq__()`	self == other
Operator	`__format__()`	Default object formatter.
Operator	`__ge__()`	self >= other
Operator	`__gt__()`	self > other
Operator	`__hash__()`	Allows hashing
Operator	`__init__()`	`__init__(self, arg: str, /) -> None`
Operator	`__le__()`	self <= other
Operator	`__lt__()`	self < other
Operator	`__ne__()`	self != other
Operator	`__repr__()`	`__repr__(self) -> str`
Operator	`__str__()`	`__str__(self) -> str`

Constructors

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) → FileType

Create variable from file.

get_options_as_strings(i: int = 0) → list[str]: Get a list of all options as strings

Operators

__format__(format_spec, /)

Default object formatter.

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