coala-analyzer / coala

coalib/misc/StringConverter.py

import re
import validators
from collections import Iterable, OrderedDict

from coalib.misc import Constants
from coalib.parsing.StringProcessing import (
    unescape, unescaped_split, unescaped_strip)


class StringConverter:
    """
    Converts strings to other things as needed. If you need some kind of string
    conversion that is not implemented here, consider adding it so everyone
    gets something out of it.
    """

    def __init__(self,
                 value,
                 strip_whitespaces=True,
                 list_delimiters=None,
                 dict_delimiter=":",
                 remove_empty_iter_elements=True):
        if list_delimiters is None:

The variable list_delimiters does not seem to be defined.

            list_delimiters = [",", ";"]

        if not isinstance(list_delimiters, Iterable):

The variable Iterable does not seem to be defined.

            raise TypeError("list_delimiters has to be an Iterable.")
        if not isinstance(strip_whitespaces, bool):

The variable bool does not seem to be defined.

The variable strip_whitespaces does not seem to be defined.

            raise TypeError("strip_whitespaces has to be a bool parameter")

        self.__strip_whitespaces = strip_whitespaces
        self.__list_delimiters = list_delimiters
        self.__dict_delimiter = dict_delimiter

The variable dict_delimiter does not seem to be defined.

        self.__remove_empty_iter_elements = remove_empty_iter_elements

The variable remove_empty_iter_elements does not seem to be defined.

        self.__escaped_list = None
        self.__unescaped_list = None
        self.__dict = None
        self.value = value

The variable value does not seem to be defined.

    def __str__(self):
        return unescape(self.value)

The variable self does not seem to be defined.

    def __bool__(self):
        if str(self).lower() in Constants.TRUE_STRINGS:
            return True
        if str(self).lower() in Constants.FALSE_STRINGS:
            return False
        raise ValueError

The variable ValueError does not seem to be defined.

    def __len__(self):
        return len(str(self))

The variable self does not seem to be defined.

    def __int__(self):
        return int(str(self))

The variable self does not seem to be defined.

    def __float__(self):
        return float(str(self))

The variable self does not seem to be defined.

    def __url__(self):
        """
        Determines the url validity of this setting.

        :return:            url string
        :raises ValueError: If the url is not valid.
        """
        strrep = str(self).strip()
        if validators.url(strrep):

The variable strrep does not seem to be defined.

            return strrep

        raise ValueError(repr(strrep) + " is not a valid url.")

    def __iter__(self, remove_backslashes=True):
        """
        Converts the value to a list using the delimiters given at construction
        time.

        Note that escaped values will be unescaped and escaped list delimiters
        will be allowed in values. If you need the escapes you should not
        use this routine.

        :param remove_backslashes: Whether or not to remove the backslashes
                                   after conversion.
        :return:                   An iterator over all values.
        """
        if remove_backslashes:

The variable remove_backslashes does not seem to be defined.

            return iter(self.__unescaped_list)

The variable self does not seem to be defined.

        else:
            return iter(self.__escaped_list)

    def __getitem__(self, item):
        return self.__dict.__getitem__(item)

The variable item does not seem to be defined.

    def keys(self):
        return self.__dict.keys()

    def __get_raw_list(self):
        pattern = ("(?:" +
                   "|".join(re.escape(v) for v in self.__list_delimiters) +

The variable v does not seem to be defined.

The variable self does not seem to be defined.

                   ")")

        return list(unescaped_split(pattern,

The variable pattern does not seem to be defined.

                                    self.value,
                                    use_regex=True))

    def __prepare_list(self):
        self.__escaped_list = self.__get_raw_list()

        if self.__strip_whitespaces:

The variable self does not seem to be defined.

            self.__escaped_list = [unescaped_strip(elem)

The variable elem does not seem to be defined.

                                   for elem in self.__escaped_list]

        self.__unescaped_list = [unescape(elem)
                                 for elem in self.__escaped_list]

        if self.__remove_empty_iter_elements:
            # Need to do after stripping, cant use builtin functionality of
            # split.
            while "" in self.__unescaped_list:
                self.__unescaped_list.remove("")
            while "" in self.__escaped_list:
                self.__escaped_list.remove("")

    def __prepare_dict(self):
        # We must keep order here, user can drop it later.
        self.__dict = OrderedDict()
        for elem in self.__get_raw_list():
            key_val = unescaped_split(self.__dict_delimiter, elem, max_split=1)

The variable elem does not seem to be defined.

The variable self does not seem to be defined.

            if self.__strip_whitespaces:
                key_val = [unescaped_strip(item) for item in key_val]

The variable item does not seem to be defined.

The variable key_val does not seem to be defined.

            key_val = [unescape(item) for item in key_val]

            if not any(item != "" for item in key_val):
                continue

            if len(key_val) < 2:
                self.__dict[key_val[0]] = ""
            else:
                self.__dict[key_val[0]] = key_val[1]

    @property

The variable property does not seem to be defined.

    def value(self):
        return self.__value

The variable self does not seem to be defined.

    @value.setter

The variable value does not seem to be defined.

    def value(self, newval):
        self.__value = str(newval)

The variable newval does not seem to be defined.

        if self.__strip_whitespaces:

The variable self does not seem to be defined.

            self.__value = unescaped_strip(self.__value)

        self.__prepare_list()
        self.__prepare_dict()

    def __eq__(self, other):
        return isinstance(other, StringConverter) and self.value == other.value

The variable StringConverter does not seem to be defined.

The variable self does not seem to be defined.

The variable other does not seem to be defined.

    def __ne__(self, other):
        return not self.__eq__(other)

The variable other does not seem to be defined.