feat: pre commit

.gitignore

@@ -131,4 +131,6 @@ dmypy.json
 # VScode
 .vscode/
 
-.local/
+.local/
+
+poetry.lock

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+default_install_hook_types: [pre-push]
+default_stages: [pre-push]
+repos:
+  - repo: local
+    hooks:
+      - id: pytest-check
+        name: pytest-check
+        entry: make
+        language: system
+        pass_filenames: false
+        always_run: true
+        args: ["pre-commit"]
+        stages: [pre-push]

README.md

@@ -72,6 +72,14 @@ from hyperon_das_atomdb.adapters import InMemoryDB
 in_memory_db = InMemoryDB()
 ```
 
+## Pre-Commit Setup
+
+Before pushing your changes, it's recommended to set up pre-commit to run automated tests locally. Run the following command (needs to be done once):
+
+```bash
+pre-commit install
+```
+
 ## Tests
 
 You can ran the command below to execute the unittests

hyperon_das_atomdb/adapters/redis_mongo_db.py

@@ -353,16 +353,16 @@ def get_all_nodes(self, node_type: str, names: bool = False) -> List[str]:
         if names:
             return [
                 document[MongoFieldNames.NODE_NAME]
-                for document in self.mongo_nodes_collection.find({
-                    MongoFieldNames.TYPE_NAME: node_type
-                })
+                for document in self.mongo_nodes_collection.find(
+                    {MongoFieldNames.TYPE_NAME: node_type}
+                )
             ]
         else:
             return [
                 document[MongoFieldNames.ID_HASH]
-                for document in self.mongo_nodes_collection.find({
-                    MongoFieldNames.TYPE_NAME: node_type
-                })
+                for document in self.mongo_nodes_collection.find(
+                    {MongoFieldNames.TYPE_NAME: node_type}
+                )
             ]
 
     def get_link_handle(self, link_type: str, target_handles: List[str]) -> str:

pyproject.toml

@@ -22,6 +22,7 @@ black = "^23.7.0"
 pytest = "^7.4.2"
 pytest-cov = "^4.1.0"
 flake8-pyproject = "^1.2.3"
+pre-commit = "^3.5.0"
 
 
 [tool.isort]

tests/unit/adapters/test_ram_only.py

@@ -278,7 +278,7 @@ def test_get_link_targets(self, database: InMemoryDB):
 
     def test_get_link_targets_invalid(self, database: InMemoryDB):
         with pytest.raises(LinkDoesNotExist) as exc_info:
-            database.get_link_targets(f'link_handle_Fake')
+            database.get_link_targets('link_handle_Fake')
         assert exc_info.type is LinkDoesNotExist
         assert exc_info.value.args[0] == "This link does not exist"
 
@@ -291,7 +291,8 @@ def test_is_ordered_true(self, database: InMemoryDB):
 
     def test_is_ordered_false(self, database: InMemoryDB):
         with pytest.raises(LinkDoesNotExist) as exc_info:
-            ret = database.is_ordered('handle_123')
+            database.is_ordered('handle_123')
+
         assert exc_info.type is LinkDoesNotExist
         assert exc_info.value.args[0] == "This link does not exist"
 

tests/unit/adapters/test_redis_mongo_db.py

@@ -1,6 +1,4 @@
-import os
 import pickle
-import re
 from typing import Any, Dict, List, Optional
 from unittest import mock
 
@@ -1849,7 +1847,7 @@
             ),
         )
     ],
-    "patterns:6e644e70a9fe3145c88b5b6261af5754": [
+    "patterns:6e644e70a9fe3145c88b5b6261af5755": [
         (
             "e4685d56969398253b6f77efd21dc347",
             (
@@ -3377,7 +3375,7 @@ def test_get_node_name_value_error(self, database):
             with pytest.raises(ValueError) as exc_info:
                 database.get_node_name('handle')
             assert exc_info.type is ValueError
-            assert exc_info.value.args[0] == f"Invalid handle: handle"
+            assert exc_info.value.args[0] == "Invalid handle: handle"
 
     def test_get_matched_node_name(self, database):
         expected = sorted(
@@ -3459,7 +3457,6 @@ def test_add_link(self, database):
         assert (14, 28) == database.count_atoms()
 
         all_nodes_before = database.get_all_nodes('Concept')
-        all_links_before = database.get_matched_type('Similarity')
         database.add_link(
             {
                 'type': 'Similarity',
@@ -3471,7 +3468,6 @@ def test_add_link(self, database):
         )
         database.commit()
         all_nodes_after = database.get_all_nodes('Concept')
-        all_links_after = database.get_matched_type('Similarity')
 
         assert len(all_nodes_before) == 14
         assert len(all_nodes_after) == 16