python.iconfTool.models.structure.ComponentsStructure Class Reference

Inheritance diagram for python.iconfTool.models.structure.ComponentsStructure:

Collaboration diagram for python.iconfTool.models.structure.ComponentsStructure:

Public Member Functions
None	__init__ (self, Dict flags_dict, Set checked_elements)
None	replace_references (self, GroupingElement element)
None	generate (self, int x_pos=1, structure_dict=None)
List[Element]	group_elements (self, List[Element] structure_list, int x_pos)
List[Element]	get_list (self)
None	filter_by_text (self, str filter_text)
None	sort (self)
Dict	generate_structure_dict (self)
None	generate_for_element (self, GroupingElement grouping_element, Dict structure)
None	add_to_checked (self, Element element)
None	remove_from_checked (self, Element element)

Public Attributes
	structure_dict
	structure_list
	filter

Detailed Description

Definition at line 101 of file structure.py.

Constructor & Destructor Documentation

__init__()

None python.iconfTool.models.structure.ComponentsStructure.__init__	(		self,
		Dict	flags_dict,
		Set	checked_elements
	)

Definition at line 102 of file structure.py.

    def __init__(self, flags_dict: Dict, checked_elements: Set) -> None:
        super().__init__(flags_dict, checked_elements)
        self.roots_dict: Dict = {}
        self.structure_list: List[Element] = []
        self.filter: ComponentsStructureFilter  # Filter object used in search
 

Member Function Documentation

add_to_checked()

None python.iconfTool.models.structure.Structure.add_to_checked (   self, Element  element  )

inherited

Definition at line 91 of file structure.py.

    def add_to_checked(self, element: Element) -> None:
        hash_value = element.hash
        self.checked_elements.add(hash_value)
 

filter_by_text()

None python.iconfTool.models.structure.ComponentsStructure.filter_by_text	(		self,
		str	filter_text
	)

Definition at line 183 of file structure.py.

    def filter_by_text(self, filter_text: str) -> None:
        self.filter.generate_by_text(filter_text)
        for element in self.structure_list:
            assert isinstance(element, GroupingElement)
            element.children = list(
                filter(
                    lambda child: child.get_reference_name()
                    in self.filter.comps_to_save
                    or child not in self.roots_dict,
                    element.children,
                )
            )
 

generate()

None python.iconfTool.models.structure.ComponentsStructure.generate	(		self,
		int	x_pos = 1,
			structure_dict = None
	)

Definition at line 121 of file structure.py.

    def generate(self, x_pos: int = 1, structure_dict=None) -> None:
 
        self.structure_dict = structure_dict or self.generate_structure_dict()
        for root_name in self.structure_dict:
            if isinstance(self.structure_dict[root_name], dict):
                root_group = GroupingElement(root_name, x_pos)
                if root_group.hash in self.checked_elements:
                    root_group.set_as_checked()
                self.generate_for_element(
                    root_group, self.structure_dict[root_name]
                )
                self.structure_list.append(root_group)
                self.roots_dict[root_name] = root_group
 
        self.structure_list = self.group_elements(
            self.structure_list, x_pos - 1
        )
 
        self.sort()
        self.filter = ComponentsStructureFilter(self.structure_dict)
 

generate_for_element()

None python.iconfTool.models.structure.Structure.generate_for_element (   self, GroupingElement  grouping_element, Dict   structure  )

inherited

Definition at line 56 of file structure.py.

    def generate_for_element(
        self, grouping_element: GroupingElement, structure: Dict
    ) -> None:
        child_x_pos = grouping_element.x_pos + INDENT
        for child in structure:
            try:
                # Handles situation when list or dict is provided as a string
                structure[child] = ast.literal_eval(structure[child])
            except (ValueError, SyntaxError):
                pass
 
            if isinstance(structure[child], dict):
                group = GroupingElement(child, child_x_pos, grouping_element)
                if group.hash in self.checked_elements:
                    group.set_as_checked()
                self.generate_for_element(group, structure[child])
                grouping_element.add_child(group)
            elif isinstance(structure[child], list):
                group = GroupingElement(child, child_x_pos, grouping_element)
                if group.hash in self.checked_elements:
                    group.set_as_checked()
                for el in structure[child]:
                    no_value_child = SingleElement(el, child_x_pos + INDENT)
                    if no_value_child.hash in self.checked_elements:
                        no_value_child.set_as_checked()
                    group.add_child(no_value_child)
                grouping_element.add_child(group)
            else:
                flag = ValueElement(
                    child, child_x_pos, structure[child], grouping_element
                )
                if flag.hash in self.checked_elements:
                    flag.set_as_checked()
                grouping_element.add_child(flag)
 

generate_structure_dict()

Dict python.iconfTool.models.structure.Structure.generate_structure_dict (   self )

inherited

Split dictionary keys into nested structure
e.g. Test1.Test2: Value -> Test1: {Test2: Value}

Definition at line 27 of file structure.py.

    def generate_structure_dict(self) -> Dict:
        """Split dictionary keys into nested structure
        e.g. Test1.Test2: Value -> Test1: {Test2: Value}
        """
        structure_dict: Dict = {}
 
        for flag, value in self.flags_dict.items():
            groups = flag.split(".")
            structure_point = structure_dict
            for i in range(len(groups) - 1):
                if groups[i] not in structure_point:
                    structure_point[groups[i]] = {}
                elif isinstance(structure_point[groups[i]], str):
                    structure_point[groups[i]] = {
                        structure_point[groups[i]]: {}
                    }
                structure_point = structure_point[groups[i]]
            if groups:
                last = groups[-1]
                if (
                    last in structure_point
                    and isinstance(structure_point[last], dict)
                    and isinstance(value, dict)
                ):
                    structure_point[last].update(value)
                else:
                    structure_point[last] = value
        return structure_dict
 

get_list()

List[Element] python.iconfTool.models.structure.ComponentsStructure.get_list

(

self

)

Definition at line 179 of file structure.py.

    def get_list(self) -> List[Element]:
        self.filter.reset()
        return self.structure_list
 

group_elements()

List[Element] python.iconfTool.models.structure.ComponentsStructure.group_elements	(		self,
		List[Element]	structure_list,
		int	x_pos
	)

Definition at line 142 of file structure.py.

    def group_elements(
        self, structure_list: List[Element], x_pos: int
    ) -> List[Element]:
 
        algs = GroupingElement("Algorithms and Sequences", x_pos)
        tools = GroupingElement("Public tools", x_pos)
        settings = GroupingElement("Application Settings and Services", x_pos)
 
        new_structure_list: List[Element] = [algs, tools, settings]
 
        seq_names = []
 
        def get_ath_sequences(el) -> None:
            if isinstance(el, GroupingElement):
                members_obj = el.get_child_by_name("Members")
                if members_obj:
                    assert isinstance(members_obj, GroupingElement)
                    for member in members_obj.children:
                        ref_name = member.get_reference_name()
                        seq_names.append(ref_name)
                        get_ath_sequences(self.roots_dict.get(ref_name))
 
        seq_names.append("AthMasterSeq")
        get_ath_sequences(self.roots_dict["AthMasterSeq"])
 
        for el in structure_list:
            if el.name == "AthMasterSeq":
                algs.add_child(el)
            elif (
                el.name == "ToolSvc"
            ):  # any of ToolSvc children is not present in roots dict
                tools.add_child(el)
            elif el.name not in seq_names:
                settings.add_child(el)
 
        return new_structure_list
 

remove_from_checked()

None python.iconfTool.models.structure.Structure.remove_from_checked (   self, Element  element  )

inherited

Definition at line 95 of file structure.py.

    def remove_from_checked(self, element: Element) -> None:
        hash_value = element.hash
        if hash_value in self.checked_elements:
            self.checked_elements.remove(hash_value)
 
 

replace_references()

None python.iconfTool.models.structure.ComponentsStructure.replace_references	(		self,
		GroupingElement	element
	)

Definition at line 108 of file structure.py.

    def replace_references(self, element: GroupingElement) -> None:
        element.replaced = True
        for i, child in enumerate(element.children):
            if isinstance(child, SingleElement):
                ref_name = child.get_reference_name()
                if ref_name in self.roots_dict and not element.has_parent(
                    self.roots_dict[ref_name].get_name()
                ):
                    element.children[i] = self.roots_dict[ref_name]
 
                    element.children[i].parent = element
                    element.update_xpos(element.x_pos)
 

sort()

None python.iconfTool.models.structure.ComponentsStructure.sort

(

self

)

Definition at line 196 of file structure.py.

    def sort(self) -> None:
        self.structure_list.sort(key=lambda el: el.get_name().lower())
        for element in self.structure_list:
            element.sort_children()
 
 

Member Data Documentation

filter

python.iconfTool.models.structure.ComponentsStructure.filter

Definition at line 140 of file structure.py.

structure_dict

python.iconfTool.models.structure.ComponentsStructure.structure_dict

Definition at line 123 of file structure.py.

structure_list

python.iconfTool.models.structure.ComponentsStructure.structure_list

Definition at line 135 of file structure.py.

---

The documentation for this class was generated from the following file:

• structure.py