TMB_Common.py

"""
Module containing miscellaneous functions used by a variety of other modules
"""

from typing import Union

Number = Union[int, float]


def indent(n: int) -> str:
    return n * " "


def rangemap_name(name: str) -> str:
    return name + "_range_map"


def pointmap_name(name: str) -> str:
    return name + "_point_map"


def name_to_filename(x: str) -> str:
    """
    Convert a full species name into a valid file name
    """
    name_replace_list = [
        [" ", "_"],
        ["(", ""],
        [")", ""],
        [",", ""],
        [".", ""],
        ["\"", ""],
        ["æ", "_ae_"],
        ["ö", "_o_"],
        ["œ", "_oe_"],
        ["ç", "_c_"],
        ["[", "_"],
        ["]", "_"]
    ]
    for r in name_replace_list:
        x = x.replace(r[0], r[1])
    return x


def place_to_filename(x: str) -> str:
    """
    Convert a location name into a valid file name
    """
    place_replace_list = [
        [", ", "_-_"],
        [" (", "_-_"],
        [")", ""],
        ["/", "-"],
        [" ", "_"],
        ["\"", ""],
        ["'", ""],
        ["ç", "c"],
        ["ñ", "n"],
        ["ã", "a"],
        ["á", "a"],
        ["é", "e"],
        ["í", "i"],
        ["ó", "o"],
        ["ơ", "o"],
        ["ú", "u"],
        ["ū", "u"]
    ]
    for r in place_replace_list:
        x = x.replace(r[0], r[1])
    return x


def unicode_to_html_encoding(x: str) -> str:
    """
    Change unicode characters to html encoding in order to display correctly in google maps
    """
    unicode_replace_list = [
        ["ç", "ç"],  # 231
        ["ñ", "ñ"],  # 241
        ["ã", "ã"],  # 227
        ["á", "á"],  # 225
        ["é", "é"],  # 233
        ["í", "í"],  # 237
        ["ó", "ó"],  # 243
        ["ơ", "ơ"],  # 417
        ["ú", "ú"],  # 250
        ["ū", "ū"]   # 363
    ]
    for r in unicode_replace_list:
        x = x.replace(r[0], r[1])
    return x


def str_to_number(number: str) -> Number:
    """
    Convert a string to either an int or float, avoiding the use of eval() for security reasons
    """
    try:
        return int(number)
    except ValueError:
        return float(number)