fix: stop library from overriding application logging config (#81)

* fix: stop library from overriding application logging config
Remove dictConfig() call from Graph.__init__ that was replacing the
host application's entire logging setup. Follow Python best practice
for library logging: add NullHandler to top-level 'cog' logger and
let the application control its own configuration.
- Remove logging_config dict from config.py
- Remove dictConfig call and import from torque.py
- Add NullHandler in cog/__init__.py
- Namespace all loggers under 'cog.' (e.g. cog.torque, cog.database)
- Clean up dictConfig references in test files

* using __name__ for logger where possible

Author: arun1729

cog/__init__.py

@@ -1,2 +1,5 @@
+import logging
+logging.getLogger("cog").addHandler(logging.NullHandler())
+
 def cog():
 	return "Cog is alive."

cog/cache.py

@@ -4,7 +4,7 @@
 class Cache:
 
     def __init__(self, cache_id, shared_cache=None):
-        self.logger = logging.getLogger('table')
+        self.logger = logging.getLogger(__name__)
         self.cache_id = cache_id
         if shared_cache is not None:
             if cache_id not in shared_cache:

cog/config.py

@@ -71,22 +71,3 @@ def index_id(index_name):
 def cog_store(db_name, table_name, instance_id):
     return "/".join(cog_context()[0:-2]+[db_name, table_name+STORE+instance_id])
 
-
-import logging
-
-logging_config = dict(
-    version = 1,
-    formatters = {
-        'f': {'format':
-              '%(asctime)s %(name)-12s %(levelname)-8s [%(filename)s:%(lineno)s - %(funcName)10s()] %(message)s'}
-        },
-    handlers = {
-        'h': {'class': 'logging.StreamHandler',
-              'formatter': 'f'
-              }
-        },
-    root = {
-        'handlers': ['h'],
-        'level': logging.WARN,
-        }
-)

cog/core.py

@@ -28,7 +28,7 @@ class Table:
 
     def __init__(self, name, namespace, db_instance_id, config, column_mode=False, shared_cache=None,
                  flush_interval=1):
-        self.logger = logging.getLogger('table')
+        self.logger = logging.getLogger('cog.table')
         self.config = config
         self.shared_cache = shared_cache
         self.flush_interval = flush_interval
@@ -179,7 +179,7 @@ def load_from_store(cls, position: int, store):
 class Index:
 
     def __init__(self, table_meta, config, logger, index_id=0):
-        self.logger = logging.getLogger('index')
+        self.logger = logging.getLogger('cog.index')
         self.table = table_meta
         self.config = config
         self.name = self.config.cog_index(table_meta.namespace, table_meta.name, table_meta.db_instance_id, index_id)
@@ -436,7 +436,7 @@ def __init__(self, tablemeta, config, logger, caching_enabled=True, shared_cache
                  flush_interval=1):
         self.caching_enabled = caching_enabled
         self.batch_mode = False  # When True, defers flush() until end_batch()
-        self.logger = logging.getLogger('store')
+        self.logger = logging.getLogger('cog.store')
         self.tablemeta = tablemeta
         self.config = config
         self.flush_interval = flush_interval
@@ -689,7 +689,7 @@ class Indexer:
     def __init__(self, tablemeta, config, logger):
         self.tablemeta = tablemeta
         self.config = config
-        self.logger = logging.getLogger('indexer')
+        self.logger = logging.getLogger('cog.indexer')
         self.index_list = []  # future range index.
         self.index_id = 0
         self.load_indexes()

cog/database.py

@@ -75,7 +75,7 @@ class Cog:
     """
 
     def __init__(self, shared_cache=None, flush_interval=1):
-        self.logger = logging.getLogger('database')
+        self.logger = logging.getLogger(__name__)
         self.config = config
         self.flush_interval = flush_interval
         self.logger.info(f"Cog init (flush_interval={flush_interval})")

cog/torque.py

@@ -3,7 +3,6 @@
 from cog.core import cog_hash, Record
 import json
 import logging
-from logging.config import dictConfig
 from . import config as cfg
 from cog.view import graph_template, script_part1, script_part2, graph_lib_src
 from cog.embedding_providers import EMBEDDING_PROVIDERS, _chunked
@@ -109,8 +108,7 @@ def __init__(self, graph_name, cog_home="cog_home", cog_path_prefix=None, enable
         else:
             self.cache = None
 
-        dictConfig(self.config.logging_config)
-        self.logger = logging.getLogger("torque")
+        self.logger = logging.getLogger(__name__)
 
         self.logger.debug(f"Torque init on graph: {graph_name} (flush_interval={flush_interval})")
 

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='cogdb',
-    version='3.7.2',
+    version='3.7.3',
     description='Persistent Embedded Graph Database',
     url='http://github.com/arun1729/cog',
     author='Arun Mahendra',

test/bench.py

@@ -4,7 +4,6 @@
 import logging
 import os
 import shutil
-from logging.config import dictConfig
 import string
 import random
 import timeit
@@ -38,7 +37,6 @@ def setUpClass(cls):
 
     def test_indexer(self):
 
-        dictConfig(config.logging_config)
 
         logger = logging.getLogger()
         config.INDEX_CAPACITY = 10003

test/test_batch_mode.py

@@ -7,7 +7,6 @@
 import timeit
 import unittest
 import logging
-from logging.config import dictConfig
 
 from cog import config
 from cog.core import Table, Record
@@ -35,7 +34,6 @@ def setUpClass(cls):
             shutil.rmtree(base_path)
         os.makedirs(base_path)
         config.CUSTOM_COG_DB_PATH = "/tmp/" + DIR_NAME
-        dictConfig(config.logging_config)
 
     def test_batch_mode_saves_correctly(self):
         """Test that batch mode saves records correctly"""
@@ -156,7 +154,6 @@ class TestCogBatchMode(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         config.CUSTOM_COG_DB_PATH = "/tmp/" + DIR_NAME
-        dictConfig(config.logging_config)
 
     def test_cog_batch_mode(self):
         """Test batch mode at Cog level"""
@@ -186,7 +183,6 @@ class TestGraphPutBatch(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         config.CUSTOM_COG_DB_PATH = "/tmp/" + DIR_NAME
-        dictConfig(config.logging_config)
 
     def test_put_batch_correctness(self):
         """Test that put_batch inserts all triples correctly"""
@@ -302,7 +298,6 @@ class TestBatchModeIntegration(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         config.CUSTOM_COG_DB_PATH = "/tmp/" + DIR_NAME
-        dictConfig(config.logging_config)
 
     def test_large_graph_insertion(self):
         """Test inserting a large graph using batch mode"""

test/test_core.py

@@ -2,7 +2,6 @@
 from cog import config
 import logging
 import os
-from logging.config import dictConfig
 import shutil
 
 import unittest
@@ -58,7 +57,6 @@ def test_record_list(self):
         self.assertEqual(record.value_link, unmarshalled_record.value_link)
 
     def test_put_get_string(self):
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         expected_data = Record("rocket", "gemini-titan")
@@ -82,7 +80,6 @@ def test_put_get_string(self):
         store.close()
 
     def test_put_get_multiple_string(self):
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         expected_data_list= [Record("rocket", "gemini-titan"), Record("rocket2", "saturn V"), Record("rocket0", "V2")]
@@ -102,7 +99,6 @@ def test_put_get_multiple_string(self):
         store.close()
 
     def test_put_get_record_update(self):
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         expected_data_list= [Record("rocket", "gemini-titan"), Record("rocket", "saturn V"), Record("rocket", "V2")]
@@ -126,7 +122,6 @@ def test_put_get_record_update(self):
 
     def test_collision(self):
         orig_conf = config.INDEX_CAPACITY
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         expected_data_list= [Record("rocket", "gemini-titan"), Record("rocket2", "saturn V"), Record("rocket0", "V2")]
@@ -151,7 +146,6 @@ def test_collision(self):
 
     def test_collision_large(self):
         orig_conf = config.INDEX_CAPACITY
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         table = Table("testdb", "test_table", "test_xcvzdfsadx", config, logger)
@@ -179,7 +173,6 @@ def test_collision_large(self):
         config.INDEX_CAPACITY = orig_conf
 
     def test_put_get_list(self):
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         fruits = (["apple", "orange", "banana", "pears", "cherry", "mango"])
@@ -211,7 +204,6 @@ def test_put_get_list(self):
         store.close()
 
     def test_delete_list(self):
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         fruits = (["apple", "orange", "banana", "pears", "cherry", "mango"])
@@ -246,7 +238,6 @@ def test_delete_list(self):
 
     def test_delete(self):
 
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         expected_data = Record("new super data","super new old stuff")
@@ -280,7 +271,6 @@ def test_delete(self):
 
     def test_indexer(self):
 
-        dictConfig(config.logging_config)
         logger = logging.getLogger()
 
         expected_data = Record("new super data","super new old stuff")