dwca.terms package#

This module corresponds to the “property” type terms defined in https://dwc.tdwg.org/list/#31-index-by-term-name, excluding the deprecated ones. These Python classes represent a field in a data file (core or extension) in a Darwin Core Archive.

Field Class#

class dwca.terms.field.Field(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: XMLObject, ABC

Element use to specify the location and content of data within a dwca.classes.data_file.DataFile.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	type: Type of the field.
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

PRINCIPAL_TAG = 'field'#: str : The principal tag of the XML document.

TYPE#

type: Type of the field.

alias of Any

URI = 'http://rs.tdwg.org/dwc/terms/'#: str: URI for the term represented by this field.

property default: Any#: Any: Specifies a value to use if one is not supplied.

format(value: str) → TYPE#

Format value in the TYPE of the field.

Parameters:

valuestr: Value to be formatted in the type of the respected field.

Returns:

TYPE: Formatted value.

property index: int#: int: Specifies the position of the column in the row.

property name: str#: str: The name of the field.

classmethod name_cls() → str#: str: The name of the field.

classmethod parse(element: Element, nmap: Dict) → Field | None#

Generate a Field object from an XML element instance.

Parameters:

elementlxml.etree.Element: An XML element instance.
nmapDict: Namespace.

Returns:

Field: A Field object.

property sql_type: str#: str: Type of field in a SQL relational database.

to_element() → Element#

Generate an XML element instance from this object.

Returns:

lxml.etree.Element: An XML element instance.

unformat(value: TYPE) → str#

Encode value from TYPE to a string.

Parameters:

valueTYPE: Value to be encoded.

Returns:

str: Text encoded value..

property uri: str#: str: An URI for the term represented by this field.

property vocabulary: str#: str: An URI for a vocabulary that the source values for this Field are based on.

OutsideTerm Class#

This is a special class, and its idea is to represent any field that is not defined in the standard.

class dwca.terms.outside_term.OutsideTerm(index: int | str, uri: str = None, default: TYPE = None, vocabulary: str = None)#

Bases: Field

Terms defined outside the Darwin Core specifications.

Parameters:

indexint | str: Specifies the position of the column in the row.
uristr: URI of the term.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a OutsideTerm object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

classmethod parse(element: Element, nmap: Dict) → OutsideTerm | None#

Generate a OutsideTerm object from an XML element instance.

Parameters:

elementlxml.etree.Element: An XML element instance.
nmapDict: Namespace.

Returns:

OutsideTerm: An OutsideTerm object.

ChronometricAge module#

Extracted from the terms defined in https://chrono.tdwg.org/list/#4-vocabulary

class dwca.terms.chronometric_age.ChronometricAgeConversionProtocol(index: int | str, default: str = None, **kwargs)#

Bases: Field

The method used for converting the UncalibratedChronometricAge into a chronometric age in years.

As captured in the EarliestChronometricAge, EarliestChronometricAgeReferenceSystem, LatestChronometricAge, and LatestChronometricAgeReferenceSystem fields. For example, calibration of conventional radiocarbon age or the currently accepted age range of a cultural or geological period.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeConversionProtocol'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeDeterminedBy(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of names of people, groups, or organizations who determined the ChronometricAge.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeDeterminedBy'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeDeterminedDate(index: int | str, default: datetime = None, **kwargs)#

Bases: Field

The date on which the ChronometricAge was determined.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `datetime`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of datetime

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeDeterminedDate'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the set of information associated with a ChronometricAge.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeID'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeProtocol(index: int | str, default: str = None, **kwargs)#

Bases: Field

A description of or reference to the methods used to determine the chronometric age.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeProtocol'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeReferences(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of identifiers of literature associated with the ChronometricAge.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeReferences'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Notes or comments about the ChronometricAge.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeRemarks'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeUncertaintyInYears(index: int | str, default: int = None, **kwargs)#

Bases: Field

The temporal uncertainty of the EarliestChronometricAge and LatestChronometicAge in years.

The expected unit for this field is years. The value in this field is number of years before and after the values given in the earliest and latest chronometric age fields within which the actual values are estimated to be.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeUncertaintyInYears'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.ChronometricAgeUncertaintyMethod(index: int | str, default: str = None, **kwargs)#

Bases: Field

The method used to generate the value of ChronometricAgeUncertaintyInYears.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/chronometricAgeUncertaintyMethod'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.EarliestChronometricAge(index: int | str, default: int = None, **kwargs)#

Bases: Field

The maximum/earliest/oldest possible age of a specimen as determined by a dating method.

The expected unit for this field is years. This field, if populated, must have an associated EarliestChronometricAgeReferenceSystem.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/chrono/terms/earliestChronometricAge'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.EarliestChronometricAgeReferenceSystem(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The reference system associated with the EarliestChronometricAge.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/earliestChronometricAgeReferenceSystem'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.LatestChronometricAge(index: int | str, default: int = None, **kwargs)#

Bases: Field

The minimum/latest/youngest possible age of a specimen as determined by a dating method.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/chrono/terms/latestChronometricAge'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.LatestChronometricAgeReferenceSystem(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The reference system associated with the LatestChronometricAge.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/latestChronometricAgeReferenceSystem'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.MaterialDated(index: int | str, default: str = None, **kwargs)#

Bases: Field

A description of the material on which the chronometricAgeProtocol was actually performed, if known.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/materialDated'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.MaterialDatedID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the MaterialSample on which the chronometricAgeProtocol was performed, if applicable.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/materialDatedID'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.MaterialDatedRelationship(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The relationship of the MaterialDated to the subject of the ChronometricAge record.

From which the ChronometricAge of the subject is inferred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/materialDatedRelationship'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.UncalibratedChronometricAge(index: int | str, default: str = None, **kwargs)#

Bases: Field

The output of a dating assay before it is calibrated into an age using a specific conversion protocol.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/uncalibratedChronometricAge'#: str: URI for the term represented by this field.

class dwca.terms.chronometric_age.VerbatimChronometricAge(index: int | str, default: str = None, **kwargs)#

Bases: Field

The verbatim age for a specimen, whether reported by a dating assay, associated references, or legacy information.

For example, this could be the radiocarbon age as given in an AMS dating report. This could also be simply what is reported as the age of a specimen in legacy collections data.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: Any, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/chrono/terms/verbatimChronometricAge'#: str: URI for the term represented by this field.

Event module#

class dwca.terms.event.DWCDay(index: int | str, default: int = None, **kwargs)#

Bases: Field

The integer day of the month on which the Event occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/day'#: str: URI for the term represented by this field.

class dwca.terms.event.DWCMonth(index: int | str, default: int = None, **kwargs)#

Bases: Field

The integer month in which the Event occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/month'#: str: URI for the term represented by this field.

class dwca.terms.event.DWCYear(index: int | str, default: int = None, **kwargs)#

Bases: Field

The four-digit year in which the Event occurred, according to the Common Era Calendar.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/year'#: str: URI for the term represented by this field.

class dwca.terms.event.EndDayOfYear(index: int | str, default: int = None, **kwargs)#

Bases: Field

The latest integer day of the year on which the Event occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/endDayOfYear'#: str: URI for the term represented by this field.

class dwca.terms.event.EventDate(index: int | str, default: datetime | Interval = None, **kwargs)#

Bases: Field

The date-time or interval during which an Event occurred.

For occurrences, this is the date-time when the Event was recorded. Not suitable for a time in a geological context.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of datetime | Interval

URI = 'http://rs.tdwg.org/dwc/terms/eventDate'#: str: URI for the term represented by this field.

class dwca.terms.event.EventID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the set of information associated with an Event (something that occurs at a place and time).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/eventID'#: str: URI for the term represented by this field.

class dwca.terms.event.EventRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/eventRemarks'#: str: URI for the term represented by this field.

class dwca.terms.event.EventTime(index: int | str, default: time | Interval = None, **kwargs)#

Bases: Field

The time or interval during which a Event occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of time | Interval

URI = 'http://rs.tdwg.org/dwc/terms/eventTime'#: str: URI for the term represented by this field.

class dwca.terms.event.EventType(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The nature of the Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/eventType'#: str: URI for the term represented by this field.

class dwca.terms.event.FieldNotes(index: int | str, default: str = None, **kwargs)#

Bases: Field

Notes taken in the field about the dwc:Event.

One of: a) An indicator of the existence of the notes. b) A reference to (publication, URI) the notes. c) The text of the notes.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/fieldNotes'#: str: URI for the term represented by this field.

class dwca.terms.event.FieldNumber(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier given to the Event in the field. Often serves as a link between field notes and the Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/fieldNumber'#: str: URI for the term represented by this field.

class dwca.terms.event.Habitat(index: int | str, default: str = None, **kwargs)#

Bases: Field

A category or description of the habitat in which the Event occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/habitat'#: str: URI for the term represented by this field.

class dwca.terms.event.ParentEventID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the broader Event that groups this and potentially other Events.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/parentEventID'#: str: URI for the term represented by this field.

class dwca.terms.event.SampleSizeUnit(index: int | str, default: str = None, **kwargs)#

Bases: Field

The unit of measurement of the size (time duration, length, area, or volume) of a sample in a sampling Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/sampleSizeUnit'#: str: URI for the term represented by this field.

class dwca.terms.event.SampleSizeValue(index: int | str, default: float = None, **kwargs)#

Bases: Field

A measurement of the size (time duration, length, area, or volume) of a sample in a sampling Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/sampleSizeValue'#: str: URI for the term represented by this field.

class dwca.terms.event.SamplingEffort(index: int | str, default: str = None, **kwargs)#

Bases: Field

The amount of effort expended during an Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/samplingEffort'#: str: URI for the term represented by this field.

class dwca.terms.event.SamplingProtocol(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

The names of, references to, or descriptions of the methods or protocols used during a Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/samplingProtocol'#: str: URI for the term represented by this field.

class dwca.terms.event.StartDayOfYear(index: int | str, default: int = None, **kwargs)#

Bases: Field

The earliest integer day of the year on which the Event occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/startDayOfYear'#: str: URI for the term represented by this field.

class dwca.terms.event.VerbatimEventDate(index: int | str, default: str = None, **kwargs)#

Bases: Field

The verbatim original representation of the date and time information for an Event.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimEventDate'#: str: URI for the term represented by this field.

GeologicalContext module#

class dwca.terms.geological_context.EarliestAgeOrLowestStage(index: int | str, default: str = None, **kwargs)#

Bases: Field

The earliest possible geochronologic age or lowest chronostratigraphic stage.

The full name of the earliest possible geochronologic age or lowest chronostratigraphic stage attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/earliestAgeOrLowestStage'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.EarliestEonOrLowestEonothem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The earliest possible geochronologic eon or lowest chrono-stratigraphic eonothem.

The full name of the earliest possible geochronologic eon or lowest chrono-stratigraphic eonothem or the informal name (“Precambrian”) attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/earliestEonOrLowestEonothem'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.EarliestEpochOrLowestSeries(index: int | str, default: str = None, **kwargs)#

Bases: Field

The earliest possible geochronologic epoch or lowest chronostratigraphic series.

The full name of the earliest possible geochronologic epoch or lowest chronostratigraphic series attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/earliestEpochOrLowestSeries'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.EarliestEraOrLowestErathem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The earliest possible geochronologic era or lowest chronostratigraphic erathem.

The full name of the earliest possible geochronologic era or lowest chronostratigraphic erathem attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/earliestEraOrLowestErathem'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.EarliestPeriodOrLowestSystem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The earliest possible geochronologic period or lowest chronostratigraphic system.

The full name of the earliest possible geochronologic period or lowest chronostratigraphic system attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/earliestPeriodOrLowestSystem'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.GeologicalContextID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the set of information associated with a GeologicalContext.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/geologicalContextID'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.HighestBiostratigraphicZone(index: int | str, default: str = None, **kwargs)#

Bases: Field

The highest possible geological biostratigraphic zone.

The full name of the highest possible geological biostratigraphic zone of the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/highestBiostratigraphicZone'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LatestAgeOrHighestStage(index: int | str, default: str = None, **kwargs)#

Bases: Field

The latest possible geochronologic age or highest chronostratigraphic stage.

The full name of the latest possible geochronologic age or highest chronostratigraphic stage attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/latestAgeOrHighestStage'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LatestEonOrHighestEonothem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The latest possible geochronologic eon or highest chrono-stratigraphic eonothem.

The full name of the latest possible geochronologic eon or highest chrono-stratigraphic eonothem or the informal name (“Precambrian”) attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/latestEonOrHighestEonothem'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LatestEpochOrHighestSeries(index: int | str, default: str = None, **kwargs)#

Bases: Field

The latest possible geochronologic epoch or highest chronostratigraphic series.

The full name of the latest possible geochronologic epoch or highest chronostratigraphic series attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/latestEpochOrHighestSeries'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LatestEraOrHighestErathem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The latest possible geochronologic era or highest chronostratigraphic erathem.

The full name of the latest possible geochronologic era or highest chronostratigraphic erathem attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/latestEraOrHighestErathem'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LatestPeriodOrHighestSystem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The latest possible geochronologic period or highest chronostratigraphic system.

The full name of the latest possible geochronologic period or highest chronostratigraphic system attributable to the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/latestPeriodOrHighestSystem'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LithostratigraphicBed(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full name of the lithostratigraphic bed from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/bed'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LithostratigraphicFormation(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full name of the lithostratigraphic formation from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/formation'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LithostratigraphicGroup(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full name of the lithostratigraphic group from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/group'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LithostratigraphicMember(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full name of the lithostratigraphic member from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/member'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LithostratigraphicTerms(index: int | str, default: str = None, **kwargs)#

Bases: Field

The combination of all litho-stratigraphic names for the rock.

The combination of all litho-stratigraphic names for the rock from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/lithostratigraphicTerms'#: str: URI for the term represented by this field.

class dwca.terms.geological_context.LowestBiostratigraphicZone(index: int | str, default: str = None, **kwargs)#

Bases: Field

The lowest possible geological biostratigraphic zone.

The full name of the lowest possible geological biostratigraphic zone of the stratigraphic horizon from which the MaterialEntity was collected.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/lowestBiostratigraphicZone'#: str: URI for the term represented by this field.

Identification module#

class dwca.terms.identification.DateIdentified(index: int | str, default: datetime | Interval = None, **kwargs)#

Bases: Field

The date on which the subject was determined as representing the Taxon.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of datetime | Interval

URI = 'http://rs.tdwg.org/dwc/terms/dateIdentified'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentificationID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the Identification (the body of information associated with the assignment of a scientific name).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/identificationID'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentificationQualifier(index: int | str, default: str = None, **kwargs)#

Bases: Field

A brief phrase or a standard term (“cf.”, “aff.”) to express the determiner’s doubts about the Identification.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/identificationQualifier'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentificationReferences(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of references (publication, global unique identifier, URI) used in the Identification.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/identificationReferences'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentificationRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the Identification.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/identificationRemarks'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentificationVerificationStatus(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

A categorical indicator of the extent to which the taxonomic identification has been verified to be correct.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/identificationVerificationStatus'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentifiedBy(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of names of people, groups, or organizations who assigned the Taxon to the subject.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/identifiedBy'#: str: URI for the term represented by this field.

class dwca.terms.identification.IdentifiedByID(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of the globally unique identifier for responsible for assigning the Taxon to the subject.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/identifiedByID'#: str: URI for the term represented by this field.

class dwca.terms.identification.TypeStatus(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of nomenclatural types (type status, typified scientific name, publication) applied to the subject.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/typeStatus'#: str: URI for the term represented by this field.

class dwca.terms.identification.VerbatimIdentification(index: int | str, default: str = None, **kwargs)#

Bases: Field

A string representing the taxonomic identification as it appeared in the original record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimIdentification'#: str: URI for the term represented by this field.

Location module#

class dwca.terms.location.Continent(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name of the continent in which the Location occurs.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/continent'#: str: URI for the term represented by this field.

class dwca.terms.location.CoordinatePrecision(index: int | str, default: float = None, **kwargs)#

Bases: Field

A decimal representation of the precision of the coordinates given in the latitude and longitude.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/coordinatePrecision'#: str: URI for the term represented by this field.

class dwca.terms.location.CoordinateUncertaintyInMeters(index: int | str, default: float = None, **kwargs)#

Bases: Field

The horizontal distance describing the smallest circle containing the whole of the Location.

Horizontal distance in meters from the given latitude and longitude. Leave the value empty if the uncertainty is unknown, cannot be estimated, or is not applicable (because there are no coordinates). Zero is not a valid value for this term.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/coordinateUncertaintyInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.Country(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name of the country or major administrative unit in which the Location occurs.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/country'#: str: URI for the term represented by this field.

class dwca.terms.location.CountryCode(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The standard code for the country in which the Location occurs.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/countryCode'#: str: URI for the term represented by this field.

class dwca.terms.location.County(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The full name of the next smaller administrative region than stateProvince in which the Location occurs.

Such as state, province, canton, department, region, etc.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/county'#: str: URI for the term represented by this field.

class dwca.terms.location.DWCLocalityTerm(index: int | str, default: str = None, **kwargs)#

Bases: Field

The specific description of the place.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/locality'#: str: URI for the term represented by this field.

class dwca.terms.location.DecimalLatitude(index: int | str, default: float = None, **kwargs)#

Bases: Field

The geographic latitude of the geographic center of a Location.

Latitude in decimal degrees, using the spatial reference system given in geodeticDatum. Positive values are north of the Equator, negative values are south of it. Legal values lie between -90 and 90, inclusive.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/decimalLatitude'#: str: URI for the term represented by this field.

class dwca.terms.location.DecimalLongitude(index: int | str, default: float = None, **kwargs)#

Bases: Field

The geographic longitude of the geographic center of a Location.

Longitude in decimal degrees, using the spatial reference system given in geodeticDatum. Positive values are east of the Greenwich Meridian, negative values are west of it. Legal values lie between -180 and 180, inclusive.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/decimalLongitude'#: str: URI for the term represented by this field.

class dwca.terms.location.FootprintSRS(index: int | str, default: str = None, **kwargs)#

Bases: Field

The geodetic datum upon which the geometry given in footprintWKT is based.

The ellipsoid, geodetic datum, or spatial reference system (SRS)

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/footprintSRS'#: str: URI for the term represented by this field.

class dwca.terms.location.FootprintSpatialFit(index: int | str, default: float = None, **kwargs)#

Bases: Field

The ratio of the area of the footprintWKT to the area of the spatial representation of the Location.

Legal values are 0, greater than or equal to 1, or undefined. A value of 1 is an exact match or 100% overlap. A value of 0 should be used if the given footprintWKT does not completely contain the original representation. The footprintSpatialFit is undefined (and should be left empty) if the original representation is any geometry without area (e.g., a point or polyline) and without uncertainty and the given georeference is ot that same geometry (without uncertainty). If both the original and the given georeference are the same point, the footprintSpatialFit is 1.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/footprintSpatialFit'#: str: URI for the term represented by this field.

class dwca.terms.location.FootprintWKT(index: int | str, default: str = None, **kwargs)#

Bases: Field

A Well-Known Text (WKT) representation of the shape (footprint, geometry) that defines the Location.

A Location may have both a point-radius representation (see DecimalLatitude) and a footprint representation, and they may differ from each other.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/footprintWKT'#: str: URI for the term represented by this field.

class dwca.terms.location.GeodeticDatum(index: int | str, default: str = None, **kwargs)#

Bases: Field

The geodetic datum upon which the geographic coordinates given in decimalLatitude and decimalLongitude are based.

Ellipsoid, geodetic datum, or spatial reference system (SRS).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/geodeticDatum'#: str: URI for the term represented by this field.

class dwca.terms.location.GeoreferenceProtocol(index: int | str, default: str = None, **kwargs)#

Bases: Field

A description or reference to the methods used to determine the spatial footprint, coordinates, and uncertainties.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/georeferenceProtocol'#: str: URI for the term represented by this field.

class dwca.terms.location.GeoreferenceRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Notes or comments about the spatial description determination.

Explaining assumptions made in addition or opposition to the those formalized in the method referred to in georeferenceProtocol.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/georeferenceRemarks'#: str: URI for the term represented by this field.

class dwca.terms.location.GeoreferenceSources(index: int | str, default: str = None, **kwargs)#

Bases: Field

A list of maps, gazetteers, or other resources used to georeference the Location.

Described specifically enough to allow anyone in the future to use the same resources.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/georeferenceSources'#: str: URI for the term represented by this field.

class dwca.terms.location.GeoreferencedBy(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of names of people, groups, or organizations who determined the georeference for the Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/georeferencedBy'#: str: URI for the term represented by this field.

class dwca.terms.location.GeoreferencedDate(index: int | str, default: datetime | Interval = None, **kwargs)#

Bases: Field

The date on which the Location was georeferenced.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of datetime | Interval

URI = 'http://rs.tdwg.org/dwc/terms/georeferencedDate'#: str: URI for the term represented by this field.

class dwca.terms.location.HigherGeography(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of geographic names less specific than the information captured in the locality term.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/higherGeography'#: str: URI for the term represented by this field.

class dwca.terms.location.HigherGeographyID(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

An identifier for the geographic region within which the Location occurred.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/higherGeographyID'#: str: URI for the term represented by this field.

class dwca.terms.location.Island(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name of the island on or near which the Location occurs.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/island'#: str: URI for the term represented by this field.

class dwca.terms.location.IslandGroup(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name of the island group in which the Location occurs.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/islandGroup'#: str: URI for the term represented by this field.

class dwca.terms.location.LocationAccordingTo(index: int | str, default: str = None, **kwargs)#

Bases: Field

Information about the source of this Location information.

Could be a publication (gazetteer), institution, or team of individuals.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/locationAccordingTo'#: str: URI for the term represented by this field.

class dwca.terms.location.LocationID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the set of Location information.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/locationID'#: str: URI for the term represented by this field.

class dwca.terms.location.LocationRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/locationRemarks'#: str: URI for the term represented by this field.

class dwca.terms.location.MaximumDepthInMeters(index: int | str, default: int = None, **kwargs)#

Bases: Field

The greater depth of a range of depth below the local surface, in meters.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/maximumDepthInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.MaximumDistanceAboveSurfaceInMeters(index: int | str, default: int = None, **kwargs)#

Bases: Field

The greater distance in a range of distance from a reference surface in the vertical direction, in meters.

Use positive values for locations above the surface, negative values for locations below. If depth measures are given, the reference surface is the location given by the depth, otherwise the reference surface is the location given by the elevation.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/maximumDistanceAboveSurfaceInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.MaximumElevationInMeters(index: int | str, default: int = None, **kwargs)#

Bases: Field

The upper limit of the range of elevation (altitude, usually above sea level), in meters.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/maximumElevationInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.MinimumDepthInMeters(index: int | str, default: int = None, **kwargs)#

Bases: Field

The lesser depth of a range of depth below the local surface, in meters.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/minimumDepthInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.MinimumDistanceAboveSurfaceInMeters(index: int | str, default: int = None, **kwargs)#

Bases: Field

The lesser distance in a range of distance from a reference surface in the vertical direction, in meters.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/minimumDistanceAboveSurfaceInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.MinimumElevationInMeters(index: int | str, default: int = None, **kwargs)#

Bases: Field

The lower limit of the range of elevation (altitude, usually above sea level), in meters.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/minimumElevationInMeters'#: str: URI for the term represented by this field.

class dwca.terms.location.Municipality(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The full name of the next smaller administrative region than county in which the Location occurs.

Such as city, municipality, etc. Do not use this term for a nearby named place that does not contain the actual Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/municipality'#: str: URI for the term represented by this field.

class dwca.terms.location.PointRadiusSpatialFit(index: int | str, default: float = None, **kwargs)#

Bases: Field

The ratio of the area of the point-radius to the area of the spatial representation of the Location.

Point-radius described by: {decimalLatitude, decimalLongitude, coordinateUncertaintyInMeters} Legal values are 0, greater than or equal to 1, or undefined. A value of 1 is an exact match or 100% overlap. A value of 0 should be used if the given point-radius does not completely contain the original representation. The pointRadiusSpatialFit is undefined (and should be left empty) if the original representation is any geometry without area (e.g., a point or polyline) and without uncertainty and the given georeference is not that same geometry (without uncertainty). If both the original and the given georeference are the same point, the pointRadiusSpatialFit is 1.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `float`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of float

URI = 'http://rs.tdwg.org/dwc/terms/pointRadiusSpatialFit'#: str: URI for the term represented by this field.

class dwca.terms.location.StateProvince(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name of the next smaller administrative region than country in which the Location occurs.

Smaller administrative region such as state, province, canton, department, region, etc.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/stateProvince'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimCoordinateSystem(index: int | str, default: str = None, **kwargs)#

Bases: Field

The coordinate format for the verbatimLatitude and verbatimLongitude or the verbatimCoordinates of the Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimCoordinateSystem'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimCoordinates(index: int | str, default: str = None, **kwargs)#

Bases: Field

The verbatim original spatial coordinates of the Location.

The coordinate ellipsoid, geodeticDatum, or full Spatial Reference System (SRS) for these coordinates should be stored in verbatimSRS and the coordinate system should be stored in verbatimCoordinateSystem.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimCoordinates'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimDepth(index: int | str, default: str = None, **kwargs)#

Bases: Field

The original description of the depth below the local surface.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimDepth'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimElevation(index: int | str, default: str = None, **kwargs)#

Bases: Field

The original description of the elevation (altitude, usually above sea level) of the Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimElevation'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimLatitude(index: int | str, default: str = None, **kwargs)#

Bases: Field

The verbatim original latitude of the Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimLatitude'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimLocality(index: int | str, default: str = None, **kwargs)#

Bases: Field

The original textual description of the place.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimLocality'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimLongitude(index: int | str, default: str = None, **kwargs)#

Bases: Field

The verbatim original longitude of the Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimLongitude'#: str: URI for the term represented by this field.

class dwca.terms.location.VerbatimSRS(index: int | str, default: str = None, **kwargs)#

Bases: Field

The geodetic datum upon which coordinates given in (Verbatim) Latitude and Longitude, or Coordinates are based.

The ellipsoid, geodetic datum, or spatial reference system (SRS)

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimSRS'#: str: URI for the term represented by this field.

class dwca.terms.location.VerticalDatum(index: int | str, default: str = None, **kwargs)#

Bases: Field

The vertical datum used as the reference upon which the values in the elevation terms are based.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verticalDatum'#: str: URI for the term represented by this field.

class dwca.terms.location.WaterBody(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name of the water body in which the Location occurs.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/waterBody'#: str: URI for the term represented by this field.

MaterialEntity module#

class dwca.terms.material_entity.AssociatedSequences(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of identifiers (e.g. URI) of genetic sequence information associated with the MaterialEntity.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/associatedSequences'#: str: URI for the term represented by this field.

class dwca.terms.material_entity.Disposition(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The current state of a MaterialEntity with respect to a collection.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/disposition'#: str: URI for the term represented by this field.

class dwca.terms.material_entity.MaterialEntityID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for a particular instance of a MaterialEntity.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/materialEntityID'#: str: URI for the term represented by this field.

class dwca.terms.material_entity.MaterialEntityRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the MaterialEntity instance.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/materialEntityRemarks'#: str: URI for the term represented by this field.

class dwca.terms.material_entity.Preparations(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of preparations and preservation methods for a MaterialEntity.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/preparations'#: str: URI for the term represented by this field.

class dwca.terms.material_entity.VerbatimLabel(index: int | str, default: str = None, **kwargs)#

Bases: Field

Raw label derived from human transcription.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimLabel'#: str: URI for the term represented by this field.

MaterialSample module#

class dwca.terms.material_sample.MaterialSampleID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the MaterialSample (as opposed to a particular digital record of the MaterialSample).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/materialSampleID'#: str: URI for the term represented by this field.

MeasurementOrFact module#

class dwca.terms.measurement_or_fact.MeasurementAccuracy(index: int | str, default: Any = None, **kwargs)#

Bases: Field

The description of the potential error associated with the MeasurementValue.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `Any`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of Any

URI = 'http://rs.tdwg.org/dwc/terms/measurementAccuracy'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementDeterminedBy(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of names of people, groups, or organizations who determined the value of the MeasurementOrFact.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/measurementDeterminedBy'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementDeterminedDate(index: int | str, default: datetime | Interval = None, **kwargs)#

Bases: Field

The date on which the MeasurementOrFact was made.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of datetime | Interval

URI = 'http://rs.tdwg.org/dwc/terms/measurementDeterminedDate'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the MeasurementOrFact.

Information pertaining to measurements, facts, characteristics, or assertions.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/measurementID'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementMethod(index: int | str, default: str = None, **kwargs)#

Bases: Field

A description of or reference to the method or protocol used to determine the MeasurementOrFact.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/measurementMethod'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes accompanying the MeasurementOrFact.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/measurementRemarks'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementType(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The nature of the measurement, fact, characteristic, or assertion.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/measurementType'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementUnit(index: int | str, default: str = None, **kwargs)#

Bases: Field

The units associated with the MeasurementValue.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/measurementUnit'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.MeasurementValue(index: int | str, default: Any = None, vocabulary: str = None)#

Bases: Field

The value of the measurement, fact, characteristic, or assertion.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `Any`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of Any

URI = 'http://rs.tdwg.org/dwc/terms/measurementValue'#: str: URI for the term represented by this field.

class dwca.terms.measurement_or_fact.ParentMeasurementID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for a broader MeasurementOrFact that groups this and potentially other MeasurementOrFacts.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/parentMeasurementID'#: str: URI for the term represented by this field.

Occurrence module#

class dwca.terms.occurrence.AssociatedMedia(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of identifiers (publication, global unique identifier, URI) of media associated with the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/associatedMedia'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.AssociatedOccurrences(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of identifiers of other Occurrence records and their associations to this Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[Tuple[str, str]]

URI = 'http://rs.tdwg.org/dwc/terms/associatedOccurrences'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.AssociatedReferences(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of identifiers of literature associated with the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/associatedReferences'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.AssociatedTaxa(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of identifiers or names of Taxon records and the associations of this Occurrence to each of them.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[Tuple[str, str]]

URI = 'http://rs.tdwg.org/dwc/terms/associatedTaxa'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.Behavior(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

The behavior shown by the subject at the time the Occurrence was recorded.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/behavior'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.Caste(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

Categorisation of individuals for eusocial species (including some mammals and arthropods).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/caste'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.CatalogNumber(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

An identifier (preferably unique) for the record within the data set or collection.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/catalogNumber'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.DWCDegreeOfEstablishment(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

The degree to which an Organism survives, reproduces, and expands its range at the given place and time.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/degreeOfEstablishment'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.DWCEstablishmentMeans(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

Statement about whether an Organism has been introduced through the activity of modern humans.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `EstablishmentMeans`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of EstablishmentMeans

URI = 'http://rs.tdwg.org/dwc/terms/establishmentMeans'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.GeoreferenceVerificationStatus(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

A categorical description of which the georeference has been verified for the Location of the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/georeferenceVerificationStatus'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.IndividualCount(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

The number of individuals present at the time of the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/individualCount'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.LifeStage(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

The age class or life stage of the Organism(s) at the time the Occurrence was recorded.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/lifeStage'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.OccurrenceID(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

An identifier for the Occurrence (as opposed to a particular digital record of the Occurrence).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/occurrenceID'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.OccurrenceRemarks(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

Comments or notes about the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/occurrenceRemarks'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.OccurrenceSex(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

The sex of the biological individual(s) represented in the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/sex'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.OccurrenceStatus(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

A statement about the presence or absence of a Taxon at a Location.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value to DefaultStatus.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from DefaultStatus to a standard string.

DefaultStatus
TYPE

class DefaultStatus(value)#

Bases: Enum

ABSENCE = 0#

PRESENT = 1#

TYPE#: alias of DefaultStatus

URI = 'http://rs.tdwg.org/dwc/terms/occurrenceStatus'#: str: URI for the term represented by this field.

format(value: str) → DefaultStatus#

Format value to DefaultStatus.

Parameters:

valuestr: Value to be formatted as a DefaultStatus.

Returns:

DefaultStatus: Value as a DefaultStatus Enum object.

unformat(value: DefaultStatus) → str#

Encode value from DefaultStatus to a standard string.

Parameters:

valueDefaultStatus: An instance of DefaultStatus to be represented as a string.

Returns:

str: String representation of DefaultStatus.

class dwca.terms.occurrence.OrganismQuantity(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A number or enumeration value for the quantity of Organisms.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of int | float | str

URI = 'http://rs.tdwg.org/dwc/terms/organismQuantity'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.OrganismQuantityType(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

The type of quantification system used for the quantity of Organisms.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/organismQuantityType'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.OtherCatalogNumbers(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of previous or alternate catalog numbers for the same Occurrence.v

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/otherCatalogNumbers'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.Pathway(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

The process by which an Organism came to be in a given place at a given time.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/pathway'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.RecordNumber(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

An identifier given to the Occurrence at the time it was recorded.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/recordNumber'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.RecordedBy(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of names of people, groups, or organizations responsible for recording the original Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/recordedBy'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.RecordedByID(index: int | str, default: TYPE = None, **kwargs)#

Bases: Field

A list of the globally unique identifier for the responsible for recording the original Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/recordedByID'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.ReproductiveCondition(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

The reproductive condition of the biological individual(s) represented in the Occurrence.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/reproductiveCondition'#: str: URI for the term represented by this field.

class dwca.terms.occurrence.Vitality(index: int | str, default: TYPE = None, vocabulary: str = None)#

Bases: Field

An indication of whether an Organism was alive or dead at the time of collection or observation.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/vitality'#: str: URI for the term represented by this field.

Organism module#

class dwca.terms.organism.AssociatedOrganisms(index: int | str, default: List[Tuple[str, str]] = None, **kwargs)#

Bases: Field

A list of identifiers of other Organisms and the associations of this Organism to each of them.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[Tuple[str, str]]

URI = 'http://rs.tdwg.org/dwc/terms/associatedOrganisms'#: str: URI for the term represented by this field.

class dwca.terms.organism.OrganismID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the Organism instance (as opposed to a particular digital record of the Organism).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/organismID'#: str: URI for the term represented by this field.

class dwca.terms.organism.OrganismName(index: int | str, default: str = None, **kwargs)#

Bases: Field

A textual name or label assigned to an Organism instance.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/organismName'#: str: URI for the term represented by this field.

class dwca.terms.organism.OrganismRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the Organism instance.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/organismRemarks'#: str: URI for the term represented by this field.

class dwca.terms.organism.OrganismScope(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

A description of the kind of Organism instance.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/organismScope'#: str: URI for the term represented by this field.

class dwca.terms.organism.PreviousIdentifications(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of previous assignments of names to the Organism.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/previousIdentifications'#: str: URI for the term represented by this field.

RecordLevel module#

class dwca.terms.record_level.DWCAccessRights(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

Information about who can access the resource or an indication of its security status.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/terms/accessRights'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCBasisOfRecord(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The specific nature of the data record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/basisOfRecord'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCBibliographicCitation(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

A bibliographic reference for the resource.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/terms/bibliographicCitation'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCCollection(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

An identifier for the collection or dataset from which the record was derived.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/collectionID'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCCollectionCode(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name, acronym, coden, or initialism identifying the collection or data set from which the record was derived.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/collectionCode'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCDataGeneralizations(index: int | str, default: Any = None, vocabulary: str = None)#

Bases: Field

Actions taken to make the shared data less specific or complete than in its original form.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `Any`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of Any

URI = 'http://rs.tdwg.org/dwc/terms/dataGeneralizations'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCDataset(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

An identifier for the set of data. An identifier for the set of data.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/datasetID'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCDatasetName(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name identifying the data set from which the record was derived.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/datasetName'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCDynamicProperties(index: int | str, default: Dict[str, Any] = None, vocabulary: str = None)#

Bases: Field

A list of additional measurements, facts, characteristics, or assertions about the record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of Dict[str, Any]

URI = 'http://rs.tdwg.org/dwc/terms/dynamicProperties'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCInformationWithheld(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

Additional information that exists, but that has not been shared in the given record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/informationWithheld'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCInstitution(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

An identifier for the institution having custody of the object(s) or information referred to in the record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/institutionID'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCInstitutionCode(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name (or acronym) in use by the institution having custody of the information referred to in the record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/institutionCode'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCLanguage(index: int | str, default: Language = None, vocabulary: str = None, two_letter_coding: bool = False)#

Bases: Field

A language of the resource.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.
two_letter_coding: bool, optional: Specifies whether or not to use two letters coding rather than three letters coding.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `Language`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value to Language.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from Language to a standard string.

TYPE#: alias of Language

URI = 'http://purl.org/dc/elements/1.1/language'#: str: URI for the term represented by this field.

format(value: str) → Language#

Format value to Language.

Parameters:

valuestr: Value to be formatted as a Language.

Returns:

Language: Value as a Language object.

unformat(value: Language) → str#

Encode value from Language to a standard string.

Parameters:

valueLanguage: An instance of Language to be represented as a string.

Returns:

str: String representation of Language.

class dwca.terms.record_level.DWCLicense(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

A legal document giving official permission to do something with the resource.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/terms/license'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCModified(index: int | str, default: datetime | Interval = None, vocabulary: str = None)#

Bases: Field

The most recent date-time on which the resource was changed.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of datetime | Interval

URI = 'http://purl.org/dc/terms/modified'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCOwnerInstitutionCode(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The name (or acronym) in use by the institution having ownership of the object(s) or information referred to in the record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/ownerInstitutionCode'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCReferences(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

A related resource that is referenced, cited, or otherwise pointed to by the described resource.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/terms/references'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCRightsHolder(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

A person or organization owning or managing rights over the resource.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/terms/rightsHolder'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCSource(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

Source reference of this species profile, a url or full publication citation.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/terms/source'#: str: URI for the term represented by this field.

class dwca.terms.record_level.DWCType(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The nature or genre of the resource.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://purl.org/dc/elements/1.1/type'#: str: URI for the term represented by this field.

ResourceRelationship module#

class dwca.terms.resource_relationship.RelatedResourceID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for a related resource.

The object, rather than the subject of the relationship.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/relatedResourceID'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.RelationshipAccordingTo(index: int | str, default: str = None, **kwargs)#

Bases: Field

The source establishing the relationship between the two resources.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/relationshipAccordingTo'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.RelationshipEstablishedDate(index: int | str, default: datetime | Interval = None, **kwargs)#

Bases: Field

The date-time on which the relationship between the two resources was established.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of datetime | Interval

URI = 'http://rs.tdwg.org/dwc/terms/relationshipEstablishedDate'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.RelationshipOfResource(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The relationship of the subject to the object.

The subject identified by Resource ID. The object identified by Related Resource ID.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/relationshipOfResource'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.RelationshipOfResourceID(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

An identifier for the relationship type.

An identifier for the relationship type (predicate) that connects the subject identified by Resource ID to its object identified by Related Resource ID.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/relationshipOfResourceID'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.RelationshipRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the relationship between the two resources.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/relationshipRemarks'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.ResourceID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the resource that is the subject of the relationship.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/resourceID'#: str: URI for the term represented by this field.

class dwca.terms.resource_relationship.ResourceRelationshipID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for an instance of relationship between one resource (the subject) and another (the object).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/resourceRelationshipID'#: str: URI for the term represented by this field.

Taxon module#

class dwca.terms.taxon.AcceptedNameUsage(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full name, with authorship and date information if known, of the Taxon.

The full scientific name, with authorship and date information if known, of the accepted (botanical) or valid (zoological) name in cases where the provided Scientific Name is considered by the reference indicated in the According To property, or of the content provider, to be a synonym or misapplied name. When applied to an Organism or an Occurrence, this term should be used in cases where a content provider regards the provided Scientific Name to be inconsistent with the taxonomic perspective of the content provider. For example, there are many discrepancies within specimen collections and observation datasets between the recorded name (e.g., the most recent identification from an expert who examined a specimen, or a field identification for an observed Organism), and the name asserted by the content provider to be taxonomically accepted.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/acceptedNameUsage'#: str: URI for the term represented by this field.

class dwca.terms.taxon.AcceptedNameUsageID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the name usage of the taxon.

This term should be used for synonyms or misapplied names to refer to the taxonID of a Taxon record that represents the accepted (botanical) or valid (zoological) name. For Darwin Core Archives the related record should be present locally in the same archive.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/acceptedNameUsageID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.CultivarEpithet(index: int | str, default: str = None, **kwargs)#

Bases: Field

Part of the name of a cultivar, cultivar group or grex that follows the Scientific Name.

According to the Rules of the Cultivated Plant Code, a cultivar name consists of a botanical name followed by a cultivar epithet. The value given as the Cultivar Epithet should exclude any quotes. The term Taxon Rank should be used to indicate which type of cultivated plant name (e.g. cultivar, cultivar group, grex) is concerned. This epithet, including any enclosing apostrophes or suffix, should be provided in Scientific Name as well.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/cultivarEpithet'#: str: URI for the term represented by this field.

class dwca.terms.taxon.DWCClass(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the class in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/class'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Family(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the family in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/family'#: str: URI for the term represented by this field.

class dwca.terms.taxon.GenericName(index: int | str, default: str = None, **kwargs)#

Bases: Field

The genus part of the Scientific Name without authorship.

For synonyms the accepted genus and the genus part of the name may be different. The term Generic Name should be used together with Specific Epithet to form a binomial and with Infraspecific Epithet to form a trinomial. The term Generic Name should only be used for combinations. Uninomials of generic rank do not have a Generic Name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/genericName'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Genus(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the genus in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/genus'#: str: URI for the term represented by this field.

class dwca.terms.taxon.HigherClassification(index: int | str, default: List[str] = None, **kwargs)#

Bases: Field

A list of taxa names terminating at the rank immediately superior to the referenced Taxon.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE

TYPE#

type: Type of the field.

alias of List[str]

URI = 'http://rs.tdwg.org/dwc/terms/higherClassification'#: str: URI for the term represented by this field.

class dwca.terms.taxon.InfragenericEpithet(index: int | str, default: str = None, **kwargs)#

Bases: Field

The infrageneric part of a binomial name at ranks above species but below genus.

The term Infrageneric Epithet should be used in conjunction with Generic Name, Specific Epithet, Infraspecific Epithet, Taxon Rank and Scientific Name Authorship to represent the individual elements of the complete Scientific Name. It can be used to indicate the subgenus placement of a species, which in zoology is often given in parentheses. Can also be used to share infrageneric names such as botanical sections (e.g., Vicia sect. Cracca).

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/infragenericEpithet'#: str: URI for the term represented by this field.

class dwca.terms.taxon.InfraspecificEpithet(index: int | str, default: str = None, **kwargs)#

Bases: Field

The name of the lowest or terminal infraspecific epithet of the Scientific Name, excluding any rank designation.

In botany, name strings in literature and identifications may have multiple infraspecific ranks. According to the International Code of Nomenclature for algae, fungi, and plants (Schenzhen Code Articles 6.7 & Art. 24.1), valid names only have two epithets, with the lowest rank being the Infraspecific Epithet. For example: the Infraspecific Epithet in the string Indigofera charlieriana subsp. sessilis var. scaberrima is scaberrima and the Scientific Name is Indigofera charlieriana var. scaberrima (Schinz) J.B.Gillett. Use Verbatim Identification for the full name string used in an Identification.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/infraspecificEpithet'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Kingdom(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the kingdom in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/kingdom'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NameAccordingTo(index: int | str, default: str = None, **kwargs)#

Bases: Field

The reference to the source in which the specific taxon concept circumscription is defined or implied.

Traditionally signified by the Latin “sensu” or “sec.” (from secundum, meaning “according to”). For taxa that result from identifications, a reference to the keys, monographs, experts and other sources should be given. This term provides context to the Scientific Name. Together with the Scientific Name, separated by sensu or sec., it forms the taxon concept label, which may be seen as having the same relationship to Taxon Concept ID as, for example, Accepted Name Usage has to Accepted Name Usage ID. When not provided, in Taxon Core data sets the Name According To can be taken to be the data set. In this case the data set mostly provides sufficient context to infer the delimitation of the taxon and its relationship with other taxa. In Occurrence Core data sets, when not provided, Name According To can be an underlying taxonomy of the data set, e.g. Plants of the World Online for vascular plant records in iNaturalist (in which case it should be provided), or, which is the case for most Preserved Specimen data sets, the Identification, in which case there is no further context.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/nameAccordingTo'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NameAccordingToID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the source in which the specific taxon concept circumscription is defined or implied.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/nameAccordingToID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NamePublishedIn(index: int | str, default: str = None, **kwargs)#

Bases: Field

A reference for the publication in which the Scientific Name was originally established.

Established under the rules of the associated Nomenclatural Code. A citation of the first publication of the name in its given combination, not the basionym / original name. Recombinations are often not published in zoology, in which case Name Published In should be empty.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/namePublishedIn'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NamePublishedInID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the publication in which the scientificName was originally established.

Under the rules of the associated Nomenclatural Code.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/namePublishedInID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NamePublishedInYear(index: int | str, default: int = None, **kwargs)#

Bases: Field

The four-digit year in which the Scientific Name was published.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `int`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of int

URI = 'http://rs.tdwg.org/dwc/terms/namePublishedInYear'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NomenclaturalCode(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The nomenclatural code (or codes in the case of an ambiregnal name) under which the Scientific Name is constructed.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/nomenclaturalCode'#: str: URI for the term represented by this field.

class dwca.terms.taxon.NomenclaturalStatus(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The status related to the original publication of the name.

The status related to the original publication of the name and its conformance to the relevant rules of nomenclature. It is based essentially on an algorithm according to the business rules of the code. It requires no taxonomic opinion.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/nomenclaturalStatus'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Order(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the order in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/order'#: str: URI for the term represented by this field.

class dwca.terms.taxon.OriginalNameUsage(index: int | str, default: str = None, **kwargs)#

Bases: Field

The taxon name as it originally appeared when first established.

The taxon name, with authorship and date information if known, as it originally appeared when first established under the rules of the associated Nomenclatural Code. The basionym (botany) or basonym (bacteriology) of the Scientific Name or the senior/earlier homonym for replaced names. For example, for names governed by the ICNafp, this term would indicate the basionym of a record representing a subsequent combination. Unlike basionyms, however, this term can apply to scientific names at all ranks.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/originalNameUsage'#: str: URI for the term represented by this field.

class dwca.terms.taxon.OriginalNameUsageID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the name usage in which the terminal term was originally established.

This term should be used to refer to the taxonID of a Taxon record that represents the usage of the terminal element of the scientificName as originally established under the rules of the associated nomenclaturalCode. For example, for names governed by the ICNafp, this term would establish the relationship between a record representing a subsequent combination and the record for its corresponding basionym. Unlike basionyms, however, this term can apply to scientific names at all ranks. For Darwin Core Archives the related record should be present locally in the same archive.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/originalNameUsageID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.ParentNameUsage(index: int | str, default: str = None, **kwargs)#

Bases: Field

The direct, most proximate higher-rank parent Taxon of the most specific element of the Scientific Name.

The full name, with authorship and date information if known, of the direct, most proximate higher-rank parent Taxon (in a classification) of the most specific element of the Scientific Name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/parentNameUsage'#: str: URI for the term represented by this field.

class dwca.terms.taxon.ParentNameUsageID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the name usage f the direct, most proximate higher-rank parent taxon.

The name usage, documented meaning of the name according to a source, of the direct, most proximate higher-rank parent taxon (in a classification) of the most specific element of the Scientific Name. This term should be used for accepted names to refer to the taxonID of a Taxon record that represents the next higher taxon rank in the same taxonomic classification. For Darwin Core Archives the related record should be present locally in the same archive.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/parentNameUsageID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Phylum(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the phylum or division in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/phylum'#: str: URI for the term represented by this field.

class dwca.terms.taxon.ScientificName(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name, with authorship and date information if known.

When forming part of an Identification, this should be the name in the lowest level taxonomic rank that can be determined. This term should not contain identification qualifications, which should instead be supplied in the identificationQualifier term. When applied to an Organism or Occurrence, this term should be used to represent the scientific name that was applied to the associated Organism in accordance with the Taxon to which it was or is currently identified. Names should be compliant to the most recent nomenclatural code. For example, names of hybrids for algae, fungi and plants should follow the rules of the International Code of Nomenclature for algae, fungi, and plants (Schenzhen Code Articles H.1, H.2 and H.3). Thus, use the multiplication sign × (Unicode U+00D7, HTML ×) to identify a hybrid, not x or X, if possible.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/scientificName'#: str: URI for the term represented by this field.

class dwca.terms.taxon.ScientificNameAuthorship(index: int | str, default: str = None, **kwargs)#

Bases: Field

The authorship information for the Scientific Name formatted.

Name formatted according to the conventions of the applicable Nomenclatural Code.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/scientificNameAuthorship'#: str: URI for the term represented by this field.

class dwca.terms.taxon.ScientificNameID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the nomenclatural (not taxonomic) details of a scientific name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/scientificNameID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.SpecificEpithet(index: int | str, default: str = None, **kwargs)#

Bases: Field

The name of the first or species epithet of the Scientific Name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/specificEpithet'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Subfamily(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the subfamily in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/subfamily'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Subgenus(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the subgenus in which the Taxon is classified.

Values should include the genus to avoid homonym confusion.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/subgenus'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Subtribe(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the subtribe in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/subtribe'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Superfamily(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the superfamily in which the Taxon is classified.

A taxonomic category subordinate to an order and superior to a family. According to ICZN article 29.2, the suffix -oidea is used for a superfamily name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/superfamily'#: str: URI for the term represented by this field.

class dwca.terms.taxon.TaxonConceptID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the taxonomic concept to which the record refers.

Not for the nomenclatural details of a Taxon.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/taxonConceptID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.TaxonID(index: int | str, default: str = None, **kwargs)#

Bases: Field

An identifier for the set of Taxon information.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/taxonID'#: str: URI for the term represented by this field.

class dwca.terms.taxon.TaxonRank(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The taxonomic rank of the most specific name in the Scientific Name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/taxonRank'#: str: URI for the term represented by this field.

class dwca.terms.taxon.TaxonRemarks(index: int | str, default: str = None, **kwargs)#

Bases: Field

Comments or notes about the taxon or name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/taxonRemarks'#: str: URI for the term represented by this field.

class dwca.terms.taxon.TaxonomicStatus(index: int | str, default: str = None, vocabulary: str = None)#

Bases: Field

The status of the use of the Scientific Name as a label for a taxon.

Requires taxonomic opinion to define the scope of a Taxon. Rules of priority then are used to define the taxonomic status of the nomenclature contained in that scope, combined with the experts’ opinion. It must be linked to a specific taxonomic reference that defines the concept.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.
vocabulary: str, optional: An URI for a vocabulary that the source values for this Field are based on.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/taxonomicStatus'#: str: URI for the term represented by this field.

class dwca.terms.taxon.Tribe(index: int | str, default: str = None, **kwargs)#

Bases: Field

The full scientific name of the tribe in which the Taxon is classified.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/tribe'#: str: URI for the term represented by this field.

class dwca.terms.taxon.VerbatimTaxonRank(index: int | str, default: str = None, **kwargs)#

Bases: Field

The taxonomic rank of the most specific name in the Scientific Name as it appears in the original record.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/verbatimTaxonRank'#: str: URI for the term represented by this field.

class dwca.terms.taxon.VernacularName(index: int | str, default: str = None, **kwargs)#

Bases: Field

A xml_common or vernacular name.

Parameters:

indexint | str: Specifies the position of the column in the row.
default: TYPE, optional: Specifies a value to use if one is not supplied.

Attributes:

NAMESPACE_TAG
default: Any: Specifies a value to use if one is not supplied.
index: int: Specifies the position of the column in the row.
name: str: The name of the field.
sql_type: str: Type of field in a SQL relational database.
uri: str: An URI for the term represented by this field.
vocabulary: str: An URI for a vocabulary that the source values for this Field are based on.

Methods

`TYPE`	alias of `str`
`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Checks if the tag is the Principal tag of the object.
`format`(value)	Format value in the TYPE of the field.
`from_string`(text)	Generates XML Object from a string of an XML file.
`from_xml`(file[, encoding])	Generates an XML Object from an XML file.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`name_cls`()	str: The name of the field.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a Field object from an XML element instance.
`to_element`()	Generate an XML element instance from this object.
`to_xml`()	Generates text of an XML file.
`unformat`(value)	Encode value from TYPE to a string.

TYPE#: alias of str

URI = 'http://rs.tdwg.org/dwc/terms/vernacularName'#: str: URI for the term represented by this field.