🌲logging

Author: davidhyman

src/snippet/__init__.py

@@ -8,9 +8,10 @@
 def main(config: Config):
     if config.log_level:
         logging.basicConfig(level=config.log_level)
-
+    logger = logging.getLogger(__name__)
+    logger.debug('project directory is %r', config.project_root)
     examples, paths, failures = run(config)
 
     if failures:
-        logging.error('failures:\n%s', textwrap.indent('\n'.join(f'{name}: {exc}' for name, exc in failures), prefix='  '))
+        logger.error('failures:\n%s', textwrap.indent('\n'.join(f'{name}: {exc}' for name, exc in failures), prefix='  '))
         raise Exception(f'There were %s failures!' % len(failures))

src/snippet/config.py

@@ -1,9 +1,11 @@
-import glob
 import logging
+import glob
 import os
 
 import toml
 
+from snippet.logs import logger
+
 
 class Config:
     # IO
@@ -20,7 +22,7 @@ class Config:
     # a mustache template for each file (triple braces important for code literals, no escaping)
     output_template = '```{{language_name}}\n{{comment_prefix}}example: {{{name}}}{{comment_suffix}}\n{{{code}}}\n```\n'
 
-    # Logging
+    # logger
     log_level = logging.INFO
 
     # Code block indicators
@@ -65,16 +67,16 @@ def get_config(config_paths=None, **options):
         config_paths.append(os.path.join(project_root, '**', '*.toml'))
 
     for toml_file in find_configs(glob_patterns=config_paths):
-        logging.debug('trying config from %s', toml_file)
+        logger.debug('trying config from %s', toml_file)
         with open(toml_file) as f:
             try:
                 config_file_contents = toml.load(f)
             except toml.TomlDecodeError as e:
-                logging.debug('failed to load %s: %s', toml_file, e)
+                logger.debug('failed to load %s: %s', toml_file, e)
                 continue
             snippet_config = config_file_contents.get('snippet')
             if snippet_config:
-                logging.info('loading config from %s', toml_file)
+                logger.info('loading config from %s', toml_file)
                 new_options.update(snippet_config)
 
     # passed keyword args override other parameters

src/snippet/file_wrangler.py

@@ -1,10 +1,10 @@
-import logging
 import os
 import glob
 
 import pystache
 
 from snippet.config import Config
+from snippet.logs import logger
 
 
 def write_example(config: Config, example_name, example_block):
@@ -24,10 +24,10 @@ def write_example(config: Config, example_name, example_block):
     )
 
     if not os.path.exists(config.output_dir):
-        logging.info('creating output directory %s', config.output_dir)
+        logger.info('creating output directory %s', config.output_dir)
         os.makedirs(config.output_dir)
     output_file = os.path.join(config.output_dir, output_file_name)
-    logging.info('writing %r to %s', example_name, output_file)
+    logger.info('writing %r to %s', example_name, output_file)
     with open(output_file, 'a' if config.output_append else 'w') as fh:
         fh.write(output)
 

src/snippet/logs.py

@@ -0,0 +1,3 @@
+import logging
+
+logger = logging.getLogger(__name__)

src/snippet/workflow.py

@@ -1,4 +1,3 @@
-import logging
 import textwrap
 from functools import partial
 
@@ -7,13 +6,14 @@
 from snippet.snippet import extract_snippets
 from snippet.wrapper import wrap
 from snippet import exceptions
+from snippet.logs import logger
 
 
 def run(config: Config):
     examples = {}
     failures = []
     paths = file_wrangler.find_files(config)
-    logging.debug('files to parse:\n%s', textwrap.indent('\n'.join(paths), prefix='  '))
+    logger.debug('files to parse:\n%s', textwrap.indent('\n'.join(paths), prefix='  '))
 
     for path in paths:
         # load the file
@@ -39,8 +39,8 @@ def run(config: Config):
 
     for (path, line_num, example_name), code_lines in examples.items():
         example_block = '\n'.join(code_lines)
-        logging.info('example: %r', example_name)
-        logging.debug('example code: %s', example_block)
+        logger.info('example: %r', example_name)
+        logger.debug('example code: %s', example_block)
 
         wrap(config, failures, path, partial(
             file_wrangler.write_example, config, example_name, example_block