Package pybaz :: Module _escaping
[frames] | no frames]

Module _escaping

source code


Internal module providing name escaping functionality.

This module implements some of public interface for the
pybaz_ package. But for convenience reasons the author prefers
to store this code in a file separate from ``__init__.py``.

.. _pybaz: pybaz-module.html

This module is strictly internal and should never be used.



Functions
 
name_escape(name)
Escape a file name using the Arch syntax.
 
name_unescape(name)
Unescape a file name using the Arch syntax.
Function Details

name_escape(name)

 
Escape a file name using the Arch syntax.

:arg name: unescaped file name.
:type name: str
:return: escaped file name.
:rtype: str

name_unescape(name)

 
Unescape a file name using the Arch syntax.

:arg name: escaped file name.
:type name: str
:return: unescaped file name.
:rtype: str
:raise errors.IllegalEscapeSequence: the syntax of ``name`` is incorrect.