Source code for pycadf.tag

# Copyright 2013 IBM Corp.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.

import six


[docs]def generate_name_value_tag(name, value):
    """Generate a CADF tag in the format name?value=<value>

    :param name: name of tag
    :param valuue: optional value tag
    """
    if name is None or value is None:
        raise ValueError('Invalid name and/or value. Values cannot be None')

    tag = name + "?value=" + value
    return tag


# TODO(mrutkows): validate any Tag's name?value= format
[docs]def is_valid(value):
    """Validation check to ensure proper Tag format
    """
    if not isinstance(value, six.string_types):
        raise TypeError
    return True