pass margin instead of margin_char

python · iritkatriel · Nov 5, 2021 · Oct 5, 2021 · Oct 8, 2021 · Oct 24, 2021
commit 7613b43c3d6621c4d3491d172d8e52d7ada8589a
diff --git a/Include/cpython/traceback.h b/Include/cpython/traceback.h
@@ -10,5 +10,5 @@ typedef struct _traceback {
     int tb_lineno;
 } PyTracebackObject;
 
-PyAPI_FUNC(int) _Py_DisplaySourceLine(PyObject *, PyObject *, int, int, int, char, int *, PyObject **);
+PyAPI_FUNC(int) _Py_DisplaySourceLine(PyObject *, PyObject *, int, int, int *, PyObject **);
 PyAPI_FUNC(void) _PyTraceback_Add(const char *, const char *, int);
diff --git a/Include/traceback.h b/Include/traceback.h
@@ -9,8 +9,8 @@ extern "C" {
 PyAPI_FUNC(int) PyTraceBack_Here(PyFrameObject *);
 PyAPI_FUNC(int) PyTraceBack_Print(PyObject *, PyObject *);
 
-int PyTraceBack_Print_Indented(PyObject *, int, char, PyObject *);
-int _Py_WriteIndentedMargin(int, char, PyObject *);
+int PyTraceBack_Print_Indented(PyObject *, int, const char*, PyObject *);
+int _Py_WriteIndentedMargin(int, const char*, PyObject *);
 int _Py_WriteIndent(int, PyObject *);
 
 /* Reveal traceback type so we can typecheck traceback objects */

diff --git a/Lib/traceback.py b/Lib/traceback.py
@@ -612,19 +612,17 @@ def __init__(self):
     def indent(self):
         return 2 * self.exception_group_depth
 
-    def margin_char(self):
-        return '|' if self.exception_group_depth else None
+    def margin(self):
+        return '| ' if self.exception_group_depth else ''
 
     def get_indent(self):
         return ' ' * self.indent()
 
-    def get_fancy_indent(self):
-        margin_char = self.margin_char()
-        margin = (margin_char + ' ') if margin_char is not None else ''
-        return self.get_indent() + margin
+    def get_indented_margin(self):
+        return self.get_indent() + self.margin()
 
     def emit(self, text_gen):
-        indent_str = self.get_fancy_indent()
+        indent_str = self.get_indented_margin()
         if isinstance(text_gen, str):
             yield textwrap.indent(text_gen, indent_str, lambda line: True)
         else:

diff --git a/Python/_warnings.c b/Python/_warnings.c
@@ -544,7 +544,7 @@ show_warning(PyObject *filename, int lineno, PyObject *text,
         PyFile_WriteString("\n", f_stderr);
     }
     else {
-        _Py_DisplaySourceLine(f_stderr, filename, lineno, 2, 0, '\0', NULL, NULL);
+        _Py_DisplaySourceLine(f_stderr, filename, lineno, 2, NULL, NULL);
     }
 
 error:

@@ -895,10 +895,10 @@ struct exception_print_context
     int need_close;            // Need a closing bottom frame
 };
 
-#define EXC_MARGIN_CHAR(ctx) ((ctx)->exception_group_depth ? '|' : '\0')
+#define EXC_MARGIN(ctx) ((ctx)->exception_group_depth ? "| " : "")
 #define EXC_INDENT(ctx) (2 * (ctx)->exception_group_depth)
 
-#define WRITE_INDENTED_MARGIN(ctx, f) _Py_WriteIndentedMargin(EXC_INDENT(ctx), EXC_MARGIN_CHAR(ctx), (f))
+#define WRITE_INDENTED_MARGIN(ctx, f) _Py_WriteIndentedMargin(EXC_INDENT(ctx), EXC_MARGIN(ctx), (f))
 
 static void
 print_exception(struct exception_print_context *ctx, PyObject *value)
@@ -924,7 +924,7 @@ print_exception(struct exception_print_context *ctx, PyObject *value)
     type = (PyObject *) Py_TYPE(value);
     tb = PyException_GetTraceback(value);
     if (tb && tb != Py_None)
-        err = PyTraceBack_Print_Indented(tb, EXC_INDENT(ctx), EXC_MARGIN_CHAR(ctx), f);
+        err = PyTraceBack_Print_Indented(tb, EXC_INDENT(ctx), EXC_MARGIN(ctx), f);
     if (err == 0 &&
         (err = _PyObject_LookupAttrId(value, &PyId_print_file_and_line, &tmp)) > 0)
     {

diff --git a/Python/traceback.c b/Python/traceback.c
@@ -396,20 +396,21 @@ _Py_WriteIndent(int indent, PyObject *f) {
     return 0;
 }
 
-/* Writes indent spaces, followed by the margin if margin_char is not `\0`.
+/* Writes indent spaces, followed by the margin if it is not `\0`.
  */
 int
-_Py_WriteIndentedMargin(int indent, char margin_char, PyObject *f) {
+_Py_WriteIndentedMargin(int indent, const char *margin, PyObject *f) {
     int err = 0;
-    char margin[] = {margin_char, ' ', '\0' };
     err |= _Py_WriteIndent(indent, f);
-    err |= PyFile_WriteString(margin, f);
+    if (margin) {
+        err |= PyFile_WriteString(margin, f);
+    }
     return err;
 }
 
-int
-_Py_DisplaySourceLine(PyObject *f, PyObject *filename, int lineno, int indent,
-                      int margin_indent, char margin_char, int *truncation, PyObject **line)
+static int
+display_source_line_with_margin(PyObject *f, PyObject *filename, int lineno, int indent,
+                      int margin_indent, const char *margin, int *truncation, PyObject **line)
 {
     int err = 0;
     int fd;
@@ -537,7 +538,7 @@ _Py_DisplaySourceLine(PyObject *f, PyObject *filename, int lineno, int indent,
         *truncation = i - indent;
     }
 
-    err |= _Py_WriteIndentedMargin(margin_indent, margin_char, f);
+    err |= _Py_WriteIndentedMargin(margin_indent, margin, f);
     /* Write some spaces before the line */
     err |= _Py_WriteIndent(indent, f);
 
@@ -550,6 +551,16 @@ _Py_DisplaySourceLine(PyObject *f, PyObject *filename, int lineno, int indent,
     return err;
 }
 
+int
+_Py_DisplaySourceLine(PyObject *f, PyObject *filename, int lineno, int indent,
+                      int *truncation, PyObject **line)
+{
+    return display_source_line_with_margin(
+        f, filename, lineno, indent,
+        0, NULL, /* no margin */
+        truncation, line);
+}
+
 /* AST based Traceback Specialization
  *
  * When displaying a new traceback line, for certain syntactical constructs
@@ -718,7 +729,7 @@ print_error_location_carets(PyObject *f, int offset, Py_ssize_t start_offset, Py
 
 static int
 tb_displayline(PyTracebackObject* tb, PyObject *f, PyObject *filename, int lineno,
-               PyFrameObject *frame, PyObject *name, int margin_indent, char margin_char)
+               PyFrameObject *frame, PyObject *name, int margin_indent, const char *margin)
 {
     int err;
     PyObject *line;
@@ -729,17 +740,17 @@ tb_displayline(PyTracebackObject* tb, PyObject *f, PyObject *filename, int linen
                                 filename, lineno, name);
     if (line == NULL)
         return -1;
-    err = _Py_WriteIndentedMargin(margin_indent, margin_char, f);
+    err = _Py_WriteIndentedMargin(margin_indent, margin, f);
     err |= PyFile_WriteObject(line, f, Py_PRINT_RAW);
     Py_DECREF(line);
     if (err != 0)
         return err;
 /* Can't be bothered to check all those 
 #define PyTraceBack_LIMIT 1000 
         :param limit: None to include all frames or the number of frames to 
 /* Can't be bothered to check all those 
 #define PyTraceBack_LIMIT 1000 
         :param limit: None to include all frames or the number of frames to 
 
     int truncation = _TRACEBACK_SOURCE_LINE_INDENT;
     PyObject* source_line = NULL;
-    if (_Py_DisplaySourceLine(f, filename, lineno, _TRACEBACK_SOURCE_LINE_INDENT,
-                              margin_indent, margin_char,
-                              &truncation, &source_line) != 0 || !source_line) {
+    if (display_source_line_with_margin(
+            f, filename, lineno, _TRACEBACK_SOURCE_LINE_INDENT,
+            margin_indent, margin, &truncation, &source_line) != 0 || !source_line) {
         /* ignore errors since we can't report them, can we? */
         err = ignore_source_errors();
         goto done;
@@ -824,7 +835,7 @@ tb_displayline(PyTracebackObject* tb, PyObject *f, PyObject *filename, int linen
         end_offset = i + 1;
     }
 
-    err = _Py_WriteIndentedMargin(margin_indent, margin_char, f);
+    err = _Py_WriteIndentedMargin(margin_indent, margin, f);
     err |= print_error_location_carets(f, truncation, start_offset, end_offset,
                                       right_start_offset, left_end_offset,
                                       primary_error_char, secondary_error_char);
@@ -855,7 +866,7 @@ tb_print_line_repeated(PyObject *f, long cnt)
 
 static int
 tb_printinternal(PyTracebackObject *tb, PyObject *f, long limit,
-                 int indent, char margin_char)
+                 int indent, const char *margin)
 {
     int err = 0;
     Py_ssize_t depth = 0;
@@ -889,7 +900,7 @@ tb_printinternal(PyTracebackObject *tb, PyObject *f, long limit,
         cnt++;
         if (err == 0 && cnt <= TB_RECURSIVE_CUTOFF) {
             err = tb_displayline(tb, f, code->co_filename, tb->tb_lineno,
-                                 tb->tb_frame, code->co_name, indent, margin_char);
+                                 tb->tb_frame, code->co_name, indent, margin);
             if (err == 0) {
                 err = PyErr_CheckSignals();
             }
@@ -906,7 +917,7 @@ tb_printinternal(PyTracebackObject *tb, PyObject *f, long limit,
 #define PyTraceBack_LIMIT 1000
 
 int
-PyTraceBack_Print_Indented(PyObject *v, int indent, char margin_char, PyObject *f)
+PyTraceBack_Print_Indented(PyObject *v, int indent, const char *margin, PyObject *f)
 {
     int err;
     PyObject *limitv;
@@ -929,17 +940,17 @@ PyTraceBack_Print_Indented(PyObject *v, int indent, char margin_char, PyObject *
             return 0;
         }
     }
-    err = _Py_WriteIndentedMargin(indent, margin_char, f);
+    err = _Py_WriteIndentedMargin(indent, margin, f);
     err |= PyFile_WriteString("Traceback (most recent call last):\n", f);
     if (!err)
-        err = tb_printinternal((PyTracebackObject *)v, f, limit, indent, margin_char);
+        err = tb_printinternal((PyTracebackObject *)v, f, limit, indent, margin);
     return err;
 }
 
 int
 PyTraceBack_Print(PyObject *v, PyObject *f)
 {
-    return PyTraceBack_Print_Indented(v, 0, '\0', f);
+    return PyTraceBack_Print_Indented(v, 0, NULL, f);
 }
 
 /* Format an integer in range [0; 0xffffffff] to decimal and write it
-Original file line number
+Diff line change
@@ Expand Up @@
             PyFile_WriteString("\n", f_stderr);
         }
         else {
-            _Py_DisplaySourceLine(f_stderr, filename, lineno, 2, 0, '\0', NULL, NULL);
+            _Py_DisplaySourceLine(f_stderr, filename, lineno, 2, NULL, NULL);
         }
     error:
@@ Expand Down @@