scripts.config_generator.display_formatter

Complexity

Total Complexity

114

Size/Duplication

Total Lines	783
Duplicated Lines	0 %

Importance

Changes

0

38 Methods

Rating	Name	Duplication	Size	Complexity
A	DispDisplay._separator()	0	20	3
A	DispDisplay._get_default()	0	4	1
A	ListDisplay.__init__()	0	2	1
A	ParameterFormatter._create_display_string()	0	32	4
A	DisplayFormatter._get_quiet()	0	10	4
B	DisplayFormatter._get_equal_lines()	0	25	6
A	DisplayFormatter._get_synopsis()	0	6	1
A	ParameterFormatter.__init__()	0	2	1
A	DispDisplay._get_option_format()	0	43	4
A	ListDisplay._get_verbose()	0	10	1
A	DispDisplay._get_verbose_verbose()	0	13	1
A	DisplayFormatter._get_extra_info()	0	16	4
A	CiteDisplay._get_citation_dependency_str()	0	26	3
B	CiteDisplay._get_citation_str()	0	32	6
A	DispDisplay._get_verbose()	0	22	2
C	DispDisplay._get_param_details()	0	69	9
A	DispDisplay._get_verbose_option_colours()	0	18	2
A	CiteDisplay._get_citation_lines()	0	29	3
A	DispDisplay.__init__()	0	2	1
A	ListDisplay._get_verbose_verbose()	0	10	1
A	DisplayFormatter._get_description()	0	16	5
A	CiteDisplay.__init__()	0	2	1
A	DisplayFormatter._remove_quotes()	0	6	2
A	CiteDisplay._get_framework_citations()	0	15	2
B	DispDisplay._append_description()	0	45	8
A	ParameterFormatter._dict_to_str()	0	14	3
A	ListDisplay._get_quiet()	0	3	1
A	ListDisplay._get_default()	0	4	1
A	DisplayFormatter._get_string()	0	34	3
A	DispDisplay._notices()	0	14	2
A	CiteDisplay._get_default()	0	15	2
A	DispDisplay._get_verbose_option_string()	0	31	4
A	DisplayFormatter._get_plugin_title()	0	9	4
A	CiteDisplay._get_framework_title()	0	7	1
A	DisplayFormatter.__init__()	0	3	1
B	DispDisplay._get_verbose_param_details()	0	29	5
A	ParameterFormatter._get_param_details()	0	30	3
A	DispDisplay.get_warnings()	0	20	5

# Copyright 2014 Diamond Light Source Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
.. module:: display_formatter
   :platform: Unix
   :synopsis: Classes for formatting plugin list output in the configurator.

.. moduleauthor:: Nicola Wadeson <scientificsoftware@diamond.ac.uk>

"""
import os
import textwrap

from colorama import Fore, Back, Style

from savu.plugins import utils as pu
import savu.data.framework_citations as fc
from savu.data.plugin_list import CitationInformation


WIDTH = 95


def get_terminal_width():
    """Return the width of the terminal"""
    try:
        terminal_width = os.get_terminal_size().columns
        return terminal_width if terminal_width < WIDTH else WIDTH
    except (AttributeError, OSError) as ae:
        return WIDTH


class DisplayFormatter(object):
    def __init__(self, plugin_list):
        self.plugin_list_inst = plugin_list
        self.plugin_list = plugin_list.plugin_list

    def _get_string(self, **kwargs):
        out_string = []
        width = get_terminal_width()

        verbosity = kwargs.get("verbose", False)
        level = kwargs.get("current_level", "basic")
        datasets = kwargs.get("datasets", False)
        expand_dim = kwargs.get("expand_dim", None)

        start = kwargs.get("start", 0)
        stop = kwargs.get("stop", len(self.plugin_list))
        subelem = kwargs.get("subelem", False)

        if stop == -1:
            stop = len(self.plugin_list)

        count = start
        plugin_list = self.plugin_list[start:stop]
        line_break = "%s" % ("-" * width)
        out_string.append(line_break)

        display_args = {
            "subelem": subelem,
            "datasets": datasets,
            "expand_dim": expand_dim,
        }
        for p_dict in plugin_list:
            count += 1
            description = self._get_description(
                width, level, p_dict, count, verbosity, display_args
            )
            out_string.append(description)
            out_string.append(line_break)
        return "\n".join(out_string)

    def _get_description(
        self, width, level, p_dict, count, verbose, display_args
    ):
        if verbose == "-q":
            return self._get_quiet(p_dict, count, width)
        if not verbose:
            return self._get_default(
                level, p_dict, count, width, display_args
            )
        if verbose == "-v":
            return self._get_verbose(
                level, p_dict, count, width, display_args
            )
        if verbose == "-vv":
            return self._get_verbose_verbose(
                level, p_dict, count, width, display_args
            )

    def _get_plugin_title(self, p_dict, width, fore_colour, back_colour,
                          active="", quiet=False, pos=None):
        pos = f"{pos})" if pos else ""
        active = f"{active} " if active else ""
        title = f"{active}{pos} {p_dict['name']}"
        title = title if quiet else f"{title} ({p_dict['id']})"
        title_str = self._get_equal_lines(
            title, width, back_colour+fore_colour, Style.RESET_ALL, " ")
        return title_str

    def _get_quiet(self, p_dict, count, width, quiet=True):
        active = (
            "***OFF***" if "active" in p_dict and not p_dict["active"] else ""
        )
        p_dict["data"] = self._remove_quotes(p_dict["data"])
        pos = p_dict["pos"].strip() if "pos" in list(p_dict.keys()) else count
        fore = Fore.LIGHTWHITE_EX
        back = Back.RED if active else Back.LIGHTBLACK_EX
        return self._get_plugin_title(
            p_dict, width, fore, back, active=active, quiet=quiet, pos=pos
        )

    def _get_synopsis(self, p_dict, width, colour_on, colour_off):
        doc_str = p_dict["doc"]
        synopsis = self._get_equal_lines(
            doc_str.get("synopsis"), width, colour_on, colour_off, " " * 2
        )
        return "\n" + synopsis

    def _get_extra_info(self, p_dict, width, colour_off, info_colour,
                        warn_colour):
        doc_str = p_dict["doc"]
        info = self._get_equal_lines(doc_str.get("info"), width, info_colour,
                                     colour_off, " " * 2)
        info = "\n"+info if info else ''

        doc_link = doc_str.get("documentation_link")
        if doc_link:
            documentation_link = f"  {doc_link}"
            info +="\n"+documentation_link

        warn = self._get_equal_lines(doc_str.get('warn'), width, warn_colour,
                                     colour_off, " "*2)
        warn = "\n"+warn if warn else ""
        return info, warn

    def _get_equal_lines(self, string, width, colour_on, colour_off, offset,
                         option_colour=False):
        """ Format the input string so that it is the width specified.
        Surround the string with provided colour.
        """
        if not string or not colour_on:
            return ""
        # Call method directly for split to be used with string and unicode
        string = string.splitlines()
        str_list = []
        for s in string:
            str_list += textwrap.wrap(s, width=width - len(offset))
        new_str_list = []
        if option_colour:
            # Alternate colour choice and doesn't colour the full width
            new_str_list = self._get_option_format(str_list, width,
                            colour_on, colour_off, offset, option_colour,
                            new_str_list)
        else:
            # Fill the whole line with the colour
            for line in str_list:
                lwidth = width - len(line) - len(offset)
                new_str_list.append(
                    colour_on + offset + line + " " * lwidth + colour_off)
        return "\n".join(new_str_list)

    def _remove_quotes(self, data_dict):
        """Remove quotes around variables for display"""
        for key, val in data_dict.items():
            val = str(val).replace("'", "")
            data_dict[key] = val
        return data_dict

class ParameterFormatter(DisplayFormatter):
    def __init__(self, plugin_list):
        super(ParameterFormatter, self).__init__(plugin_list)

    def _get_param_details(self, level, p_dict, width,
                           desc=False, breakdown=False):
        """ Return a list of parameters organised by visibility level

        :param level: The visibility level controls which parameters the
           user can see
        :param p_dict: Parameter dictionary for one plugin
        :param width: The terminal display width for output string
        :param desc: The description for use later on within the display
          formatter
        :param breakdown: Boolean True if the verbose verbose information
          should be shown
        :return: List of parameters in order
        """
        params = ""
        keycount = 0
        # Return the list of parameters according to the visibility level
        keys = pu.set_order_by_visibility(p_dict["param"], level=level)
        longest_key = max(keys, key=len)
        try:
            for key in keys:
                keycount += 1
                params = self._create_display_string(
                    desc, key, p_dict, params, keycount, longest_key,
                    width, breakdown
                )
            return params
        except Exception as e:
            print("ERROR: " + str(e))
            raise

    def _create_display_string(self, desc, key, p_dict, params, keycount,
                               longest_key, width, breakdown, expand_dim=None):
        """Create a string to describe the current parameter (key)
        to display to the terminal

        :param desc: the verbose description to display
        :param key: current parameter name
        :param p_dict: parameter dictionary for one plugin
        :param params: parameter info string to display
        :param keycount: current parameter number
        :param longest_key: longest parameter name for this plugin
        :param width: display text width
        :param breakdown: bool True if the verbose verbose information
          should be shown
        :param expand_dim: number of dimensions
        :return: string to describe parameter (key)
        """
        margin = 6
        str_margin = " " * margin
        sp = (len(longest_key) - len(key)) * " "
        # Align the parameter numbers
        temp = f"{keycount}) {sp}{key} : "
        temp = "\n   %2i) %20s : %s"
        val = p_dict["data"][key]
        if key == "preview" and expand_dim is not None:
            expand_dict = p_dict["tools"].get_expand_dict(val, expand_dim)
            val = self._dict_to_str(expand_dict, 15*" ")
        params += temp % (keycount, key, val)
        if desc:
            params = self._append_description(desc, key, p_dict, str_margin,
                                              width, params, breakdown)
        return params


    def _dict_to_str(self, _dict, indent):
        """Change the dictionary to a formatted string

        :param _dict:
        :param indent: number of space to indent by
        :return: String containing the formatted dict
        """
        dict_str = ""
        indent += (3 * " ")
        for k,v in _dict.items():
            if isinstance(v, dict):
                v = self._dict_to_str(v, indent+"  ")
            dict_str += f"\n{indent}{k:>11} : {v}"
        return dict_str


class DispDisplay(ParameterFormatter):
    def __init__(self, plugin_list):
        super(DispDisplay, self).__init__(plugin_list)

    def _get_default(self, level, p_dict, count, width, display_args=False):
        title = self._get_quiet(p_dict, count, width)
        params = self._get_param_details(level, p_dict, width, display_args)
        return title + params

    def _get_param_details(self, level, p_dict, width, display_args=False,
                           desc=False, breakdown=False):
        """
        Return a list of parameters organised by visibility level

        :param level: The visibility level controls which parameters the
           user can see
        :param p_dict: Parameter dictionary for one plugin
        :param width: The terminal display width for output strings
        :param display_args: A dictionary with subelem and datasets.
          This filters the visible parameters again. If subelem is chosen,
          only that one parameter is shown (this is useful when ONE parameter
          is modified in the terminal). If datasets is chosen, ONLY the
          in/out dataset parameters are shown
        :param desc: The description for use later on within the display
          formatter
        :param breakdown: Boolean True if the verbose verbose information
          should be shown
        :return: List of parameters in order
        """
        # Check if the parameters need to be filtered
        subelem = display_args.get("subelem")
        datasets = display_args.get("datasets")
        expand_dim = display_args.get("expand_dim")

        level = level if not (subelem or datasets) else False
        # Return the list of parameters according to the visibility level
        # unless a subelement or dataset choice is specified
        keys = pu.set_order_by_visibility(p_dict["param"], level=level)

        filter = subelem if subelem else datasets
        # If datasets parameter specified, only show these
        filter_items = (
            [pu.param_to_str(subelem, keys)]
            if subelem
            else ["in_datasets", "out_datasets"]
        )
        # Get the longest parameter name, to align values in console
        if filter:
            longest_key = max(filter_items, key=len)
        else:
            longest_key = max(keys, key=len)
        params = ""
        keycount = 0
        prev_visibility = ""
        try:
            for key in keys:
                keycount += 1
                if filter:
                    if key in filter_items:
                        params = \
                            self._separator(key, p_dict, prev_visibility,
                                            params, width)
                        params = self._create_display_string(desc, key,
                                       p_dict, params, keycount, longest_key,
                                       width, breakdown, expand_dim)
                else:
                    params = \
                        self._separator(key, p_dict, prev_visibility,
                                        params, width)
                    params = self._create_display_string(desc, key, p_dict,
                                        params, keycount, longest_key, width,
                                        breakdown, expand_dim)
                prev_visibility = p_dict["param"][key]["visibility"]

            return params
        except Exception as e:
            print("ERROR: " + str(e))
            raise

    def _separator(self, key, p_dict, prev_visibility, params, width):
        """Add a line separator to the parameter string 'params'

        :param key: parameter name
        :param p_dict: dictionary of parameter definitions
        :param prev_visibility: visibility level for the previous parameter
        :param params: parameter string
        :param width: width of the console display
        :return: parameter string
        """
        offset = 2
        align = "left"
        cur_visibility = p_dict["param"][key]["visibility"]
        split = "-" * ((width - len(cur_visibility)) - offset)
        if cur_visibility != prev_visibility:
            if align == "left":
                params += "\n" + "-" * offset + cur_visibility + split
            else:
                params += "\n" + split + cur_visibility + "-" * offset
        return params

    def _get_verbose(
        self, level, p_dict, count, width, display_args, breakdown=False
    ):
        title = self._get_quiet(p_dict, count, width, quiet=False)
        colour_on = Back.LIGHTBLACK_EX + Fore.LIGHTWHITE_EX
        colour_off = Back.RESET + Fore.RESET
        synopsis = self._get_synopsis(p_dict, width, colour_on, colour_off)
        param_desc = {k: v["description"] for k, v in p_dict["param"].items()}
        params = self._get_param_details(
            level, p_dict, width, display_args, desc=param_desc
        )
        if breakdown:
            params = self._get_param_details(
                level,
                p_dict,
                width,
                display_args,
                desc=param_desc,
                breakdown=breakdown,
            )
            return title, synopsis, params
        return title + synopsis + params

    def _get_verbose_verbose(self, level, p_dict, count, width, display_args):
        title, synopsis, param_details = self._get_verbose(
            level, p_dict, count, width, display_args, breakdown=True
        )
        info_c = Back.CYAN + Fore.LIGHTWHITE_EX
        warn_c = Style.RESET_ALL + Fore.RED
        c_off = Back.RESET + Fore.RESET
        info, warn = self._get_extra_info(
            p_dict, width, c_off, info_c, warn_c
        )
        # Synopsis and get_extra info both call plugin instance and populate
        # parameters which means yaml_load will be called twice
        return title + synopsis + info + warn + param_details

    def _notices(self):
        width = 86
        warnings = self.get_warnings(width)
        if warnings:
            notice = (
                Back.RED
                + Fore.WHITE
                + "IMPORTANT PLUGIN NOTICES"
                + Back.RESET
                + Fore.RESET
                + "\n"
            )
            border = "*" * width + "\n"
            print((border + notice + warnings + "\n" + border))

    def get_warnings(self, width):
        # remove display styling outside of this class
        colour = Back.RESET + Fore.RESET
        warnings = []
        names = []
        for plugin in self.plugin_list:
            if plugin["name"] not in names:
                names.append(plugin["name"])
                doc_str = plugin["doc"]
                warn = doc_str.get("warn")
                if warn:
                    for w in warn.split("\n"):
                        string = plugin["name"] + ": " + w
                        warnings.append(
                            self._get_equal_lines(
                                string, width - 1, colour, colour, " " * 2
                            )
                        )
        return "\n".join(
            ["*" + "\n ".join(w.split("\n")) for w in warnings if w]
        )

    def _append_description(self, desc, key, p_dict, str_margin, width,
                            params, breakdown):
        c_off = Back.RESET + Fore.RESET
        description_verbose = False
        description_keys = ""
        if isinstance(desc[key], str):
            pdesc = " ".join(desc[key].split())
            pdesc = self._get_equal_lines(
                pdesc, width, Fore.CYAN, Fore.RESET, str_margin
            )
            params += "\n" + pdesc
        elif isinstance(desc[key], dict):
            description_keys = desc[key].keys()
            for param_key in description_keys:
                if param_key == "summary":
                    pdesc = desc[key][param_key]
                    pdesc = self._get_equal_lines(
                        pdesc, width, Fore.CYAN, Fore.RESET, str_margin
                    )
                    params += "\n" + pdesc

                if breakdown:
                    params = self._get_verbose_param_details(
                        p_dict, param_key, desc, key, params, width
                    )
                    description_verbose = True

        options = p_dict["param"][key].get("options")
        if options:
            option_text = "Options:"
            option_text = self._get_equal_lines(
                option_text, width, Fore.BLUE, Fore.RESET, str_margin
            )
            params += "\n" + option_text
            for opt in options:
                current_opt = p_dict["data"][key]
                option_verbose = \
                    self._get_verbose_option_string(opt, current_opt,
                            description_keys, description_verbose,
                            desc, key, c_off, width, str_margin)

                temp = "\n" + "%s" + c_off + Style.RESET_ALL
                params += temp % option_verbose

        return params

    def _get_verbose_option_string(self, opt, current_opt, description_keys,
                                   description_verbose, desc, key, c_off,
                                   width, str_margin):
        """ Get the option description string and correctly format it """
        colour, v_colour = self._get_verbose_option_colours(opt, current_opt)
        unicode_bullet_point = "\u2022"
        opt_margin = str_margin + (2 * " ")
        if (description_verbose is True) and ("options" in description_keys):
            # If there are option descriptions present
            options_desc = {k: v
                            for k, v in desc[key]["options"].items()
                            if v}
            if opt in options_desc.keys():
                # Append the description
                opt_d = unicode_bullet_point + str(opt) + ": " \
                        + options_desc[opt]
            else:
                # No description if the field is blank
                opt_d = unicode_bullet_point + str(opt) + ": "
            option_verbose = "\n" + opt_d
            option_verbose = \
                self._get_equal_lines(option_verbose,
                                       width, v_colour, c_off,
                                       opt_margin, option_colour=colour)
        else:
            option_verbose = unicode_bullet_point + str(opt)
            option_verbose = \
                self._get_equal_lines(option_verbose,
                                       width, colour, c_off, opt_margin,
                                       option_colour=colour)
        return option_verbose

    def _get_verbose_option_colours(self, opt, current_opt):
        """Set the colour of the option text

        :param opt: Option string
        :param current_opt: The curently selected option value
        :return: colour, verbose_color
        """
        if current_opt == opt:
            # Highlight the currently selected option by setting a
            # background colour and white text
            colour = Back.BLUE + Fore.LIGHTWHITE_EX
            verbose_color = Back.BLACK + Fore.LIGHTWHITE_EX
        else:
            # Make the option bold using Style.BRIGHT
            colour = Fore.BLUE + Style.BRIGHT
            # Remove bold style for the description
            verbose_color = Style.RESET_ALL + Fore.BLACK
        return colour, verbose_color

    def _get_verbose_param_details(
        self, p_dict, param_key, desc, key, params, width
    ):
        margin = 6
        str_margin = " " * margin
        if param_key == "verbose":
            verbose = desc[key][param_key]
            # Account for margin space
            style_on = Fore.CYAN + "\033[3m"
            style_off = Fore.RESET + "\033[0m"
            verbose = self._get_equal_lines(
                verbose, width, style_on, style_off, str_margin
            )
            params += "\n" + verbose

        if param_key == "range":
            p_range = desc[key][param_key]
            if p_range:
                try:
                    r_color = Fore.MAGENTA
                    r_off = Fore.RESET
                    p_range = self._get_equal_lines(
                        p_range, width, r_color, r_off, str_margin
                    )
                    params += "\n" + p_range
                except TypeError:
                    print(f"You have not filled in the {param_key} field "
                          f"within the yaml information.")
        return params

    def _get_option_format(self, str_list, width, colour_on, colour_off,
                           offset, option_colour, new_str_list):
        """ Special format for the options list """
        count = 0
        for line in str_list:
            lwidth = width - len(line) - len(offset)
            count += 1
            if count == 1:
                """At the first line, split the key so that it's colour is
                different. This is done here so that I keep the key and
                value on the same line.
                I have not passed in the unicode colour before this
                point as the textwrap does not take unicode into
                account when calculating the final string width.
                """
                if ":" in line:
                    option_text = line.split(":")[0]
                    opt_descr_text = line.split(":")[1]
                    line = (
                        option_colour
                        + option_text
                        + ":"
                        + colour_on
                        + opt_descr_text
                    )
                    new_str_list.append(
                        offset + line + colour_off + " " * lwidth
                    )
                else:
                    # Assumes that the option string is one line, the length
                    # of the width
                    new_str_list.append(
                        offset
                        + option_colour
                        + line
                        + colour_off
                        + " " * lwidth
                    )
            else:
                new_str_list.append(
                    offset + colour_on + line + colour_off + " " * lwidth
                )
        return new_str_list


class ListDisplay(ParameterFormatter):
    def __init__(self, plugin_list):
        super(ListDisplay, self).__init__(plugin_list)

    def _get_quiet(self, p_dict, count, width):
        return self._get_plugin_title(
            p_dict, width, Fore.RESET, Back.RESET, quiet=True
        )

    def _get_default(self, level, p_dict, count, width, display_args=False):
        title = self._get_quiet(p_dict, count, width)
        synopsis = self._get_synopsis(p_dict, width, Fore.CYAN, Fore.RESET)
        return title + synopsis

    def _get_verbose(
        self, level, p_dict, count, width, display_args, breakdown=False
    ):
        default_str = self._get_default(level, p_dict, count, width)
        info_c = Fore.CYAN
        c_off = Back.RESET + Fore.RESET
        info, warn = self._get_extra_info(
            p_dict, width, c_off, info_c, info_c
        )
        return default_str + info

    def _get_verbose_verbose(self, level, p_dict, count, width, display_args):
        all_params = self._get_param_details("all", p_dict, width)
        default_str = self._get_default(level, p_dict, count, width)
        info_c = Fore.CYAN
        warn_c = Fore.RED
        c_off = Back.RESET + Fore.RESET
        info, warn = self._get_extra_info(
            p_dict, width, c_off, info_c, warn_c
        )
        return default_str + info + warn + all_params


class CiteDisplay(DisplayFormatter):
    def __init__(self, plugin_list):
        super(CiteDisplay, self).__init__(plugin_list)

    def _get_default(self, level, p_dict, count, width, display_args=False):
        """Find the citations and print them. Only display citations
        if they are required. For example, if certain methods are being
        used.
        """
        title = self._get_quiet(p_dict, count, width)
        citation = self._get_citation_str(
            p_dict["tools"].get_citations(), width, parameters=p_dict["data"]
        )
        if count == 1:
            # Display framework citations before the first citation
            framework_citations = self._get_framework_citations(width)
            return framework_citations + title + citation

        return title + citation

    def _get_citation_str(self, citation_dict, width, parameters=""):
        """Get the plugin citation information

        :param: citation_dict: Dictionay containing citation information
        :param parameters: Dictionary containing parameter information
        :param width: The terminal display width for output strings
        :return: cite, A string containing plugin citations
        """
        margin = 6
        str_margin = " " * margin
        line_break = "\n" + str_margin + "-" * (width - margin) + "\n"
        cite = ""
        if citation_dict:
            for citation in citation_dict.values():
                if citation.dependency and parameters:
                    # If the citation is dependent upon a certain parameter
                    # value being chosen
                    str_dep = self._get_citation_dependency_str(
                        citation, parameters, width, str_margin
                    )
                    if str_dep:
                        cite += line_break + str_dep + "\n" \
                                + self._get_citation_lines(citation,
                                                           width,
                                                           str_margin)
                else:
                    cite += line_break \
                            + self._get_citation_lines(citation,
                                                       width, str_margin)
        else:
            cite = f"\n\n{' '}No citations"
        return cite

    def _get_citation_dependency_str(
        self, citation, parameters, width, str_margin
    ):
        """Create a message for citations dependent on a
        certain parameter

        :param citation: Single citation dictionary
        :param parameters: List of current parameter values
        :param width: The terminal display width for output strings
        :param str_margin: The terminal display margin
        :return: str_dep, A string to identify citations dependent on
        certain parameter values
        """
        str_dep = ""
        for (citation_dependent_parameter, citation_dependent_value) \
            in citation.dependency.items():
            current_value = parameters[citation_dependent_parameter]
            if current_value == citation_dependent_value:
                str_dep = (
                    f"This citation is for the {citation_dependent_value}"
                    f" {citation_dependent_parameter}"
                )
                str_dep = self._get_equal_lines(
                    str_dep, width, Style.BRIGHT, Style.RESET_ALL, str_margin
                )
        return str_dep

    def _get_framework_title(self, width, fore_colour, back_colour):
        title = "Framework Citations "
        width -= len(title)
        title_str = (
            back_colour + fore_colour + title + " " * width + Style.RESET_ALL
        )
        return title_str

    def _get_framework_citations(self, width):
        """Create a string containing framework citations

        :param width: Width of formatted text
        :return: String with framework citations
        """
        citation_dict = {}
        framework_cites = fc.get_framework_citations()
        for name, cite in framework_cites.items():
            citation_dict.update({name: cite})
        title = \
            self._get_framework_title(width, Fore.LIGHTWHITE_EX,
                                             Back.LIGHTBLACK_EX)
        cite = self._get_citation_str(citation_dict, width)
        return title + cite + "\n"

    def _get_citation_lines(self, citation, width, str_margin):
        """Print certain information about the citation in order.

        :param citation: Single citation dictionary
        :param width: The terminal display width for output strings
        :param str_margin: The terminal display margin
        :return: A string containing citation details
        """
        cite_keys = ["name", "description", "doi", "bibtex", "endnote"]
        cite_dict = citation.__dict__
        cite_str = ""

        style_on = Style.BRIGHT
        style_off = Style.RESET_ALL

        for key in cite_keys:
            if cite_dict[key]:
                # Set the key name to be bold
                cite_key = self._get_equal_lines(
                    key.title(), width, style_on, style_off, str_margin
                )
                # No style for the citation content
                cite_value = self._get_equal_lines(
                    cite_dict[key], width, style_off, style_off, str_margin
                )
                # New line for each item
                cite_str += "\n" + cite_key + "\n" + cite_value + "\n"

        return cite_str