#!/usr/bin/env python
#
# colors.py
#
# Copyright © 2020 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.
#
__all__ = [
"black",
"blue",
"brown",
"colour",
"cyan",
"darkgray",
"darkgrey",
"gray",
"green",
"grey",
"lime",
"magenta",
"olive",
"orange",
"pink",
"purple",
"red",
"teal",
"violet",
"white",
"yellow"
]
[docs]def colour(text_colour: str, text: str) -> str:
r"""
Make the given text the given colour.
Akin to ``\color{text_colour}{string}``.
:param text_colour: The colour to make the text
:param text: The text to colour
:return: The formatted string.
"""
return fr"{{\color{{{text_colour}}}{text}}}"
[docs]def black(text: str) -> str:
r"""
Make the given text black.
Akin to ``\color{black}{string}``.
:param text:
:return: The formatted string.
"""
return colour("black", text)
[docs]def blue(text: str) -> str:
r"""
Make the given text blue.
Akin to ``\color{blue}{string}``.
:param text:
:return: The formatted string.
"""
return colour("blue", text)
[docs]def brown(text: str) -> str:
r"""
Make the given text brown.
Akin to ``\color{brown}{string}``.
:param text:
:return: The formatted string.
"""
return colour("brown", text)
[docs]def cyan(text: str) -> str:
r"""
Make the given text cyan.
Akin to ``\color{cyan}{string}``.
:param text:
:return: The formatted string.
"""
return colour("cyan", text)
[docs]def darkgrey(text: str) -> str:
r"""
Make the given text darkgrey.
Akin to ``\color{darkgray}{string}``.
:param text:
:return: The formatted string.
"""
return colour("darkgray", text)
[docs]def darkgray(text: str) -> str:
r"""
Make the given text darkgray.
Akin to ``\\color{darkgray}{string}``.
:param text:
:return: The formatted string.
"""
return colour("darkgray", text)
[docs]def grey(text: str) -> str:
r"""
Make the given text grey.
Akin to ``\color{gray}{string}``.
:param text:
:return: The formatted string.
"""
return colour("gray", text)
[docs]def gray(text: str) -> str:
r"""
Make the given text gray.
Akin to ``\color{gray}{string}``.
:param text:
:return: The formatted string.
"""
return colour("gray", text)
[docs]def green(text: str) -> str:
r"""
Make the given text green.
Akin to ``\color{green}{string}``.
:param text:
:return: The formatted string.
"""
return colour("green", text)
[docs]def lime(text: str) -> str:
r"""
Make the given text lime.
Akin to ``\color{lime}{string}``.
:param text:
:return: The formatted string.
"""
return colour("lime", text)
[docs]def magenta(text: str) -> str:
r"""
Make the given text magenta.
Akin to ``\color{magenta}{string}``.
:param text:
:return: The formatted string.
"""
return colour("magenta", text)
[docs]def olive(text: str) -> str:
r"""
Make the given text olive.
Akin to ``\color{olive}{string}``.
:param text:
:return: The formatted string.
"""
return colour("olive", text)
[docs]def orange(text: str) -> str:
r"""
Make the given text orange.
Akin to ``\color{orange}{string}``.
:param text:
:return: The formatted string.
"""
return colour("orange", text)
[docs]def pink(text: str) -> str:
r"""
Make the given text pink.
Akin to ``\color{pink}{string}``.
:param text:
:return: The formatted string.
"""
return colour("pink", text)
[docs]def purple(text: str) -> str:
r"""
Make the given text purple.
Akin to ``\color{purple}{string}``.
:param text:
:return: The formatted string.
"""
return colour("purple", text)
[docs]def red(text: str) -> str:
r"""
Make the given text red.
Akin to ``\color{red}{string}``.
:param text:
:return: The formatted string.
"""
return colour("red", text)
[docs]def teal(text: str) -> str:
r"""
Make the given text teal.
Akin to ``\color{teal}{string}``.
:param text:
:return: The formatted string.
"""
return colour("teal", text)
[docs]def violet(text: str) -> str:
r"""
Make the given text violet.
Akin to ``\color{violet}{string}``.
:param text:
:return: The formatted string.
"""
return colour("violet", text)
[docs]def white(text: str) -> str:
r"""
Make the given text white.
Akin to ``\color{white}{string}``.
:param text:
:return: The formatted string.
"""
return colour("white", text)
[docs]def yellow(text: str) -> str:
r"""
Make the given text yellow.
Akin to ``\color{yellow}{string}``.
:param text:
:return: The formatted string.
"""
return colour("yellow", text)