xml.Options

The xml.Options class represents the validation job’s options as a dictionary. This class implements the .

class xml.Options

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Methods

xml.Options.clear()

Removes all entries from the options dictionary.

xml.Options.get(option, default=None)

Returns the value of the given option. If the option was not previously set, default is returned. This method will not raise a KeyError exception.

xml.Options.items()

Returns a new view of option name/value tuples contained in this options dictionary.

xml.Options.keys()

Returns a new view of option names contained in this options dictionary.

xml.Options.pop(option, **kargs)

Returns the value for the given option and then removes it from the options dictionary. If the option was not found, default is returned. If default was not specified, a KeyError exception is raised.

xml.Options.popitem()

Returns a random option name/value tuple for the options dictionary and then removes it from the options dictionary. If the options dictionary is empty, a KeyError exception is raised.

xml.Options.setdefault(option, default=None)

Returns the value of the given option. If the option was not previously set, it is stored with the default value and default is returned. This method will not raise a KeyError exception.

xml.Options.update(other)

Updates the options dictionary from an other dictionary. Any existing options are overwritten.

xml.Options.values()

Returns a new view of option values contained in this options dictionary.

Special methods

__contains__, __delitem__, __eq__, __ge__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __setitem__