Add some useful debug prints

Signed-off-by: Evan Flynn <[email protected]>

Author: evan-flynn-apexai

markdown/core.py

@@ -233,7 +233,7 @@ def convert(self, source):
         5. The output is written to a string.
 
         """
-
+        logger.debug("Converting markdown file to serialzed XHTML or HTML")
         # Fix up the source text
         if not source.strip():
             return ''  # a blank Unicode string
@@ -246,20 +246,23 @@ def convert(self, source):
             raise
 
         # Split into lines and run the line preprocessors.
+        logger.debug("Split document into lines")
         self.lines = source.split("\n")
         for prep in self.preprocessors:
+            logger.debug(f"Running preprocessor prep for {prep.__module__.__str__()}")
             self.lines = prep.run(self.lines)
 
-        # Parse the high-level elements.
+        logger.debug("Parse the high-level elements of the file")
         root = self.parser.parseDocument(self.lines).getroot()
 
-        # Run the tree-processors
+        logger.debug("Run the tree-processors")
         for treeprocessor in self.treeprocessors:
+            logger.debug(f"Running treeprocessor for {treeprocessor.__module__.__str__()}:{treeprocessor.__class__.__name__}")
             newRoot = treeprocessor.run(root)
             if newRoot is not None:
                 root = newRoot
 
-        # Serialize _properly_.  Strip top-level tags.
+        logger.debug("Serialize _properly_.  Strip top-level tags.")
         output = self.serializer(root)
         if self.stripTopLevelTags:
             try:
@@ -269,14 +272,14 @@ def convert(self, source):
                 output = output[start:end].strip()
             except ValueError as e:  # pragma: no cover
                 if output.strip().endswith('<%s />' % self.doc_tag):
-                    # We have an empty document
+                    logger.debug("Document is empty")
                     output = ''
                 else:
                     # We have a serious problem
                     raise ValueError('Markdown failed to strip top-level '
                                      'tags. Document=%r' % output.strip()) from e
 
-        # Run the text post-processors
+        logger.debug("Run the text post-processors")
         for pp in self.postprocessors:
             output = pp.run(output)
 

markdown/treeprocessors.py

@@ -18,12 +18,14 @@
 
 License: BSD (see LICENSE.md for details).
 """
-
+import logging
 import re
 import xml.etree.ElementTree as etree
 from . import util
 from . import inlinepatterns
 
+logger = logging.getLogger('MARKDOWN')
+
 
 def build_treeprocessors(md, **kwargs):
     """ Build the default  `treeprocessors` for Markdown. """
@@ -340,6 +342,7 @@ def run(self, tree, ancestors=None):
         Returns: `ElementTree` object with applied inline patterns.
 
         """
+        logger.debug("Running inline treeprocessor")
         self.stashed_nodes = {}
 
         # Ensure a valid parent list, but copy passed in lists
@@ -413,7 +416,7 @@ def _prettifyETree(self, elem):
 
     def run(self, root):
         """ Add line breaks to `ElementTree` root object. """
-
+        logger.debug("Running line break treeprocessor")
         self._prettifyETree(root)
         # Do `<br />`'s separately as they are often in the middle of
         # inline content and missed by `_prettifyETree`.
@@ -445,6 +448,7 @@ def unescape(self, text):
         return self.RE.sub(self._unescape, text)
 
     def run(self, root):
+        logger.debug("Running UnescapeTreeprocessor")
         """ Loop over all elements and unescape all text. """
         for elem in root.iter():
             # Unescape text content