API

pymerit

Standardized metadata generation and processing.

This package provides:

1. Simple format for the metadata
2. Handlers to load and store metadata

Base

Base classes for metadata including a metaclass to enable tracking of the schema-specific classes.

class pymerit.base.MeritBase(*args, **kwargs)

Base abstract class for pymerit schema implementors

description

Property-like access to metadata description element

dump()

Return the metadata as a dictionary

dumps()

Dump the internal structure into JSON-formatted string

classmethod find_handler(schema)

Short form of find_handler_for_schema

classmethod find_handler_for_dict(dct)

Find the handler class and load dict

A class can load one or more schema types.

classmethod find_handler_for_schema(schema)

Find loader for a given schema.

A class can load one or more schema types.

initialize(*args, **kwargs)

Initialize the state of the metadata object

load(metadata)

Load a dictionary. Call element-specific handler if it exists.

loads(s)

Load a serialized string into a object

metadata = None

Internal dict representation of the metadata

required elements: name, description

name

Property-like access to metadata name element

prettyprint(max_width=80)

Dump content in a neat form..

schema = 'default:base:v1'

Every Merit metadata class should specify a schema (a string or a list of strings)

classmethod schema_get(schemas)

List known schemas and handling classes

classmethod schema_list()

List known schemas and handling classes

classmethod schema_register(targetcls)

Register class

classmethod schema_unregister(targetcls)

Unregister cls

validate(metadata=None)

Check if the metadata is valid

Parameters:metadata (dict) – Optional metadata dict to be validated. If not specified, will use the class’s metadata attribute.

classmethod validate_cls(targetcls, dct)

Validate the class implementing schema

class pymerit.base.MeritContextBase(*args, **kwargs)

Baseclass for context schemas

initialize(*args, **kwargs)

Initialize the state of the metadata object

class pymerit.base.MeritGlobalBase(*args, **kwargs)

Base abstract class for pymerit schema implementors

add_context(c)

Add a context (e.g., host info) to metadata

add_resource(r)

Add a resource (e.g., file) to metadata

dump_contexts(contexts)

Dump contexts

dump_resources(resources)

Dump resources

initialize(*args, **kwargs)

Initialize the state of the metadata object

load_contexts(contexts)

Validate and load contexts

load_resources(resources)

Validate and load resourcess

class pymerit.base.MeritMeta(name, bases, dct)

Meta class for all elements with schemas. This allows for registration, validation, and tracking of the schema implementors.

class pymerit.base.MeritResourceBase(*args, **kwargs)

Baseclass for resource schemas

initialize(*args, **kwargs)

Initialize the state of the metadata object

Extensible pymerit libraries

class pymerit.contrib.MeritContextPlatform(*args, **kwargs)

initialize(*args, **kwargs)

Initialize the state of the metadata object

class pymerit.contrib.MeritContextProcess(*args, **kwargs)

initialize(*args, **kwargs)

Initialize the state of the metadata object

class pymerit.contrib.MeritDefault(*args, **kwargs)

initialize(*args, **kwargs)

Initialize the state of the metadata object

class pymerit.contrib.MeritResourceFile(*args, **kwargs)

initialize(*args, **kwargs)

Initialize the state of the metadata object

validate_path(path)

Check if the path exists

class pymerit.contrib.MeritResourceS3File(*args, **kwargs)

initialize(*args, **kwargs)

Initialize the state of the metadata object

Exceptions

exception pymerit.exceptions.MeritDuplicateSchema

Another handler exists for the given schema

exception pymerit.exceptions.MeritInvalidAttribute

Invalid name specified to generate the class attribute

exception pymerit.exceptions.MeritInvalidContext

Invalid class specified while adding context

exception pymerit.exceptions.MeritInvalidMetadata

Metadata cannot be loaded due to missing fields

exception pymerit.exceptions.MeritInvalidResource

Invalid class specified while adding resource

exception pymerit.exceptions.MeritInvalidSchema

Invalid schema definition

exception pymerit.exceptions.MeritMissingSchema

Schema not defined in the given merit subclass

exception pymerit.exceptions.MeritNoAttribute

Internal metadata does not have the required attribute

exception pymerit.exceptions.MeritNoHandler

Not class to handle metadata with a given schema

exception pymerit.exceptions.MeritNotRegistered

Class not a registered handler for any schema

Utils

Helper functions

pymerit.utils.all_subclasses(cls)

Find all subclasses of a class

Return type:object Returns:“Set of subclasses” Parameters:cls (object) – Baseclass

pymerit.utils.find_handler(schema)

Find handler classes

Parameters:schema (str) – Schema to find handler for

pymerit.utils.new(metadata, mode='json')

Create Merit object from dictionary

Parameters:metadata (dict) – Metadata to be loaded

pymerit.utils.schema_register(cls)

Register a new handler class

Parameters:cls (class) – Handler class

pymerit.utils.schema_unregister(cls)

Unregister a handler class

Parameters:cls (class) – Handler class

CLI

merit

CLI for merit metadata files

merit [OPTIONS] COMMAND [ARGS]...

metadata

Metadata processing

merit metadata [OPTIONS] COMMAND [ARGS]...

show

Show metadata content

merit metadata show [OPTIONS] FILENAME

Arguments

FILENAME

Required argument

schema

Discovery and operation

merit schema [OPTIONS] COMMAND [ARGS]...

list

List available schemas

merit schema list [OPTIONS]

show

Show details of a schema

merit schema show [OPTIONS] SCHEMA

Arguments

SCHEMA

Required argument