#!/usr/bin/env python
#
# core.py
"""
Core functionality.
"""
#
# Copyright © 2020-2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
# OR OTHER DEALINGS IN THE SOFTWARE.
#
# stdlib
from typing import Optional
__all__ = ["begin", "end", "make_caption", "make_label", "re_escape"]
[docs]def make_caption(caption: str) -> str:
r"""
Akin to ``\caption{}``.
:param caption:
"""
return rf"\caption{{{caption}}}"
[docs]def make_label(label: str) -> str:
r"""
Akin to ``\label{}``.
:param label:
"""
return rf"\label{{{label}}}"
[docs]def begin(environment: str, options: Optional[str] = None) -> str:
r"""
Akin to ``\begin{environment}``.
:param environment:
:param options:
"""
if options:
return rf"\begin{{{environment}}}{{{options}}}"
else:
return rf"\begin{{{environment}}}"
[docs]def end(environment: str) -> str:
r"""
Akin to ``\end{environment}``.
:param environment:
"""
return rf"\end{{{environment}}}"
[docs]def re_escape(string: str) -> str:
"""
Escape literal backslashes for use with :mod:`re`.
.. seealso:: :func:`re.escape`, which escapes all characters treated specially be :mod:`re`.
:param string:
"""
return string.replace('\\', "\\\\")