eml.types package#

Classes with no predefine Principal Tag#

_NoTagObject Base Class#

class eml.types.no_tag_object._NoTagObject#

Bases: XMLObject, ABC

Abstract class of object with no tag on EML schema

Attributes:

NAMESPACE_TAG

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into an XMLObject.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate a lxml.tree.Element from the Responsible Party object.
`to_xml`()	Generates text of an XML file.

classmethod check_principal_tag(tag: str, nmap: Dict) → None#

Always return True due tag not existing until set

Parameters:

tagstr: Any tag.
nmapDict: Namespace.

set_tag(tag: str) → None#

Set tag for the element output.

Parameters:

tagstr: Tag of the XML output element.

to_element() → Element#

Generate a lxml.tree.Element from the Responsible Party object.

Returns:

lxml.tree.Element: Object in the XML Element format.

Raises:

RuntimeError: If tag is not set before calling this method.

Extension String Class#

class eml.types.extension_string.ExtensionString(value: str | ExtensionString, system: str = None)#

Bases: _NoTagObject

Extension string representing a string value with extra attributes.

Parameters:

valuestr | ExtensionString: Value of the string or another ExtensionString object.
systemstr, optional: The data management system.

Attributes:

NAMESPACE_TAG
system: str: The data management system within which an identifier is in scope and therefore unique.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into an Extension String.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate a lxml.tree.Element from the extended string.
`to_xml`()	Generates text of an XML file.

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

Parses a lxml element into an Extension String.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

ExtensionString: Object parsed.

property system: str#: str: The data management system within which an identifier is in scope and therefore unique.

to_element() → Element#

Generate a lxml.tree.Element from the extended string.

Returns:

lxml.tree.Element: Object in the XML Element format.

Raises:

RuntimeError: If tag is not set before calling this method.

Extension URI Class#

class eml.types.extension_uri.ExtensionURI(value: str, label: str)#

Bases: _NoTagObject

Extension URI representing an uri value with extra attributes.

Parameters:

valuestr: Value of the URI.
labelstr: A human-readable representation of the URI.

Attributes:

NAMESPACE_TAG
label: str: A human-readable representation of the URI.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate an ExtensionURI object from an XML element instance.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate an XML element with the information of the extension URI.
`to_xml`()	Generates text of an XML file.

property label: str#: str: A human-readable representation of the URI.

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

Generate an ExtensionURI object from an XML element instance.

Parameters:

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

Returns:

ExtensionURI: An URI with a human-readable label.

to_element() → Element#

Generate an XML element with the information of the extension URI.

Returns:

lxml.etree.Element: An XML element instance.

i18n String Class#

class eml.types.i18n_string.I18nString(value: str | I18nString, lang: Language | str = Language.ENG)#

Bases: _NoTagObject

Internationalization of a string representing a text and its language.

Parameters:

valuestr or I18nString: Value of the string.
langLanguage or str: Language of the string or valid abbreviation. Default ENG (English).

Raises:

TypeError: Wrong language type.
NotImplementedError: Abbreviation not available yet or wrong language.

Attributes:

NAMESPACE_TAG
language: Language: The language of the string.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into an i18n String.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate a lxml.tree.Element from the i18n string.
`to_xml`()	Generates text of an XML file.

property language: Language#: Language: The language of the string.

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

Parses a lxml element into an i18n String.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

I18nString: Object parsed.

to_element() → Element#

Generate a lxml.tree.Element from the i18n string.

Returns:

lxml.tree.Element: Object in the XML Element format.

Raises:

RuntimeError: If tag is not set before calling this method.

TextType Class#

class eml.types.text_type.EMLTextType(sections: List[EMLSection] = None, paragraphs: List[str | I18nString] = None, markdowns: List[str] = None, language: Language = Language.ENG)#

Bases: _NoTagObject

A simple text description.

Parameters:

sectionsList[EMLSection], optional: A section of related text.
paragraphsList[I18String or str], optional: A simple paragraph of text.
markdownsList[str], optional: A block of text formatted with Markdown directives.
languageLanguage, optional: Language of abstract.

Attributes:

NAMESPACE_TAG
language: Language: Language of the text.
markdowns: List[str]: A block of text formatted with Markdown directives.
paragraphs: List[I18nString]: A simple paragraph of text.
sections: List[EMLSection]: A section of related text.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate an EMLTextType from an XML element.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Get an XML Element from the EMLTextType object
`to_xml`()	Generates text of an XML file.

property language: Language#: Language: Language of the text.

property markdowns: List[str]#: List[str]: A block of text formatted with Markdown directives.

property paragraphs: List[I18nString]#: List[I18nString]: A simple paragraph of text.

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

Generate an EMLTextType from an XML element.

Parameters:

elementlxml.etree.Element: XML Element to be parsed.
nmapDict: Namespace of the XML element.

Returns:

EMLTextType: Parsed object

property sections: List[EMLSection]#: List[EMLSection]: A section of related text.

to_element() → Element#

Get an XML Element from the EMLTextType object

Returns:

lxml.etree.Element: XML Element with the information of the EMLTextType instance

Responsible Party Class#

class eml.types.responsible_party.ResponsibleParty(_id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, individual_name: IndividualName = None, organization_name: I18nString = None, position_name: I18nString = None, address: List[EMLAddress] = None, phone: List[EMLPhone] = None, mail: List[str | I18nString] = None, url: List[str] = None)#

Bases: EMLObject, _NoTagObject

The individual, organization, or role associated with a resource.

Parameters:

_idstr, optional: Unique identifier within the scope.
scopeScope, default DOCUMENT: The scope of the identifier.
systemstr, optional: The data management system within which an identifier is in scope and therefore unique.
referencingbool, optional, default=False: Whether the resource is referencing another or is being defined.
references_systemstr, optional: System attribute of reference.
individual_nameIndividualName, optional: The full name of the person being described.
organization_nameI18nString, optional: The full name of the organization being described.
position_nameI18nString, optional: The name of the title or position associated with the resource.
addressList[EMLAddress], optional: A list of full addresses information for a given responsible party entry.
phoneList[EMLPhone], optional: A list of phone information about the contact.
mailList[str or I18nString], optional: A list of email addresses of the contact.
urlList[str], optional: A list of links to associated online information, usually a website.

Attributes:

NAMESPACE_TAG
address: List[EMLAddress]: A list of full addresses information for a given responsible party entry.
id: str: Unique identifier of the resource
individual_name: IndividualName: the full name of the person being described.
mail: List[I18nString]: A list of email addresses of the contact.
organization_name: I18nString: The full name of the organization being described.
phone: List[EMLPhone]: A list of phon information about the contact.
position_name: I18nString: The name of the title or position associated with the resource.
references: bool: Whether the resource is referencing another or is being defined
referencing: bool: Whether the resource is referencing another or is being defined
scope: Scope: The scope of the identifier.
system: str: The data management system within which an identifier is in scope and therefore unique.
url: List[str]: A list of links to associated online information, usually a website.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`generate_references_element`()	Generate the <references> element.
`get_no_referrer`(element, nmap)	Generate a Responsible Party that do not reference another.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`get_referrer`(element, nmap)	Generate a Responsible Party referencing another Responsible Party.
`get_role`(element, nmap)	Get role for an XML element.
`get_scope`(element)	Get the scope from the element.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Common parse of an EML object
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate a lxml.tree.Element from the Responsible Party object.
`to_xml`()	Generates text of an XML file.

property address: List[EMLAddress]#: List[EMLAddress]: A list of full addresses information for a given responsible party entry.

classmethod get_no_referrer(element: Element, nmap: Dict) → ResponsibleParty#

Generate a Responsible Party that do not reference another.

Parameters:

elementlxml.etree.Element: XML element to parse.
nmapDict: Namespace.

Returns:

ResponsibleParty: Object parsed.

classmethod get_referrer(element: Element, nmap: Dict) → ResponsibleParty#

Generate a Responsible Party referencing another Responsible Party.

Parameters:

elementlxml.etree.Element: XML element to parse with references object.
nmapDict: Namespace.

Returns:

ResponsibleParty: Object parsed that reference another responsible party on document.

classmethod get_role(element: Element, nmap: Dict) → Role#

Get role for an XML element.

Parameters:

elementlxml.etree.Element: XML element with role on it.
nmapDict: Namespace.

Returns:

Role: Value of the role inside the XML element.

property individual_name: IndividualName#: IndividualName: the full name of the person being described.

property mail: List[I18nString]#: List[I18nString]: A list of email addresses of the contact.

property organization_name: I18nString#: I18nString: The full name of the organization being described.

property phone: List[EMLPhone]#: List[EMLPhone]: A list of phon information about the contact.

property position_name: I18nString#: I18nString: The name of the title or position associated with the resource.

to_element() → Element#

Generate a lxml.tree.Element from the Responsible Party object.

Returns:

lxml.tree.Element: Object in the XML Element format.

Raises:

RuntimeError: If tag is not set before calling this method.

property url: List[str]#: List[str]: A list of links to associated online information, usually a website.

class eml.types.responsible_party.Role(value)#

Bases: CamelCaseEnum

The role the party played with respect to the resource.

AUTHOR = 0#

CONTENT_PROVIDER = 1#

CUSTODIAN_STEWARD = 2#

DISTRIBUTOR = 3#

EDITOR = 4#

METADATA_PROVIDER = 5#

ORIGINATOR = 6#

POINT_OF_CONTACT = 7#

PRINCIPAL_INVESTIGATOR = 8#

PROCESSOR = 9#

PUBLISHER = 10#

USER = 11#

Semantic Annotation Class#

class eml.types.semantic_annotation.SemanticAnnotation(property_uri: Tuple[str, str], value_uri: Tuple[str, str], _id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None)#

Bases: EMLObject, _NoTagObject

A precisely-defined semantic statement about this resource.

Parameters:

property_uriTuple[str, str]: The persistent URI used to identify a property from a vocabulary.
value_uriTuple[str, str]: The persistent URI used to identify a value from a vocabulary.
_idstr, optional: Unique identifier within the scope.
scopeScope, default DOCUMENT: The scope of the identifier.
systemstr, optional: The data management system within which an identifier is in scope and therefore unique.

Attributes:

NAMESPACE_TAG
id: str: Unique identifier of the resource
property_uri: ExtensionURI: The persistent URI used to identify a property from a vocabulary.
references: bool: Whether the resource is referencing another or is being defined
referencing: bool: Whether the resource is referencing another or is being defined
scope: Scope: The scope of the identifier.
system: str: The data management system within which an identifier is in scope and therefore unique.
value_uri: ExtensionURI: The persistent URI used to identify a value from a vocabulary.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`generate_references_element`()	Generate the <references> element.
`get_no_referrer`(element, nmap)	Generate a Semantic Annotation from an XML element instance.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`get_referrer`(element, nmap)	Semantic Annotation doesn't have a reference.
`get_scope`(element)	Get the scope from the element.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Common parse of an EML object
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate an XML element instance.
`to_xml`()	Generates text of an XML file.

classmethod get_no_referrer(element: Element, nmap: Dict) → SemanticAnnotation#

Generate a Semantic Annotation from an XML element instance.

Parameters:

elementlxml.etree.Element: XML element to parse.
nmapDict: Namespace.

Returns:

SemanticAnnotation: Object parsed.

classmethod get_referrer(element: Element, nmap: Dict) → SemanticAnnotation#

Semantic Annotation doesn’t have a reference. This method raise an exception.

Parameters:

elementlxml.etree.Element: XML element to parse with references object.
nmapDict: Namespace.

Returns:

SemanticAnnotation: Object parsed that would reference another.

Raises:

ValueError: Semantic Annotation cannot reference another annotation.

property property_uri: ExtensionURI#: ExtensionURI: The persistent URI used to identify a property from a vocabulary.

to_element() → Element#

Generate an XML element instance.

Returns:

lxml.etree.Element: XML element instance.

property value_uri: ExtensionURI#: ExtensionURI: The persistent URI used to identify a value from a vocabulary.

Research Project Class#

class eml.types.research_project.ResearchProject(_id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, title: str | List[str] = None, personnel: List[Tuple[ResponsibleParty, Role]] = None, abstract: EMLTextType = None, funding: EMLTextType = None, related_projects: List[ResearchProject] = None)#

Bases: EMLObject, _NoTagObject

Descriptor of a research context for a dataset or another project.

Parameters:

_idstr, optional: Unique identifier within the scope.
scopeScope, default DOCUMENT: The scope of the identifier.
systemstr, optional: The data management system within which an identifier is in scope and therefore unique.
referencingbool, optional, default=False: Whether the resource is referencing another or is being defined.
references_systemstr, optional: System attribute of reference.
titlestr | List[str]: Title(s) of the project.
personnelList[Tuple[ResponsibleParty, Role]]: Contact and role information for people involved in the research project.
abstractEMLTextType, optional: Project Abstract.
fundingEMLTextType, optional: Funding information.
related_projectsList[ResearchProject], optional: This field is a recursive link to another project.

Raises:

TypeError: If it is not a reference, raises TypeError if title or personnel is not given.

Attributes:

NAMESPACE_TAG
abstract: EMLTextType: Project Abstract.
award: List: Awards information.
design_description: None: Description of research design.
funding: EMLTextType: Funding information.
id: str: Unique identifier of the resource
personnel: List[Tuple[ResponsibleParty, Role]]: Contact and role information for people involved in the research project.
references: bool: Whether the resource is referencing another or is being defined
referencing: bool: Whether the resource is referencing another or is being defined
related_project: List[ResearchProject]: List of related projects.
scope: Scope: The scope of the identifier.
study_area_description: None: Description of the study area.
system: str: The data management system within which an identifier is in scope and therefore unique.
title: str: A descriptive title for the research project.
titles: List[str]: A list of all titles of this project.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`generate_references_element`()	Generate the <references> element.
`get_no_referrer`(element, nmap)	Generate a Research Project that do not reference another.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`get_referrer`(element, nmap)	Generate a Research Project referencing another Research Project.
`get_scope`(element)	Get the scope from the element.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Common parse of an EML object
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate a lxml.tree.Element from the Research Project object.
`to_xml`()	Generates text of an XML file.

property abstract: EMLTextType#: EMLTextType: Project Abstract.

property award: List#: List: Awards information.

property design_description: None#: None: Description of research design.

property funding: EMLTextType#: EMLTextType: Funding information.

classmethod get_no_referrer(element: Element, nmap: Dict) → ResearchProject#

Generate a Research Project that do not reference another.

Parameters:

elementlxml.etree.Element: XML element to parse.
nmapDict: Namespace.

Returns:

ResearchProject: Object parsed.

classmethod get_referrer(element: Element, nmap: Dict) → ResearchProject#

Generate a Research Project referencing another Research Project.

Parameters:

elementlxml.etree.Element: XML element to parse with references object.
nmapDict: Namespace.

Returns:

ResearchProject: Object parsed that reference another research project on document.

property personnel: List[Tuple[ResponsibleParty, Role]]#: List[Tuple[ResponsibleParty, Role]]: Contact and role information for people involved in the research project.

property related_project: List[ResearchProject]#: List[ResearchProject]: List of related projects.

property study_area_description: None#: None: Description of the study area.

property title: str | None#: str: A descriptive title for the research project.

property titles: List[str]#: List[str]: A list of all titles of this project.

to_element() → Element#

Generate a lxml.tree.Element from the Research Project object.

Returns:

lxml.tree.Element: Object in the XML Element format.

Raises:

RuntimeError: If tag is not set before calling this method.

Access Classes#

class eml.types.access_type.AccessOrder(value)#

Bases: CamelCaseEnum

ALLOW_FIRST = 0#

DENY_FIRST = 1#

class eml.types.access_type.AccessPermission(value)#

Bases: CamelCaseEnum

ALL = 3#

CHANGE_PERMISSION = 2#

READ = 0#

WRITE = 1#

class eml.types.access_type.AccessRole(principal: List[str], permission: List[AccessPermission])#

Bases: _NoTagObject

Access Rules define a user’s access to a resource.

Parameters:

principalList[str]: The user or group (principal) for which the access control applies.
permission: List[AccessPermission]: The type of permission being granted or denied.

Attributes:

NAMESPACE_TAG
permission: List[AccessPermission]: The type of permission being granted or denied.
principal: List[str]: The user or group (principal) for which the access control applies.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate a AccessRole instance from an XML element instance.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generate an XML element instance using this Access Role object.
`to_xml`()	Generates text of an XML file.

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

Generate a AccessRole instance from an XML element instance.

Parameters:

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

Returns:

AccessRole: An instance of AccessRole.

property permission: List[AccessPermission]#: List[AccessPermission]: The type of permission being granted or denied.

property principal: List[str]#: List[str]: The user or group (principal) for which the access control applies.

to_element() → Element#

Generate an XML element instance using this Access Role object.

Returns:

lxml.etree.Element: An XML element instance.

class eml.types.access_type.AccessType(auth_system: str, _id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, order: AccessOrder | str = AccessOrder.ALLOW_FIRST, allow: AccessRole = None, deny: AccessRole = None)#

Bases: EMLObject

Access control rules for the entire resource, which can be overridden by access rules in distribution trees.

Parameters:

auth_systemstr: The authentication system is used to verify the user or group to whom access is allowed or denied.
_idstr, optional: Unique identifier within the scope.
scopeScope, default DOCUMENT: The scope of the identifier.
systemstr, optional: The data management system within which an identifier is in scope and therefore unique.
referencingbool, optional, default=False: Whether the resource is referencing another or is being defined.
references_systemstr, optional: System attribute of reference.
order: Order, optional: The order in which the allow and deny rules should be applied.
allow: AccessRole: A rule that grants a permission type. Mandatory if AccessType is not a reference.
deny: AccessRole: A rule that revokes a permission type. Mandatory if AccessType is not a reference.

Attributes:

NAMESPACE_TAG
allow: AccessRole: A rule that grants a permission type.
auth_system: str: The authentication system is used to verify the user or group to whom access is allowed or denied.
deny: AccessRole: A rule that revokes a permission type.
id: str: Unique identifier of the resource
order: AccessOrder: The order in which the allow and deny rules should be applied.
references: bool: Whether the resource is referencing another or is being defined
referencing: bool: Whether the resource is referencing another or is being defined
scope: Scope: The scope of the identifier.
system: str: The data management system within which an identifier is in scope and therefore unique.

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.
`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.
`generate_references_element`()	Generate the <references> element.
`get_no_referrer`(element, nmap)	Generate an AccessType object that does not reference another AccessType.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`get_referrer`(element, nmap)	Generate an AccessType object that references another AccessType.
`get_scope`(element)	Get the scope from the element.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Common parse of an EML object
`to_element`()	Generate an XML element instance using this object.
`to_xml`()	Generates text of an XML file.

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

property allow: AccessRole#: AccessRole: A rule that grants a permission type.

property auth_system: str#: str: The authentication system is used to verify the user or group to whom access is allowed or denied.

property deny: AccessRole#: AccessRole: A rule that revokes a permission type.

classmethod get_no_referrer(element: Element, nmap: Dict) → EMLObject#

Generate an AccessType object that does not reference another AccessType.

Parameters:

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

Returns:

AccessType: Instance of AccessType

classmethod get_referrer(element: Element, nmap: Dict) → AccessType#

Generate an AccessType object that references another AccessType.

Parameters:

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

Returns:

AccessType: Instance of AccessType

property order: AccessOrder#: AccessOrder: The order in which the allow and deny rules should be applied.

to_element() → Element#

Generate an XML element instance using this object.

Returns:

lxml.etree.Element: An XML element instance.

Procedure Step Class#

class eml.types.procedure_step.ProcedureStep(description: EMLTextType, citation: EMLCitation = None, protocol: EMLProtocol = None, instrumentation: List[str] = None, software: List[EMLSoftware] = None, sub_step: List[ProcedureStep] = None)#

Bases: _NoTagObject

Represent a description of a specific step of the method.

Parameters:

descriptionEMLTextType: Description of the methods employed in collecting or generating a data set or other resource or in quality control and assurance.
citationEMLCitation, optional: Literature citation relating to the methods used.
protocolEMLProtocol, optional: Protocol description relating to the methods used.
instrumentationList[str], optional: Instruments used for measurement and recording data.
softwareList[EMLSoftware], optional: Software used in the processing of data.
sub_stepList[ProcedureStep], optional: This fields allows the nesting of additional method steps within this step.

Attributes:

NAMESPACE_TAG
citation: EMLCitation: Literature citation relating to the methods used.
description: EMLTextType: Description of the methods employed in collecting or generating a data set or other resource or in quality control and assurance.
instrumentation: List[str]: Instruments used for measurement and recording data.
protocol: EMLProtocol: Protocol description relating to the methods used.
software: List[EMLSoftware]: Software used in the processing of data.
sub_step: List[ProcedureStep]: List of sub step, useful for hierarchical method descriptions.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into a Procedure Step object.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generates a lxml.tree.Element from the Procedure Step object.
`to_xml`()	Generates text of an XML file.

property citation: EMLCitation#: EMLCitation: Literature citation relating to the methods used.

property description: EMLTextType#: EMLTextType: Description of the methods employed in collecting or generating a data set or other resource or in quality control and assurance.

property instrumentation: List[str]#: List[str]: Instruments used for measurement and recording data.

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

Parses a lxml element into a Procedure Step object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

ProcedureStep: Object parsed.

property protocol: EMLProtocol#: EMLProtocol: Protocol description relating to the methods used.

property software: List[EMLSoftware]#: List[EMLSoftware]: Software used in the processing of data.

property sub_step: List[ProcedureStep]#: List[ProcedureStep]: List of sub step, useful for hierarchical method descriptions.

to_element() → Element#

Generates a lxml.tree.Element from the Procedure Step object.

Returns:

lxml.tree.Element: Methods instance in the Element format.

Classes with predefine Principal Tag#

Section Class#

class eml.types.section.EMLSection(title: I18nString | str = None, paragraph: I18nString | str = None, section: EMLSection = None, language: Language = Language.ENG)#

Bases: XMLObject

A section of related text.

The “section” element allows for grouping related paragraphs of text together, with an optional title.

Parameters:

titleI18nString or str, optional: The optional title of the section.
paragraphI18String or str, optional: A simple paragraph of text. If section is not given, this parameter is mandatory.
sectionSection, optional: A section of related text. If paragraph is not given, this parameter is mandatory.
languageLanguage, optional: Language of section. Default “ENG”

Attributes:

NAMESPACE_TAG
language: Language: Language of section.
paragraph: I18nString: A simple paragraph of text.
section: EMLSection: A section of related text.
title: I18nString: The optional title of the section.

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.
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate an EMLSection from an XML element.
`to_element`()	Get an XML Element from the EMLSection object
`to_xml`()	Generates text of an XML file.

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

property language: Language#: Language: Language of section.

property paragraph: I18nString#: I18nString: A simple paragraph of text.

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

Generate an EMLSection from an XML element.

Parameters:

elementlxml.etree.Element: XML Element to be parsed.
nmapDict: Namespace of the XML element.

Returns:

EMLSection: Parsed object

property section: EMLSection#: EMLSection: A section of related text.

property title: I18nString#: I18nString: The optional title of the section.

to_element() → Element#

Get an XML Element from the EMLSection object

Returns:

lxml.etree.Element: XML Element with the information of the EMLSection instance

Individual Name Class#

Bases: XMLObject

Class representing the full name of the person being described.

Parameters:

last_namestr or I18nString: The last name of the individual.
first_namestr, I18nString or List[I18nString], optional: The given name of the individual.
salutationstr, I18nString or List[I18nString], optional: The salutation used to address an individual.
languageLanguage, optional: In case of given, the language of all the parameters given

Attributes:

NAMESPACE_TAG
first_name: List[I18nString]: The given name of the individual.
last_name: I18nString: The last name of the individual.
salutation: List[I18nString]: The salutation used to address an individual.

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.
`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.
`lang`(language)	Returns the individual name text representation in the given language.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into an IndividualName object.
`to_element`()	Generates a lxml.tree.Element from the object.
`to_xml`()	Generates text of an XML file.

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

property first_name: List[I18nString]#: List[I18nString]: The given name of the individual.

lang(language: Language) → str#

Returns the individual name text representation in the given language.

Parameters:

languageLanguage: The language to get the text representation.

Returns:

str: Text representation of object in the selected language

property last_name: I18nString#: I18nString: The last name of the individual.

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

Parses a lxml element into an IndividualName object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

IndividualName: Object parsed.

property salutation: List[I18nString]#: List[I18nString]: The salutation used to address an individual.

to_element() → Element#

Generates a lxml.tree.Element from the object.

Returns:

lxml.tree.Element: Object in the Element format.

Organization Name Class#

Position Name Class#

Address Class#

class eml.types.address.EMLAddress(_id: str = None, scope: ~eml.types.eml_object.Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, delivery_point: str | ~eml.types.i18n_string.I18nString | ~typing.List[~eml.types.i18n_string.I18nString] = None, city: str | ~eml.types.i18n_string.I18nString = None, administrative_area: str | ~eml.types.i18n_string.I18nString = None, postal_code: str | ~eml.types.i18n_string.I18nString = None, country: str | ~eml.types.i18n_string.I18nString = None, language: <Language.ENG: 'English'> = None)#

Bases: EMLObject

The full address information for a given responsible party entry.

Parameters:

_idstr, optional: Unique identifier within the scope.
scopeScope, default DOCUMENT: The scope of the identifier.
systemstr, optional: The data management system within which an identifier is in scope and therefore unique.
referencingbool, optional, default=False: Whether the resource is referencing another or is being defined
references_systemstr, optional: System attribute of reference
delivery_pointstr, I18nString or List[I18String], optional: The location for postal deliveries.
citystr or I18nString, optional: The name of the city for the contact.
administrative_areastr or I18nString, optional: The political area of a country.
postal_codestr or I18nString, optional: The postal code used for routing to an address.
countrystr or I18nString, optional: The name of the country for the contact’s address.

Attributes:

NAMESPACE_TAG
administrative_area: I18nString: The political area of a country.
city: I18String: The name of the city for the contact.
country: I18nString: The name of the country for the contact’s address.
delivery_point: List[I18nString]: The location for postal deliveries.
id: str: Unique identifier of the resource
postal_code: I18nString: The postal code used for routing to an address.
references: bool: Whether the resource is referencing another or is being defined
referencing: bool: Whether the resource is referencing another or is being defined
scope: Scope: The scope of the identifier.
system: str: The data management system within which an identifier is in scope and therefore unique.

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.
`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.
`generate_references_element`()	Generate the <references> element.
`get_no_referrer`(element, nmap)	Generate an EML Object that do not reference another.
`get_principal_tag`()	Returns the principal tag with namespaces if it is present.
`get_referrer`(element, nmap)	Generate an EML Address referencing another EML Address.
`get_scope`(element)	Get the scope from the element.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Common parse of an EML object
`to_element`()	Generate a lxml.tree.Element from the object.
`to_xml`()	Generates text of an XML file.

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

property administrative_area: I18nString#: I18nString: The political area of a country.

property city: I18nString#: I18String: The name of the city for the contact.

property country: I18nString#: I18nString: The name of the country for the contact’s address.

property delivery_point: List[I18nString]#: List[I18nString]: The location for postal deliveries.

classmethod get_no_referrer(element: Element, nmap: Dict) → EMLAddress#

Generate an EML Object that do not reference another.

Parameters:

elementlxml.etree.Element: XML element to parse.
nmapDict: Namespace.

Returns:

EMLAddress: Object parsed.

classmethod get_referrer(element: Element, nmap: Dict) → EMLAddress#

Generate an EML Address referencing another EML Address.

Parameters:

elementlxml.etree.Element: XML element to parse with references EML address.
nmapDict: Namespace.

Returns:

EMLAddress: Object parsed that reference an Address.

property postal_code: I18nString#: I18nString: The postal code used for routing to an address.

to_element() → Element#

Generate a lxml.tree.Element from the object.

Returns:

lxml.tree.Element: Object in the Element format.

Phone Class#

class eml.types.phone.EMLPhone(phone: str, phone_type: str = 'voice')#

Bases: XMLObject

Information about the contact’s telephone.

Parameters:

phonestr: The phone field describes information about the responsible party’s telephone.
phone_typestr, optional: The type of the phone to which this number applies. Default “voice”.

Attributes:

NAMESPACE_TAG
phone: str: The phone field describes information about the responsible party’s telephone.
phone_type: str: The type of the phone to which this number applies.

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.
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into an EML Phone object.
`to_element`()	Generates a lxml.tree.Element from the EML Phone object.
`to_xml`()	Generates text of an XML file.

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

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

Parses a lxml element into an EML Phone object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

XMLObject: Object parsed.

property phone: str#: str: The phone field describes information about the responsible party’s telephone.

property phone_type: str#: str: The type of the phone to which this number applies.

to_element() → Element#

Generates a lxml.tree.Element from the EML Phone object.

Returns:

lxml.tree.Element: Object in the Element format.

Section Class#

class eml.types.section.EMLSection(title: I18nString | str = None, paragraph: I18nString | str = None, section: EMLSection = None, language: Language = Language.ENG)#

Bases: XMLObject

A section of related text.

The “section” element allows for grouping related paragraphs of text together, with an optional title.

Parameters:

titleI18nString or str, optional: The optional title of the section.
paragraphI18String or str, optional: A simple paragraph of text. If section is not given, this parameter is mandatory.
sectionSection, optional: A section of related text. If paragraph is not given, this parameter is mandatory.
languageLanguage, optional: Language of section. Default “ENG”

Attributes:

NAMESPACE_TAG
language: Language: Language of section.
paragraph: I18nString: A simple paragraph of text.
section: EMLSection: A section of related text.
title: I18nString: The optional title of the section.

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.
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Generate an EMLSection from an XML element.
`to_element`()	Get an XML Element from the EMLSection object
`to_xml`()	Generates text of an XML file.

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

property language: Language#: Language: Language of section.

property paragraph: I18nString#: I18nString: A simple paragraph of text.

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

Generate an EMLSection from an XML element.

Parameters:

elementlxml.etree.Element: XML Element to be parsed.
nmapDict: Namespace of the XML element.

Returns:

EMLSection: Parsed object

property section: EMLSection#: EMLSection: A section of related text.

property title: I18nString#: I18nString: The optional title of the section.

to_element() → Element#

Get an XML Element from the EMLSection object

Returns:

lxml.etree.Element: XML Element with the information of the EMLSection instance

Maintenance Class#

class eml.types.maintenance.MaintUpFreqType(value)#

Bases: CamelCaseEnum

Maintenance Update Frequency.

Frequency with which changes and additions are made to the dataset after the initial dataset is completed.

Attributes:

ANNUALLYint: Every year.
AS_NEEDEDint: Maintenance as needed.
BIANNUALLYint: Every two years.
CONTINUALLYint: Maintenance continually.
DAILYint: Every day.
IRREGULARint: Irregular maintenance.
MONTHLYint: Every month.
NOT_PLANNEDint: Maintenance not planned.
WEEKLYint: Every week.
UNKNOWNint: Unknown maintenance.
UNKOWNint: Unknown with typo.
OTHER_MAINTENANCE_PERIODint: Other unidentified maintenance period.

ANNUALLY = 1#

AS_NEEDED = 2#

BIANNUALLY = 3#

CONTINUALLY = 4#

DAILY = 5#

IRREGULAR = 6#

MONTHLY = 7#

NOT_PLANNED = 8#

OTHER_MAINTENANCE_PERIOD = 12#

UNKNOWN = 10#

UNKOWN = 11#

WEEKLY = 9#

class eml.types.maintenance.Maintenance(description: EMLTextType, maintenance_update_frequency: MaintUpFreqType = None, change_history: List[ChangeHistory] = None)#

Bases: XMLObject

Class representing a description of the maintenance of a data resource.

Parameters:

descriptionEMLTextType: A text description of the maintenance of this data resource.
maintenance_update_frequencyMaintUpFreqType, optional: Frequency with which changes and additions are made to the dataset after the initial dataset is completed.
change_historyList[ChangeHistory], optional: A description of changes made to the data since its release.

Attributes:

NAMESPACE_TAG
change_history: List[ChangeHistory]: A description of changes made to the data since its release.
description: EMLTextType: A text description of the maintenance of this data resource.
maintenance_update_frequency: MaintUpFreqType: Frequency with which changes and additions are made to the dataset after the initial dataset is completed.

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.
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into a Maintenance object.
`to_element`()	Generates a lxml.tree.Element from the Maintenance object.
`to_xml`()	Generates text of an XML file.

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

property change_history: List[ChangeHistory]#: List[ChangeHistory]: A description of changes made to the data since its release.

property description: EMLTextType#: EMLTextType: A text description of the maintenance of this data resource.

property maintenance_update_frequency: MaintUpFreqType#: MaintUpFreqType: Frequency with which changes and additions are made to the dataset after the initial dataset is completed.

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

Parses a lxml element into a Maintenance object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Maintenance object.
nmapDict: Dictionary of namespace.

Returns:

Maintenance: Object parsed.

to_element() → Element#

Generates a lxml.tree.Element from the Maintenance object.

Returns:

lxml.tree.Element: Object in the Element format.

Change History Class#

class eml.types.change_history.ChangeHistory(change_scope: str, old_value: str, change_date: date, comment: str = None)#

Bases: XMLObject

Attributes:

NAMESPACE_TAG
change_date: datetime.date: The date the changes were applied.
change_scope: str: An expression describing the scope to which the documented change was applied.
comment: str: Explanation or justification for the change made to the data.
old_value: str: The previous value of the data prior to the change.

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.
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into a ChangeHistory object.
`to_element`()	Generate an XML element with ChangeHistory instance information.
`to_xml`()	Generates text of an XML file.

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

property change_date: date#: datetime.date: The date the changes were applied.

property change_scope: str#: str: An expression describing the scope to which the documented change was applied.

property comment: str#: str: Explanation or justification for the change made to the data.

property old_value: str#: str: The previous value of the data prior to the change.

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

Parses a lxml element into a ChangeHistory object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

ChangeHistory: Instance from parsed xml element.

to_element() → Element#

Generate an XML element with ChangeHistory instance information.

Returns:

lxml.etree.Element: XML element object

Methods Class#

class eml.types.methods.Methods(method_steps: List[ProcedureStep], data_sources: List[List[EMLDataset] | None] = None)#

Bases: XMLObject

Class representing the methods field documents scientific methods used in the collection of this dataset.

Parameters:

method_stepsList[ProcedureStep]: A list of description of a specific step of the method. At least one must be given.
data_sourcesList[List[EMLDataset] | None], optional: The sources of data used by each method step.

Raises:

RuntimeError: At least one step must be given.

Attributes:

NAMESPACE_TAG
method_steps: List[MethodStep]: A list of description of a specific step of the method.
quality_control: ProcedureStep: Information on possible errors or on the quality of a data set.
sampling: None: Description of sampling procedures including the geographic, temporal and taxonomic coverage of the study.

Methods

`MethodStep`(procedure_step[, data_source])	Represent the description of a specific step of the method.
`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.
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into a Methods object.
`to_element`()	Generates a lxml.tree.Element from the Methods object.
`to_xml`()	Generates text of an XML file.

class MethodStep(procedure_step: ProcedureStep, data_source: List[EMLDataset] = None)#

Bases: ProcedureStep

Represent the description of a specific step of the method.

Parameters:

procedure_stepProcedureStep: A description of a specific step.
data_sourceList[EMLDataset], optional: Sources of data used by this MethodStep.

Attributes:

NAMESPACE_TAG
citation: EMLCitation: Literature citation relating to the methods used.
data_source: List[EMLDataset]: Sources of data used by this MethodStep.
description: EMLTextType: Description of the methods employed in collecting or generating a data set or other resource or in quality control and assurance.
instrumentation: List[str]: Instruments used for measurement and recording data.
protocol: EMLProtocol: Protocol description relating to the methods used.
software: List[EMLSoftware]: Software used in the processing of data.
sub_step: List[ProcedureStep]: List of sub step, useful for hierarchical method descriptions.

Methods

`add_namespace`(prefix, uri)	Add a namespace to the XML object.
`check_principal_tag`(tag, nmap)	Always return True due tag not existing until set
`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.
`object_to_element`(tag[, prefix])	Generates an element using tag, adding namespace tag.
`parse`(element, nmap)	Parses a lxml element into a Method Step object.
`set_tag`(tag)	Set tag for the element output.
`to_element`()	Generates a lxml.tree.Element from the Method Step object.
`to_xml`()	Generates text of an XML file.

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

property data_source: List[EMLDataset]#: List[EMLDataset]: Sources of data used by this MethodStep.

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

Parses a lxml element into a Method Step object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

Methods.MethodStep: Object parsed.

to_element() → Element#

Generates a lxml.tree.Element from the Method Step object.

Returns:

lxml.tree.Element: Methods instance in the Element format.

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

property method_steps: List[MethodStep]#: List[MethodStep]: A list of description of a specific step of the method.

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

Parses a lxml element into a Methods object.

Parameters:

elementlxml.tree.Element: Object in the Element format to be parsed into a Python object.
nmapDict: Dictionary of namespace.

Returns:

Methods: Object parsed.

property quality_control: List[ProcedureStep]#: ProcedureStep: Information on possible errors or on the quality of a data set.

property sampling: None#: None: Description of sampling procedures including the geographic, temporal and taxonomic coverage of the study.

to_element() → Element#

Generates a lxml.tree.Element from the Methods object.

Returns:

lxml.tree.Element: Methods instance in the Element format.