pytorch/torch/csrc/jit/source_range.cpp
James Reed 45bfa6a5c6 Fix missing newline in compiled from source range highlihgt (#25802)
Summary:
Pull Request resolved: https://github.com/pytorch/pytorch/pull/25802

Test script

```
import torch

def foo(x, y):
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    return x

scripted = torch.jit.script(foo)
scripted.save('foo.zip')

loaded = torch.jit.load('foo.zip')
loaded(torch.rand(3, 4), torch.rand(4, 5))
```

Before this change
```
RuntimeError: The size of tensor a (4) must match the size of tensor b (5) at non-singleton dimension 1
The above operation failed in interpreter, with the following stack trace:
at code/__torch__.py:7:9
op_version_set = 1
class PlaceholderModule(Module):
  __parameters__ = []
  def forward(self: __torch__.PlaceholderModule,
    x: Tensor,
    y: Tensor) -> Tensor:
    x0 = torch.add(x, y, alpha=1)
         ~~~~~~~~~ <--- HERE
    x1 = torch.add(x0, y, alpha=1)
    x2 = torch.add(x1, y, alpha=1)
    x3 = torch.add(x2, y, alpha=1)
    x4 = torch.add(x3, y, alpha=1)
    x5 = torch.add(x4, y, alpha=1)
    x6 = torch.add(x5, y, alpha=1)
    x7 = torch.add(x6, y, alpha=1)
    x8 = torch.add(x7, y, alpha=1)
    x9 = torch.add(x8, y, alpha=1)Compiled from code at /home/jamesreed/print_test.py:5:8
def foo(x, y):
    x = x + y
        ~~~~~ <--- HERE
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
```

After this change
```
RuntimeError: The size of tensor a (4) must match the size of tensor b (5) at non-singleton dimension 1
The above operation failed in interpreter, with the following stack trace:
at code/__torch__.py:7:9
op_version_set = 1
class PlaceholderModule(Module):
  __parameters__ = []
  def forward(self: __torch__.PlaceholderModule,
    x: Tensor,
    y: Tensor) -> Tensor:
    x0 = torch.add(x, y, alpha=1)
         ~~~~~~~~~ <--- HERE
    x1 = torch.add(x0, y, alpha=1)
    x2 = torch.add(x1, y, alpha=1)
    x3 = torch.add(x2, y, alpha=1)
    x4 = torch.add(x3, y, alpha=1)
    x5 = torch.add(x4, y, alpha=1)
    x6 = torch.add(x5, y, alpha=1)
    x7 = torch.add(x6, y, alpha=1)
    x8 = torch.add(x7, y, alpha=1)
    x9 = torch.add(x8, y, alpha=1)
Compiled from code at /home/jamesreed/print_test.py:5:8
def foo(x, y):
    x = x + y
        ~~~~~ <--- HERE
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
    x = x + y
```

Test Plan: Imported from OSS

Differential Revision: D17250599

Pulled By: jamesr66a

fbshipit-source-id: 56266dcbf2c2287dc8ced7b9463ed42ef5f1167c
2019-09-07 14:38:53 -07:00

81 lines
2.7 KiB
C++

#include <torch/csrc/jit/source_range.h>
#include <torch/csrc/jit/source_range_serialization.h>
namespace torch {
namespace jit {
c10::optional<SourceRange> Source::findSourceRangeThatGenerated(
const SourceRange& range) {
if (!gen_ranges_) {
return c10::nullopt;
}
return gen_ranges_->findSourceRangeThatGenerated(range);
}
// a range of a shared string 'file_' with
C10_EXPORT void SourceRange::highlight(std::ostream& out) const {
// This is an empty SourceRange, used as a sentinel value.
if (!source_) {
return;
}
const std::string& str = source_->text();
if (size() == str.size()) {
// this is just the entire file, not a subset, so print it out.
// primarily used to print out python stack traces
out << str;
return;
}
size_t begin_line = start(); // beginning of line to highlight
size_t end_line = start(); // end of line to highlight
while (begin_line > 0 && str[begin_line - 1] != '\n')
--begin_line;
while (end_line < str.size() && str[end_line] != '\n')
++end_line;
AT_ASSERT(begin_line == 0 || str[begin_line - 1] == '\n');
AT_ASSERT(end_line == str.size() || str[end_line] == '\n');
size_t begin_highlight = begin_line; // beginning of context, CONTEXT lines
// before the highlight line
for (size_t i = 0; begin_highlight > 0; --begin_highlight) {
if (str[begin_highlight - 1] == '\n')
++i;
if (i >= CONTEXT)
break;
}
AT_ASSERT(begin_highlight == 0 || str[begin_highlight - 1] == '\n');
size_t end_highlight =
end_line; // end of context, CONTEXT lines after the highlight line
for (size_t i = 0; end_highlight < str.size(); ++end_highlight) {
if (str[end_highlight] == '\n')
++i;
if (i >= CONTEXT)
break;
}
AT_ASSERT(end_highlight == str.size() || str[end_highlight] == '\n');
if (auto flc = file_line_col()) {
std::string filename;
size_t line, col;
std::tie(filename, line, col) = *flc;
out << "at " << filename << ":" << line << ":" << col << "\n";
}
out << str.substr(begin_highlight, end_line - begin_highlight) << "\n";
out << std::string(start() - begin_line, ' ');
size_t len = std::min(size(), end_line - start());
out << std::string(len, '~')
<< (len < size() ? "... <--- HERE" : " <--- HERE");
auto line_substr = str.substr(end_line, end_highlight - end_line);
out << line_substr;
if (!line_substr.empty() && line_substr.back() != '\n')
out << "\n";
// Retrieve original SourceRange, if present.
if (auto orig_source_range = findSourceRangeThatGenerated()) {
out << "Compiled from code ";
orig_source_range->highlight(out);
}
}
} // namespace jit
} // namespace torch