Function check_name_validity

tables/path.py:119–155

Check the validity of the `name` of a Node object. Validity of Node names is more limited than attribute names. If the name is not valid, a ``ValueError`` is raised. If it is valid but it can not be used with natural naming, a `NaturalNameWarning` is issued. >>> warnings.simp

(name: str)

def check_name_validity(name: str) -> None:
    """Check the validity of the `name` of a Node object.

    Validity of Node names is more limited than attribute names.

    If the name is not valid, a ``ValueError`` is raised.  If it is
    valid but it can not be used with natural naming, a
    `NaturalNameWarning` is issued.

    >>> warnings.simplefilter("ignore")
    >>> check_name_validity('a')
    >>> check_name_validity('a_b')
    >>> check_name_validity('a:b')          # NaturalNameWarning
    >>> check_name_validity('/a/b')
    Traceback (most recent call last):
     ...
    ValueError: the ``/`` character is not allowed in object names: '/a/b'
    >>> check_name_validity('.')
    Traceback (most recent call last):
     ...
    ValueError: ``.`` is not allowed as an object name
    >>> check_name_validity('')
    Traceback (most recent call last):
     ...
    ValueError: the empty string is not allowed as an object name

    """
    check_attribute_name(name)

    # Check whether `name` is a valid HDF5 name.
    # http://hdfgroup.org/HDF5/doc/UG/03_Model.html#Structure
    if name == ".":
        raise ValueError("``.`` is not allowed as an object name")
    elif "/" in name:
        raise ValueError(
            "the ``/`` character is not allowed " "in object names: %r" % name
        )


def join_path(parentpath: str, name: str) -> str: