Improve warning reports

executablebooks · Mar 12, 2020 · 5ac4d41 · 5ac4d41
1 parent fb259c1
commit 5ac4d41
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/mistletoe/base_elements.py b/mistletoe/base_elements.py
@@ -266,6 +266,15 @@ def from_source_lines(cls, lines: SourceLines, start_line=None) -> "Position":
             data=lines.metadata,
         )
 
+    def make_loc_str(self) -> str:
+        """Create a location string ``<uri>:<line_start>:<line_end>``"""
+        string = "{0}:{1}:{2}".format(
+            self.uri or "", self.line_start, self.line_end or ""
+        )
+        if self.data:
+            string += " {}".format(self.data)
+        return string
+
     def __repr__(self):
         args = ""
         if self.line_end is not None:

diff --git a/mistletoe/block_tokens.py b/mistletoe/block_tokens.py
@@ -104,8 +104,9 @@ def read(cls, lines: SourceLines):
         position = Position.from_source_lines(lines, start_line=start_line)
         if log_warning:
             get_parse_context().logger.warning(
-                "No closing `---` was found for initial metadata block: "
-                "{}".format(position)
+                "{} No closing `---` was found for initial metadata block".format(
+                    position.make_loc_str()
+                )
             )
 
         return cls(content="".join(line_buffer), position=position)
@@ -968,8 +969,8 @@ def append_link_definitions(matches, position):
                 link_definitions[key] = dest, title
             else:
                 get_parse_context().logger.warning(
-                    "ignoring duplicate link definition '{}' at: {}\n".format(
-                        key, position
+                    "{} ignoring duplicate link definition '{}'".format(
+                        position.make_loc_str(), key
                     )
                 )
 

diff --git a/mistletoe/block_tokens_ext.py b/mistletoe/block_tokens_ext.py
@@ -75,8 +75,8 @@ def read(cls, lines: SourceLines):
             get_parse_context().foot_definitions[target] = token
         else:
             get_parse_context().logger.warning(
-                "ignoring duplicate footnote definition '{}' at: {}".format(
-                    target, position
+                "{} ignoring duplicate footnote definition '{}'".format(
+                    position.make_loc_str(), target
                 )
             )
         return token