TagDefinition

class asdf.extension.TagDefinition(tag_uri, *, schema_uris=None, title=None, description=None)[source]

Bases: object

Container for properties of a custom YAML tag.

Parameters
tag_uristr

Tag URI.

schema_uristr, optional

URI of the schema that should be used to validate objects with this tag.

titlestr, optional

Short description of the tag.

descriptionstr, optional

Long description of the tag.

Attributes Summary

description

Get the long description of the tag.

schema_uri

DEPRECATED

schema_uris

Get the URIs of the schemas that should be used to validate objects with this tag.

tag_uri

Get the tag URI.

title

Get the short description of the tag.

Attributes Documentation

description

Get the long description of the tag.

Returns
str or None
schema_uri

DEPRECATED

Get the URI of the schema that should be used to validate objects with this tag.

Returns
str or None
schema_uris

Get the URIs of the schemas that should be used to validate objects with this tag.

Returns
list
tag_uri

Get the tag URI.

Returns
str
title

Get the short description of the tag.

Returns
str or None