Classes

Entry

Container for a single YAML key value pairing and associated metadata.

__init__(self, key, value, meta) special

Initialize the object

Parameters:

Name	Type	Description	Default
key		Name of the value	required
value		Given value.	required
meta		Any associated comments or meta data.	required

Source code in yamldoc/entries.py

def __init__(self, key, value, meta):
    """
    Initialize the object

    Arguments:
       key: Name of the value
       value: Given value.
       meta: Any associated comments or meta data.
    """
    self.key = key
    self.value = value
    self.meta = meta
    self.isBase = False
    self.type = None

__repr__(self) special

Gives a print representation for the class.

Source code in yamldoc/entries.py

def __repr__(self):
    """
    Gives a print representation for the class.
    """
    if self.type is not None:
        return f'YAML Entry [{self.key}: {self.value}]\n\t Meta: {self.meta}\n\t Type: {self.type}'
    else:
        return f'YAML Entry [{self.key}: {self.value}]\n\t Meta: {self.meta}'

to_markdown(self, schema=False)

Prints the entry as markdown.

Parameters:

Name	Type	Description	Default
schema		Print with four columns instead of three.	False

Source code in yamldoc/entries.py

def to_markdown(self, schema = False):
    """
    Prints the entry as markdown.

    Arguments:
        schema: Print with four columns instead of three.
    """
    if schema: 
        m = '<br />'.join(textwrap.wrap(self.meta, width = 50))
        if self.type == None:
            vartype = "Unknown"
        else:
            vartype = self.type
        return f'| `{self.key}` | `{self.value}` | {vartype} | {m} |\n'
    else:
        m = '<br />'.join(textwrap.wrap(self.meta, width = 50))
        return f'| `{self.key}` | `{self.value}` | {m} |\n'

MetaEntry

A container to hold a base level YAML entry plus any associated hierarchical keys and values.

__init__(self, name, meta) special

Initialize the object.

Parameters:

Name	Type	Description	Default
name		Name of the value.	required
meta		Comments derived from YAML file.	required

Source code in yamldoc/entries.py

def __init__(self, name, meta):
    """ 
    Initialize the object.

    Arguments:
        name: Name of the value.
        meta: Comments derived from YAML file.
    """
    self.name = name
    self.meta = meta
    self.isBase = True
    self.entries = []
    self.has_schema = False

__repr__(self) special

Returns a print representation.

Source code in yamldoc/entries.py

def __repr__(self):
    """
    Returns a print representation.
    """
    if self.has_schema:
        return f'YAML Meta Object with {len(self.entries)} entries [{self.name}] and type information.' 
    else:
        return f'YAML Meta Object with {len(self.entries)} entries [{self.name}]'

to_markdown(self, schema=False)

Prints the contents of the object in markdown.

!!! argumenets schema: Print with four columns instead of three.

Source code in yamldoc/entries.py

def to_markdown(self, schema=False):
    """ 
    Prints the contents of the object in markdown.

    Argumenets:
        schema: Print with four columns instead of three.
    """
    if schema:
        output = f'## `{self.name}`\n\n{self.meta}\n\n'
        output += "### Member variables:\n\n"

        output += "| Key | Value | Type | Information |\n"
        output += "| :-: | :-: | :-: | :-- |\n"

        for entry in self.entries:
            output += entry.to_markdown(schema)
        output += "\n\n"
        return output

    else: 
        output = f'## `{self.name}`\n\n{self.meta}\n\n'
        output += "### Member variables:\n\n"

        output += "| Key | Value | Information |\n"
        output += "| :-: | :-: | :-- |\n"

        for entry in self.entries:
            output += entry.to_markdown()

        output += "\n\n"

        return output