API

Specification Interface

hallmarkfe.spec.parse_generic(arg)

Create Hallmark specification object

Parameters:arg (object) – Specification (a dictionary) or file location (a string)

hallmarkfe.spec.register(cls)

Register specification handler

Parameters:cls (class) – Handler class

hallmarkfe.spec.unregister(cls)

Unregister specification handler

Parameters:cls (class) – Handler class

class hallmarkfe.spec.SpecRegistry

Bases: object

Registry of all the loaded specification handlers

classmethod find_handler_for_schema(spec)

Find loader for a given schema.

A class can load one or more schema types.

classmethod find_handler_generic(arg)

Find the handler class and load file

A class can load one or more schema types.

classmethod register(cls)

Add handler to the registry

classmethod schema_get(schema)

List known schemas and handling classes

classmethod schema_list()

List known schemas and handling classes

classmethod unregister(cls)

Add handler to the registry

class hallmarkfe.spec.SpecMeta(name, bases, dct)

Bases: abc.ABCMeta

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

mro() → list

return a type’s method resolution order

register(subclass)

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.

validate_handler(dct)

Validate the class implementing schema

validate_handler_schema(dct)

Validate schema specification

class hallmarkfe.spec.SpecBase(*args, **kwargs)

Bases: object

Base abstract class for spec implementors

description

Property-like access to specification’s description element

dump()

Return the specification as a dictionary

dumps()

Dump the internal structure into JSON-formatted string

initialize(*args, **kwargs)

Initialize the state of the metadata object

load(spec)

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

loads(s)

Load a serialized string into a object

classmethod match(schemas)

Check if this handler can service a given set of schemas

This is a conservative function

name

Property-like access to specification’s name element

order = None

Order in which the elements must be stored/printed

owner

Property-like access to specification’s owner element

prettyprint(max_width=80)

Dump content in a neat form..

schema = 'global:default:v1'

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

spec = None

Internal dict representation of the specification

required elements: name, description

validate(spec=None)

Check if the spec is valid

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

class hallmarkfe.spec.SpecManagerBase(*args, **kwargs)

Bases: object

Manage a specification directory

clear()

Clear the state

load(path)

Load a directory

specs = None

Accept path and read list of spec files available in path.

required prefix: spec_

exception hallmarkfe.spec.SpecNoHandler

Bases: Exception

Not class to handle metadata with a given schema

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception hallmarkfe.spec.SpecInvalidSchema

Bases: Exception

Invalid schema definition

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception hallmarkfe.spec.SpecMissingSchema

Bases: Exception

Schema not defined in the given merit subclass

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception hallmarkfe.spec.SpecInvalidSpecification

Bases: Exception

Specification cannot be loaded due to missing or invalid fields.

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

CLI

hfe

Commandline for Hallmark Specifications

hfe [OPTIONS] COMMAND [ARGS]...

schema

Discovery and operation specification formats

hfe schema [OPTIONS] COMMAND [ARGS]...

list

List available schemas

hfe schema list [OPTIONS]