add template debugging #349

Author: DonJayamanne

package.json

@@ -182,7 +182,7 @@
  "label": "Python",
  "enableBreakpointsFor": {
  "languageIds": [
- "python"
+ "python", "html"
  ]
  },
  "aiKey": "AIF-d9b70cd4-b9f9-4d70-929b-a071c400b217",

pythonFiles/PythonTools/visualstudio_py_debugger.py

@@ -13,6 +13,7 @@
 # 
 # See the Apache Version 2.0 License for specific language governing
 # permissions and limitations under the License.
+# With number of modifications by Don Jayamanne
 
 from __future__ import with_statement
 
@@ -174,6 +175,26 @@ def __len__(self):
 BREAKPOINT_PASS_COUNT_WHEN_EQUAL = 2
 BREAKPOINT_PASS_COUNT_WHEN_EQUAL_OR_GREATER = 3
 
+## Begin modification by Don Jayamanne
+DJANGO_VERSIONS_IDENTIFIED = False
+IS_DJANGO18 = False
+IS_DJANGO19 = False
+IS_DJANGO19_OR_HIGHER = False
+
+try:
+ dict_contains = dict.has_key
+except:
+ try:
+ #Py3k does not have has_key anymore, and older versions don't have __contains__
+ dict_contains = dict.__contains__
+ except:
+ try:
+ dict_contains = dict.has_key
+ except NameError:
+ def dict_contains(d, key):
+ return d.has_key(key)
+## End modification by Don Jayamanne
+
 class BreakpointInfo(object):
  __slots__ = [
  'breakpoint_id', 'filename', 'lineno', 'condition_kind', 'condition',
@@ -619,19 +640,57 @@ def update_all_thread_stacks(blocking_thread = None, check_is_blocked = True):
  cur_thread._block_starting_lock.release()
 
 DJANGO_BREAKPOINTS = {}
+DJANGO_TEMPLATES = {}
 
 class DjangoBreakpointInfo(object):
  def __init__(self, filename):
  self._line_locations = None
  self.filename = filename
  self.breakpoints = {}
+ self.rangeIsPlainText = {}
 
  def add_breakpoint(self, lineno, brkpt_id):
  self.breakpoints[lineno] = brkpt_id
 
  def remove_breakpoint(self, lineno):
- del self.breakpoints[lineno]
- 
+ try:
+ del self.breakpoints[lineno]
+ except:
+ pass
+
+ def has_breakpoint_for_line(self, lineNumber):
+ return self.breakpoints.get(lineNumber) is not None
+
+ def is_range_plain_text(self, start, end):
+ key = str(start) + '-' + str(end)
+ if self.rangeIsPlainText.get(key) is None:
+ # we need to calculate our line number offset information
+ try:
+ with open(self.filename, 'rb') as contents:
+ contents.seek(start, 0) # 0 = start of file, optional in this case
+ data = contents.read(end - start)
+ isPlainText = True 
+ if data.startswith('{{') and data.endswith('}}'):
+ isPlainText = False
+ if data.startswith('{%') and data.endswith('%}'):
+ isPlainText = False
+ self.rangeIsPlainText[key] = isPlainText
+ return isPlainText 
+ except:
+ return False
+ else:
+ return self.rangeIsPlainText.get(key)
+
+ def line_number_to_offset(self, lineNumber):
+ line_locs = self.line_locations 
+ if line_locs is not None:
+ low_line = line_locs[lineNumber - 1]
+ hi_line = line_locs[lineNumber]
+
+ return low_line, hi_line
+
+ return (None, None)
+
  @property
  def line_locations(self):
  if self._line_locations is None:
@@ -680,28 +739,42 @@ def should_break(self, start, end):
  return False, 0
 
 def get_django_frame_source(frame):
+ global DJANGO_VERSIONS_IDENTIFIED
+ global IS_DJANGO18
+ global IS_DJANGO19
+ global IS_DJANGO19_OR_HIGHER
+ if DJANGO_VERSIONS_IDENTIFIED == False:
+ DJANGO_VERSIONS_IDENTIFIED = True
+ try:
+ import django
+ version = django.VERSION
+ IS_DJANGO18 = version[0] == 1 and version[1] == 8
+ IS_DJANGO19 = version[0] == 1 and version[1] == 9
+ IS_DJANGO19_OR_HIGHER = ((version[0] == 1 and version[1] >= 9) or version[0] > 1)
+ except:
+ pass 
  if frame.f_code.co_name == 'render':
+ origin = _get_template_file_name(frame)
+ line = _get_template_line(frame)
+ position = None
  self_obj = frame.f_locals.get('self', None)
  if self_obj is None:
  return None
- name = type(self_obj).__name__
- if name in ('Template', 'TextNode'):
- return None
- source_obj = getattr(self_obj, 'source', None)
- if source_obj and hasattr(source_obj, '__len__') and len(source_obj) == 2:
- return str(source_obj[0]), source_obj[1]
-
- token_obj = getattr(self_obj, 'token', None)
- if token_obj is None:
- return None
- template_obj = getattr(frame.f_locals.get('context', None), 'template', None)
- if template_obj is None:
- return None
- template_name = getattr(template_obj, 'origin', None)
- position = getattr(token_obj, 'position', None)
- if template_name and position:
- return str(template_name), position
 
+ if self_obj is not None and hasattr(self_obj, 'token') and hasattr(self_obj.token, 'position'):
+ position = self_obj.token.position
+
+ if origin is not None and position is None:
+ active_bps = DJANGO_BREAKPOINTS.get(origin.lower())
+ if active_bps is None:
+ active_bps = DJANGO_TEMPLATES.get(origin.lower())
+ if active_bps is None:
+ DJANGO_BREAKPOINTS[origin.lower()] = active_bps = DjangoBreakpointInfo(origin.lower())
+ if active_bps is not None:
+ if line is not None:
+ position = active_bps.line_number_to_offset(line)
+ if origin and position:
+ return str(origin), position, line
 
  return None
 
@@ -901,12 +974,15 @@ def handle_call(self, frame, arg):
  if DJANGO_BREAKPOINTS:
  source_obj = get_django_frame_source(frame)
  if source_obj is not None:
- origin, (start, end) = source_obj
+ origin, (start, end), lineNumber = source_obj
 
  active_bps = DJANGO_BREAKPOINTS.get(origin.lower())
  should_break = False
- if active_bps is not None:
+ if active_bps is not None and origin != '<unknown source>': 
  should_break, bkpt_id = active_bps.should_break(start, end)
+ isPlainText = active_bps.is_range_plain_text(start, end)
+ if isPlainText:
+ should_break = False
  if should_break:
  probe_stack()
  update_all_thread_stacks(self)
@@ -1464,7 +1540,7 @@ def get_frame_list(self):
  frame_info = None
 
  if source_obj is not None:
- origin, (start, end) = source_obj
+ origin, (start, end), lineNumber = source_obj
 
  filename = str(origin)
  bp_info = DJANGO_BREAKPOINTS.get(filename.lower())
@@ -1622,6 +1698,7 @@ def __init__(self, conn):
  to_bytes('brka') : self.command_break_all,
  to_bytes('resa') : self.command_resume_all,
  to_bytes('rest') : self.command_resume_thread,
+ to_bytes('thrf') : self.command_get_thread_frames,
  to_bytes('ares') : self.command_auto_resume,
  to_bytes('exec') : self.command_execute_code,
  to_bytes('chld') : self.command_enum_children,
@@ -1805,6 +1882,13 @@ def command_break_all(self):
  SEND_BREAK_COMPLETE = True
  mark_all_threads_for_break()
 
+ def command_get_thread_frames(self):
+ tid = read_int(self.conn)
+ THREADS_LOCK.acquire()
+ thread = THREADS[tid]
+ THREADS_LOCK.release()
+ thread.enum_thread_frames_locally()
+
  def command_resume_all(self):
  # resume all
  THREADS_LOCK.acquire()
@@ -2190,7 +2274,7 @@ def attach_process(port_num, debug_id, debug_options, currentPid, report = False
  ## Begin modification by Don Jayamanne
  # Pass current Process id to pass back to debugger
  write_int(conn, currentPid) # success
- ## End Modification by Don Jayamanne
+ ## End Modification by Don Jayamanne 
  break
  except:
  import time
@@ -2480,7 +2564,7 @@ def debug(file, port_num, debug_id, debug_options, currentPid, run_as = 'script'
  # Pass current Process id to pass back to debugger
  attach_process(port_num, debug_id, debug_options, currentPid, report = True)
  ## End Modification by Don Jayamanne
- 
+
  # setup the current thread
  cur_thread = new_thread()
  cur_thread.stepping = STEPPING_LAUNCH_BREAK
@@ -2529,3 +2613,94 @@ def debug(file, port_num, debug_id, debug_options, currentPid, run_as = 'script'
  get_code(exec_code),
  get_code(new_thread_wrapper)
 ))
+
+## Begin modification by Don Jayamanne
+def _read_file(filename):
+ f = open(filename, "r")
+ s = f.read()
+ f.close()
+ return s
+
+
+def _offset_to_line_number(text, offset):
+ curLine = 1
+ curOffset = 0
+ while curOffset < offset:
+ if curOffset == len(text):
+ return -1
+ c = text[curOffset]
+ if c == '\n':
+ curLine += 1
+ elif c == '\r':
+ curLine += 1
+ if curOffset < len(text) and text[curOffset + 1] == '\n':
+ curOffset += 1
+
+ curOffset += 1
+
+ return curLine
+
+
+def _get_source_django_18_or_lower(frame):
+ # This method is usable only for the Django <= 1.8
+ try:
+ node = frame.f_locals['self']
+ if hasattr(node, 'source'):
+ return node.source
+ else:
+ if IS_DJANGO18:
+ # The debug setting was changed since Django 1.8
+ print("WARNING: Template path is not available. Set the 'debug' option in the OPTIONS of a DjangoTemplates "
+ "backend.")
+ else:
+ # The debug setting for Django < 1.8
+ print("WARNING: Template path is not available. Please set TEMPLATE_DEBUG=True in your settings.py to make "
+ "django template breakpoints working")
+ return None
+
+ except:
+ print(traceback.format_exc())
+ return None
+
+def _get_template_file_name(frame):
+ try:
+ if IS_DJANGO19_OR_HIGHER:
+ # The Node source was removed since Django 1.9
+ if dict_contains(frame.f_locals, 'context'):
+ context = frame.f_locals['context']
+ if hasattr(context, 'template') and hasattr(context.template, 'origin') and \
+ hasattr(context.template.origin, 'name'):
+ return context.template.origin.name
+ return None
+ source = _get_source_django_18_or_lower(frame)
+ if source is None:
+ print("Source is None\n")
+ return None
+ fname = source[0].name
+
+ if fname == '<unknown source>':
+ print("Source name is %s\n" + fname)
+ return None
+ else:
+ abs_path_real_path_and_base = get_abs_path_real_path_and_base_from_file(fname)
+ return abs_path_real_path_and_base[1]
+ except:
+ print(traceback.format_exc())
+ return None
+
+
+def _get_template_line(frame):
+ if IS_DJANGO19_OR_HIGHER:
+ # The Node source was removed since Django 1.9
+ self = frame.f_locals['self']
+ if hasattr(self, 'token') and hasattr(self.token, 'lineno'):
+ return self.token.lineno
+ else:
+ return None
+ source = _get_source_django_18_or_lower(frame)
+ file_name = _get_template_file_name(frame)
+ try:
+ return _offset_to_line_number(_read_file(file_name), source[1][0])
+ except:
+ return None
+## End modification by Don Jayamanne

src/client/debugger/PythonProcess.ts

@@ -281,7 +281,12 @@ export class PythonProcess extends EventEmitter implements IPythonProcess {
  this.stream.WriteInt32(brkpoint.LineNo);
  this.stream.WriteString(brkpoint.Filename);
 
- if (!brkpoint.IsDjangoBreakpoint) {
+ if (brkpoint.IsDjangoBreakpoint) {
+ // Bining django breakpoints don't return any responses
+ // Assume it worked
+ resolve();
+ }
+ else {
  this.SendCondition(brkpoint);
  this.SendPassCount(brkpoint);
  }