gavo.votable.model module
xmlstan elements of VOTable.
-
class gavo.votable.model.VOTable[source]
Bases: _MIVOTElements
The container for VOTable elements.
-
class BINARY(id=None)[source]
Bases: _BinaryDataElement
-
class BINARY2(id=None)[source]
Bases: _BinaryDataElement
-
class COOSYS(ID=None, epoch=None, equinox=None, id=None, refposition=None, system=None)[source]
Bases: _VOTElement
-
class DATA(id=None)[source]
Bases: _VOTElement
-
class DEFINITIONS(id=None)[source]
Bases: _VOTElement
-
class DESCRIPTION(id=None)[source]
Bases: _VOTElement
-
class DescribedElement(ID=None, id=None, name=None, ref=None, ucd=None, utype=None)[source]
Bases: _VOTElement
-
getDescription() → str[source]
returns the description for this element, or an empty string.
-
getDesignation() → str[source]
returns some name-like thing for a FIELD or PARAM.
-
class FIELD(ID=None, arraysize=None, datatype=None, format=None, id=None, name=None, precision=None, ref=None, type=None, ucd=None, unit=None, utype=None, width=None, xtype=None)[source]
Bases: TypedElement
-
class FIELDref(ID=None, id=None, name=None, ref=None, ucd=None, unit=None, utype=None, xtype=None)[source]
Bases: _RefElement
-
class FITS(id=None)[source]
Bases: _VOTElement
-
class GROUP(ID=None, id=None, name=None, ref=None, ucd=None, utype=None)[source]
Bases: DescribedElement
-
class INFO(ID=None, id=None, name=None, ref=None, ucd=None, unit=None, utype=None, value=None, xtype=None)[source]
Bases: _ValuedElement
-
isEmpty() → bool[source]
returns true if the current node has no non-empty children and no
non-whitespace text content.
-
class INFO_atend(ID=None, id=None, name=None, ref=None, ucd=None, unit=None, utype=None, value=None, xtype=None)[source]
Bases: INFO
-
name_ = 'INFO'
-
class LINK(ID=None, action=None, content_role=None, content_type=None, gref=None, href=None, id=None, name=None, title=None, value=None)[source]
Bases: _VOTElement
-
class MAX(id=None, inclusive=None, value=None)[source]
Bases: _VOTElement
-
isEmpty() → bool[source]
returns true if the current node has no non-empty children and no
non-whitespace text content.
-
class MIN(id=None, inclusive=None, value=None)[source]
Bases: _VOTElement
-
isEmpty() → bool[source]
returns true if the current node has no non-empty children and no
non-whitespace text content.
-
class OPTION(id=None, name=None, value='')[source]
Bases: _VOTElement
-
class PARAM(ID=None, arraysize=None, datatype=None, format=None, id=None, name=None, precision=None, ref=None, type=None, ucd=None, unit=None, utype=None, value='', width=None, xtype=None)[source]
Bases: TypedElement
-
class PARAMref(ID=None, id=None, name=None, ref=None, ucd=None, unit=None, utype=None, xtype=None)[source]
Bases: _RefElement
-
class RESOURCE(ID=None, id=None, name=None, type=None, utype=None)[source]
Bases: _VOTElement
-
writeErrorElement(outputFile: BinaryIO, exception: Exception)[source]
-
class ROLE(id=None)[source]
Bases: _VOTElement
-
class STREAM(actuate=None, encoding=None, expires=None, href=None, id=None, rights=None, type=None)[source]
Bases: _VOTElement
-
class TABLE(ID=None, id=None, name=None, nrows=None, ref=None, ucd=None, utype=None)[source]
Bases: DescribedElement
A TABLE element.
If you want to access fields by name (getFieldForName), make sure
name and ids are unique.
-
getFieldForName(name: str) → FIELD[source]
returns the FIELD having a name or id of name.
A KeyError is raised when the field does not exist; if names are
not unique, the last column with the name specified is returned.
-
getFields() → List[FIELD][source]
-
class TABLEDATA(id=None)[source]
Bases: _ContentElement
-
write(file: BinaryIO) → None[source]
-
class TD(encoding=None, id=None)[source]
Bases: _VOTElement
-
class TIMESYS(ID=None, id=None, refposition='UNKNOWN', timeorigin=None, timescale='UNKNOWN')[source]
Bases: _VOTElement
-
class TR(ID=None, id=None)[source]
Bases: _VOTElement
-
class TYPE(id=None)[source]
Bases: _VOTElement
-
class TypedElement(ID=None, arraysize=None, datatype=None, format=None, id=None, name=None, precision=None, ref=None, type=None, ucd=None, unit=None, utype=None, width=None, xtype=None)[source]
Bases: _ValuedElement
-
getLength() → Optional[int][source]
returns the number of items one should expect in value, or
None for variable-length arrays.
-
getShape() → Optional[Tuple[int, ...]][source]
-
hasVarLength() → bool[source]
-
isMultiDim() → bool[source]
-
isScalar() → bool[source]
-
class VALUES(ID=None, id=None, null=None, ref=None, type=None)[source]
Bases: _VOTElement
-
isEmpty() → bool[source]
returns true if the current node has no non-empty children and no
non-whitespace text content.
-
class VOTABLE(ID=None, id=None, version='1.5')[source]
Bases: _VOTElement
-
class VOTABLE11(ID=None, id=None, version='1.1')[source]
Bases: VOTABLE
-
name_ = 'VOTABLE'
-
class VOTABLE12(ID=None, id=None, version='1.2')[source]
Bases: VOTABLE
-
name_ = 'VOTABLE'
-
gavo.votable.model.voTag(tagName: str, version: str = '1.4')[source]
returns the VOTable QName for tagName.
You only need this if you want to search in ElementTrees.