GeoEco.Metadata.Metadata

class GeoEco.Metadata.Metadata(name, shortDescription=None, longDescription=None)

Bases: object

Base class for most metadata classes.

Parameters:

• name (str) – Name of the entity. Minimum length꞉ 1.

• shortDescription (str, optional) – One-line description, ideally as plain text (but reStructuredText is OK). Minimum length꞉ 1.

• longDescription (str, optional) – Detailed description, formatted as reStructuredText. Minimum length꞉ 1.

Returns:

New Metadata instance.

Return type:

Metadata

Properties

property DocString

(str) Python docstring (the value used for the __doc__ attribute). Read only. Minimum length꞉ 1. The docstring is constructed dynamically from metadata. It uses the format described in Google’s Python Style Guide.

property LongDescription

(str or None) Detailed description, formatted as reStructuredText. Minimum length꞉ 1. LongDescription is optional; if detailed information is not needed, you need only write a ShortDescription.

property Name

(str) Name, as provided to the constructor. Read only. Minimum length꞉ 1.

property Object

(object) Python object to which this metadata applies. Read only. The type the Python object depends on which type of metadata is involved:

Type of metadata	Type of the Object property
ModuleMetadata	ModuleType
ClassMetadata	type
PropertyMetadata	property
MethodMetadata	MethodType

property ShortDescription

(str or None) One-line description, ideally as plain text (but reStructuredText is OK). Minimum length꞉ 1. Keep the ShortDescription as concise as possible, ideally just one sentence. Do not include newline characters in the ShortDescription. Put detailed information in LongDescription (which can contain newlines).

Methods