code.delx.au - gnu-emacs/blob - test/automated/python-tests.el

   1 ;;; python-tests.el --- Test suite for python.el
   2
   3 ;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
   4
   5 ;; This file is part of GNU Emacs.
   6
   7 ;; GNU Emacs is free software: you can redistribute it and/or modify
   8 ;; it under the terms of the GNU General Public License as published by
   9 ;; the Free Software Foundation, either version 3 of the License, or
  10 ;; (at your option) any later version.
  11
  12 ;; GNU Emacs is distributed in the hope that it will be useful,
  13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ;; GNU General Public License for more details.
  16
  17 ;; You should have received a copy of the GNU General Public License
  18 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 ;;; Commentary:
  21
  22 ;;; Code:
  23
  24 (require 'ert)
  25 (require 'python)
  26
  27 (defmacro python-tests-with-temp-buffer (contents &rest body)
  28   "Create a `python-mode' enabled temp buffer with CONTENTS.
  29 BODY is code to be executed within the temp buffer.  Point is
  30 always located at the beginning of buffer."
  31   (declare (indent 1) (debug t))
  32   `(with-temp-buffer
  33      (python-mode)
  34      (insert ,contents)
  35      (goto-char (point-min))
  36      ,@body))
  37
  38 (defmacro python-tests-with-temp-file (contents &rest body)
  39   "Create a `python-mode' enabled file with CONTENTS.
  40 BODY is code to be executed within the temp buffer.  Point is
  41 always located at the beginning of buffer."
  42   (declare (indent 1) (debug t))
  43   ;; temp-file never actually used for anything?
  44   `(let* ((temp-file (make-temp-file "python-tests" nil ".py"))
  45           (buffer (find-file-noselect temp-file)))
  46      (unwind-protect
  47          (with-current-buffer buffer
  48            (python-mode)
  49            (insert ,contents)
  50            (goto-char (point-min))
  51            ,@body)
  52        (and buffer (kill-buffer buffer))
  53        (delete-file temp-file))))
  54
  55 (defun python-tests-look-at (string &optional num restore-point)
  56   "Move point at beginning of STRING in the current buffer.
  57 Optional argument NUM defaults to 1 and is an integer indicating
  58 how many occurrences must be found, when positive the search is
  59 done forwards, otherwise backwards.  When RESTORE-POINT is
  60 non-nil the point is not moved but the position found is still
  61 returned.  When searching forward and point is already looking at
  62 STRING, it is skipped so the next STRING occurrence is selected."
  63   (let* ((num (or num 1))
  64          (starting-point (point))
  65          (string (regexp-quote string))
  66          (search-fn (if (> num 0) #'re-search-forward #'re-search-backward))
  67          (deinc-fn (if (> num 0) #'1- #'1+))
  68          (found-point))
  69     (prog2
  70         (catch 'exit
  71           (while (not (= num 0))
  72             (when (and (> num 0)
  73                        (looking-at string))
  74               ;; Moving forward and already looking at STRING, skip it.
  75               (forward-char (length (match-string-no-properties 0))))
  76             (and (not (funcall search-fn string nil t))
  77                  (throw 'exit t))
  78             (when (> num 0)
  79               ;; `re-search-forward' leaves point at the end of the
  80               ;; occurrence, move back so point is at the beginning
  81               ;; instead.
  82               (forward-char (- (length (match-string-no-properties 0)))))
  83             (setq
  84              num (funcall deinc-fn num)
  85              found-point (point))))
  86         found-point
  87       (and restore-point (goto-char starting-point)))))
  88
  89 (defun python-tests-self-insert (char-or-str)
  90   "Call `self-insert-command' for chars in CHAR-OR-STR."
  91   (let ((chars
  92          (cond
  93           ((characterp char-or-str)
  94            (list char-or-str))
  95           ((stringp char-or-str)
  96            (string-to-list char-or-str))
  97           ((not
  98             (cl-remove-if #'characterp char-or-str))
  99            char-or-str)
 100           (t (error "CHAR-OR-STR must be a char, string, or list of char")))))
 101     (mapc
 102      (lambda (char)
 103        (let ((last-command-event char))
 104          (call-interactively 'self-insert-command)))
 105      chars)))
 106
 107 \f
 108 ;;; Tests for your tests, so you can test while you test.
 109
 110 (ert-deftest python-tests-look-at-1 ()
 111   "Test forward movement."
 112   (python-tests-with-temp-buffer
 113    "Lorem ipsum dolor sit amet, consectetur adipisicing elit,
 114 sed do eiusmod tempor incididunt ut labore et dolore magna
 115 aliqua."
 116    (let ((expected (save-excursion
 117                      (dotimes (i 3)
 118                        (re-search-forward "et" nil t))
 119                      (forward-char -2)
 120                      (point))))
 121      (should (= (python-tests-look-at "et" 3 t) expected))
 122      ;; Even if NUM is bigger than found occurrences the point of last
 123      ;; one should be returned.
 124      (should (= (python-tests-look-at "et" 6 t) expected))
 125      ;; If already looking at STRING, it should skip it.
 126      (dotimes (i 2) (re-search-forward "et"))
 127      (forward-char -2)
 128      (should (= (python-tests-look-at "et") expected)))))
 129
 130 (ert-deftest python-tests-look-at-2 ()
 131   "Test backward movement."
 132   (python-tests-with-temp-buffer
 133    "Lorem ipsum dolor sit amet, consectetur adipisicing elit,
 134 sed do eiusmod tempor incididunt ut labore et dolore magna
 135 aliqua."
 136    (let ((expected
 137           (save-excursion
 138             (re-search-forward "et" nil t)
 139             (forward-char -2)
 140             (point))))
 141      (dotimes (i 3)
 142        (re-search-forward "et" nil t))
 143      (should (= (python-tests-look-at "et" -3 t) expected))
 144      (should (= (python-tests-look-at "et" -6 t) expected)))))
 145
 146 \f
 147 ;;; Bindings
 148
 149 \f
 150 ;;; Python specialized rx
 151
 152 \f
 153 ;;; Font-lock and syntax
 154
 155 (ert-deftest python-syntax-after-python-backspace ()
 156   ;; `python-indent-dedent-line-backspace' garbles syntax
 157   :expected-result :failed
 158   (python-tests-with-temp-buffer
 159       "\"\"\""
 160     (goto-char (point-max))
 161     (python-indent-dedent-line-backspace 1)
 162     (should (string= (buffer-string) "\"\""))
 163     (should (null (nth 3 (syntax-ppss))))))
 164
 165 \f
 166 ;;; Indentation
 167
 168 ;; See: http://www.python.org/dev/peps/pep-0008/#indentation
 169
 170 (ert-deftest python-indent-pep8-1 ()
 171   "First pep8 case."
 172   (python-tests-with-temp-buffer
 173    "# Aligned with opening delimiter
 174 foo = long_function_name(var_one, var_two,
 175                          var_three, var_four)
 176 "
 177    (should (eq (car (python-indent-context)) 'no-indent))
 178    (should (= (python-indent-calculate-indentation) 0))
 179    (python-tests-look-at "foo = long_function_name(var_one, var_two,")
 180    (should (eq (car (python-indent-context)) 'after-line))
 181    (should (= (python-indent-calculate-indentation) 0))
 182    (python-tests-look-at "var_three, var_four)")
 183    (should (eq (car (python-indent-context)) 'inside-paren))
 184    (should (= (python-indent-calculate-indentation) 25))))
 185
 186 (ert-deftest python-indent-pep8-2 ()
 187   "Second pep8 case."
 188   (python-tests-with-temp-buffer
 189    "# More indentation included to distinguish this from the rest.
 190 def long_function_name(
 191         var_one, var_two, var_three,
 192         var_four):
 193     print (var_one)
 194 "
 195    (should (eq (car (python-indent-context)) 'no-indent))
 196    (should (= (python-indent-calculate-indentation) 0))
 197    (python-tests-look-at "def long_function_name(")
 198    (should (eq (car (python-indent-context)) 'after-line))
 199    (should (= (python-indent-calculate-indentation) 0))
 200    (python-tests-look-at "var_one, var_two, var_three,")
 201    (should (eq (car (python-indent-context)) 'inside-paren))
 202    (should (= (python-indent-calculate-indentation) 8))
 203    (python-tests-look-at "var_four):")
 204    (should (eq (car (python-indent-context)) 'inside-paren))
 205    (should (= (python-indent-calculate-indentation) 8))
 206    (python-tests-look-at "print (var_one)")
 207    (should (eq (car (python-indent-context)) 'after-beginning-of-block))
 208    (should (= (python-indent-calculate-indentation) 4))))
 209
 210 (ert-deftest python-indent-pep8-3 ()
 211   "Third pep8 case."
 212   (python-tests-with-temp-buffer
 213    "# Extra indentation is not necessary.
 214 foo = long_function_name(
 215   var_one, var_two,
 216   var_three, var_four)
 217 "
 218    (should (eq (car (python-indent-context)) 'no-indent))
 219    (should (= (python-indent-calculate-indentation) 0))
 220    (python-tests-look-at "foo = long_function_name(")
 221    (should (eq (car (python-indent-context)) 'after-line))
 222    (should (= (python-indent-calculate-indentation) 0))
 223    (python-tests-look-at "var_one, var_two,")
 224    (should (eq (car (python-indent-context)) 'inside-paren))
 225    (should (= (python-indent-calculate-indentation) 4))
 226    (python-tests-look-at "var_three, var_four)")
 227    (should (eq (car (python-indent-context)) 'inside-paren))
 228    (should (= (python-indent-calculate-indentation) 4))))
 229
 230 (ert-deftest python-indent-after-comment-1 ()
 231   "The most simple after-comment case that shouldn't fail."
 232   (python-tests-with-temp-buffer
 233    "# Contents will be modified to correct indentation
 234 class Blag(object):
 235     def _on_child_complete(self, child_future):
 236         if self.in_terminal_state():
 237             pass
 238         # We only complete when all our async children have entered a
 239     # terminal state. At that point, if any child failed, we fail
 240 # with the exception with which the first child failed.
 241 "
 242    (python-tests-look-at "# We only complete")
 243    (should (eq (car (python-indent-context)) 'after-line))
 244    (should (= (python-indent-calculate-indentation) 8))
 245    (python-tests-look-at "# terminal state")
 246    (should (eq (car (python-indent-context)) 'after-comment))
 247    (should (= (python-indent-calculate-indentation) 8))
 248    (python-tests-look-at "# with the exception")
 249    (should (eq (car (python-indent-context)) 'after-comment))
 250    ;; This one indents relative to previous block, even given the fact
 251    ;; that it was under-indented.
 252    (should (= (python-indent-calculate-indentation) 4))
 253    (python-tests-look-at "# terminal state" -1)
 254    ;; It doesn't hurt to check again.
 255    (should (eq (car (python-indent-context)) 'after-comment))
 256    (python-indent-line)
 257    (should (= (current-indentation) 8))
 258    (python-tests-look-at "# with the exception")
 259    (should (eq (car (python-indent-context)) 'after-comment))
 260    ;; Now everything should be lined up.
 261    (should (= (python-indent-calculate-indentation) 8))))
 262
 263 (ert-deftest python-indent-after-comment-2 ()
 264   "Test after-comment in weird cases."
 265   (python-tests-with-temp-buffer
 266    "# Contents will be modified to correct indentation
 267 def func(arg):
 268     # I don't do much
 269     return arg
 270     # This comment is badly indented just because.
 271     # But we won't mess with the user in this line.
 272
 273 now_we_do_mess_cause_this_is_not_a_comment = 1
 274
 275 # yeah, that.
 276 "
 277    (python-tests-look-at "# I don't do much")
 278    (should (eq (car (python-indent-context)) 'after-beginning-of-block))
 279    (should (= (python-indent-calculate-indentation) 4))
 280    (python-tests-look-at "return arg")
 281    ;; Comment here just gets ignored, this line is not a comment so
 282    ;; the rules won't apply here.
 283    (should (eq (car (python-indent-context)) 'after-beginning-of-block))
 284    (should (= (python-indent-calculate-indentation) 4))
 285    (python-tests-look-at "# This comment is badly")
 286    (should (eq (car (python-indent-context)) 'after-line))
 287    ;; The return keyword moves indentation backwards 4 spaces, but
 288    ;; let's assume this comment was placed there because the user
 289    ;; wanted to (manually adding spaces or whatever).
 290    (should (= (python-indent-calculate-indentation) 0))
 291    (python-tests-look-at "# but we won't mess")
 292    (should (eq (car (python-indent-context)) 'after-comment))
 293    (should (= (python-indent-calculate-indentation) 4))
 294    ;; Behave the same for blank lines: potentially a comment.
 295    (forward-line 1)
 296    (should (eq (car (python-indent-context)) 'after-comment))
 297    (should (= (python-indent-calculate-indentation) 4))
 298    (python-tests-look-at "now_we_do_mess")
 299    ;; Here is where comment indentation starts to get ignored and
 300    ;; where the user can't freely indent anymore.
 301    (should (eq (car (python-indent-context)) 'after-line))
 302    (should (= (python-indent-calculate-indentation) 0))
 303    (python-tests-look-at "# yeah, that.")
 304    (should (eq (car (python-indent-context)) 'after-line))
 305    (should (= (python-indent-calculate-indentation) 0))))
 306
 307 (ert-deftest python-indent-inside-paren-1 ()
 308   "The most simple inside-paren case that shouldn't fail."
 309   (python-tests-with-temp-buffer
 310    "
 311 data = {
 312     'key':
 313     {
 314         'objlist': [
 315             {
 316                 'pk': 1,
 317                 'name': 'first',
 318             },
 319             {
 320                 'pk': 2,
 321                 'name': 'second',
 322             }
 323         ]
 324     }
 325 }
 326 "
 327    (python-tests-look-at "data = {")
 328    (should (eq (car (python-indent-context)) 'after-line))
 329    (should (= (python-indent-calculate-indentation) 0))
 330    (python-tests-look-at "'key':")
 331    (should (eq (car (python-indent-context)) 'inside-paren))
 332    (should (= (python-indent-calculate-indentation) 4))
 333    (python-tests-look-at "{")
 334    (should (eq (car (python-indent-context)) 'inside-paren))
 335    (should (= (python-indent-calculate-indentation) 4))
 336    (python-tests-look-at "'objlist': [")
 337    (should (eq (car (python-indent-context)) 'inside-paren))
 338    (should (= (python-indent-calculate-indentation) 8))
 339    (python-tests-look-at "{")
 340    (should (eq (car (python-indent-context)) 'inside-paren))
 341    (should (= (python-indent-calculate-indentation) 12))
 342    (python-tests-look-at "'pk': 1,")
 343    (should (eq (car (python-indent-context)) 'inside-paren))
 344    (should (= (python-indent-calculate-indentation) 16))
 345    (python-tests-look-at "'name': 'first',")
 346    (should (eq (car (python-indent-context)) 'inside-paren))
 347    (should (= (python-indent-calculate-indentation) 16))
 348    (python-tests-look-at "},")
 349    (should (eq (car (python-indent-context)) 'inside-paren))
 350    (should (= (python-indent-calculate-indentation) 12))
 351    (python-tests-look-at "{")
 352    (should (eq (car (python-indent-context)) 'inside-paren))
 353    (should (= (python-indent-calculate-indentation) 12))
 354    (python-tests-look-at "'pk': 2,")
 355    (should (eq (car (python-indent-context)) 'inside-paren))
 356    (should (= (python-indent-calculate-indentation) 16))
 357    (python-tests-look-at "'name': 'second',")
 358    (should (eq (car (python-indent-context)) 'inside-paren))
 359    (should (= (python-indent-calculate-indentation) 16))
 360    (python-tests-look-at "}")
 361    (should (eq (car (python-indent-context)) 'inside-paren))
 362    (should (= (python-indent-calculate-indentation) 12))
 363    (python-tests-look-at "]")
 364    (should (eq (car (python-indent-context)) 'inside-paren))
 365    (should (= (python-indent-calculate-indentation) 8))
 366    (python-tests-look-at "}")
 367    (should (eq (car (python-indent-context)) 'inside-paren))
 368    (should (= (python-indent-calculate-indentation) 4))
 369    (python-tests-look-at "}")
 370    (should (eq (car (python-indent-context)) 'inside-paren))
 371    (should (= (python-indent-calculate-indentation) 0))))
 372
 373 (ert-deftest python-indent-inside-paren-2 ()
 374   "Another more compact paren group style."
 375   (python-tests-with-temp-buffer
 376    "
 377 data = {'key': {
 378     'objlist': [
 379         {'pk': 1,
 380          'name': 'first'},
 381         {'pk': 2,
 382          'name': 'second'}
 383     ]
 384 }}
 385 "
 386    (python-tests-look-at "data = {")
 387    (should (eq (car (python-indent-context)) 'after-line))
 388    (should (= (python-indent-calculate-indentation) 0))
 389    (python-tests-look-at "'objlist': [")
 390    (should (eq (car (python-indent-context)) 'inside-paren))
 391    (should (= (python-indent-calculate-indentation) 4))
 392    (python-tests-look-at "{'pk': 1,")
 393    (should (eq (car (python-indent-context)) 'inside-paren))
 394    (should (= (python-indent-calculate-indentation) 8))
 395    (python-tests-look-at "'name': 'first'},")
 396    (should (eq (car (python-indent-context)) 'inside-paren))
 397    (should (= (python-indent-calculate-indentation) 9))
 398    (python-tests-look-at "{'pk': 2,")
 399    (should (eq (car (python-indent-context)) 'inside-paren))
 400    (should (= (python-indent-calculate-indentation) 8))
 401    (python-tests-look-at "'name': 'second'}")
 402    (should (eq (car (python-indent-context)) 'inside-paren))
 403    (should (= (python-indent-calculate-indentation) 9))
 404    (python-tests-look-at "]")
 405    (should (eq (car (python-indent-context)) 'inside-paren))
 406    (should (= (python-indent-calculate-indentation) 4))
 407    (python-tests-look-at "}}")
 408    (should (eq (car (python-indent-context)) 'inside-paren))
 409    (should (= (python-indent-calculate-indentation) 0))
 410    (python-tests-look-at "}")
 411    (should (eq (car (python-indent-context)) 'inside-paren))
 412    (should (= (python-indent-calculate-indentation) 0))))
 413
 414 (ert-deftest python-indent-after-block-1 ()
 415   "The most simple after-block case that shouldn't fail."
 416   (python-tests-with-temp-buffer
 417    "
 418 def foo(a, b, c=True):
 419 "
 420    (should (eq (car (python-indent-context)) 'no-indent))
 421    (should (= (python-indent-calculate-indentation) 0))
 422    (goto-char (point-max))
 423    (should (eq (car (python-indent-context)) 'after-beginning-of-block))
 424    (should (= (python-indent-calculate-indentation) 4))))
 425
 426 (ert-deftest python-indent-after-block-2 ()
 427   "A weird (malformed) multiline block statement."
 428   (python-tests-with-temp-buffer
 429    "
 430 def foo(a, b, c={
 431     'a':
 432 }):
 433 "
 434    (goto-char (point-max))
 435    (should (eq (car (python-indent-context)) 'after-beginning-of-block))
 436    (should (= (python-indent-calculate-indentation) 4))))
 437
 438 (ert-deftest python-indent-after-backslash-1 ()
 439   "The most common case."
 440   (python-tests-with-temp-buffer
 441    "
 442 from foo.bar.baz import something, something_1 \\\\
 443     something_2 something_3, \\\\
 444     something_4, something_5
 445 "
 446    (python-tests-look-at "from foo.bar.baz import something, something_1")
 447    (should (eq (car (python-indent-context)) 'after-line))
 448    (should (= (python-indent-calculate-indentation) 0))
 449    (python-tests-look-at "something_2 something_3,")
 450    (should (eq (car (python-indent-context)) 'after-backslash))
 451    (should (= (python-indent-calculate-indentation) 4))
 452    (python-tests-look-at "something_4, something_5")
 453    (should (eq (car (python-indent-context)) 'after-backslash))
 454    (should (= (python-indent-calculate-indentation) 4))
 455    (goto-char (point-max))
 456    (should (eq (car (python-indent-context)) 'after-line))
 457    (should (= (python-indent-calculate-indentation) 0))))
 458
 459 (ert-deftest python-indent-after-backslash-2 ()
 460   "A pretty extreme complicated case."
 461   (python-tests-with-temp-buffer
 462    "
 463 objects = Thing.objects.all() \\\\
 464                        .filter(
 465                            type='toy',
 466                            status='bought'
 467                        ) \\\\
 468                        .aggregate(
 469                            Sum('amount')
 470                        ) \\\\
 471                        .values_list()
 472 "
 473    (python-tests-look-at "objects = Thing.objects.all()")
 474    (should (eq (car (python-indent-context)) 'after-line))
 475    (should (= (python-indent-calculate-indentation) 0))
 476    (python-tests-look-at ".filter(")
 477    (should (eq (car (python-indent-context)) 'after-backslash))
 478    (should (= (python-indent-calculate-indentation) 23))
 479    (python-tests-look-at "type='toy',")
 480    (should (eq (car (python-indent-context)) 'inside-paren))
 481    (should (= (python-indent-calculate-indentation) 27))
 482    (python-tests-look-at "status='bought'")
 483    (should (eq (car (python-indent-context)) 'inside-paren))
 484    (should (= (python-indent-calculate-indentation) 27))
 485    (python-tests-look-at ") \\\\")
 486    (should (eq (car (python-indent-context)) 'inside-paren))
 487    (should (= (python-indent-calculate-indentation) 23))
 488    (python-tests-look-at ".aggregate(")
 489    (should (eq (car (python-indent-context)) 'after-backslash))
 490    (should (= (python-indent-calculate-indentation) 23))
 491    (python-tests-look-at "Sum('amount')")
 492    (should (eq (car (python-indent-context)) 'inside-paren))
 493    (should (= (python-indent-calculate-indentation) 27))
 494    (python-tests-look-at ") \\\\")
 495    (should (eq (car (python-indent-context)) 'inside-paren))
 496    (should (= (python-indent-calculate-indentation) 23))
 497    (python-tests-look-at ".values_list()")
 498    (should (eq (car (python-indent-context)) 'after-backslash))
 499    (should (= (python-indent-calculate-indentation) 23))
 500    (forward-line 1)
 501    (should (eq (car (python-indent-context)) 'after-line))
 502    (should (= (python-indent-calculate-indentation) 0))))
 503
 504 (ert-deftest python-indent-block-enders-1 ()
 505   "Test de-indentation for pass keyword."
 506   (python-tests-with-temp-buffer
 507       "
 508 Class foo(object):
 509
 510     def bar(self):
 511         if self.baz:
 512             return (1,
 513                     2,
 514                     3)
 515
 516         else:
 517             pass
 518 "
 519     (python-tests-look-at "3)")
 520     (forward-line 1)
 521     (should (= (python-indent-calculate-indentation) 8))
 522     (python-tests-look-at "pass")
 523     (forward-line 1)
 524     (should (= (python-indent-calculate-indentation) 8))))
 525
 526 (ert-deftest python-indent-block-enders-2 ()
 527   "Test de-indentation for return keyword."
 528   (python-tests-with-temp-buffer
 529       "
 530 Class foo(object):
 531     '''raise lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
 532
 533     eiusmod tempor incididunt ut labore et dolore magna aliqua.
 534     '''
 535     def bar(self):
 536         \"return (1, 2, 3).\"
 537         if self.baz:
 538             return (1,
 539                     2,
 540                     3)
 541 "
 542     (python-tests-look-at "def")
 543     (should (= (python-indent-calculate-indentation) 4))
 544     (python-tests-look-at "if")
 545     (should (= (python-indent-calculate-indentation) 8))
 546     (python-tests-look-at "return")
 547     (should (= (python-indent-calculate-indentation) 12))
 548     (goto-char (point-max))
 549     (should (= (python-indent-calculate-indentation) 8))))
 550
 551 (ert-deftest python-indent-block-enders-3 ()
 552   "Test de-indentation for continue keyword."
 553   (python-tests-with-temp-buffer
 554       "
 555 for element in lst:
 556     if element is None:
 557         continue
 558 "
 559     (python-tests-look-at "if")
 560     (should (= (python-indent-calculate-indentation) 4))
 561     (python-tests-look-at "continue")
 562     (should (= (python-indent-calculate-indentation) 8))
 563     (forward-line 1)
 564     (should (= (python-indent-calculate-indentation) 4))))
 565
 566 (ert-deftest python-indent-block-enders-4 ()
 567   "Test de-indentation for break keyword."
 568   (python-tests-with-temp-buffer
 569       "
 570 for element in lst:
 571     if element is None:
 572         break
 573 "
 574     (python-tests-look-at "if")
 575     (should (= (python-indent-calculate-indentation) 4))
 576     (python-tests-look-at "break")
 577     (should (= (python-indent-calculate-indentation) 8))
 578     (forward-line 1)
 579     (should (= (python-indent-calculate-indentation) 4))))
 580
 581 (ert-deftest python-indent-block-enders-5 ()
 582   "Test de-indentation for raise keyword."
 583   (python-tests-with-temp-buffer
 584       "
 585 for element in lst:
 586     if element is None:
 587         raise ValueError('Element cannot be None')
 588 "
 589     (python-tests-look-at "if")
 590     (should (= (python-indent-calculate-indentation) 4))
 591     (python-tests-look-at "raise")
 592     (should (= (python-indent-calculate-indentation) 8))
 593     (forward-line 1)
 594     (should (= (python-indent-calculate-indentation) 4))))
 595
 596 (ert-deftest python-indent-dedenters-1 ()
 597   "Test de-indentation for the elif keyword."
 598   (python-tests-with-temp-buffer
 599       "
 600 if save:
 601     try:
 602         write_to_disk(data)
 603     finally:
 604         cleanup()
 605         elif
 606 "
 607     (python-tests-look-at "elif\n")
 608     (should (eq (car (python-indent-context)) 'dedenter-statement))
 609     (should (= (python-indent-calculate-indentation) 0))
 610     (should (equal (python-indent-calculate-levels) '(0)))))
 611
 612 (ert-deftest python-indent-dedenters-2 ()
 613   "Test de-indentation for the else keyword."
 614   (python-tests-with-temp-buffer
 615       "
 616 if save:
 617     try:
 618         write_to_disk(data)
 619     except IOError:
 620         msg = 'Error saving to disk'
 621         message(msg)
 622         logger.exception(msg)
 623     except Exception:
 624         if hide_details:
 625             logger.exception('Unhandled exception')
 626             else
 627     finally:
 628         data.free()
 629 "
 630     (python-tests-look-at "else\n")
 631     (should (eq (car (python-indent-context)) 'dedenter-statement))
 632     (should (= (python-indent-calculate-indentation) 8))
 633     (should (equal (python-indent-calculate-levels) '(0 4 8)))))
 634
 635 (ert-deftest python-indent-dedenters-3 ()
 636   "Test de-indentation for the except keyword."
 637   (python-tests-with-temp-buffer
 638       "
 639 if save:
 640     try:
 641         write_to_disk(data)
 642         except
 643 "
 644     (python-tests-look-at "except\n")
 645     (should (eq (car (python-indent-context)) 'dedenter-statement))
 646     (should (= (python-indent-calculate-indentation) 4))
 647     (should (equal (python-indent-calculate-levels) '(4)))))
 648
 649 (ert-deftest python-indent-dedenters-4 ()
 650   "Test de-indentation for the finally keyword."
 651   (python-tests-with-temp-buffer
 652       "
 653 if save:
 654     try:
 655         write_to_disk(data)
 656         finally
 657 "
 658     (python-tests-look-at "finally\n")
 659     (should (eq (car (python-indent-context)) 'dedenter-statement))
 660     (should (= (python-indent-calculate-indentation) 4))
 661     (should (equal (python-indent-calculate-levels) '(4)))))
 662
 663 (ert-deftest python-indent-dedenters-5 ()
 664   "Test invalid levels are skipped in a complex example."
 665   (python-tests-with-temp-buffer
 666       "
 667 if save:
 668     try:
 669         write_to_disk(data)
 670     except IOError:
 671         msg = 'Error saving to disk'
 672         message(msg)
 673         logger.exception(msg)
 674     finally:
 675         if cleanup:
 676             do_cleanup()
 677         else
 678 "
 679     (python-tests-look-at "else\n")
 680     (should (eq (car (python-indent-context)) 'dedenter-statement))
 681     (should (= (python-indent-calculate-indentation) 8))
 682     (should (equal (python-indent-calculate-levels) '(0 8)))))
 683
 684 (ert-deftest python-indent-dedenters-6 ()
 685   "Test indentation is zero when no opening block for dedenter."
 686   (python-tests-with-temp-buffer
 687       "
 688 try:
 689     # if save:
 690         write_to_disk(data)
 691         else
 692 "
 693     (python-tests-look-at "else\n")
 694     (should (eq (car (python-indent-context)) 'dedenter-statement))
 695     (should (= (python-indent-calculate-indentation) 0))
 696     (should (equal (python-indent-calculate-levels) '(0)))))
 697
 698 (ert-deftest python-indent-dedenters-7 ()
 699   "Test indentation case from Bug#15163."
 700   (python-tests-with-temp-buffer
 701       "
 702 if a:
 703     if b:
 704         pass
 705     else:
 706         pass
 707         else:
 708 "
 709     (python-tests-look-at "else:" 2)
 710     (should (eq (car (python-indent-context)) 'dedenter-statement))
 711     (should (= (python-indent-calculate-indentation) 0))
 712     (should (equal (python-indent-calculate-levels) '(0)))))
 713
 714 (ert-deftest python-indent-dedenters-8 ()
 715   "Test indentation for Bug#18432."
 716   (python-tests-with-temp-buffer
 717    "
 718 if (a == 1 or
 719     a == 2):
 720     pass
 721 elif (a == 3 or
 722 a == 4):
 723 "
 724    (python-tests-look-at "a == 4):\n")
 725    (should (eq (car (python-indent-context)) 'inside-paren))
 726    (should (= (python-indent-calculate-indentation) 6))
 727    (should (equal (python-indent-calculate-levels) '(0 4 6)))))
 728
 729 (ert-deftest python-indent-electric-colon-1 ()
 730   "Test indentation case from Bug#18228."
 731   (python-tests-with-temp-buffer
 732    "
 733 def a():
 734     pass
 735
 736 def b()
 737 "
 738    (python-tests-look-at "def b()")
 739    (goto-char (line-end-position))
 740    (python-tests-self-insert ":")
 741    (should (= (current-indentation) 0))))
 742
 743 (ert-deftest python-indent-region-1 ()
 744   "Test indentation case from Bug#18843."
 745   (let ((contents "
 746 def foo ():
 747     try:
 748         pass
 749     except:
 750         pass
 751 "))
 752     (python-tests-with-temp-buffer
 753      contents
 754      (python-indent-region (point-min) (point-max))
 755      (should (string= (buffer-substring-no-properties (point-min) (point-max))
 756                       contents)))))
 757
 758 (ert-deftest python-indent-region-2 ()
 759   "Test region indentation on comments."
 760   (let ((contents "
 761 def f():
 762     if True:
 763         pass
 764
 765 # This is
 766 # some multiline
 767 # comment
 768 "))
 769     (python-tests-with-temp-buffer
 770      contents
 771      (python-indent-region (point-min) (point-max))
 772      (should (string= (buffer-substring-no-properties (point-min) (point-max))
 773                       contents)))))
 774
 775 (ert-deftest python-indent-region-3 ()
 776   "Test region indentation on comments."
 777   (let ((contents "
 778 def f():
 779     if True:
 780         pass
 781 # This is
 782 # some multiline
 783 # comment
 784 ")
 785         (expected "
 786 def f():
 787     if True:
 788         pass
 789     # This is
 790     # some multiline
 791     # comment
 792 "))
 793     (python-tests-with-temp-buffer
 794      contents
 795      (python-indent-region (point-min) (point-max))
 796      (should (string= (buffer-substring-no-properties (point-min) (point-max))
 797                       expected)))))
 798
 799 (ert-deftest python-indent-region-4 ()
 800   "Test region indentation block starts, dedenters and enders."
 801   (let ((contents "
 802 def f():
 803     if True:
 804 a  = 5
 805     else:
 806             a = 10
 807     return a
 808 ")
 809         (expected "
 810 def f():
 811     if True:
 812         a  = 5
 813     else:
 814         a = 10
 815     return a
 816 "))
 817     (python-tests-with-temp-buffer
 818      contents
 819      (python-indent-region (point-min) (point-max))
 820      (should (string= (buffer-substring-no-properties (point-min) (point-max))
 821                       expected)))))
 822
 823 (ert-deftest python-indent-region-5 ()
 824   "Test region indentation leaves strings untouched (start delimiter)."
 825   (let ((contents "
 826 def f():
 827 '''
 828 this is
 829 a multiline
 830 string
 831 '''
 832 ")
 833         (expected "
 834 def f():
 835     '''
 836 this is
 837 a multiline
 838 string
 839 '''
 840 "))
 841     (python-tests-with-temp-buffer
 842      contents
 843      (python-indent-region (point-min) (point-max))
 844      (should (string= (buffer-substring-no-properties (point-min) (point-max))
 845                       expected)))))
 846
 847 \f
 848 ;;; Navigation
 849
 850 (ert-deftest python-nav-beginning-of-defun-1 ()
 851   (python-tests-with-temp-buffer
 852    "
 853 def decoratorFunctionWithArguments(arg1, arg2, arg3):
 854     '''print decorated function call data to stdout.
 855
 856     Usage:
 857
 858     @decoratorFunctionWithArguments('arg1', 'arg2')
 859     def func(a, b, c=True):
 860         pass
 861     '''
 862
 863     def wwrap(f):
 864         print 'Inside wwrap()'
 865         def wrapped_f(*args):
 866             print 'Inside wrapped_f()'
 867             print 'Decorator arguments:', arg1, arg2, arg3
 868             f(*args)
 869             print 'After f(*args)'
 870         return wrapped_f
 871     return wwrap
 872 "
 873    (python-tests-look-at "return wrap")
 874    (should (= (save-excursion
 875                 (python-nav-beginning-of-defun)
 876                 (point))
 877               (save-excursion
 878                 (python-tests-look-at "def wrapped_f(*args):" -1)
 879                 (beginning-of-line)
 880                 (point))))
 881    (python-tests-look-at "def wrapped_f(*args):" -1)
 882    (should (= (save-excursion
 883                 (python-nav-beginning-of-defun)
 884                 (point))
 885               (save-excursion
 886                 (python-tests-look-at "def wwrap(f):" -1)
 887                 (beginning-of-line)
 888                 (point))))
 889    (python-tests-look-at "def wwrap(f):" -1)
 890    (should (= (save-excursion
 891                 (python-nav-beginning-of-defun)
 892                 (point))
 893               (save-excursion
 894                 (python-tests-look-at "def decoratorFunctionWithArguments" -1)
 895                 (beginning-of-line)
 896                 (point))))))
 897
 898 (ert-deftest python-nav-beginning-of-defun-2 ()
 899   (python-tests-with-temp-buffer
 900    "
 901 class C(object):
 902
 903     def m(self):
 904         self.c()
 905
 906         def b():
 907             pass
 908
 909         def a():
 910             pass
 911
 912     def c(self):
 913         pass
 914 "
 915    ;; Nested defuns, are handled with care.
 916    (python-tests-look-at "def c(self):")
 917    (should (= (save-excursion
 918                 (python-nav-beginning-of-defun)
 919                 (point))
 920               (save-excursion
 921                 (python-tests-look-at "def m(self):" -1)
 922                 (beginning-of-line)
 923                 (point))))
 924    ;; Defuns on same levels should be respected.
 925    (python-tests-look-at "def a():" -1)
 926    (should (= (save-excursion
 927                 (python-nav-beginning-of-defun)
 928                 (point))
 929               (save-excursion
 930                 (python-tests-look-at "def b():" -1)
 931                 (beginning-of-line)
 932                 (point))))
 933    ;; Jump to a top level defun.
 934    (python-tests-look-at "def b():" -1)
 935    (should (= (save-excursion
 936                 (python-nav-beginning-of-defun)
 937                 (point))
 938               (save-excursion
 939                 (python-tests-look-at "def m(self):" -1)
 940                 (beginning-of-line)
 941                 (point))))
 942    ;; Jump to a top level defun again.
 943    (python-tests-look-at "def m(self):" -1)
 944    (should (= (save-excursion
 945                 (python-nav-beginning-of-defun)
 946                 (point))
 947               (save-excursion
 948                 (python-tests-look-at "class C(object):" -1)
 949                 (beginning-of-line)
 950                 (point))))))
 951
 952 (ert-deftest python-nav-end-of-defun-1 ()
 953   (python-tests-with-temp-buffer
 954    "
 955 class C(object):
 956
 957     def m(self):
 958         self.c()
 959
 960         def b():
 961             pass
 962
 963         def a():
 964             pass
 965
 966     def c(self):
 967         pass
 968 "
 969    (should (= (save-excursion
 970                 (python-tests-look-at "class C(object):")
 971                 (python-nav-end-of-defun)
 972                 (point))
 973               (save-excursion
 974                 (point-max))))
 975    (should (= (save-excursion
 976                 (python-tests-look-at "def m(self):")
 977                 (python-nav-end-of-defun)
 978                 (point))
 979               (save-excursion
 980                 (python-tests-look-at "def c(self):")
 981                 (forward-line -1)
 982                 (point))))
 983    (should (= (save-excursion
 984                 (python-tests-look-at "def b():")
 985                 (python-nav-end-of-defun)
 986                 (point))
 987               (save-excursion
 988                 (python-tests-look-at "def b():")
 989                 (forward-line 2)
 990                 (point))))
 991    (should (= (save-excursion
 992                 (python-tests-look-at "def c(self):")
 993                 (python-nav-end-of-defun)
 994                 (point))
 995               (save-excursion
 996                 (point-max))))))
 997
 998 (ert-deftest python-nav-end-of-defun-2 ()
 999   (python-tests-with-temp-buffer
1000    "
1001 def decoratorFunctionWithArguments(arg1, arg2, arg3):
1002     '''print decorated function call data to stdout.
1003
1004     Usage:
1005
1006     @decoratorFunctionWithArguments('arg1', 'arg2')
1007     def func(a, b, c=True):
1008         pass
1009     '''
1010
1011     def wwrap(f):
1012         print 'Inside wwrap()'
1013         def wrapped_f(*args):
1014             print 'Inside wrapped_f()'
1015             print 'Decorator arguments:', arg1, arg2, arg3
1016             f(*args)
1017             print 'After f(*args)'
1018         return wrapped_f
1019     return wwrap
1020 "
1021    (should (= (save-excursion
1022                 (python-tests-look-at "def decoratorFunctionWithArguments")
1023                 (python-nav-end-of-defun)
1024                 (point))
1025               (save-excursion
1026                 (point-max))))
1027    (should (= (save-excursion
1028                 (python-tests-look-at "@decoratorFunctionWithArguments")
1029                 (python-nav-end-of-defun)
1030                 (point))
1031               (save-excursion
1032                 (point-max))))
1033    (should (= (save-excursion
1034                 (python-tests-look-at "def wwrap(f):")
1035                 (python-nav-end-of-defun)
1036                 (point))
1037               (save-excursion
1038                 (python-tests-look-at "return wwrap")
1039                 (line-beginning-position))))
1040    (should (= (save-excursion
1041                 (python-tests-look-at "def wrapped_f(*args):")
1042                 (python-nav-end-of-defun)
1043                 (point))
1044               (save-excursion
1045                 (python-tests-look-at "return wrapped_f")
1046                 (line-beginning-position))))
1047    (should (= (save-excursion
1048                 (python-tests-look-at "f(*args)")
1049                 (python-nav-end-of-defun)
1050                 (point))
1051               (save-excursion
1052                 (python-tests-look-at "return wrapped_f")
1053                 (line-beginning-position))))))
1054
1055 (ert-deftest python-nav-backward-defun-1 ()
1056   (python-tests-with-temp-buffer
1057    "
1058 class A(object): # A
1059
1060     def a(self): # a
1061         pass
1062
1063     def b(self): # b
1064         pass
1065
1066     class B(object): # B
1067
1068         class C(object): # C
1069
1070             def d(self): # d
1071                 pass
1072
1073             # def e(self): # e
1074             #     pass
1075
1076     def c(self): # c
1077         pass
1078
1079     # def d(self): # d
1080     #     pass
1081 "
1082    (goto-char (point-max))
1083    (should (= (save-excursion (python-nav-backward-defun))
1084               (python-tests-look-at "    def c(self): # c" -1)))
1085    (should (= (save-excursion (python-nav-backward-defun))
1086               (python-tests-look-at "            def d(self): # d" -1)))
1087    (should (= (save-excursion (python-nav-backward-defun))
1088               (python-tests-look-at "        class C(object): # C" -1)))
1089    (should (= (save-excursion (python-nav-backward-defun))
1090               (python-tests-look-at "    class B(object): # B" -1)))
1091    (should (= (save-excursion (python-nav-backward-defun))
1092               (python-tests-look-at "    def b(self): # b" -1)))
1093    (should (= (save-excursion (python-nav-backward-defun))
1094               (python-tests-look-at "    def a(self): # a" -1)))
1095    (should (= (save-excursion (python-nav-backward-defun))
1096               (python-tests-look-at "class A(object): # A" -1)))
1097    (should (not (python-nav-backward-defun)))))
1098
1099 (ert-deftest python-nav-backward-defun-2 ()
1100   (python-tests-with-temp-buffer
1101    "
1102 def decoratorFunctionWithArguments(arg1, arg2, arg3):
1103     '''print decorated function call data to stdout.
1104
1105     Usage:
1106
1107     @decoratorFunctionWithArguments('arg1', 'arg2')
1108     def func(a, b, c=True):
1109         pass
1110     '''
1111
1112     def wwrap(f):
1113         print 'Inside wwrap()'
1114         def wrapped_f(*args):
1115             print 'Inside wrapped_f()'
1116             print 'Decorator arguments:', arg1, arg2, arg3
1117             f(*args)
1118             print 'After f(*args)'
1119         return wrapped_f
1120     return wwrap
1121 "
1122    (goto-char (point-max))
1123    (should (= (save-excursion (python-nav-backward-defun))
1124               (python-tests-look-at "        def wrapped_f(*args):" -1)))
1125    (should (= (save-excursion (python-nav-backward-defun))
1126               (python-tests-look-at "    def wwrap(f):" -1)))
1127    (should (= (save-excursion (python-nav-backward-defun))
1128               (python-tests-look-at "def decoratorFunctionWithArguments(arg1, arg2, arg3):" -1)))
1129    (should (not (python-nav-backward-defun)))))
1130
1131 (ert-deftest python-nav-backward-defun-3 ()
1132   (python-tests-with-temp-buffer
1133    "
1134 '''
1135     def u(self):
1136         pass
1137
1138     def v(self):
1139         pass
1140
1141     def w(self):
1142         pass
1143 '''
1144
1145 class A(object):
1146     pass
1147 "
1148    (goto-char (point-min))
1149    (let ((point (python-tests-look-at "class A(object):")))
1150      (should (not (python-nav-backward-defun)))
1151      (should (= point (point))))))
1152
1153 (ert-deftest python-nav-forward-defun-1 ()
1154   (python-tests-with-temp-buffer
1155    "
1156 class A(object): # A
1157
1158     def a(self): # a
1159         pass
1160
1161     def b(self): # b
1162         pass
1163
1164     class B(object): # B
1165
1166         class C(object): # C
1167
1168             def d(self): # d
1169                 pass
1170
1171             # def e(self): # e
1172             #     pass
1173
1174     def c(self): # c
1175         pass
1176
1177     # def d(self): # d
1178     #     pass
1179 "
1180    (goto-char (point-min))
1181    (should (= (save-excursion (python-nav-forward-defun))
1182               (python-tests-look-at "(object): # A")))
1183    (should (= (save-excursion (python-nav-forward-defun))
1184               (python-tests-look-at "(self): # a")))
1185    (should (= (save-excursion (python-nav-forward-defun))
1186               (python-tests-look-at "(self): # b")))
1187    (should (= (save-excursion (python-nav-forward-defun))
1188               (python-tests-look-at "(object): # B")))
1189    (should (= (save-excursion (python-nav-forward-defun))
1190               (python-tests-look-at "(object): # C")))
1191    (should (= (save-excursion (python-nav-forward-defun))
1192               (python-tests-look-at "(self): # d")))
1193    (should (= (save-excursion (python-nav-forward-defun))
1194               (python-tests-look-at "(self): # c")))
1195    (should (not (python-nav-forward-defun)))))
1196
1197 (ert-deftest python-nav-forward-defun-2 ()
1198   (python-tests-with-temp-buffer
1199    "
1200 def decoratorFunctionWithArguments(arg1, arg2, arg3):
1201     '''print decorated function call data to stdout.
1202
1203     Usage:
1204
1205     @decoratorFunctionWithArguments('arg1', 'arg2')
1206     def func(a, b, c=True):
1207         pass
1208     '''
1209
1210     def wwrap(f):
1211         print 'Inside wwrap()'
1212         def wrapped_f(*args):
1213             print 'Inside wrapped_f()'
1214             print 'Decorator arguments:', arg1, arg2, arg3
1215             f(*args)
1216             print 'After f(*args)'
1217         return wrapped_f
1218     return wwrap
1219 "
1220    (goto-char (point-min))
1221    (should (= (save-excursion (python-nav-forward-defun))
1222               (python-tests-look-at "(arg1, arg2, arg3):")))
1223    (should (= (save-excursion (python-nav-forward-defun))
1224               (python-tests-look-at "(f):")))
1225    (should (= (save-excursion (python-nav-forward-defun))
1226               (python-tests-look-at "(*args):")))
1227    (should (not (python-nav-forward-defun)))))
1228
1229 (ert-deftest python-nav-forward-defun-3 ()
1230   (python-tests-with-temp-buffer
1231    "
1232 class A(object):
1233     pass
1234
1235 '''
1236     def u(self):
1237         pass
1238
1239     def v(self):
1240         pass
1241
1242     def w(self):
1243         pass
1244 '''
1245 "
1246    (goto-char (point-min))
1247    (let ((point (python-tests-look-at "(object):")))
1248      (should (not (python-nav-forward-defun)))
1249      (should (= point (point))))))
1250
1251 (ert-deftest python-nav-beginning-of-statement-1 ()
1252   (python-tests-with-temp-buffer
1253    "
1254 v1 = 123 + \
1255      456 + \
1256      789
1257 v2 = (value1,
1258       value2,
1259
1260       value3,
1261       value4)
1262 v3 = ('this is a string'
1263
1264       'that is continued'
1265       'between lines'
1266       'within a paren',
1267       # this is a comment, yo
1268       'continue previous line')
1269 v4 = '''
1270 a very long
1271 string
1272 '''
1273 "
1274    (python-tests-look-at "v2 =")
1275    (python-util-forward-comment -1)
1276    (should (= (save-excursion
1277                 (python-nav-beginning-of-statement)
1278                 (point))
1279               (python-tests-look-at "v1 =" -1 t)))
1280    (python-tests-look-at "v3 =")
1281    (python-util-forward-comment -1)
1282    (should (= (save-excursion
1283                 (python-nav-beginning-of-statement)
1284                 (point))
1285               (python-tests-look-at "v2 =" -1 t)))
1286    (python-tests-look-at "v4 =")
1287    (python-util-forward-comment -1)
1288    (should (= (save-excursion
1289                 (python-nav-beginning-of-statement)
1290                 (point))
1291               (python-tests-look-at "v3 =" -1 t)))
1292    (goto-char (point-max))
1293    (python-util-forward-comment -1)
1294    (should (= (save-excursion
1295                 (python-nav-beginning-of-statement)
1296                 (point))
1297               (python-tests-look-at "v4 =" -1 t)))))
1298
1299 (ert-deftest python-nav-end-of-statement-1 ()
1300   (python-tests-with-temp-buffer
1301    "
1302 v1 = 123 + \
1303      456 + \
1304      789
1305 v2 = (value1,
1306       value2,
1307
1308       value3,
1309       value4)
1310 v3 = ('this is a string'
1311
1312       'that is continued'
1313       'between lines'
1314       'within a paren',
1315       # this is a comment, yo
1316       'continue previous line')
1317 v4 = '''
1318 a very long
1319 string
1320 '''
1321 "
1322    (python-tests-look-at "v1 =")
1323    (should (= (save-excursion
1324                 (python-nav-end-of-statement)
1325                 (point))
1326               (save-excursion
1327                 (python-tests-look-at "789")
1328                 (line-end-position))))
1329    (python-tests-look-at "v2 =")
1330    (should (= (save-excursion
1331                 (python-nav-end-of-statement)
1332                 (point))
1333               (save-excursion
1334                 (python-tests-look-at "value4)")
1335                 (line-end-position))))
1336    (python-tests-look-at "v3 =")
1337    (should (= (save-excursion
1338                 (python-nav-end-of-statement)
1339                 (point))
1340               (save-excursion
1341                 (python-tests-look-at
1342                  "'continue previous line')")
1343                 (line-end-position))))
1344    (python-tests-look-at "v4 =")
1345    (should (= (save-excursion
1346                 (python-nav-end-of-statement)
1347                 (point))
1348               (save-excursion
1349                 (goto-char (point-max))
1350                 (python-util-forward-comment -1)
1351                 (point))))))
1352
1353 (ert-deftest python-nav-forward-statement-1 ()
1354   (python-tests-with-temp-buffer
1355    "
1356 v1 = 123 + \
1357      456 + \
1358      789
1359 v2 = (value1,
1360       value2,
1361
1362       value3,
1363       value4)
1364 v3 = ('this is a string'
1365
1366       'that is continued'
1367       'between lines'
1368       'within a paren',
1369       # this is a comment, yo
1370       'continue previous line')
1371 v4 = '''
1372 a very long
1373 string
1374 '''
1375 "
1376    (python-tests-look-at "v1 =")
1377    (should (= (save-excursion
1378                 (python-nav-forward-statement)
1379                 (point))
1380               (python-tests-look-at "v2 =")))
1381    (should (= (save-excursion
1382                 (python-nav-forward-statement)
1383                 (point))
1384               (python-tests-look-at "v3 =")))
1385    (should (= (save-excursion
1386                 (python-nav-forward-statement)
1387                 (point))
1388               (python-tests-look-at "v4 =")))
1389    (should (= (save-excursion
1390                 (python-nav-forward-statement)
1391                 (point))
1392               (point-max)))))
1393
1394 (ert-deftest python-nav-backward-statement-1 ()
1395   (python-tests-with-temp-buffer
1396    "
1397 v1 = 123 + \
1398      456 + \
1399      789
1400 v2 = (value1,
1401       value2,
1402
1403       value3,
1404       value4)
1405 v3 = ('this is a string'
1406
1407       'that is continued'
1408       'between lines'
1409       'within a paren',
1410       # this is a comment, yo
1411       'continue previous line')
1412 v4 = '''
1413 a very long
1414 string
1415 '''
1416 "
1417    (goto-char (point-max))
1418    (should (= (save-excursion
1419                 (python-nav-backward-statement)
1420                 (point))
1421               (python-tests-look-at "v4 =" -1)))
1422    (should (= (save-excursion
1423                 (python-nav-backward-statement)
1424                 (point))
1425               (python-tests-look-at "v3 =" -1)))
1426    (should (= (save-excursion
1427                 (python-nav-backward-statement)
1428                 (point))
1429               (python-tests-look-at "v2 =" -1)))
1430    (should (= (save-excursion
1431                 (python-nav-backward-statement)
1432                 (point))
1433               (python-tests-look-at "v1 =" -1)))))
1434
1435 (ert-deftest python-nav-backward-statement-2 ()
1436   :expected-result :failed
1437   (python-tests-with-temp-buffer
1438    "
1439 v1 = 123 + \
1440      456 + \
1441      789
1442 v2 = (value1,
1443       value2,
1444
1445       value3,
1446       value4)
1447 "
1448    ;; FIXME: For some reason `python-nav-backward-statement' is moving
1449    ;; back two sentences when starting from 'value4)'.
1450    (goto-char (point-max))
1451    (python-util-forward-comment -1)
1452    (should (= (save-excursion
1453                 (python-nav-backward-statement)
1454                 (point))
1455               (python-tests-look-at "v2 =" -1 t)))))
1456
1457 (ert-deftest python-nav-beginning-of-block-1 ()
1458   (python-tests-with-temp-buffer
1459    "
1460 def decoratorFunctionWithArguments(arg1, arg2, arg3):
1461     '''print decorated function call data to stdout.
1462
1463     Usage:
1464
1465     @decoratorFunctionWithArguments('arg1', 'arg2')
1466     def func(a, b, c=True):
1467         pass
1468     '''
1469
1470     def wwrap(f):
1471         print 'Inside wwrap()'
1472         def wrapped_f(*args):
1473             print 'Inside wrapped_f()'
1474             print 'Decorator arguments:', arg1, arg2, arg3
1475             f(*args)
1476             print 'After f(*args)'
1477         return wrapped_f
1478     return wwrap
1479 "
1480    (python-tests-look-at "return wwrap")
1481    (should (= (save-excursion
1482                 (python-nav-beginning-of-block)
1483                 (point))
1484               (python-tests-look-at "def decoratorFunctionWithArguments" -1)))
1485    (python-tests-look-at "print 'Inside wwrap()'")
1486    (should (= (save-excursion
1487                 (python-nav-beginning-of-block)
1488                 (point))
1489               (python-tests-look-at "def wwrap(f):" -1)))
1490    (python-tests-look-at "print 'After f(*args)'")
1491    (end-of-line)
1492    (should (= (save-excursion
1493                 (python-nav-beginning-of-block)
1494                 (point))
1495               (python-tests-look-at "def wrapped_f(*args):" -1)))
1496    (python-tests-look-at "return wrapped_f")
1497    (should (= (save-excursion
1498                 (python-nav-beginning-of-block)
1499                 (point))
1500               (python-tests-look-at "def wwrap(f):" -1)))))
1501
1502 (ert-deftest python-nav-end-of-block-1 ()
1503   (python-tests-with-temp-buffer
1504    "
1505 def decoratorFunctionWithArguments(arg1, arg2, arg3):
1506     '''print decorated function call data to stdout.
1507
1508     Usage:
1509
1510     @decoratorFunctionWithArguments('arg1', 'arg2')
1511     def func(a, b, c=True):
1512         pass
1513     '''
1514
1515     def wwrap(f):
1516         print 'Inside wwrap()'
1517         def wrapped_f(*args):
1518             print 'Inside wrapped_f()'
1519             print 'Decorator arguments:', arg1, arg2, arg3
1520             f(*args)
1521             print 'After f(*args)'
1522         return wrapped_f
1523     return wwrap
1524 "
1525    (python-tests-look-at "def decoratorFunctionWithArguments")
1526    (should (= (save-excursion
1527                 (python-nav-end-of-block)
1528                 (point))
1529               (save-excursion
1530                 (goto-char (point-max))
1531                 (python-util-forward-comment -1)
1532                 (point))))
1533    (python-tests-look-at "def wwrap(f):")
1534    (should (= (save-excursion
1535                 (python-nav-end-of-block)
1536                 (point))
1537               (save-excursion
1538                 (python-tests-look-at "return wrapped_f")
1539                 (line-end-position))))
1540    (end-of-line)
1541    (should (= (save-excursion
1542                 (python-nav-end-of-block)
1543                 (point))
1544               (save-excursion
1545                 (python-tests-look-at "return wrapped_f")
1546                 (line-end-position))))
1547    (python-tests-look-at "f(*args)")
1548    (should (= (save-excursion
1549                 (python-nav-end-of-block)
1550                 (point))
1551               (save-excursion
1552                 (python-tests-look-at "print 'After f(*args)'")
1553                 (line-end-position))))))
1554
1555 (ert-deftest python-nav-forward-block-1 ()
1556   "This also accounts as a test for `python-nav-backward-block'."
1557   (python-tests-with-temp-buffer
1558    "
1559 if request.user.is_authenticated():
1560     # def block():
1561     #     pass
1562     try:
1563         profile = request.user.get_profile()
1564     except Profile.DoesNotExist:
1565         profile = Profile.objects.create(user=request.user)
1566     else:
1567         if profile.stats:
1568             profile.recalculate_stats()
1569         else:
1570             profile.clear_stats()
1571     finally:
1572         profile.views += 1
1573         profile.save()
1574 "
1575    (should (= (save-excursion (python-nav-forward-block))
1576               (python-tests-look-at "if request.user.is_authenticated():")))
1577    (should (= (save-excursion (python-nav-forward-block))
1578               (python-tests-look-at "try:")))
1579    (should (= (save-excursion (python-nav-forward-block))
1580               (python-tests-look-at "except Profile.DoesNotExist:")))
1581    (should (= (save-excursion (python-nav-forward-block))
1582               (python-tests-look-at "else:")))
1583    (should (= (save-excursion (python-nav-forward-block))
1584               (python-tests-look-at "if profile.stats:")))
1585    (should (= (save-excursion (python-nav-forward-block))
1586               (python-tests-look-at "else:")))
1587    (should (= (save-excursion (python-nav-forward-block))
1588               (python-tests-look-at "finally:")))
1589    ;; When point is at the last block, leave it there and return nil
1590    (should (not (save-excursion (python-nav-forward-block))))
1591    ;; Move backwards, and even if the number of moves is less than the
1592    ;; provided argument return the point.
1593    (should (= (save-excursion (python-nav-forward-block -10))
1594               (python-tests-look-at
1595                "if request.user.is_authenticated():" -1)))))
1596
1597 (ert-deftest python-nav-forward-sexp-1 ()
1598   (python-tests-with-temp-buffer
1599    "
1600 a()
1601 b()
1602 c()
1603 "
1604    (python-tests-look-at "a()")
1605    (python-nav-forward-sexp)
1606    (should (looking-at "$"))
1607    (should (save-excursion
1608              (beginning-of-line)
1609              (looking-at "a()")))
1610    (python-nav-forward-sexp)
1611    (should (looking-at "$"))
1612    (should (save-excursion
1613              (beginning-of-line)
1614              (looking-at "b()")))
1615    (python-nav-forward-sexp)
1616    (should (looking-at "$"))
1617    (should (save-excursion
1618              (beginning-of-line)
1619              (looking-at "c()")))
1620    ;; Movement next to a paren should do what lisp does and
1621    ;; unfortunately It can't change, because otherwise
1622    ;; `blink-matching-open' breaks.
1623    (python-nav-forward-sexp -1)
1624    (should (looking-at "()"))
1625    (should (save-excursion
1626              (beginning-of-line)
1627              (looking-at "c()")))
1628    (python-nav-forward-sexp -1)
1629    (should (looking-at "c()"))
1630    (python-nav-forward-sexp -1)
1631    (should (looking-at "b()"))
1632    (python-nav-forward-sexp -1)
1633    (should (looking-at "a()"))))
1634
1635 (ert-deftest python-nav-forward-sexp-2 ()
1636   (python-tests-with-temp-buffer
1637    "
1638 def func():
1639     if True:
1640         aaa = bbb
1641         ccc = ddd
1642         eee = fff
1643     return ggg
1644 "
1645    (python-tests-look-at "aa =")
1646    (python-nav-forward-sexp)
1647    (should (looking-at " = bbb"))
1648    (python-nav-forward-sexp)
1649    (should (looking-at "$"))
1650    (should (save-excursion
1651              (back-to-indentation)
1652              (looking-at "aaa = bbb")))
1653    (python-nav-forward-sexp)
1654    (should (looking-at "$"))
1655    (should (save-excursion
1656              (back-to-indentation)
1657              (looking-at "ccc = ddd")))
1658    (python-nav-forward-sexp)
1659    (should (looking-at "$"))
1660    (should (save-excursion
1661              (back-to-indentation)
1662              (looking-at "eee = fff")))
1663    (python-nav-forward-sexp)
1664    (should (looking-at "$"))
1665    (should (save-excursion
1666              (back-to-indentation)
1667              (looking-at "return ggg")))
1668    (python-nav-forward-sexp -1)
1669    (should (looking-at "def func():"))))
1670
1671 (ert-deftest python-nav-forward-sexp-3 ()
1672   (python-tests-with-temp-buffer
1673    "
1674 from some_module import some_sub_module
1675 from another_module import another_sub_module
1676
1677 def another_statement():
1678     pass
1679 "
1680    (python-tests-look-at "some_module")
1681    (python-nav-forward-sexp)
1682    (should (looking-at " import"))
1683    (python-nav-forward-sexp)
1684    (should (looking-at " some_sub_module"))
1685    (python-nav-forward-sexp)
1686    (should (looking-at "$"))
1687    (should
1688     (save-excursion
1689       (back-to-indentation)
1690       (looking-at
1691        "from some_module import some_sub_module")))
1692    (python-nav-forward-sexp)
1693    (should (looking-at "$"))
1694    (should
1695     (save-excursion
1696       (back-to-indentation)
1697       (looking-at
1698        "from another_module import another_sub_module")))
1699    (python-nav-forward-sexp)
1700    (should (looking-at "$"))
1701    (should
1702     (save-excursion
1703       (back-to-indentation)
1704       (looking-at
1705        "pass")))
1706    (python-nav-forward-sexp -1)
1707    (should (looking-at "def another_statement():"))
1708    (python-nav-forward-sexp -1)
1709    (should (looking-at "from another_module import another_sub_module"))
1710    (python-nav-forward-sexp -1)
1711    (should (looking-at "from some_module import some_sub_module"))))
1712
1713 (ert-deftest python-nav-forward-sexp-safe-1 ()
1714   (python-tests-with-temp-buffer
1715    "
1716 profile = Profile.objects.create(user=request.user)
1717 profile.notify()
1718 "
1719    (python-tests-look-at "profile =")
1720    (python-nav-forward-sexp-safe 1)
1721    (should (looking-at "$"))
1722    (beginning-of-line 1)
1723    (python-tests-look-at "user=request.user")
1724    (python-nav-forward-sexp-safe -1)
1725    (should (looking-at "(user=request.user)"))
1726    (python-nav-forward-sexp-safe -4)
1727    (should (looking-at "profile ="))
1728    (python-tests-look-at "user=request.user")
1729    (python-nav-forward-sexp-safe 3)
1730    (should (looking-at ")"))
1731    (python-nav-forward-sexp-safe 1)
1732    (should (looking-at "$"))
1733    (python-nav-forward-sexp-safe 1)
1734    (should (looking-at "$"))))
1735
1736 (ert-deftest python-nav-up-list-1 ()
1737   (python-tests-with-temp-buffer
1738    "
1739 def f():
1740     if True:
1741         return [i for i in range(3)]
1742 "
1743    (python-tests-look-at "3)]")
1744    (python-nav-up-list)
1745    (should (looking-at "]"))
1746    (python-nav-up-list)
1747    (should (looking-at "$"))))
1748
1749 (ert-deftest python-nav-backward-up-list-1 ()
1750   :expected-result :failed
1751   (python-tests-with-temp-buffer
1752    "
1753 def f():
1754     if True:
1755         return [i for i in range(3)]
1756 "
1757    (python-tests-look-at "3)]")
1758    (python-nav-backward-up-list)
1759    (should (looking-at "(3)\\]"))
1760    (python-nav-backward-up-list)
1761    (should (looking-at
1762             "\\[i for i in range(3)\\]"))
1763    ;; FIXME: Need to move to beginning-of-statement.
1764    (python-nav-backward-up-list)
1765    (should (looking-at
1766             "return \\[i for i in range(3)\\]"))
1767    (python-nav-backward-up-list)
1768    (should (looking-at "if True:"))
1769    (python-nav-backward-up-list)
1770    (should (looking-at "def f():"))))
1771
1772 \f
1773 ;;; Shell integration
1774
1775 (defvar python-tests-shell-interpreter "python")
1776
1777 (ert-deftest python-shell-get-process-name-1 ()
1778   "Check process name calculation on different scenarios."
1779   (python-tests-with-temp-buffer
1780       ""
1781     (should (string= (python-shell-get-process-name nil)
1782                      python-shell-buffer-name))
1783     ;; When the `current-buffer' doesn't have `buffer-file-name', even
1784     ;; if dedicated flag is non-nil should not include its name.
1785     (should (string= (python-shell-get-process-name t)
1786                      python-shell-buffer-name)))
1787   (python-tests-with-temp-file
1788       ""
1789     ;; `buffer-file-name' is non-nil but the dedicated flag is nil and
1790     ;; should be respected.
1791     (should (string= (python-shell-get-process-name nil)
1792                      python-shell-buffer-name))
1793     (should (string=
1794              (python-shell-get-process-name t)
1795              (format "%s[%s]" python-shell-buffer-name buffer-file-name)))))
1796
1797 (ert-deftest python-shell-internal-get-process-name-1 ()
1798   "Check the internal process name is config-unique."
1799   (let* ((python-shell-interpreter python-tests-shell-interpreter)
1800          (python-shell-interpreter-args "")
1801          (python-shell-prompt-regexp ">>> ")
1802          (python-shell-prompt-block-regexp "[.][.][.] ")
1803          (python-shell-setup-codes "")
1804          (python-shell-process-environment "")
1805          (python-shell-extra-pythonpaths "")
1806          (python-shell-exec-path "")
1807          (python-shell-virtualenv-path "")
1808          (expected (python-tests-with-temp-buffer
1809                        "" (python-shell-internal-get-process-name))))
1810     ;; Same configurations should match.
1811     (should
1812      (string= expected
1813               (python-tests-with-temp-buffer
1814                   "" (python-shell-internal-get-process-name))))
1815     (let ((python-shell-interpreter-args "-B"))
1816       ;; A minimal change should generate different names.
1817       (should
1818        (not (string=
1819              expected
1820              (python-tests-with-temp-buffer
1821                  "" (python-shell-internal-get-process-name))))))))
1822
1823 (ert-deftest python-shell-parse-command-1 ()
1824   "Check the command to execute is calculated correctly.
1825 Using `python-shell-interpreter' and
1826 `python-shell-interpreter-args'."
1827   (skip-unless (executable-find python-tests-shell-interpreter))
1828   (let ((python-shell-interpreter (executable-find
1829                                    python-tests-shell-interpreter))
1830         (python-shell-interpreter-args "-B"))
1831     (should (string=
1832              (format "%s %s"
1833                      python-shell-interpreter
1834                      python-shell-interpreter-args)
1835              (python-shell-parse-command)))))
1836
1837 (ert-deftest python-shell-calculate-process-environment-1 ()
1838   "Test `python-shell-process-environment' modification."
1839   (let* ((python-shell-process-environment
1840           '("TESTVAR1=value1" "TESTVAR2=value2"))
1841          (process-environment
1842           (python-shell-calculate-process-environment)))
1843     (should (equal (getenv "TESTVAR1") "value1"))
1844     (should (equal (getenv "TESTVAR2") "value2"))))
1845
1846 (ert-deftest python-shell-calculate-process-environment-2 ()
1847   "Test `python-shell-extra-pythonpaths' modification."
1848   (let* ((process-environment process-environment)
1849          (original-pythonpath (setenv "PYTHONPATH" "path3"))
1850          (paths '("path1" "path2"))
1851          (python-shell-extra-pythonpaths paths)
1852          (process-environment
1853           (python-shell-calculate-process-environment)))
1854     (should (equal (getenv "PYTHONPATH")
1855                    (concat
1856                     (mapconcat 'identity paths path-separator)
1857                     path-separator original-pythonpath)))))
1858
1859 (ert-deftest python-shell-calculate-process-environment-3 ()
1860   "Test `python-shell-virtualenv-path' modification."
1861   (let* ((original-path (or (getenv "PATH") ""))
1862          (python-shell-virtualenv-path
1863           (directory-file-name user-emacs-directory))
1864          (process-environment
1865           (python-shell-calculate-process-environment)))
1866     (should (not (getenv "PYTHONHOME")))
1867     (should (string= (getenv "VIRTUAL_ENV") python-shell-virtualenv-path))
1868     (should (equal (getenv "PATH")
1869                    (format "%s/bin%s%s"
1870                            python-shell-virtualenv-path
1871                            path-separator original-path)))))
1872
1873 (ert-deftest python-shell-calculate-process-environment-4 ()
1874   "Test `python-shell-unbuffered' modification."
1875   (setenv "PYTHONUNBUFFERED")
1876   (let* ((process-environment
1877           (python-shell-calculate-process-environment)))
1878     ;; Defaults to t
1879     (should python-shell-unbuffered)
1880     (should (string= (getenv "PYTHONUNBUFFERED") "1"))))
1881
1882 (ert-deftest python-shell-calculate-process-environment-5 ()
1883   (setenv "PYTHONUNBUFFERED")
1884   "Test `python-shell-unbuffered' modification."
1885   (let* ((python-shell-unbuffered nil)
1886          (process-environment
1887           (python-shell-calculate-process-environment)))
1888     (should (not (getenv "PYTHONUNBUFFERED")))))
1889
1890 (ert-deftest python-shell-calculate-exec-path-1 ()
1891   "Test `python-shell-exec-path' modification."
1892   (let* ((original-exec-path exec-path)
1893          (python-shell-exec-path '("path1" "path2"))
1894          (exec-path (python-shell-calculate-exec-path)))
1895     (should (equal
1896              exec-path
1897              (append python-shell-exec-path
1898                      original-exec-path)))))
1899
1900 (ert-deftest python-shell-calculate-exec-path-2 ()
1901   "Test `python-shell-exec-path' modification."
1902   (let* ((original-exec-path exec-path)
1903          (python-shell-virtualenv-path
1904           (directory-file-name (expand-file-name user-emacs-directory)))
1905          (exec-path (python-shell-calculate-exec-path)))
1906     (should (equal
1907              exec-path
1908              (append (cons
1909                       (format "%s/bin" python-shell-virtualenv-path)
1910                       original-exec-path))))))
1911
1912 (ert-deftest python-shell-make-comint-1 ()
1913   "Check comint creation for global shell buffer."
1914   (skip-unless (executable-find python-tests-shell-interpreter))
1915   ;; The interpreter can get killed too quickly to allow it to clean
1916   ;; up the tempfiles that the default python-shell-setup-codes create,
1917   ;; so it leaves tempfiles behind, which is a minor irritation.
1918   (let* ((python-shell-setup-codes nil)
1919          (python-shell-interpreter
1920           (executable-find python-tests-shell-interpreter))
1921          (proc-name (python-shell-get-process-name nil))
1922          (shell-buffer
1923           (python-tests-with-temp-buffer
1924            "" (python-shell-make-comint
1925                (python-shell-parse-command) proc-name)))
1926          (process (get-buffer-process shell-buffer)))
1927     (unwind-protect
1928         (progn
1929           (set-process-query-on-exit-flag process nil)
1930           (should (process-live-p process))
1931           (with-current-buffer shell-buffer
1932             (should (eq major-mode 'inferior-python-mode))
1933             (should (string= (buffer-name) (format "*%s*" proc-name)))))
1934       (kill-buffer shell-buffer))))
1935
1936 (ert-deftest python-shell-make-comint-2 ()
1937   "Check comint creation for internal shell buffer."
1938   (skip-unless (executable-find python-tests-shell-interpreter))
1939   (let* ((python-shell-setup-codes nil)
1940          (python-shell-interpreter
1941           (executable-find python-tests-shell-interpreter))
1942          (proc-name (python-shell-internal-get-process-name))
1943          (shell-buffer
1944           (python-tests-with-temp-buffer
1945            "" (python-shell-make-comint
1946                (python-shell-parse-command) proc-name nil t)))
1947          (process (get-buffer-process shell-buffer)))
1948     (unwind-protect
1949         (progn
1950           (set-process-query-on-exit-flag process nil)
1951           (should (process-live-p process))
1952           (with-current-buffer shell-buffer
1953             (should (eq major-mode 'inferior-python-mode))
1954             (should (string= (buffer-name) (format " *%s*" proc-name)))))
1955       (kill-buffer shell-buffer))))
1956
1957 (ert-deftest python-shell-make-comint-3 ()
1958   "Check comint creation with overridden python interpreter and args.
1959 The command passed to `python-shell-make-comint' as argument must
1960 locally override global values set in `python-shell-interpreter'
1961 and `python-shell-interpreter-args' in the new shell buffer."
1962   (skip-unless (executable-find python-tests-shell-interpreter))
1963   (let* ((python-shell-setup-codes nil)
1964          (python-shell-interpreter "interpreter")
1965          (python-shell-interpreter-args "--some-args")
1966          (proc-name (python-shell-get-process-name nil))
1967          (interpreter-override
1968           (concat (executable-find python-tests-shell-interpreter) " " "-i"))
1969          (shell-buffer
1970           (python-tests-with-temp-buffer
1971            "" (python-shell-make-comint interpreter-override proc-name nil)))
1972          (process (get-buffer-process shell-buffer)))
1973     (unwind-protect
1974         (progn
1975           (set-process-query-on-exit-flag process nil)
1976           (should (process-live-p process))
1977           (with-current-buffer shell-buffer
1978             (should (eq major-mode 'inferior-python-mode))
1979             (should (file-equal-p
1980                      python-shell-interpreter
1981                      (executable-find python-tests-shell-interpreter)))
1982             (should (string= python-shell-interpreter-args "-i"))))
1983       (kill-buffer shell-buffer))))
1984
1985 (ert-deftest python-shell-make-comint-4 ()
1986   "Check shell calculated prompts regexps are set."
1987   (skip-unless (executable-find python-tests-shell-interpreter))
1988   (let* ((process-environment process-environment)
1989          (python-shell-setup-codes nil)
1990          (python-shell-interpreter
1991           (executable-find python-tests-shell-interpreter))
1992          (python-shell-interpreter-args "-i")
1993          (python-shell--prompt-calculated-input-regexp nil)
1994          (python-shell--prompt-calculated-output-regexp nil)
1995          (python-shell-prompt-detect-enabled t)
1996          (python-shell-prompt-input-regexps '("extralargeinputprompt" "sml"))
1997          (python-shell-prompt-output-regexps '("extralargeoutputprompt" "sml"))
1998          (python-shell-prompt-regexp "in")
1999          (python-shell-prompt-block-regexp "block")
2000          (python-shell-prompt-pdb-regexp "pdf")
2001          (python-shell-prompt-output-regexp "output")
2002          (startup-code (concat "import sys\n"
2003                                "sys.ps1 = 'py> '\n"
2004                                "sys.ps2 = '..> '\n"
2005                                "sys.ps3 = 'out '\n"))
2006          (startup-file (python-shell--save-temp-file startup-code))
2007          (proc-name (python-shell-get-process-name nil))
2008          (shell-buffer
2009           (progn
2010             (setenv "PYTHONSTARTUP" startup-file)
2011             (python-tests-with-temp-buffer
2012              "" (python-shell-make-comint
2013                  (python-shell-parse-command) proc-name nil))))
2014          (process (get-buffer-process shell-buffer)))
2015     (unwind-protect
2016         (progn
2017           (set-process-query-on-exit-flag process nil)
2018           (should (process-live-p process))
2019           (with-current-buffer shell-buffer
2020             (should (eq major-mode 'inferior-python-mode))
2021             (should (string=
2022                      python-shell--prompt-calculated-input-regexp
2023                      (concat "^\\(extralargeinputprompt\\|\\.\\.> \\|"
2024                              "block\\|py> \\|pdf\\|sml\\|in\\)")))
2025             (should (string=
2026                      python-shell--prompt-calculated-output-regexp
2027                      "^\\(extralargeoutputprompt\\|output\\|out \\|sml\\)"))))
2028       (delete-file startup-file)
2029       (kill-buffer shell-buffer))))
2030
2031 (ert-deftest python-shell-get-process-1 ()
2032   "Check dedicated shell process preference over global."
2033   (skip-unless (executable-find python-tests-shell-interpreter))
2034   (python-tests-with-temp-file
2035       ""
2036     (let* ((python-shell-setup-codes nil)
2037            (python-shell-interpreter
2038             (executable-find python-tests-shell-interpreter))
2039            (global-proc-name (python-shell-get-process-name nil))
2040            (dedicated-proc-name (python-shell-get-process-name t))
2041            (global-shell-buffer
2042             (python-shell-make-comint
2043              (python-shell-parse-command) global-proc-name))
2044            (dedicated-shell-buffer
2045             (python-shell-make-comint
2046              (python-shell-parse-command) dedicated-proc-name))
2047            (global-process (get-buffer-process global-shell-buffer))
2048            (dedicated-process (get-buffer-process dedicated-shell-buffer)))
2049       (unwind-protect
2050           (progn
2051             (set-process-query-on-exit-flag global-process nil)
2052             (set-process-query-on-exit-flag dedicated-process nil)
2053             ;; Prefer dedicated if global also exists.
2054             (should (equal (python-shell-get-process) dedicated-process))
2055             (kill-buffer dedicated-shell-buffer)
2056             ;; If there's only global, use it.
2057             (should (equal (python-shell-get-process) global-process))
2058             (kill-buffer global-shell-buffer)
2059             ;; No buffer available.
2060             (should (not (python-shell-get-process))))
2061         (ignore-errors (kill-buffer global-shell-buffer))
2062         (ignore-errors (kill-buffer dedicated-shell-buffer))))))
2063
2064 (ert-deftest python-shell-get-or-create-process-1 ()
2065   "Check shell dedicated process creation."
2066   (skip-unless (executable-find python-tests-shell-interpreter))
2067   (python-tests-with-temp-file
2068    ""
2069    (let* ((cmd
2070            (concat (executable-find python-tests-shell-interpreter) " -i"))
2071           (use-dialog-box)
2072           (dedicated-process-name (python-shell-get-process-name t))
2073           (dedicated-process (python-shell-get-or-create-process cmd t))
2074           (dedicated-shell-buffer (process-buffer dedicated-process)))
2075      (unwind-protect
2076          (progn
2077            (set-process-query-on-exit-flag dedicated-process nil)
2078            ;; should be dedicated.
2079            (should (equal (process-name dedicated-process)
2080                           dedicated-process-name))
2081            (kill-buffer dedicated-shell-buffer)
2082            ;; Check there are no processes for current buffer.
2083            (should (not (python-shell-get-process))))
2084        (ignore-errors (kill-buffer dedicated-shell-buffer))))))
2085
2086 (ert-deftest python-shell-get-or-create-process-2 ()
2087   "Check shell global process creation."
2088   (skip-unless (executable-find python-tests-shell-interpreter))
2089   (python-tests-with-temp-file
2090    ""
2091    (let* ((cmd
2092            (concat (executable-find python-tests-shell-interpreter) " -i"))
2093           (use-dialog-box)
2094           (process-name (python-shell-get-process-name nil))
2095           (process (python-shell-get-or-create-process cmd))
2096           (shell-buffer (process-buffer process)))
2097      (unwind-protect
2098          (progn
2099            (set-process-query-on-exit-flag process nil)
2100            ;; should be global.
2101            (should (equal (process-name process) process-name))
2102            (kill-buffer shell-buffer)
2103            ;; Check there are no processes for current buffer.
2104            (should (not (python-shell-get-process))))
2105        (ignore-errors (kill-buffer shell-buffer))))))
2106
2107 (ert-deftest python-shell-get-or-create-process-3 ()
2108   "Check shell dedicated/global process preference."
2109   (skip-unless (executable-find python-tests-shell-interpreter))
2110   (python-tests-with-temp-file
2111    ""
2112    (let* ((cmd
2113            (concat (executable-find python-tests-shell-interpreter) " -i"))
2114           (python-shell-interpreter python-tests-shell-interpreter)
2115           (use-dialog-box)
2116           (dedicated-process-name (python-shell-get-process-name t))
2117           (global-process)
2118           (dedicated-process))
2119      (progn
2120        ;; Create global process
2121        (run-python cmd nil)
2122        (setq global-process (get-buffer-process "*Python*"))
2123        (should global-process)
2124        (set-process-query-on-exit-flag global-process nil)
2125        ;; Create dedicated process
2126        (run-python cmd t)
2127        (setq dedicated-process (get-process dedicated-process-name))
2128        (should dedicated-process)
2129        (set-process-query-on-exit-flag dedicated-process nil)
2130        ;; Prefer dedicated.
2131        (should (equal (python-shell-get-or-create-process)
2132                       dedicated-process))
2133        ;; Kill the dedicated so the global takes over.
2134        (kill-buffer (process-buffer dedicated-process))
2135        ;; Detect global.
2136        (should (equal (python-shell-get-or-create-process) global-process))
2137        ;; Kill the global.
2138        (kill-buffer (process-buffer global-process))
2139        ;; Check there are no processes for current buffer.
2140        (should (not (python-shell-get-process)))))))
2141
2142 (ert-deftest python-shell-internal-get-or-create-process-1 ()
2143   "Check internal shell process creation fallback."
2144   (skip-unless (executable-find python-tests-shell-interpreter))
2145   (python-tests-with-temp-file
2146    ""
2147    (should (not (process-live-p (python-shell-internal-get-process-name))))
2148    (let* ((python-shell-interpreter
2149            (executable-find python-tests-shell-interpreter))
2150           (internal-process-name (python-shell-internal-get-process-name))
2151           (internal-process (python-shell-internal-get-or-create-process))
2152           (internal-shell-buffer (process-buffer internal-process)))
2153      (unwind-protect
2154          (progn
2155            (set-process-query-on-exit-flag internal-process nil)
2156            (should (equal (process-name internal-process)
2157                           internal-process-name))
2158            (should (equal internal-process
2159                           (python-shell-internal-get-or-create-process)))
2160            ;; Assert the internal process is not a user process
2161            (should (not (python-shell-get-process)))
2162            (kill-buffer internal-shell-buffer))
2163        (ignore-errors (kill-buffer internal-shell-buffer))))))
2164
2165 (ert-deftest python-shell-prompt-detect-1 ()
2166   "Check prompt autodetection."
2167   (skip-unless (executable-find python-tests-shell-interpreter))
2168   (let ((process-environment process-environment))
2169     ;; Ensure no startup file is enabled
2170     (setenv "PYTHONSTARTUP" "")
2171     (should python-shell-prompt-detect-enabled)
2172     (should (equal (python-shell-prompt-detect) '(">>> " "... " "")))))
2173
2174 (ert-deftest python-shell-prompt-detect-2 ()
2175   "Check prompt autodetection with startup file.  Bug#17370."
2176   (skip-unless (executable-find python-tests-shell-interpreter))
2177   (let* ((process-environment process-environment)
2178          (startup-code (concat "import sys\n"
2179                                "sys.ps1 = 'py> '\n"
2180                                "sys.ps2 = '..> '\n"
2181                                "sys.ps3 = 'out '\n"))
2182          (startup-file (python-shell--save-temp-file startup-code)))
2183     (unwind-protect
2184         (progn
2185           ;; Ensure startup file is enabled
2186           (setenv "PYTHONSTARTUP" startup-file)
2187           (should python-shell-prompt-detect-enabled)
2188           (should (equal (python-shell-prompt-detect) '("py> " "..> " "out "))))
2189       (ignore-errors (delete-file startup-file)))))
2190
2191 (ert-deftest python-shell-prompt-detect-3 ()
2192   "Check prompts are not autodetected when feature is disabled."
2193   (skip-unless (executable-find python-tests-shell-interpreter))
2194   (let ((process-environment process-environment)
2195         (python-shell-prompt-detect-enabled nil))
2196     ;; Ensure no startup file is enabled
2197     (should (not python-shell-prompt-detect-enabled))
2198     (should (not (python-shell-prompt-detect)))))
2199
2200 (ert-deftest python-shell-prompt-detect-4 ()
2201   "Check warning is shown when detection fails."
2202   (skip-unless (executable-find python-tests-shell-interpreter))
2203   (let* ((process-environment process-environment)
2204          ;; Trigger failure by removing prompts in the startup file
2205          (startup-code (concat "import sys\n"
2206                                "sys.ps1 = ''\n"
2207                                "sys.ps2 = ''\n"
2208                                "sys.ps3 = ''\n"))
2209          (startup-file (python-shell--save-temp-file startup-code)))
2210     (unwind-protect
2211         (progn
2212           (kill-buffer (get-buffer-create "*Warnings*"))
2213           (should (not (get-buffer "*Warnings*")))
2214           (setenv "PYTHONSTARTUP" startup-file)
2215           (should python-shell-prompt-detect-failure-warning)
2216           (should python-shell-prompt-detect-enabled)
2217           (should (not (python-shell-prompt-detect)))
2218           (should (get-buffer "*Warnings*")))
2219       (ignore-errors (delete-file startup-file)))))
2220
2221 (ert-deftest python-shell-prompt-detect-5 ()
2222   "Check disabled warnings are not shown when detection fails."
2223   (skip-unless (executable-find python-tests-shell-interpreter))
2224   (let* ((process-environment process-environment)
2225          (startup-code (concat "import sys\n"
2226                                "sys.ps1 = ''\n"
2227                                "sys.ps2 = ''\n"
2228                                "sys.ps3 = ''\n"))
2229          (startup-file (python-shell--save-temp-file startup-code))
2230          (python-shell-prompt-detect-failure-warning nil))
2231     (unwind-protect
2232         (progn
2233           (kill-buffer (get-buffer-create "*Warnings*"))
2234           (should (not (get-buffer "*Warnings*")))
2235           (setenv "PYTHONSTARTUP" startup-file)
2236           (should (not python-shell-prompt-detect-failure-warning))
2237           (should python-shell-prompt-detect-enabled)
2238           (should (not (python-shell-prompt-detect)))
2239           (should (not (get-buffer "*Warnings*"))))
2240       (ignore-errors (delete-file startup-file)))))
2241
2242 (ert-deftest python-shell-prompt-detect-6 ()
2243   "Warnings are not shown when detection is disabled."
2244   (skip-unless (executable-find python-tests-shell-interpreter))
2245   (let* ((process-environment process-environment)
2246          (startup-code (concat "import sys\n"
2247                                "sys.ps1 = ''\n"
2248                                "sys.ps2 = ''\n"
2249                                "sys.ps3 = ''\n"))
2250          (startup-file (python-shell--save-temp-file startup-code))
2251          (python-shell-prompt-detect-failure-warning t)
2252          (python-shell-prompt-detect-enabled nil))
2253     (unwind-protect
2254         (progn
2255           (kill-buffer (get-buffer-create "*Warnings*"))
2256           (should (not (get-buffer "*Warnings*")))
2257           (setenv "PYTHONSTARTUP" startup-file)
2258           (should python-shell-prompt-detect-failure-warning)
2259           (should (not python-shell-prompt-detect-enabled))
2260           (should (not (python-shell-prompt-detect)))
2261           (should (not (get-buffer "*Warnings*"))))
2262       (ignore-errors (delete-file startup-file)))))
2263
2264 (ert-deftest python-shell-prompt-validate-regexps-1 ()
2265   "Check `python-shell-prompt-input-regexps' are validated."
2266   (let* ((python-shell-prompt-input-regexps '("\\("))
2267          (error-data (should-error (python-shell-prompt-validate-regexps)
2268                                    :type 'user-error)))
2269     (should
2270      (string= (cadr error-data)
2271               "Invalid regexp \\( in `python-shell-prompt-input-regexps'"))))
2272
2273 (ert-deftest python-shell-prompt-validate-regexps-2 ()
2274   "Check `python-shell-prompt-output-regexps' are validated."
2275   (let* ((python-shell-prompt-output-regexps '("\\("))
2276          (error-data (should-error (python-shell-prompt-validate-regexps)
2277                                    :type 'user-error)))
2278     (should
2279      (string= (cadr error-data)
2280               "Invalid regexp \\( in `python-shell-prompt-output-regexps'"))))
2281
2282 (ert-deftest python-shell-prompt-validate-regexps-3 ()
2283   "Check `python-shell-prompt-regexp' is validated."
2284   (let* ((python-shell-prompt-regexp "\\(")
2285          (error-data (should-error (python-shell-prompt-validate-regexps)
2286                                    :type 'user-error)))
2287     (should
2288      (string= (cadr error-data)
2289               "Invalid regexp \\( in `python-shell-prompt-regexp'"))))
2290
2291 (ert-deftest python-shell-prompt-validate-regexps-4 ()
2292   "Check `python-shell-prompt-block-regexp' is validated."
2293   (let* ((python-shell-prompt-block-regexp "\\(")
2294          (error-data (should-error (python-shell-prompt-validate-regexps)
2295                                    :type 'user-error)))
2296     (should
2297      (string= (cadr error-data)
2298               "Invalid regexp \\( in `python-shell-prompt-block-regexp'"))))
2299
2300 (ert-deftest python-shell-prompt-validate-regexps-5 ()
2301   "Check `python-shell-prompt-pdb-regexp' is validated."
2302   (let* ((python-shell-prompt-pdb-regexp "\\(")
2303          (error-data (should-error (python-shell-prompt-validate-regexps)
2304                                    :type 'user-error)))
2305     (should
2306      (string= (cadr error-data)
2307               "Invalid regexp \\( in `python-shell-prompt-pdb-regexp'"))))
2308
2309 (ert-deftest python-shell-prompt-validate-regexps-6 ()
2310   "Check `python-shell-prompt-output-regexp' is validated."
2311   (let* ((python-shell-prompt-output-regexp "\\(")
2312          (error-data (should-error (python-shell-prompt-validate-regexps)
2313                                    :type 'user-error)))
2314     (should
2315      (string= (cadr error-data)
2316               "Invalid regexp \\( in `python-shell-prompt-output-regexp'"))))
2317
2318 (ert-deftest python-shell-prompt-validate-regexps-7 ()
2319   "Check default regexps are valid."
2320   ;; should not signal error
2321   (python-shell-prompt-validate-regexps))
2322
2323 (ert-deftest python-shell-prompt-set-calculated-regexps-1 ()
2324   "Check regexps are validated."
2325   (let* ((python-shell-prompt-output-regexp '("\\("))
2326          (python-shell--prompt-calculated-input-regexp nil)
2327          (python-shell--prompt-calculated-output-regexp nil)
2328          (python-shell-prompt-detect-enabled nil)
2329          (error-data (should-error (python-shell-prompt-set-calculated-regexps)
2330                                    :type 'user-error)))
2331     (should
2332      (string= (cadr error-data)
2333               "Invalid regexp \\( in `python-shell-prompt-output-regexp'"))))
2334
2335 (ert-deftest python-shell-prompt-set-calculated-regexps-2 ()
2336   "Check `python-shell-prompt-input-regexps' are set."
2337   (let* ((python-shell-prompt-input-regexps '("my" "prompt"))
2338          (python-shell-prompt-output-regexps '(""))
2339          (python-shell-prompt-regexp "")
2340          (python-shell-prompt-block-regexp "")
2341          (python-shell-prompt-pdb-regexp "")
2342          (python-shell-prompt-output-regexp "")
2343          (python-shell--prompt-calculated-input-regexp nil)
2344          (python-shell--prompt-calculated-output-regexp nil)
2345          (python-shell-prompt-detect-enabled nil))
2346     (python-shell-prompt-set-calculated-regexps)
2347     (should (string= python-shell--prompt-calculated-input-regexp
2348                      "^\\(prompt\\|my\\|\\)"))))
2349
2350 (ert-deftest python-shell-prompt-set-calculated-regexps-3 ()
2351   "Check `python-shell-prompt-output-regexps' are set."
2352   (let* ((python-shell-prompt-input-regexps '(""))
2353          (python-shell-prompt-output-regexps '("my" "prompt"))
2354          (python-shell-prompt-regexp "")
2355          (python-shell-prompt-block-regexp "")
2356          (python-shell-prompt-pdb-regexp "")
2357          (python-shell-prompt-output-regexp "")
2358          (python-shell--prompt-calculated-input-regexp nil)
2359          (python-shell--prompt-calculated-output-regexp nil)
2360          (python-shell-prompt-detect-enabled nil))
2361     (python-shell-prompt-set-calculated-regexps)
2362     (should (string= python-shell--prompt-calculated-output-regexp
2363                      "^\\(prompt\\|my\\|\\)"))))
2364
2365 (ert-deftest python-shell-prompt-set-calculated-regexps-4 ()
2366   "Check user defined prompts are set."
2367   (let* ((python-shell-prompt-input-regexps '(""))
2368          (python-shell-prompt-output-regexps '(""))
2369          (python-shell-prompt-regexp "prompt")
2370          (python-shell-prompt-block-regexp "block")
2371          (python-shell-prompt-pdb-regexp "pdb")
2372          (python-shell-prompt-output-regexp "output")
2373          (python-shell--prompt-calculated-input-regexp nil)
2374          (python-shell--prompt-calculated-output-regexp nil)
2375          (python-shell-prompt-detect-enabled nil))
2376     (python-shell-prompt-set-calculated-regexps)
2377     (should (string= python-shell--prompt-calculated-input-regexp
2378                      "^\\(prompt\\|block\\|pdb\\|\\)"))
2379     (should (string= python-shell--prompt-calculated-output-regexp
2380                      "^\\(output\\|\\)"))))
2381
2382 (ert-deftest python-shell-prompt-set-calculated-regexps-5 ()
2383   "Check order of regexps (larger first)."
2384   (let* ((python-shell-prompt-input-regexps '("extralargeinputprompt" "sml"))
2385          (python-shell-prompt-output-regexps '("extralargeoutputprompt" "sml"))
2386          (python-shell-prompt-regexp "in")
2387          (python-shell-prompt-block-regexp "block")
2388          (python-shell-prompt-pdb-regexp "pdf")
2389          (python-shell-prompt-output-regexp "output")
2390          (python-shell--prompt-calculated-input-regexp nil)
2391          (python-shell--prompt-calculated-output-regexp nil)
2392          (python-shell-prompt-detect-enabled nil))
2393     (python-shell-prompt-set-calculated-regexps)
2394     (should (string= python-shell--prompt-calculated-input-regexp
2395                      "^\\(extralargeinputprompt\\|block\\|pdf\\|sml\\|in\\)"))
2396     (should (string= python-shell--prompt-calculated-output-regexp
2397                      "^\\(extralargeoutputprompt\\|output\\|sml\\)"))))
2398
2399 (ert-deftest python-shell-prompt-set-calculated-regexps-6 ()
2400   "Check detected prompts are included `regexp-quote'd."
2401   (skip-unless (executable-find python-tests-shell-interpreter))
2402   (let* ((python-shell-prompt-input-regexps '(""))
2403          (python-shell-prompt-output-regexps '(""))
2404          (python-shell-prompt-regexp "")
2405          (python-shell-prompt-block-regexp "")
2406          (python-shell-prompt-pdb-regexp "")
2407          (python-shell-prompt-output-regexp "")
2408          (python-shell--prompt-calculated-input-regexp nil)
2409          (python-shell--prompt-calculated-output-regexp nil)
2410          (python-shell-prompt-detect-enabled t)
2411          (process-environment process-environment)
2412          (startup-code (concat "import sys\n"
2413                                "sys.ps1 = 'p.> '\n"
2414                                "sys.ps2 = '..> '\n"
2415                                "sys.ps3 = 'o.t '\n"))
2416          (startup-file (python-shell--save-temp-file startup-code)))
2417     (unwind-protect
2418         (progn
2419           (setenv "PYTHONSTARTUP" startup-file)
2420           (python-shell-prompt-set-calculated-regexps)
2421           (should (string= python-shell--prompt-calculated-input-regexp
2422                            "^\\(\\.\\.> \\|p\\.> \\|\\)"))
2423           (should (string= python-shell--prompt-calculated-output-regexp
2424                            "^\\(o\\.t \\|\\)")))
2425       (ignore-errors (delete-file startup-file)))))
2426
2427 \f
2428 ;;; Shell completion
2429
2430 \f
2431 ;;; PDB Track integration
2432
2433 \f
2434 ;;; Symbol completion
2435
2436 \f
2437 ;;; Fill paragraph
2438
2439 \f
2440 ;;; Skeletons
2441
2442 \f
2443 ;;; FFAP
2444
2445 \f
2446 ;;; Code check
2447
2448 \f
2449 ;;; Eldoc
2450
2451 \f
2452 ;;; Imenu
2453
2454 (ert-deftest python-imenu-create-index-1 ()
2455   (python-tests-with-temp-buffer
2456    "
2457 class Foo(models.Model):
2458     pass
2459
2460
2461 class Bar(models.Model):
2462     pass
2463
2464
2465 def decorator(arg1, arg2, arg3):
2466     '''print decorated function call data to stdout.
2467
2468     Usage:
2469
2470     @decorator('arg1', 'arg2')
2471     def func(a, b, c=True):
2472         pass
2473     '''
2474
2475     def wrap(f):
2476         print ('wrap')
2477         def wrapped_f(*args):
2478             print ('wrapped_f')
2479             print ('Decorator arguments:', arg1, arg2, arg3)
2480             f(*args)
2481             print ('called f(*args)')
2482         return wrapped_f
2483     return wrap
2484
2485
2486 class Baz(object):
2487
2488     def a(self):
2489         pass
2490
2491     def b(self):
2492         pass
2493
2494     class Frob(object):
2495
2496         def c(self):
2497             pass
2498 "
2499    (goto-char (point-max))
2500    (should (equal
2501             (list
2502              (cons "Foo (class)" (copy-marker 2))
2503              (cons "Bar (class)" (copy-marker 38))
2504              (list
2505               "decorator (def)"
2506               (cons "*function definition*" (copy-marker 74))
2507               (list
2508                "wrap (def)"
2509                (cons "*function definition*" (copy-marker 254))
2510                (cons "wrapped_f (def)" (copy-marker 294))))
2511              (list
2512               "Baz (class)"
2513               (cons "*class definition*" (copy-marker 519))
2514               (cons "a (def)" (copy-marker 539))
2515               (cons "b (def)" (copy-marker 570))
2516               (list
2517                "Frob (class)"
2518                (cons "*class definition*" (copy-marker 601))
2519                (cons "c (def)" (copy-marker 626)))))
2520             (python-imenu-create-index)))))
2521
2522 (ert-deftest python-imenu-create-index-2 ()
2523   (python-tests-with-temp-buffer
2524    "
2525 class Foo(object):
2526     def foo(self):
2527         def foo1():
2528             pass
2529
2530     def foobar(self):
2531         pass
2532 "
2533    (goto-char (point-max))
2534    (should (equal
2535             (list
2536              (list
2537               "Foo (class)"
2538               (cons "*class definition*" (copy-marker 2))
2539               (list
2540                "foo (def)"
2541                (cons "*function definition*" (copy-marker 21))
2542                (cons "foo1 (def)" (copy-marker 40)))
2543               (cons "foobar (def)"  (copy-marker 78))))
2544             (python-imenu-create-index)))))
2545
2546 (ert-deftest python-imenu-create-index-3 ()
2547   (python-tests-with-temp-buffer
2548    "
2549 class Foo(object):
2550     def foo(self):
2551         def foo1():
2552             pass
2553         def foo2():
2554             pass
2555 "
2556    (goto-char (point-max))
2557    (should (equal
2558             (list
2559              (list
2560               "Foo (class)"
2561               (cons "*class definition*" (copy-marker 2))
2562               (list
2563                "foo (def)"
2564                (cons "*function definition*" (copy-marker 21))
2565                (cons "foo1 (def)" (copy-marker 40))
2566                (cons "foo2 (def)" (copy-marker 77)))))
2567             (python-imenu-create-index)))))
2568
2569 (ert-deftest python-imenu-create-index-4 ()
2570   (python-tests-with-temp-buffer
2571    "
2572 class Foo(object):
2573     class Bar(object):
2574         def __init__(self):
2575             pass
2576
2577         def __str__(self):
2578             pass
2579
2580     def __init__(self):
2581             pass
2582 "
2583    (goto-char (point-max))
2584    (should (equal
2585             (list
2586              (list
2587               "Foo (class)"
2588               (cons "*class definition*" (copy-marker 2))
2589               (list
2590                "Bar (class)"
2591                (cons "*class definition*" (copy-marker 21))
2592                (cons "__init__ (def)" (copy-marker 44))
2593                (cons "__str__ (def)" (copy-marker 90)))
2594               (cons "__init__ (def)" (copy-marker 135))))
2595             (python-imenu-create-index)))))
2596
2597 (ert-deftest python-imenu-create-flat-index-1 ()
2598   (python-tests-with-temp-buffer
2599    "
2600 class Foo(models.Model):
2601     pass
2602
2603
2604 class Bar(models.Model):
2605     pass
2606
2607
2608 def decorator(arg1, arg2, arg3):
2609     '''print decorated function call data to stdout.
2610
2611     Usage:
2612
2613     @decorator('arg1', 'arg2')
2614     def func(a, b, c=True):
2615         pass
2616     '''
2617
2618     def wrap(f):
2619         print ('wrap')
2620         def wrapped_f(*args):
2621             print ('wrapped_f')
2622             print ('Decorator arguments:', arg1, arg2, arg3)
2623             f(*args)
2624             print ('called f(*args)')
2625         return wrapped_f
2626     return wrap
2627
2628
2629 class Baz(object):
2630
2631     def a(self):
2632         pass
2633
2634     def b(self):
2635         pass
2636
2637     class Frob(object):
2638
2639         def c(self):
2640             pass
2641 "
2642    (goto-char (point-max))
2643    (should (equal
2644             (list (cons "Foo" (copy-marker 2))
2645                   (cons "Bar" (copy-marker 38))
2646                   (cons "decorator" (copy-marker 74))
2647                   (cons "decorator.wrap" (copy-marker 254))
2648                   (cons "decorator.wrap.wrapped_f" (copy-marker 294))
2649                   (cons "Baz" (copy-marker 519))
2650                   (cons "Baz.a" (copy-marker 539))
2651                   (cons "Baz.b" (copy-marker 570))
2652                   (cons "Baz.Frob" (copy-marker 601))
2653                   (cons "Baz.Frob.c" (copy-marker 626)))
2654             (python-imenu-create-flat-index)))))
2655
2656 (ert-deftest python-imenu-create-flat-index-2 ()
2657   (python-tests-with-temp-buffer
2658    "
2659 class Foo(object):
2660     class Bar(object):
2661         def __init__(self):
2662             pass
2663
2664         def __str__(self):
2665             pass
2666
2667     def __init__(self):
2668             pass
2669 "
2670    (goto-char (point-max))
2671    (should (equal
2672             (list
2673              (cons "Foo" (copy-marker 2))
2674              (cons "Foo.Bar" (copy-marker 21))
2675              (cons "Foo.Bar.__init__" (copy-marker 44))
2676              (cons "Foo.Bar.__str__" (copy-marker 90))
2677              (cons "Foo.__init__"  (copy-marker 135)))
2678             (python-imenu-create-flat-index)))))
2679
2680 \f
2681 ;;; Misc helpers
2682
2683 (ert-deftest python-info-current-defun-1 ()
2684   (python-tests-with-temp-buffer
2685    "
2686 def foo(a, b):
2687 "
2688    (forward-line 1)
2689    (should (string= "foo" (python-info-current-defun)))
2690    (should (string= "def foo" (python-info-current-defun t)))
2691    (forward-line 1)
2692    (should (not (python-info-current-defun)))
2693    (indent-for-tab-command)
2694    (should (string= "foo" (python-info-current-defun)))
2695    (should (string= "def foo" (python-info-current-defun t)))))
2696
2697 (ert-deftest python-info-current-defun-2 ()
2698   (python-tests-with-temp-buffer
2699    "
2700 class C(object):
2701
2702     def m(self):
2703         if True:
2704             return [i for i in range(3)]
2705         else:
2706             return []
2707
2708         def b():
2709             do_b()
2710
2711         def a():
2712             do_a()
2713
2714     def c(self):
2715         do_c()
2716 "
2717    (forward-line 1)
2718    (should (string= "C" (python-info-current-defun)))
2719    (should (string= "class C" (python-info-current-defun t)))
2720    (python-tests-look-at "return [i for ")
2721    (should (string= "C.m" (python-info-current-defun)))
2722    (should (string= "def C.m" (python-info-current-defun t)))
2723    (python-tests-look-at "def b():")
2724    (should (string= "C.m.b" (python-info-current-defun)))
2725    (should (string= "def C.m.b" (python-info-current-defun t)))
2726    (forward-line 2)
2727    (indent-for-tab-command)
2728    (python-indent-dedent-line-backspace 1)
2729    (should (string= "C.m" (python-info-current-defun)))
2730    (should (string= "def C.m" (python-info-current-defun t)))
2731    (python-tests-look-at "def c(self):")
2732    (forward-line -1)
2733    (indent-for-tab-command)
2734    (should (string= "C.m.a" (python-info-current-defun)))
2735    (should (string= "def C.m.a" (python-info-current-defun t)))
2736    (python-indent-dedent-line-backspace 1)
2737    (should (string= "C.m" (python-info-current-defun)))
2738    (should (string= "def C.m" (python-info-current-defun t)))
2739    (python-indent-dedent-line-backspace 1)
2740    (should (string= "C" (python-info-current-defun)))
2741    (should (string= "class C" (python-info-current-defun t)))
2742    (python-tests-look-at "def c(self):")
2743    (should (string= "C.c" (python-info-current-defun)))
2744    (should (string= "def C.c" (python-info-current-defun t)))
2745    (python-tests-look-at "do_c()")
2746    (should (string= "C.c" (python-info-current-defun)))
2747    (should (string= "def C.c" (python-info-current-defun t)))))
2748
2749 (ert-deftest python-info-current-defun-3 ()
2750   (python-tests-with-temp-buffer
2751    "
2752 def decoratorFunctionWithArguments(arg1, arg2, arg3):
2753     '''print decorated function call data to stdout.
2754
2755     Usage:
2756
2757     @decoratorFunctionWithArguments('arg1', 'arg2')
2758     def func(a, b, c=True):
2759         pass
2760     '''
2761
2762     def wwrap(f):
2763         print 'Inside wwrap()'
2764         def wrapped_f(*args):
2765             print 'Inside wrapped_f()'
2766             print 'Decorator arguments:', arg1, arg2, arg3
2767             f(*args)
2768             print 'After f(*args)'
2769         return wrapped_f
2770     return wwrap
2771 "
2772    (python-tests-look-at "def wwrap(f):")
2773    (forward-line -1)
2774    (should (not (python-info-current-defun)))
2775    (indent-for-tab-command 1)
2776    (should (string= (python-info-current-defun)
2777                     "decoratorFunctionWithArguments"))
2778    (should (string= (python-info-current-defun t)
2779                     "def decoratorFunctionWithArguments"))
2780    (python-tests-look-at "def wrapped_f(*args):")
2781    (should (string= (python-info-current-defun)
2782                     "decoratorFunctionWithArguments.wwrap.wrapped_f"))
2783    (should (string= (python-info-current-defun t)
2784                     "def decoratorFunctionWithArguments.wwrap.wrapped_f"))
2785    (python-tests-look-at "return wrapped_f")
2786    (should (string= (python-info-current-defun)
2787                     "decoratorFunctionWithArguments.wwrap"))
2788    (should (string= (python-info-current-defun t)
2789                     "def decoratorFunctionWithArguments.wwrap"))
2790    (end-of-line 1)
2791    (python-tests-look-at "return wwrap")
2792    (should (string= (python-info-current-defun)
2793                     "decoratorFunctionWithArguments"))
2794    (should (string= (python-info-current-defun t)
2795                     "def decoratorFunctionWithArguments"))))
2796
2797 (ert-deftest python-info-current-symbol-1 ()
2798   (python-tests-with-temp-buffer
2799    "
2800 class C(object):
2801
2802     def m(self):
2803         self.c()
2804
2805     def c(self):
2806         print ('a')
2807 "
2808    (python-tests-look-at "self.c()")
2809    (should (string= "self.c" (python-info-current-symbol)))
2810    (should (string= "C.c" (python-info-current-symbol t)))))
2811
2812 (ert-deftest python-info-current-symbol-2 ()
2813   (python-tests-with-temp-buffer
2814    "
2815 class C(object):
2816
2817     class M(object):
2818
2819         def a(self):
2820             self.c()
2821
2822         def c(self):
2823             pass
2824 "
2825    (python-tests-look-at "self.c()")
2826    (should (string= "self.c" (python-info-current-symbol)))
2827    (should (string= "C.M.c" (python-info-current-symbol t)))))
2828
2829 (ert-deftest python-info-current-symbol-3 ()
2830   "Keywords should not be considered symbols."
2831   :expected-result :failed
2832   (python-tests-with-temp-buffer
2833    "
2834 class C(object):
2835     pass
2836 "
2837    ;; FIXME: keywords are not symbols.
2838    (python-tests-look-at "class C")
2839    (should (not (python-info-current-symbol)))
2840    (should (not (python-info-current-symbol t)))
2841    (python-tests-look-at "C(object)")
2842    (should (string= "C" (python-info-current-symbol)))
2843    (should (string= "class C" (python-info-current-symbol t)))))
2844
2845 (ert-deftest python-info-statement-starts-block-p-1 ()
2846   (python-tests-with-temp-buffer
2847    "
2848 def long_function_name(
2849         var_one, var_two, var_three,
2850         var_four):
2851     print (var_one)
2852 "
2853    (python-tests-look-at "def long_function_name")
2854    (should (python-info-statement-starts-block-p))
2855    (python-tests-look-at "print (var_one)")
2856    (python-util-forward-comment -1)
2857    (should (python-info-statement-starts-block-p))))
2858
2859 (ert-deftest python-info-statement-starts-block-p-2 ()
2860   (python-tests-with-temp-buffer
2861    "
2862 if width == 0 and height == 0 and \\\\
2863    color == 'red' and emphasis == 'strong' or \\\\
2864    highlight > 100:
2865     raise ValueError('sorry, you lose')
2866 "
2867    (python-tests-look-at "if width == 0 and")
2868    (should (python-info-statement-starts-block-p))
2869    (python-tests-look-at "raise ValueError(")
2870    (python-util-forward-comment -1)
2871    (should (python-info-statement-starts-block-p))))
2872
2873 (ert-deftest python-info-statement-ends-block-p-1 ()
2874   (python-tests-with-temp-buffer
2875    "
2876 def long_function_name(
2877         var_one, var_two, var_three,
2878         var_four):
2879     print (var_one)
2880 "
2881    (python-tests-look-at "print (var_one)")
2882    (should (python-info-statement-ends-block-p))))
2883
2884 (ert-deftest python-info-statement-ends-block-p-2 ()
2885   (python-tests-with-temp-buffer
2886    "
2887 if width == 0 and height == 0 and \\\\
2888    color == 'red' and emphasis == 'strong' or \\\\
2889    highlight > 100:
2890     raise ValueError(
2891 'sorry, you lose'
2892
2893 )
2894 "
2895    (python-tests-look-at "raise ValueError(")
2896    (should (python-info-statement-ends-block-p))))
2897
2898 (ert-deftest python-info-beginning-of-statement-p-1 ()
2899   (python-tests-with-temp-buffer
2900    "
2901 def long_function_name(
2902         var_one, var_two, var_three,
2903         var_four):
2904     print (var_one)
2905 "
2906    (python-tests-look-at "def long_function_name")
2907    (should (python-info-beginning-of-statement-p))
2908    (forward-char 10)
2909    (should (not (python-info-beginning-of-statement-p)))
2910    (python-tests-look-at "print (var_one)")
2911    (should (python-info-beginning-of-statement-p))
2912    (goto-char (line-beginning-position))
2913    (should (not (python-info-beginning-of-statement-p)))))
2914
2915 (ert-deftest python-info-beginning-of-statement-p-2 ()
2916   (python-tests-with-temp-buffer
2917    "
2918 if width == 0 and height == 0 and \\\\
2919    color == 'red' and emphasis == 'strong' or \\\\
2920    highlight > 100:
2921     raise ValueError(
2922 'sorry, you lose'
2923
2924 )
2925 "
2926    (python-tests-look-at "if width == 0 and")
2927    (should (python-info-beginning-of-statement-p))
2928    (forward-char 10)
2929    (should (not (python-info-beginning-of-statement-p)))
2930    (python-tests-look-at "raise ValueError(")
2931    (should (python-info-beginning-of-statement-p))
2932    (goto-char (line-beginning-position))
2933    (should (not (python-info-beginning-of-statement-p)))))
2934
2935 (ert-deftest python-info-end-of-statement-p-1 ()
2936   (python-tests-with-temp-buffer
2937    "
2938 def long_function_name(
2939         var_one, var_two, var_three,
2940         var_four):
2941     print (var_one)
2942 "
2943    (python-tests-look-at "def long_function_name")
2944    (should (not (python-info-end-of-statement-p)))
2945    (end-of-line)
2946    (should (not (python-info-end-of-statement-p)))
2947    (python-tests-look-at "print (var_one)")
2948    (python-util-forward-comment -1)
2949    (should (python-info-end-of-statement-p))
2950    (python-tests-look-at "print (var_one)")
2951    (should (not (python-info-end-of-statement-p)))
2952    (end-of-line)
2953    (should (python-info-end-of-statement-p))))
2954
2955 (ert-deftest python-info-end-of-statement-p-2 ()
2956   (python-tests-with-temp-buffer
2957    "
2958 if width == 0 and height == 0 and \\\\
2959    color == 'red' and emphasis == 'strong' or \\\\
2960    highlight > 100:
2961     raise ValueError(
2962 'sorry, you lose'
2963
2964 )
2965 "
2966    (python-tests-look-at "if width == 0 and")
2967    (should (not (python-info-end-of-statement-p)))
2968    (end-of-line)
2969    (should (not (python-info-end-of-statement-p)))
2970    (python-tests-look-at "raise ValueError(")
2971    (python-util-forward-comment -1)
2972    (should (python-info-end-of-statement-p))
2973    (python-tests-look-at "raise ValueError(")
2974    (should (not (python-info-end-of-statement-p)))
2975    (end-of-line)
2976    (should (not (python-info-end-of-statement-p)))
2977    (goto-char (point-max))
2978    (python-util-forward-comment -1)
2979    (should (python-info-end-of-statement-p))))
2980
2981 (ert-deftest python-info-beginning-of-block-p-1 ()
2982   (python-tests-with-temp-buffer
2983    "
2984 def long_function_name(
2985         var_one, var_two, var_three,
2986         var_four):
2987     print (var_one)
2988 "
2989    (python-tests-look-at "def long_function_name")
2990    (should (python-info-beginning-of-block-p))
2991    (python-tests-look-at "var_one, var_two, var_three,")
2992    (should (not (python-info-beginning-of-block-p)))
2993    (python-tests-look-at "print (var_one)")
2994    (should (not (python-info-beginning-of-block-p)))))
2995
2996 (ert-deftest python-info-beginning-of-block-p-2 ()
2997   (python-tests-with-temp-buffer
2998    "
2999 if width == 0 and height == 0 and \\\\
3000    color == 'red' and emphasis == 'strong' or \\\\
3001    highlight > 100:
3002     raise ValueError(
3003 'sorry, you lose'
3004
3005 )
3006 "
3007    (python-tests-look-at "if width == 0 and")
3008    (should (python-info-beginning-of-block-p))
3009    (python-tests-look-at "color == 'red' and emphasis")
3010    (should (not (python-info-beginning-of-block-p)))
3011    (python-tests-look-at "raise ValueError(")
3012    (should (not (python-info-beginning-of-block-p)))))
3013
3014 (ert-deftest python-info-end-of-block-p-1 ()
3015   (python-tests-with-temp-buffer
3016    "
3017 def long_function_name(
3018         var_one, var_two, var_three,
3019         var_four):
3020     print (var_one)
3021 "
3022    (python-tests-look-at "def long_function_name")
3023    (should (not (python-info-end-of-block-p)))
3024    (python-tests-look-at "var_one, var_two, var_three,")
3025    (should (not (python-info-end-of-block-p)))
3026    (python-tests-look-at "var_four):")
3027    (end-of-line)
3028    (should (not (python-info-end-of-block-p)))
3029    (python-tests-look-at "print (var_one)")
3030    (should (not (python-info-end-of-block-p)))
3031    (end-of-line 1)
3032    (should (python-info-end-of-block-p))))
3033
3034 (ert-deftest python-info-end-of-block-p-2 ()
3035   (python-tests-with-temp-buffer
3036    "
3037 if width == 0 and height == 0 and \\\\
3038    color == 'red' and emphasis == 'strong' or \\\\
3039    highlight > 100:
3040     raise ValueError(
3041 'sorry, you lose'
3042
3043 )
3044 "
3045    (python-tests-look-at "if width == 0 and")
3046    (should (not (python-info-end-of-block-p)))
3047    (python-tests-look-at "color == 'red' and emphasis == 'strong' or")
3048    (should (not (python-info-end-of-block-p)))
3049    (python-tests-look-at "highlight > 100:")
3050    (end-of-line)
3051    (should (not (python-info-end-of-block-p)))
3052    (python-tests-look-at "raise ValueError(")
3053    (should (not (python-info-end-of-block-p)))
3054    (end-of-line 1)
3055    (should (not (python-info-end-of-block-p)))
3056    (goto-char (point-max))
3057    (python-util-forward-comment -1)
3058    (should (python-info-end-of-block-p))))
3059
3060 (ert-deftest python-info-dedenter-opening-block-position-1 ()
3061   (python-tests-with-temp-buffer
3062       "
3063 if request.user.is_authenticated():
3064     try:
3065         profile = request.user.get_profile()
3066     except Profile.DoesNotExist:
3067         profile = Profile.objects.create(user=request.user)
3068     else:
3069         if profile.stats:
3070             profile.recalculate_stats()
3071         else:
3072             profile.clear_stats()
3073     finally:
3074         profile.views += 1
3075         profile.save()
3076 "
3077     (python-tests-look-at "try:")
3078     (should (not (python-info-dedenter-opening-block-position)))
3079     (python-tests-look-at "except Profile.DoesNotExist:")
3080     (should (= (python-tests-look-at "try:" -1 t)
3081                (python-info-dedenter-opening-block-position)))
3082     (python-tests-look-at "else:")
3083     (should (= (python-tests-look-at "except Profile.DoesNotExist:" -1 t)
3084                (python-info-dedenter-opening-block-position)))
3085     (python-tests-look-at "if profile.stats:")
3086     (should (not (python-info-dedenter-opening-block-position)))
3087     (python-tests-look-at "else:")
3088     (should (= (python-tests-look-at "if profile.stats:" -1 t)
3089                (python-info-dedenter-opening-block-position)))
3090     (python-tests-look-at "finally:")
3091     (should (= (python-tests-look-at "else:" -2 t)
3092                (python-info-dedenter-opening-block-position)))))
3093
3094 (ert-deftest python-info-dedenter-opening-block-position-2 ()
3095   (python-tests-with-temp-buffer
3096       "
3097 if request.user.is_authenticated():
3098     profile = Profile.objects.get_or_create(user=request.user)
3099     if profile.stats:
3100         profile.recalculate_stats()
3101
3102 data = {
3103     'else': 'do it'
3104 }
3105     'else'
3106 "
3107     (python-tests-look-at "'else': 'do it'")
3108     (should (not (python-info-dedenter-opening-block-position)))
3109     (python-tests-look-at "'else'")
3110     (should (not (python-info-dedenter-opening-block-position)))))
3111
3112 (ert-deftest python-info-dedenter-opening-block-position-3 ()
3113   (python-tests-with-temp-buffer
3114       "
3115 if save:
3116     try:
3117         write_to_disk(data)
3118     except IOError:
3119         msg = 'Error saving to disk'
3120         message(msg)
3121         logger.exception(msg)
3122     except Exception:
3123         if hide_details:
3124             logger.exception('Unhandled exception')
3125             else
3126     finally:
3127         data.free()
3128 "
3129     (python-tests-look-at "try:")
3130     (should (not (python-info-dedenter-opening-block-position)))
3131
3132     (python-tests-look-at "except IOError:")
3133     (should (= (python-tests-look-at "try:" -1 t)
3134                (python-info-dedenter-opening-block-position)))
3135
3136     (python-tests-look-at "except Exception:")
3137     (should (= (python-tests-look-at "except IOError:" -1 t)
3138                (python-info-dedenter-opening-block-position)))
3139
3140     (python-tests-look-at "if hide_details:")
3141     (should (not (python-info-dedenter-opening-block-position)))
3142
3143     ;; check indentation modifies the detected opening block
3144     (python-tests-look-at "else")
3145     (should (= (python-tests-look-at "if hide_details:" -1 t)
3146                (python-info-dedenter-opening-block-position)))
3147
3148     (indent-line-to 8)
3149     (should (= (python-tests-look-at "if hide_details:" -1 t)
3150                (python-info-dedenter-opening-block-position)))
3151
3152     (indent-line-to 4)
3153     (should (= (python-tests-look-at "except Exception:" -1 t)
3154                (python-info-dedenter-opening-block-position)))
3155
3156     (indent-line-to 0)
3157     (should (= (python-tests-look-at "if save:" -1 t)
3158                (python-info-dedenter-opening-block-position)))))
3159
3160 (ert-deftest python-info-dedenter-opening-block-positions-1 ()
3161   (python-tests-with-temp-buffer
3162       "
3163 if save:
3164     try:
3165         write_to_disk(data)
3166     except IOError:
3167         msg = 'Error saving to disk'
3168         message(msg)
3169         logger.exception(msg)
3170     except Exception:
3171         if hide_details:
3172             logger.exception('Unhandled exception')
3173             else
3174     finally:
3175         data.free()
3176 "
3177     (python-tests-look-at "try:")
3178     (should (not (python-info-dedenter-opening-block-positions)))
3179
3180     (python-tests-look-at "except IOError:")
3181     (should
3182      (equal (list
3183              (python-tests-look-at "try:" -1 t))
3184             (python-info-dedenter-opening-block-positions)))
3185
3186     (python-tests-look-at "except Exception:")
3187     (should
3188      (equal (list
3189              (python-tests-look-at "except IOError:" -1 t))
3190             (python-info-dedenter-opening-block-positions)))
3191
3192     (python-tests-look-at "if hide_details:")
3193     (should (not (python-info-dedenter-opening-block-positions)))
3194
3195     ;; check indentation does not modify the detected opening blocks
3196     (python-tests-look-at "else")
3197     (should
3198      (equal (list
3199              (python-tests-look-at "if hide_details:" -1 t)
3200              (python-tests-look-at "except Exception:" -1 t)
3201              (python-tests-look-at "if save:" -1 t))
3202             (python-info-dedenter-opening-block-positions)))
3203
3204     (indent-line-to 8)
3205     (should
3206      (equal (list
3207              (python-tests-look-at "if hide_details:" -1 t)
3208              (python-tests-look-at "except Exception:" -1 t)
3209              (python-tests-look-at "if save:" -1 t))
3210             (python-info-dedenter-opening-block-positions)))
3211
3212     (indent-line-to 4)
3213     (should
3214      (equal (list
3215              (python-tests-look-at "if hide_details:" -1 t)
3216              (python-tests-look-at "except Exception:" -1 t)
3217              (python-tests-look-at "if save:" -1 t))
3218             (python-info-dedenter-opening-block-positions)))
3219
3220     (indent-line-to 0)
3221     (should
3222      (equal (list
3223              (python-tests-look-at "if hide_details:" -1 t)
3224              (python-tests-look-at "except Exception:" -1 t)
3225              (python-tests-look-at "if save:" -1 t))
3226             (python-info-dedenter-opening-block-positions)))))
3227
3228 (ert-deftest python-info-dedenter-opening-block-positions-2 ()
3229   "Test detection of opening blocks for elif."
3230   (python-tests-with-temp-buffer
3231       "
3232 if var:
3233     if var2:
3234         something()
3235     elif var3:
3236         something_else()
3237         elif
3238 "
3239     (python-tests-look-at "elif var3:")
3240     (should
3241      (equal (list
3242              (python-tests-look-at "if var2:" -1 t)
3243              (python-tests-look-at "if var:" -1 t))
3244             (python-info-dedenter-opening-block-positions)))
3245
3246     (python-tests-look-at "elif\n")
3247     (should
3248      (equal (list
3249              (python-tests-look-at "elif var3:" -1 t)
3250              (python-tests-look-at "if var:" -1 t))
3251             (python-info-dedenter-opening-block-positions)))))
3252
3253 (ert-deftest python-info-dedenter-opening-block-positions-3 ()
3254   "Test detection of opening blocks for else."
3255   (python-tests-with-temp-buffer
3256       "
3257 try:
3258     something()
3259 except:
3260     if var:
3261         if var2:
3262             something()
3263         elif var3:
3264             something_else()
3265             else
3266
3267 if var4:
3268     while var5:
3269         var4.pop()
3270         else
3271
3272     for value in var6:
3273         if value > 0:
3274             print value
3275             else
3276 "
3277     (python-tests-look-at "else\n")
3278     (should
3279      (equal (list
3280              (python-tests-look-at "elif var3:" -1 t)
3281              (python-tests-look-at "if var:" -1 t)
3282              (python-tests-look-at "except:" -1 t))
3283             (python-info-dedenter-opening-block-positions)))
3284
3285     (python-tests-look-at "else\n")
3286     (should
3287      (equal (list
3288              (python-tests-look-at "while var5:" -1 t)
3289              (python-tests-look-at "if var4:" -1 t))
3290             (python-info-dedenter-opening-block-positions)))
3291
3292     (python-tests-look-at "else\n")
3293     (should
3294      (equal (list
3295              (python-tests-look-at "if value > 0:" -1 t)
3296              (python-tests-look-at "for value in var6:" -1 t)
3297              (python-tests-look-at "if var4:" -1 t))
3298             (python-info-dedenter-opening-block-positions)))))
3299
3300 (ert-deftest python-info-dedenter-opening-block-positions-4 ()
3301   "Test detection of opening blocks for except."
3302   (python-tests-with-temp-buffer
3303       "
3304 try:
3305     something()
3306 except ValueError:
3307     something_else()
3308     except
3309 "
3310     (python-tests-look-at "except ValueError:")
3311     (should
3312      (equal (list (python-tests-look-at "try:" -1 t))
3313             (python-info-dedenter-opening-block-positions)))
3314
3315     (python-tests-look-at "except\n")
3316     (should
3317      (equal (list (python-tests-look-at "except ValueError:" -1 t))
3318             (python-info-dedenter-opening-block-positions)))))
3319
3320 (ert-deftest python-info-dedenter-opening-block-positions-5 ()
3321   "Test detection of opening blocks for finally."
3322   (python-tests-with-temp-buffer
3323       "
3324 try:
3325     something()
3326     finally
3327
3328 try:
3329     something_else()
3330 except:
3331     logger.exception('something went wrong')
3332     finally
3333
3334 try:
3335     something_else_else()
3336 except Exception:
3337     logger.exception('something else went wrong')
3338 else:
3339     print ('all good')
3340     finally
3341 "
3342     (python-tests-look-at "finally\n")
3343     (should
3344      (equal (list (python-tests-look-at "try:" -1 t))
3345             (python-info-dedenter-opening-block-positions)))
3346
3347     (python-tests-look-at "finally\n")
3348     (should
3349      (equal (list (python-tests-look-at "except:" -1 t))
3350             (python-info-dedenter-opening-block-positions)))
3351
3352     (python-tests-look-at "finally\n")
3353     (should
3354      (equal (list (python-tests-look-at "else:" -1 t))
3355             (python-info-dedenter-opening-block-positions)))))
3356
3357 (ert-deftest python-info-dedenter-opening-block-message-1 ()
3358   "Test dedenters inside strings are ignored."
3359   (python-tests-with-temp-buffer
3360       "'''
3361 try:
3362     something()
3363 except:
3364     logger.exception('something went wrong')
3365 '''
3366 "
3367     (python-tests-look-at "except\n")
3368     (should (not (python-info-dedenter-opening-block-message)))))
3369
3370 (ert-deftest python-info-dedenter-opening-block-message-2 ()
3371   "Test except keyword."
3372   (python-tests-with-temp-buffer
3373       "
3374 try:
3375     something()
3376 except:
3377     logger.exception('something went wrong')
3378 "
3379     (python-tests-look-at "except:")
3380     (should (string=
3381              "Closes try:"
3382              (substring-no-properties
3383               (python-info-dedenter-opening-block-message))))
3384     (end-of-line)
3385     (should (string=
3386              "Closes try:"
3387              (substring-no-properties
3388               (python-info-dedenter-opening-block-message))))))
3389
3390 (ert-deftest python-info-dedenter-opening-block-message-3 ()
3391   "Test else keyword."
3392   (python-tests-with-temp-buffer
3393       "
3394 try:
3395     something()
3396 except:
3397     logger.exception('something went wrong')
3398 else:
3399     logger.debug('all good')
3400 "
3401     (python-tests-look-at "else:")
3402     (should (string=
3403              "Closes except:"
3404              (substring-no-properties
3405               (python-info-dedenter-opening-block-message))))
3406     (end-of-line)
3407     (should (string=
3408              "Closes except:"
3409              (substring-no-properties
3410               (python-info-dedenter-opening-block-message))))))
3411
3412 (ert-deftest python-info-dedenter-opening-block-message-4 ()
3413   "Test finally keyword."
3414   (python-tests-with-temp-buffer
3415       "
3416 try:
3417     something()
3418 except:
3419     logger.exception('something went wrong')
3420 else:
3421     logger.debug('all good')
3422 finally:
3423     clean()
3424 "
3425     (python-tests-look-at "finally:")
3426     (should (string=
3427              "Closes else:"
3428              (substring-no-properties
3429               (python-info-dedenter-opening-block-message))))
3430     (end-of-line)
3431     (should (string=
3432              "Closes else:"
3433              (substring-no-properties
3434               (python-info-dedenter-opening-block-message))))))
3435
3436 (ert-deftest python-info-dedenter-opening-block-message-5 ()
3437   "Test elif keyword."
3438   (python-tests-with-temp-buffer
3439       "
3440 if a:
3441     something()
3442 elif b:
3443 "
3444     (python-tests-look-at "elif b:")
3445     (should (string=
3446              "Closes if a:"
3447              (substring-no-properties
3448               (python-info-dedenter-opening-block-message))))
3449     (end-of-line)
3450     (should (string=
3451              "Closes if a:"
3452              (substring-no-properties
3453               (python-info-dedenter-opening-block-message))))))
3454
3455
3456 (ert-deftest python-info-dedenter-statement-p-1 ()
3457   "Test dedenters inside strings are ignored."
3458   (python-tests-with-temp-buffer
3459       "'''
3460 try:
3461     something()
3462 except:
3463     logger.exception('something went wrong')
3464 '''
3465 "
3466     (python-tests-look-at "except\n")
3467     (should (not (python-info-dedenter-statement-p)))))
3468
3469 (ert-deftest python-info-dedenter-statement-p-2 ()
3470   "Test except keyword."
3471   (python-tests-with-temp-buffer
3472       "
3473 try:
3474     something()
3475 except:
3476     logger.exception('something went wrong')
3477 "
3478     (python-tests-look-at "except:")
3479     (should (= (point) (python-info-dedenter-statement-p)))
3480     (end-of-line)
3481     (should (= (save-excursion
3482                  (back-to-indentation)
3483                  (point))
3484                (python-info-dedenter-statement-p)))))
3485
3486 (ert-deftest python-info-dedenter-statement-p-3 ()
3487   "Test else keyword."
3488   (python-tests-with-temp-buffer
3489       "
3490 try:
3491     something()
3492 except:
3493     logger.exception('something went wrong')
3494 else:
3495     logger.debug('all good')
3496 "
3497     (python-tests-look-at "else:")
3498     (should (= (point) (python-info-dedenter-statement-p)))
3499     (end-of-line)
3500     (should (= (save-excursion
3501                  (back-to-indentation)
3502                  (point))
3503                (python-info-dedenter-statement-p)))))
3504
3505 (ert-deftest python-info-dedenter-statement-p-4 ()
3506   "Test finally keyword."
3507   (python-tests-with-temp-buffer
3508       "
3509 try:
3510     something()
3511 except:
3512     logger.exception('something went wrong')
3513 else:
3514     logger.debug('all good')
3515 finally:
3516     clean()
3517 "
3518     (python-tests-look-at "finally:")
3519     (should (= (point) (python-info-dedenter-statement-p)))
3520     (end-of-line)
3521     (should (= (save-excursion
3522                  (back-to-indentation)
3523                  (point))
3524                (python-info-dedenter-statement-p)))))
3525
3526 (ert-deftest python-info-dedenter-statement-p-5 ()
3527   "Test elif keyword."
3528   (python-tests-with-temp-buffer
3529       "
3530 if a:
3531     something()
3532 elif b:
3533 "
3534     (python-tests-look-at "elif b:")
3535     (should (= (point) (python-info-dedenter-statement-p)))
3536     (end-of-line)
3537     (should (= (save-excursion
3538                  (back-to-indentation)
3539                  (point))
3540                (python-info-dedenter-statement-p)))))
3541
3542 (ert-deftest python-info-line-ends-backslash-p-1 ()
3543   (python-tests-with-temp-buffer
3544    "
3545 objects = Thing.objects.all() \\\\
3546                        .filter(
3547                            type='toy',
3548                            status='bought'
3549                        ) \\\\
3550                        .aggregate(
3551                            Sum('amount')
3552                        ) \\\\
3553                        .values_list()
3554 "
3555    (should (python-info-line-ends-backslash-p 2)) ; .filter(...
3556    (should (python-info-line-ends-backslash-p 3))
3557    (should (python-info-line-ends-backslash-p 4))
3558    (should (python-info-line-ends-backslash-p 5))
3559    (should (python-info-line-ends-backslash-p 6)) ; ) \...
3560    (should (python-info-line-ends-backslash-p 7))
3561    (should (python-info-line-ends-backslash-p 8))
3562    (should (python-info-line-ends-backslash-p 9))
3563    (should (not (python-info-line-ends-backslash-p 10))))) ; .values_list()...
3564
3565 (ert-deftest python-info-beginning-of-backslash-1 ()
3566   (python-tests-with-temp-buffer
3567    "
3568 objects = Thing.objects.all() \\\\
3569                        .filter(
3570                            type='toy',
3571                            status='bought'
3572                        ) \\\\
3573                        .aggregate(
3574                            Sum('amount')
3575                        ) \\\\
3576                        .values_list()
3577 "
3578    (let ((first 2)
3579          (second (python-tests-look-at ".filter("))
3580          (third (python-tests-look-at ".aggregate(")))
3581      (should (= first (python-info-beginning-of-backslash 2)))
3582      (should (= second (python-info-beginning-of-backslash 3)))
3583      (should (= second (python-info-beginning-of-backslash 4)))
3584      (should (= second (python-info-beginning-of-backslash 5)))
3585      (should (= second (python-info-beginning-of-backslash 6)))
3586      (should (= third (python-info-beginning-of-backslash 7)))
3587      (should (= third (python-info-beginning-of-backslash 8)))
3588      (should (= third (python-info-beginning-of-backslash 9)))
3589      (should (not (python-info-beginning-of-backslash 10))))))
3590
3591 (ert-deftest python-info-continuation-line-p-1 ()
3592   (python-tests-with-temp-buffer
3593    "
3594 if width == 0 and height == 0 and \\\\
3595    color == 'red' and emphasis == 'strong' or \\\\
3596    highlight > 100:
3597     raise ValueError(
3598 'sorry, you lose'
3599
3600 )
3601 "
3602    (python-tests-look-at "if width == 0 and height == 0 and")
3603    (should (not (python-info-continuation-line-p)))
3604    (python-tests-look-at "color == 'red' and emphasis == 'strong' or")
3605    (should (python-info-continuation-line-p))
3606    (python-tests-look-at "highlight > 100:")
3607    (should (python-info-continuation-line-p))
3608    (python-tests-look-at "raise ValueError(")
3609    (should (not (python-info-continuation-line-p)))
3610    (python-tests-look-at "'sorry, you lose'")
3611    (should (python-info-continuation-line-p))
3612    (forward-line 1)
3613    (should (python-info-continuation-line-p))
3614    (python-tests-look-at ")")
3615    (should (python-info-continuation-line-p))
3616    (forward-line 1)
3617    (should (not (python-info-continuation-line-p)))))
3618
3619 (ert-deftest python-info-block-continuation-line-p-1 ()
3620   (python-tests-with-temp-buffer
3621    "
3622 if width == 0 and height == 0 and \\\\
3623    color == 'red' and emphasis == 'strong' or \\\\
3624    highlight > 100:
3625     raise ValueError(
3626 'sorry, you lose'
3627
3628 )
3629 "
3630    (python-tests-look-at "if width == 0 and")
3631    (should (not (python-info-block-continuation-line-p)))
3632    (python-tests-look-at "color == 'red' and emphasis == 'strong' or")
3633    (should (= (python-info-block-continuation-line-p)
3634               (python-tests-look-at "if width == 0 and" -1 t)))
3635    (python-tests-look-at "highlight > 100:")
3636    (should (not (python-info-block-continuation-line-p)))))
3637
3638 (ert-deftest python-info-block-continuation-line-p-2 ()
3639   (python-tests-with-temp-buffer
3640    "
3641 def foo(a,
3642         b,
3643         c):
3644     pass
3645 "
3646    (python-tests-look-at "def foo(a,")
3647    (should (not (python-info-block-continuation-line-p)))
3648    (python-tests-look-at "b,")
3649    (should (= (python-info-block-continuation-line-p)
3650               (python-tests-look-at "def foo(a," -1 t)))
3651    (python-tests-look-at "c):")
3652    (should (not (python-info-block-continuation-line-p)))))
3653
3654 (ert-deftest python-info-assignment-continuation-line-p-1 ()
3655   (python-tests-with-temp-buffer
3656    "
3657 data = foo(), bar() \\\\
3658        baz(), 4 \\\\
3659        5, 6
3660 "
3661    (python-tests-look-at "data = foo(), bar()")
3662    (should (not (python-info-assignment-continuation-line-p)))
3663    (python-tests-look-at "baz(), 4")
3664    (should (= (python-info-assignment-continuation-line-p)
3665               (python-tests-look-at "foo()," -1 t)))
3666    (python-tests-look-at "5, 6")
3667    (should (not (python-info-assignment-continuation-line-p)))))
3668
3669 (ert-deftest python-info-assignment-continuation-line-p-2 ()
3670   (python-tests-with-temp-buffer
3671    "
3672 data = (foo(), bar()
3673         baz(), 4
3674         5, 6)
3675 "
3676    (python-tests-look-at "data = (foo(), bar()")
3677    (should (not (python-info-assignment-continuation-line-p)))
3678    (python-tests-look-at "baz(), 4")
3679    (should (= (python-info-assignment-continuation-line-p)
3680               (python-tests-look-at "(foo()," -1 t)))
3681    (python-tests-look-at "5, 6)")
3682    (should (not (python-info-assignment-continuation-line-p)))))
3683
3684 (ert-deftest python-info-looking-at-beginning-of-defun-1 ()
3685   (python-tests-with-temp-buffer
3686    "
3687 def decorat0r(deff):
3688     '''decorates stuff.
3689
3690     @decorat0r
3691     def foo(arg):
3692         ...
3693     '''
3694     def wrap():
3695         deff()
3696     return wwrap
3697 "
3698    (python-tests-look-at "def decorat0r(deff):")
3699    (should (python-info-looking-at-beginning-of-defun))
3700    (python-tests-look-at "def foo(arg):")
3701    (should (not (python-info-looking-at-beginning-of-defun)))
3702    (python-tests-look-at "def wrap():")
3703    (should (python-info-looking-at-beginning-of-defun))
3704    (python-tests-look-at "deff()")
3705    (should (not (python-info-looking-at-beginning-of-defun)))))
3706
3707 (ert-deftest python-info-current-line-comment-p-1 ()
3708   (python-tests-with-temp-buffer
3709    "
3710 # this is a comment
3711 foo = True  # another comment
3712 '#this is a string'
3713 if foo:
3714     # more comments
3715     print ('bar') # print bar
3716 "
3717    (python-tests-look-at "# this is a comment")
3718    (should (python-info-current-line-comment-p))
3719    (python-tests-look-at "foo = True  # another comment")
3720    (should (not (python-info-current-line-comment-p)))
3721    (python-tests-look-at "'#this is a string'")
3722    (should (not (python-info-current-line-comment-p)))
3723    (python-tests-look-at "# more comments")
3724    (should (python-info-current-line-comment-p))
3725    (python-tests-look-at "print ('bar') # print bar")
3726    (should (not (python-info-current-line-comment-p)))))
3727
3728 (ert-deftest python-info-current-line-empty-p ()
3729   (python-tests-with-temp-buffer
3730    "
3731 # this is a comment
3732
3733 foo = True  # another comment
3734 "
3735    (should (python-info-current-line-empty-p))
3736    (python-tests-look-at "# this is a comment")
3737    (should (not (python-info-current-line-empty-p)))
3738    (forward-line 1)
3739    (should (python-info-current-line-empty-p))))
3740
3741 \f
3742 ;;; Utility functions
3743
3744 (ert-deftest python-util-goto-line-1 ()
3745   (python-tests-with-temp-buffer
3746    (concat
3747     "# a comment
3748 # another comment
3749 def foo(a, b, c):
3750     pass" (make-string 20 ?\n))
3751    (python-util-goto-line 10)
3752    (should (= (line-number-at-pos) 10))
3753    (python-util-goto-line 20)
3754    (should (= (line-number-at-pos) 20))))
3755
3756 (ert-deftest python-util-clone-local-variables-1 ()
3757   (let ((buffer (generate-new-buffer
3758                  "python-util-clone-local-variables-1"))
3759         (varcons
3760          '((python-fill-docstring-style . django)
3761            (python-shell-interpreter . "python")
3762            (python-shell-interpreter-args . "manage.py shell")
3763            (python-shell-prompt-regexp . "In \\[[0-9]+\\]: ")
3764            (python-shell-prompt-output-regexp . "Out\\[[0-9]+\\]: ")
3765            (python-shell-extra-pythonpaths "/home/user/pylib/")
3766            (python-shell-completion-setup-code
3767             . "from IPython.core.completerlib import module_completion")
3768            (python-shell-completion-string-code
3769             . "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")
3770            (python-shell-virtualenv-path
3771             . "/home/user/.virtualenvs/project"))))
3772     (with-current-buffer buffer
3773       (kill-all-local-variables)
3774       (dolist (ccons varcons)
3775         (set (make-local-variable (car ccons)) (cdr ccons))))
3776     (python-tests-with-temp-buffer
3777      ""
3778      (python-util-clone-local-variables buffer)
3779      (dolist (ccons varcons)
3780        (should
3781         (equal (symbol-value (car ccons)) (cdr ccons)))))
3782     (kill-buffer buffer)))
3783
3784 (ert-deftest python-util-strip-string-1 ()
3785   (should (string= (python-util-strip-string "\t\r\n    str") "str"))
3786   (should (string= (python-util-strip-string "str \n\r") "str"))
3787   (should (string= (python-util-strip-string "\t\r\n    str \n\r ") "str"))
3788   (should
3789    (string= (python-util-strip-string "\n str \nin \tg \n\r") "str \nin \tg"))
3790   (should (string= (python-util-strip-string "\n \t \n\r ") ""))
3791   (should (string= (python-util-strip-string "") "")))
3792
3793 (ert-deftest python-util-forward-comment-1 ()
3794   (python-tests-with-temp-buffer
3795    (concat
3796     "# a comment
3797 # another comment
3798      # bad indented comment
3799 # more comments" (make-string 9999 ?\n))
3800    (python-util-forward-comment 1)
3801    (should (= (point) (point-max)))
3802    (python-util-forward-comment -1)
3803    (should (= (point) (point-min)))))
3804
3805 (ert-deftest python-util-valid-regexp-p-1 ()
3806   (should (python-util-valid-regexp-p ""))
3807   (should (python-util-valid-regexp-p python-shell-prompt-regexp))
3808   (should (not (python-util-valid-regexp-p "\\("))))
3809
3810 \f
3811 ;;; Electricity
3812
3813 (ert-deftest python-parens-electric-indent-1 ()
3814   (require 'electric)
3815   (let ((eim electric-indent-mode))
3816     (unwind-protect
3817         (progn
3818           (python-tests-with-temp-buffer
3819               "
3820 from django.conf.urls import patterns, include, url
3821
3822 from django.contrib import admin
3823
3824 from myapp import views
3825
3826
3827 urlpatterns = patterns('',
3828     url(r'^$', views.index
3829 )
3830 "
3831             (electric-indent-mode 1)
3832             (python-tests-look-at "views.index")
3833             (end-of-line)
3834
3835             ;; Inserting commas within the same line should leave
3836             ;; indentation unchanged.
3837             (python-tests-self-insert ",")
3838             (should (= (current-indentation) 4))
3839
3840             ;; As well as any other input happening within the same
3841             ;; set of parens.
3842             (python-tests-self-insert " name='index')")
3843             (should (= (current-indentation) 4))
3844
3845             ;; But a comma outside it, should trigger indentation.
3846             (python-tests-self-insert ",")
3847             (should (= (current-indentation) 23))
3848
3849             ;; Newline indents to the first argument column
3850             (python-tests-self-insert "\n")
3851             (should (= (current-indentation) 23))
3852
3853             ;; All this input must not change indentation
3854             (indent-line-to 4)
3855             (python-tests-self-insert "url(r'^/login$', views.login)")
3856             (should (= (current-indentation) 4))
3857
3858             ;; But this comma does
3859             (python-tests-self-insert ",")
3860             (should (= (current-indentation) 23))))
3861       (or eim (electric-indent-mode -1)))))
3862
3863 (ert-deftest python-triple-quote-pairing ()
3864   (require 'electric)
3865   (let ((epm electric-pair-mode))
3866     (unwind-protect
3867         (progn
3868           (python-tests-with-temp-buffer
3869               "\"\"\n"
3870             (or epm (electric-pair-mode 1))
3871             (goto-char (1- (point-max)))
3872             (python-tests-self-insert ?\")
3873             (should (string= (buffer-string)
3874                              "\"\"\"\"\"\"\n"))
3875             (should (= (point) 4)))
3876           (python-tests-with-temp-buffer
3877               "\n"
3878             (python-tests-self-insert (list ?\" ?\" ?\"))
3879             (should (string= (buffer-string)
3880                              "\"\"\"\"\"\"\n"))
3881             (should (= (point) 4)))
3882           (python-tests-with-temp-buffer
3883               "\"\n\"\"\n"
3884             (goto-char (1- (point-max)))
3885             (python-tests-self-insert ?\")
3886             (should (= (point) (1- (point-max))))
3887             (should (string= (buffer-string)
3888                              "\"\n\"\"\"\n"))))
3889       (or epm (electric-pair-mode -1)))))
3890
3891
3892 (provide 'python-tests)
3893
3894 ;; Local Variables:
3895 ;; coding: utf-8
3896 ;; indent-tabs-mode: nil
3897 ;; End:
3898
3899 ;;; python-tests.el ends here