vscode.py 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. import os
  2. import re
  3. from prospector.formatters.base import Formatter
  4. class VSCodeFormatter(Formatter):
  5. """
  6. This formatter outputs messages in the same way as vscode prospector linter expects.
  7. """
  8. def render(self, summary=True, messages=True, profile=False):
  9. # this formatter will always ignore the summary and profile
  10. cur_loc = None
  11. output = []
  12. for message in sorted(self.messages):
  13. if cur_loc != message.location.path:
  14. cur_loc = message.location.path
  15. module_name = self._make_path(message.location.path).replace(os.path.sep, ".")
  16. module_name = re.sub(r"(\.__init__)?\.py$", "", module_name)
  17. header = "************* Module %s" % module_name
  18. output.append(header)
  19. template = "%(line)s,%(character)s,%(code)s,%(code)s:%(source)s %(message)s"
  20. output.append(
  21. template
  22. % {
  23. "line": message.location.line,
  24. "character": message.location.character,
  25. "source": message.source,
  26. "code": message.code,
  27. "message": message.message.strip(),
  28. }
  29. )
  30. return "\n".join(output)