Add/fix mypy type annotations at BFS, DFS in graphs

Author: mhihasan

graphs/breadth_first_search.py

@@ -2,12 +2,12 @@
 
 """ Author: OMKAR PATHAK """
 
-from typing import Set
+from typing import Dict, List, Set
 
 
 class Graph:
     def __init__(self) -> None:
-        self.vertices = {}
+        self.vertices: Dict[int, List[int]] = {}
 
     def print_graph(self) -> None:
         """

graphs/depth_first_search.py

@@ -2,20 +2,21 @@
 
 from __future__ import annotations
 
+from typing import Set
 
-def depth_first_search(graph: dict, start: str) -> set[int]:
+
+def depth_first_search(graph: dict, start: str) -> Set[str]:
     """Depth First Search on Graph
     :param graph: directed graph in dictionary format
-    :param vertex: starting vertex as a string
+    :param start: starting vertex as a string
     :returns: the trace of the search
-    >>> G = { "A": ["B", "C", "D"], "B": ["A", "D", "E"],
+    >>> input_G = { "A": ["B", "C", "D"], "B": ["A", "D", "E"],
     ... "C": ["A", "F"], "D": ["B", "D"], "E": ["B", "F"],
     ... "F": ["C", "E", "G"], "G": ["F"] }
-    >>> start = "A"
     >>> output_G = list({'A', 'B', 'C', 'D', 'E', 'F', 'G'})
-    >>> all(x in output_G for x in list(depth_first_search(G, "A")))
+    >>> all(x in output_G for x in list(depth_first_search(input_G, "A")))
     True
-    >>> all(x in output_G for x in list(depth_first_search(G, "G")))
+    >>> all(x in output_G for x in list(depth_first_search(input_G, "G")))
     True
     """
     explored, stack = set(start), [start]

scripts/build_directory_md.py

@@ -5,10 +5,14 @@
 
 URL_BASE = "https://github.com/TheAlgorithms/Python/blob/master"
 
+IGNORED_DIRS = ["scripts", "venv"]
+
 
 def good_file_paths(top_dir: str = ".") -> Iterator[str]:
     for dir_path, dir_names, filenames in os.walk(top_dir):
-        dir_names[:] = [d for d in dir_names if d != "scripts" and d[0] not in "._"]
+        dir_names[:] = [
+            d for d in dir_names if d not in IGNORED_DIRS and d[0] not in "._"
+        ]
         for filename in filenames:
             if filename == "__init__.py":
                 continue