FileType

class pyarts.arts.FileType(*args, **kwargs)

Group name: “FileType”

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	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	pyarts.arts.FileType.ASCII	“ascii” - FileType
Static Data	pyarts.arts.FileType.Ascii	“ascii” - FileType
Static Data	pyarts.arts.FileType.BINARY	“binary” - FileType
Static Data	pyarts.arts.FileType.Binary	“binary” - FileType
Static Data	pyarts.arts.FileType.ZASCII	“zascii” - FileType
Static Data	pyarts.arts.FileType.Zip	“zascii” - FileType
Static Data	pyarts.arts.FileType.ascii	“ascii” - FileType
Static Data	pyarts.arts.FileType.bin	“binary” - FileType
Static Data	pyarts.arts.FileType.binary	“binary” - FileType
Static Data	pyarts.arts.FileType.text	“ascii” - FileType
Static Data	pyarts.arts.FileType.zascii	“zascii” - FileType
Static Data	pyarts.arts.FileType.zip	“zascii” - FileType
Operator	__eq__()	self == other
Operator	__ge__()	self >= other
Operator	__getstate__()	__getstate__(self) -> tuple[str]
Operator	__gt__()	self > other
Operator	__hash__()	Allows hashing
Operator	__le__()	self <= other
Operator	__lt__()	self < other
Operator	__ne__()	self != other
Operator	__setstate__()	__setstate__(self, arg: tuple[str], /) -> None

Constructors

__init__(self) → None

__init__(self, arg: pyarts.arts.FileType) → None

__init__(self, arg: str, /) → None

Methods

readxml(self, file: str) → None

Read variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

savexml(self, file: str, type: str = 'ascii', clobber: bool = True) → None

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) – Type of file to save. See FileType for options.

• clobber (bool) – Overwrite existing files or add new file with modified name?

On Error:

Throws RuntimeError for any failure to save

Static Methods

fromxml(file: str) → pyarts.arts.FileType

Create variable from file

Parameters:

file (str) – A file that can be read

On Error:

Throws RuntimeError for any failure to read

get_options() → list[pyarts.arts.FileType]

Get a list of all options

get_options_as_strings() → list[str]

Get a list of all options as strings

Operators

__eq__(self, arg: pyarts.arts.FileType, /) → bool

self == other

__ge__(self, arg: pyarts.arts.FileType, /) → bool

self >= other

__getstate__(self) → tuple[str]

__gt__(self, arg: pyarts.arts.FileType, /) → bool

self > other

__hash__(self) → int

Allows hashing

__le__(self, arg: pyarts.arts.FileType, /) → bool

self <= other

__lt__(self, arg: pyarts.arts.FileType, /) → bool

self < other

__ne__(self, arg: pyarts.arts.FileType, /) → bool

self != other

__setstate__(self, arg: tuple[str], /) → None