dbgraph 0.2.1__tar.gz → 0.2.2__tar.gz

{dbgraph-0.2.1 → dbgraph-0.2.2}/.idea/workspace.xml

@@ -4,15 +4,8 @@
     <option name="autoReloadType" value="SELECTIVE" />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="263a96da-9a82-40fd-89b2-ba71dd2c194d" name="Changes" comment="fix bugs in builder">
-      <change beforePath="$PROJECT_DIR$/dbgraph/__init__.py" beforeDir="false" afterPath="$PROJECT_DIR$/dbgraph/__init__.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/dbgraph/builder/sql_graph_builder.py" beforeDir="false" afterPath="$PROJECT_DIR$/dbgraph/builder/sql_graph_builder.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/dbgraph/entity/aspect.py" beforeDir="false" afterPath="$PROJECT_DIR$/dbgraph/entity/aspect.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/dbgraph/persistent/json_utils.py" beforeDir="false" afterPath="$PROJECT_DIR$/dbgraph/persistent/json_utils.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/dbgraph/persistent/sql_graph_persistent.py" beforeDir="false" afterPath="$PROJECT_DIR$/dbgraph/persistent/sql_graph_persistent.py" afterDir="false" />
+    <list default="true" id="263a96da-9a82-40fd-89b2-ba71dd2c194d" name="Changes" comment="update renderer">
       <change beforePath="$PROJECT_DIR$/pyproject.toml" beforeDir="false" afterPath="$PROJECT_DIR$/pyproject.toml" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/test_load_graph_sql.py" beforeDir="false" afterPath="$PROJECT_DIR$/tests/test_load_graph_sql.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/tests/test_sql_graph_persistent.py" beforeDir="false" afterPath="$PROJECT_DIR$/tests/test_sql_graph_persistent.py" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -69,28 +62,30 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent"><![CDATA[{
-  "keyToString": {
-    "ASKED_SHARE_PROJECT_CONFIGURATION_FILES": "true",
-    "ModuleVcsDetector.initialDetectionPerformed": "true",
-    "Python tests.Python tests for tests.test_dbgraph.TestDBGraph.executor": "Run",
-    "Python tests.Python tests for tests.test_load_graph_sql.TestLoadGraphSQL.test_load.executor": "Run",
-    "Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph.executor": "Run",
-    "Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent.executor": "Run",
-    "Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent.test_load_graph.executor": "Run",
-    "Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent.test_save_graph.executor": "Run",
-    "Python tests.Python tests in test_load_graph_sql.py.executor": "Run",
-    "Python tests.Python tests in tests.executor": "Run",
-    "RunOnceActivity.ShowReadmeOnStart": "true",
-    "RunOnceActivity.git.unshallow": "true",
-    "RunOnceActivity.typescript.service.memoryLimit.init": "true",
-    "codeWithMe.voiceChat.enabledByDefault": "false",
-    "git-widget-placeholder": "main",
-    "ignore.virus.scanning.warn.message": "true",
-    "nodejs_package_manager_path": "npm",
-    "settings.editor.selected.configurable": "editor.preferences.folding"
+  <component name="PropertiesComponent">{
+  &quot;keyToString&quot;: {
+    &quot;ASKED_SHARE_PROJECT_CONFIGURATION_FILES&quot;: &quot;true&quot;,
+    &quot;ModuleVcsDetector.initialDetectionPerformed&quot;: &quot;true&quot;,
+    &quot;Python tests.Python tests for tests.test_dbgraph.TestDBGraph.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_load_graph_sql.TestLoadGraphSQL.test_load.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test__build_links.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent.test_load_graph.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent.test_save_graph.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests in test_load_graph_sql.py.executor&quot;: &quot;Run&quot;,
+    &quot;Python tests.Python tests in tests.executor&quot;: &quot;Run&quot;,
+    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.git.unshallow&quot;: &quot;true&quot;,
+    &quot;RunOnceActivity.typescript.service.memoryLimit.init&quot;: &quot;true&quot;,
+    &quot;codeWithMe.voiceChat.enabledByDefault&quot;: &quot;false&quot;,
+    &quot;git-widget-placeholder&quot;: &quot;main&quot;,
+    &quot;ignore.virus.scanning.warn.message&quot;: &quot;true&quot;,
+    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;,
+    &quot;settings.editor.selected.configurable&quot;: &quot;editor.preferences.folding&quot;
   }
-}]]></component>
+}</component>
   <component name="RunManager" selected="Python tests.Python tests in tests">
     <configuration name="Python tests for tests.test_load_graph_sql.TestLoadGraphSQL.test_load" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="dbgraph" />
@@ -109,7 +104,7 @@
       <option name="_new_targetType" value="&quot;PYTHON&quot;" />
       <method v="2" />
     </configuration>
-    <configuration name="Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
+    <configuration name="Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="dbgraph" />
       <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
@@ -122,11 +117,11 @@
       <option name="DEBUG_JUST_MY_CODE" value="false" />
       <option name="RUN_TOOL" value="" />
       <option name="_new_additionalArguments" value="&quot;&quot;" />
-      <option name="_new_target" value="&quot;tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph&quot;" />
+      <option name="_new_target" value="&quot;tests.test_sql_graph_builder.TestSQLGraphBuilder&quot;" />
       <option name="_new_targetType" value="&quot;PYTHON&quot;" />
       <method v="2" />
     </configuration>
-    <configuration name="Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
+    <configuration name="Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test__build_links" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="dbgraph" />
       <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
@@ -139,11 +134,11 @@
       <option name="DEBUG_JUST_MY_CODE" value="false" />
       <option name="RUN_TOOL" value="" />
       <option name="_new_additionalArguments" value="&quot;&quot;" />
-      <option name="_new_target" value="&quot;tests.test_sql_graph_persistent.TestSQLGraphPersistent&quot;" />
+      <option name="_new_target" value="&quot;tests.test_sql_graph_builder.TestSQLGraphBuilder.test__build_links&quot;" />
       <option name="_new_targetType" value="&quot;PYTHON&quot;" />
       <method v="2" />
     </configuration>
-    <configuration name="Python tests in test_load_graph_sql.py" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
+    <configuration name="Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
       <module name="dbgraph" />
       <option name="ENV_FILES" value="" />
       <option name="INTERPRETER_OPTIONS" value="" />
@@ -156,8 +151,8 @@
       <option name="DEBUG_JUST_MY_CODE" value="false" />
       <option name="RUN_TOOL" value="" />
       <option name="_new_additionalArguments" value="&quot;&quot;" />
-      <option name="_new_target" value="&quot;$PROJECT_DIR$/tests/test_load_graph_sql.py&quot;" />
-      <option name="_new_targetType" value="&quot;PATH&quot;" />
+      <option name="_new_target" value="&quot;tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph&quot;" />
+      <option name="_new_targetType" value="&quot;PYTHON&quot;" />
       <method v="2" />
     </configuration>
     <configuration name="Python tests in tests" type="tests" factoryName="Autodetect" temporary="true" nameIsGenerated="true">
@@ -180,10 +175,10 @@
     <recent_temporary>
       <list>
         <item itemvalue="Python tests.Python tests in tests" />
-        <item itemvalue="Python tests.Python tests for tests.test_load_graph_sql.TestLoadGraphSQL.test_load" />
-        <item itemvalue="Python tests.Python tests in test_load_graph_sql.py" />
-        <item itemvalue="Python tests.Python tests for tests.test_sql_graph_persistent.TestSQLGraphPersistent" />
+        <item itemvalue="Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder" />
+        <item itemvalue="Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test__build_links" />
         <item itemvalue="Python tests.Python tests for tests.test_sql_graph_builder.TestSQLGraphBuilder.test_build_graph" />
+        <item itemvalue="Python tests.Python tests for tests.test_load_graph_sql.TestLoadGraphSQL.test_load" />
       </list>
     </recent_temporary>
   </component>
@@ -226,7 +221,31 @@
       <option name="project" value="LOCAL" />
       <updated>1788407330419</updated>
     </task>
-    <option name="localTasksCounter" value="4" />
+    <task id="LOCAL-00004" summary="format">
+      <option name="closed" value="true" />
+      <created>1788407896437</created>
+      <option name="number" value="00004" />
+      <option name="presentableId" value="LOCAL-00004" />
+      <option name="project" value="LOCAL" />
+      <updated>1788407896437</updated>
+    </task>
+    <task id="LOCAL-00005" summary="remove events">
+      <option name="closed" value="true" />
+      <created>1788576856001</created>
+      <option name="number" value="00005" />
+      <option name="presentableId" value="LOCAL-00005" />
+      <option name="project" value="LOCAL" />
+      <updated>1788576856001</updated>
+    </task>
+    <task id="LOCAL-00006" summary="update renderer">
+      <option name="closed" value="true" />
+      <created>1788922273132</created>
+      <option name="number" value="00006" />
+      <option name="presentableId" value="LOCAL-00006" />
+      <option name="project" value="LOCAL" />
+      <updated>1788922273132</updated>
+    </task>
+    <option name="localTasksCounter" value="7" />
     <servers />
   </component>
   <component name="TypeScriptGeneratedFilesManager">
@@ -246,7 +265,10 @@
   <component name="VcsManagerConfiguration">
     <MESSAGE value="update packaging" />
     <MESSAGE value="fix bugs in builder" />
-    <option name="LAST_COMMIT_MESSAGE" value="fix bugs in builder" />
+    <MESSAGE value="format" />
+    <MESSAGE value="remove events" />
+    <MESSAGE value="update renderer" />
+    <option name="LAST_COMMIT_MESSAGE" value="update renderer" />
   </component>
   <component name="XDebuggerManager">
     <breakpoint-manager>

{dbgraph-0.2.1 → dbgraph-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: dbgraph
-Version: 0.2.1
+Version: 0.2.2
 Summary: dbgraph is a database profiling tool which model the database as a graph
 Requires-Python: >=3.11
 Requires-Dist: bm25s>=0.3.9

{dbgraph-0.2.1 → dbgraph-0.2.2}/dbgraph/entity/dbgraph.py

@@ -7,6 +7,10 @@ import rustworkx as rx
 
 from dbgraph.entity.asset import Asset
 from dbgraph.entity.link import Link
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from dbgraph.entity.rdbgraph import RDatabaseGraph
 
 
 @dataclass
@@ -88,7 +92,7 @@ class DatabaseGraph:
 
     def select_shortest_paths(self, src_id: str, dst_id: str) -> list[DatabaseGraph]:
         """
-        Find shortest paths between two Assets.
+        Find the shortest paths between two Assets.
 
         Args:
             src_id: ID of the source asset
@@ -135,7 +139,7 @@ class DatabaseGraph:
         return [self._graph.get_node_data(i) for i in asset_indices]
 
     def find_shortest_paths(self, src_id: str, dst_id: str) -> list[list[Asset]]:
-        """Find shortest paths between two Assets
+        """Find the shortest paths between two Assets
 
         Args:
             src_id: ID of the source asset
@@ -150,3 +154,7 @@ class DatabaseGraph:
         paths = rx.all_shortest_paths(self._graph, src_idx, dst_idx)
 
         return [[self._graph.get_node_data(i) for i in path] for path in paths]
+
+    def to_relational(self) -> "RDatabaseGraph":
+        """Return the RDatabaseGraph"""
+        return RDatabaseGraph.from_graph(self)

{dbgraph-0.2.1 → dbgraph-0.2.2}/dbgraph/render/graph_renderer.py

@@ -7,5 +7,5 @@ class GraphRenderer(ABC):
     """Interface for rendering the graph"""
 
     @abstractmethod
-    def render(self, graph: DatabaseGraph):
-        """Render the graph, store data inside the class"""
+    def render(self, graph: DatabaseGraph) -> str:
+        """Render the graph to text-based format"""

{dbgraph-0.2.1 → dbgraph-0.2.2}/dbgraph/render/markdown_renderer.py

@@ -13,11 +13,11 @@ from dbgraph.entity.asset import Asset
 from dbgraph.entity.dbgraph import DatabaseGraph
 from dbgraph.entity.link import Link
 from dbgraph.entity.rdbgraph import RDatabaseGraph
-from dbgraph.render.text_renderer import TextRenderer
+from dbgraph.render.graph_renderer import GraphRenderer
 
 
 @dataclass
-class MarkdownRenderer(TextRenderer):
+class MarkdownRenderer(GraphRenderer):
     """Render the graph to Markdown format"""
 
     categorical_value_max_char: int = 50
@@ -89,7 +89,7 @@ class MarkdownRenderer(TextRenderer):
 
         return answer
 
-    def render(self, graph: DatabaseGraph):
+    def render(self, graph: DatabaseGraph) -> str:
         graph = RDatabaseGraph.from_graph(graph)
         tables = graph.get_tables()
         answer = ""
@@ -103,9 +103,4 @@ class MarkdownRenderer(TextRenderer):
             answer += "\n# List of Foreign Key Constraints"
             for fk in foreign_keys:
                 answer += f"\n{self._dump_fk(fk, graph)}"
-        self.content = answer
-
-    def get_content(self) -> str:
-        if not self.content:
-            raise RuntimeError("Content is empty. Please run `render()` first!")
-        return self.content
+        return answer

{dbgraph-0.2.1 → dbgraph-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "dbgraph"
-version = "0.2.1"
+version = "0.2.2"
 description = "dbgraph is a database profiling tool which model the database as a graph"
 readme = "README.md"
 requires-python = ">=3.11"

{dbgraph-0.2.1 → dbgraph-0.2.2}/tests/test_markdown_renderer.py

@@ -12,8 +12,8 @@ class TestMarkdownRenderer(unittest.TestCase):
         self.renderer = MarkdownRenderer()
 
     def test_render(self):
-        self.renderer.render(self.graph)
-        self.assertIsInstance(self.renderer.get_content(), str)
+        markdown = self.renderer.render(self.graph)
+        self.assertIsInstance(markdown, str)
 
 
 if __name__ == "__main__":

dbgraph-0.2.1/dbgraph/event/event.py

@@ -1,20 +0,0 @@
-from dataclasses import dataclass
-
-
-@dataclass
-class Event:
-    """Base event used in DBGraph"""
-
-    message: str
-
-
-@dataclass
-class ProgressEvent(Event):
-    """Event with progress"""
-
-    target: float
-    current: float
-
-    def get_percentage(self) -> float:
-        """Return the progress of the task in percentage"""
-        return self.current / self.target

dbgraph-0.2.1/dbgraph/event/event_bus.py

@@ -1,61 +0,0 @@
-import queue
-import threading
-
-from dbgraph.event.event import Event
-from dbgraph.event.event_handler import EventHandler
-
-
-class EventBus:
-    """Store events in a queue and manage a background thread to distribute events"""
-
-    def __init__(self) -> None:
-        self.queue = queue.Queue()
-        self.handlers: dict[type[Event], set[EventHandler]] = {}
-        self._thread: threading.Thread | None = None
-        self._stop_event = threading.Event()
-
-    def subscribe(self, event_type: type[Event], handler: EventHandler):
-        """Subscribe a handler to specific type of event"""
-        if event_type in self.handlers:
-            self.handlers[event_type].add(handler)
-        else:
-            self.handlers[event_type] = {handler}
-
-    def unsubscribe(self, event_type: type[Event], handler: EventHandler):
-        """Unsubscribe a handler from listening to specific event type"""
-        self.handlers[event_type].remove(handler)
-
-    def publish(self, event: Event):
-        """Push an event into the event queue"""
-        self.queue.put(event)
-
-    def _dispatch(self):
-        """Get the latest event and let the appropriate handler process it"""
-        event = self.queue.get()
-        for handler in self.handlers[type(event)]:
-            handler.handle(event)
-
-    def _run(self):
-        """Run the event loop"""
-        while not self._stop_event.is_set():
-            try:
-                self._dispatch()
-            except queue.Empty:
-                continue
-
-    def start(self):
-        """Start the event background thread"""
-        if self._thread is not None and self._thread.is_alive():
-            return
-        self._stop_event.clear()
-        self._thread = threading.Thread(
-            target=self._run, name="dbgraph-event-bus", daemon=True
-        )
-        self._thread.start()
-
-    def stop(self):
-        """Stop the event background thread"""
-        self._stop_event.set()
-        if self._thread is not None:
-            self._thread.join()
-            self._thread = None

dbgraph-0.2.1/dbgraph/event/event_handler.py

@@ -1,11 +0,0 @@
-from abc import ABC, abstractmethod
-
-from dbgraph.event.event import Event
-
-
-class EventHandler(ABC):
-    """Interface for event handler"""
-
-    @abstractmethod
-    def handle(self, event: Event):
-        """Handle the event"""

dbgraph-0.2.1/dbgraph/render/text_renderer.py

@@ -1,11 +0,0 @@
-from abc import ABC, abstractmethod
-
-from dbgraph.render.graph_renderer import GraphRenderer
-
-
-class TextRenderer(GraphRenderer, ABC):
-    """Render the graph to text-based representation"""
-
-    @abstractmethod
-    def get_content(self) -> str:
-        """Get the text data"""