python.el 133 KB
Newer Older
1
;;; python.el --- Python's flying circus support for Emacs
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
2

3
;; Copyright (C) 2003-2013 Free Software Foundation, Inc.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
4 5

;; Author: Fabián E. Gallina <fabian@anue.biz>
6
;; URL: https://github.com/fgallina/python.el
7
;; Version: 0.24.2
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
8 9 10 11
;; Maintainer: FSF
;; Created: Jul 2010
;; Keywords: languages

12
;; This file is part of GNU Emacs.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
13

14 15 16 17
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published
;; by the Free Software Foundation, either version 3 of the License,
;; or (at your option) any later version.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
18

19 20 21 22
;; GNU Emacs is distributed in the hope that it will be useful, but
;; WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;; General Public License for more details.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
23 24

;; You should have received a copy of the GNU General Public License
25
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
26 27 28 29 30 31 32 33

;;; Commentary:

;; Major mode for editing Python files with some fontification and
;; indentation bits extracted from original Dave Love's python.el
;; found in GNU/Emacs.

;; Implements Syntax highlighting, Indentation, Movement, Shell
34 35
;; interaction, Shell completion, Shell virtualenv support, Pdb
;; tracking, Symbol completion, Skeletons, FFAP, Code Check, Eldoc,
36
;; Imenu.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
37 38 39 40 41 42

;; Syntax highlighting: Fontification of code is provided and supports
;; python's triple quoted strings properly.

;; Indentation: Automatic indentation with indentation cycling is
;; provided, it allows you to navigate different available levels of
43 44 45
;; indentation by hitting <tab> several times.  Also when inserting a
;; colon the `python-indent-electric-colon' command is invoked and
;; causes the current line to be dedented automatically if needed.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
46 47

;; Movement: `beginning-of-defun' and `end-of-defun' functions are
48
;; properly implemented.  There are also specialized
49 50 51 52
;; `forward-sentence' and `backward-sentence' replacements called
;; `python-nav-forward-block', `python-nav-backward-block'
;; respectively which navigate between beginning of blocks of code.
;; Extra functions `python-nav-forward-statement',
53 54 55 56
;; `python-nav-backward-statement',
;; `python-nav-beginning-of-statement', `python-nav-end-of-statement',
;; `python-nav-beginning-of-block' and `python-nav-end-of-block' are
;; included but no bound to any key.  At last but not least the
57 58 59 60 61 62 63
;; specialized `python-nav-forward-sexp' allows easy navigation
;; between code blocks.  If you prefer `cc-mode'-like `forward-sexp'
;; movement, setting `forward-sexp-function' to nil is enough, You can
;; do that using the `python-mode-hook':

;; (add-hook 'python-mode-hook
;;           (lambda () (setq forward-sexp-function nil)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
64

65
;; Shell interaction: is provided and allows you to execute easily any
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
66 67 68
;; block of code of your current buffer in an inferior Python process.

;; Shell completion: hitting tab will try to complete the current
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
69
;; word.  Shell completion is implemented in a manner that if you
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
70 71
;; change the `python-shell-interpreter' to any other (for example
;; IPython) it should be easy to integrate another way to calculate
72
;; completions.  You just need to specify your custom
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
73
;; `python-shell-completion-setup-code' and
74
;; `python-shell-completion-string-code'.
75 76

;; Here is a complete example of the settings you would use for
77
;; iPython 0.11:
78 79 80 81 82 83

;; (setq
;;  python-shell-interpreter "ipython"
;;  python-shell-interpreter-args ""
;;  python-shell-prompt-regexp "In \\[[0-9]+\\]: "
;;  python-shell-prompt-output-regexp "Out\\[[0-9]+\\]: "
84 85
;;  python-shell-completion-setup-code
;;    "from IPython.core.completerlib import module_completion"
86
;;  python-shell-completion-module-string-code
87
;;    "';'.join(module_completion('''%s'''))\n"
88
;;  python-shell-completion-string-code
89
;;    "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")
90 91

;; For iPython 0.10 everything would be the same except for
92 93
;; `python-shell-completion-string-code' and
;; `python-shell-completion-module-string-code':
94 95

;; (setq python-shell-completion-string-code
96 97
;;       "';'.join(__IP.complete('''%s'''))\n"
;;       python-shell-completion-module-string-code "")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
98

99 100 101 102 103 104 105 106 107 108 109 110
;; Unfortunately running iPython on Windows needs some more tweaking.
;; The way you must set `python-shell-interpreter' and
;; `python-shell-interpreter-args' is as follows:

;; (setq
;;  python-shell-interpreter "C:\\Python27\\python.exe"
;;  python-shell-interpreter-args
;;  "-i C:\\Python27\\Scripts\\ipython-script.py")

;; That will spawn the iPython process correctly (Of course you need
;; to modify the paths according to your system).

111 112 113 114 115 116
;; Please note that the default completion system depends on the
;; readline module, so if you are using some Operating System that
;; bundles Python without it (like Windows) just install the
;; pyreadline from http://ipython.scipy.org/moin/PyReadline/Intro and
;; you should be good to go.

117 118
;; Shell virtualenv support: The shell also contains support for
;; virtualenvs and other special environment modifications thanks to
119 120
;; `python-shell-process-environment' and `python-shell-exec-path'.
;; These two variables allows you to modify execution paths and
121
;; environment variables to make easy for you to setup virtualenv rules
122
;; or behavior modifications when running shells.  Here is an example
123 124 125 126 127 128 129 130 131 132 133 134 135 136
;; of how to make shell processes to be run using the /path/to/env/
;; virtualenv:

;; (setq python-shell-process-environment
;;       (list
;;        (format "PATH=%s" (mapconcat
;;                           'identity
;;                           (reverse
;;                            (cons (getenv "PATH")
;;                                  '("/path/to/env/bin/")))
;;                           ":"))
;;        "VIRTUAL_ENV=/path/to/env/"))
;; (python-shell-exec-path . ("/path/to/env/bin/"))

Paul Eggert's avatar
Paul Eggert committed
137
;; Since the above is cumbersome and can be programmatically
138 139 140 141 142 143 144 145
;; calculated, the variable `python-shell-virtualenv-path' is
;; provided.  When this variable is set with the path of the
;; virtualenv to use, `process-environment' and `exec-path' get proper
;; values in order to run shells inside the specified virtualenv.  So
;; the following will achieve the same as the previous example:

;; (setq python-shell-virtualenv-path "/path/to/env/")

146 147 148 149
;; Also the `python-shell-extra-pythonpaths' variable have been
;; introduced as simple way of adding paths to the PYTHONPATH without
;; affecting existing values.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
150 151 152 153
;; Pdb tracking: when you execute a block of code that contains some
;; call to pdb (or ipdb) it will prompt the block of code and will
;; follow the execution of pdb marking the current line with an arrow.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
154
;; Symbol completion: you can complete the symbol at point.  It uses
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
155 156 157
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.

158 159 160 161 162
;; Skeletons: 6 skeletons are provided for simple inserting of class,
;; def, for, if, try and while.  These skeletons are integrated with
;; dabbrev.  If you have `dabbrev-mode' activated and
;; `python-skeleton-autoinsert' is set to t, then whenever you type
;; the name of any of those defined and hit SPC, they will be
163 164 165 166
;; automatically expanded.  As an alternative you can use the defined
;; skeleton commands: `python-skeleton-class', `python-skeleton-def'
;; `python-skeleton-for', `python-skeleton-if', `python-skeleton-try'
;; and `python-skeleton-while'.
167

168 169 170 171
;; FFAP: You can find the filename for a given module when using ffap
;; out of the box.  This feature needs an inferior python shell
;; running.

172 173
;; Code check: Check the current file for errors with `python-check'
;; using the program defined in `python-check-command'.
174

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
175
;; Eldoc: returns documentation for object at point by using the
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
176
;; inferior python subprocess to inspect its documentation.  As you
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
177 178 179
;; might guessed you should run `python-shell-send-buffer' from time
;; to time to get better results too.

180
;; Imenu: This mode supports Imenu in its most basic form, letting it
181 182
;; build the necessary alist via `imenu-default-create-index-function'
;; by having set `imenu-extract-index-name-function' to
183 184 185
;; `python-info-current-defun' and
;; `imenu-prev-index-position-function' to
;; `python-imenu-prev-index-position'.
186

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
;; If you used python-mode.el you probably will miss auto-indentation
;; when inserting newlines.  To achieve the same behavior you have
;; two options:

;; 1) Use GNU/Emacs' standard binding for `newline-and-indent': C-j.

;; 2) Add the following hook in your .emacs:

;; (add-hook 'python-mode-hook
;;   #'(lambda ()
;;       (define-key python-mode-map "\C-m" 'newline-and-indent)))

;; I'd recommend the first one since you'll get the same behavior for
;; all modes out-of-the-box.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
202 203 204 205 206 207 208 209 210 211 212 213
;;; Installation:

;; Add this to your .emacs:

;; (add-to-list 'load-path "/folder/containing/file")
;; (require 'python)

;;; TODO:

;;; Code:

(require 'ansi-color)
214
(require 'comint)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
215

216 217 218 219
;; Avoid compiler warnings
(defvar view-return-to-alist)
(defvar compilation-error-regexp-alist)
(defvar outline-heading-end-regexp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
220 221 222 223 224 225 226 227 228 229 230

(autoload 'comint-mode "comint")

;;;###autoload
(add-to-list 'auto-mode-alist (cons (purecopy "\\.py\\'")  'python-mode))
;;;###autoload
(add-to-list 'interpreter-mode-alist (cons (purecopy "python") 'python-mode))

(defgroup python nil
  "Python Language's flying circus support for Emacs."
  :group 'languages
231
  :version "24.3"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
232 233 234 235 236 237 238
  :link '(emacs-commentary-link "python"))


;;; Bindings

(defvar python-mode-map
  (let ((map (make-sparse-keymap)))
239
    ;; Movement
240 241 242
    (define-key map [remap backward-sentence] 'python-nav-backward-block)
    (define-key map [remap forward-sentence] 'python-nav-forward-block)
    (define-key map [remap backward-up-list] 'python-nav-backward-up-list)
243
    (define-key map "\C-c\C-j" 'imenu)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
244 245 246 247 248
    ;; Indent specific
    (define-key map "\177" 'python-indent-dedent-line-backspace)
    (define-key map (kbd "<backtab>") 'python-indent-dedent-line)
    (define-key map "\C-c<" 'python-indent-shift-left)
    (define-key map "\C-c>" 'python-indent-shift-right)
249
    (define-key map ":" 'python-indent-electric-colon)
250 251 252 253 254 255 256
    ;; Skeletons
    (define-key map "\C-c\C-tc" 'python-skeleton-class)
    (define-key map "\C-c\C-td" 'python-skeleton-def)
    (define-key map "\C-c\C-tf" 'python-skeleton-for)
    (define-key map "\C-c\C-ti" 'python-skeleton-if)
    (define-key map "\C-c\C-tt" 'python-skeleton-try)
    (define-key map "\C-c\C-tw" 'python-skeleton-while)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
257
    ;; Shell interaction
258
    (define-key map "\C-c\C-p" 'run-python)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
259 260 261 262 263 264
    (define-key map "\C-c\C-s" 'python-shell-send-string)
    (define-key map "\C-c\C-r" 'python-shell-send-region)
    (define-key map "\C-\M-x" 'python-shell-send-defun)
    (define-key map "\C-c\C-c" 'python-shell-send-buffer)
    (define-key map "\C-c\C-l" 'python-shell-send-file)
    (define-key map "\C-c\C-z" 'python-shell-switch-to-shell)
265 266
    ;; Some util commands
    (define-key map "\C-c\C-v" 'python-check)
267
    (define-key map "\C-c\C-f" 'python-eldoc-at-point)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
268 269
    ;; Utilities
    (substitute-key-definition 'complete-symbol 'completion-at-point
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
270
                               map global-map)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
271 272
    (easy-menu-define python-menu map "Python Mode menu"
      `("Python"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
273 274 275 276 277 278 279 280 281 282 283 284
        :help "Python-specific Features"
        ["Shift region left" python-indent-shift-left :active mark-active
         :help "Shift region left by a single indentation step"]
        ["Shift region right" python-indent-shift-right :active mark-active
         :help "Shift region right by a single indentation step"]
        "-"
        ["Start of def/class" beginning-of-defun
         :help "Go to start of outermost definition around point"]
        ["End of def/class" end-of-defun
         :help "Go to end of definition around point"]
        ["Mark def/class" mark-defun
         :help "Mark outermost definition around point"]
285
        ["Jump to def/class" imenu
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
286
         :help "Jump to a class or function definition"]
287
        "--"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
288
        ("Skeletons")
289
        "---"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
        ["Start interpreter" run-python
         :help "Run inferior Python process in a separate buffer"]
        ["Switch to shell" python-shell-switch-to-shell
         :help "Switch to running inferior Python process"]
        ["Eval string" python-shell-send-string
         :help "Eval string in inferior Python session"]
        ["Eval buffer" python-shell-send-buffer
         :help "Eval buffer in inferior Python session"]
        ["Eval region" python-shell-send-region
         :help "Eval region in inferior Python session"]
        ["Eval defun" python-shell-send-defun
         :help "Eval defun in inferior Python session"]
        ["Eval file" python-shell-send-file
         :help "Eval file in inferior Python session"]
        ["Debugger" pdb :help "Run pdb under GUD"]
305
        "----"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
306 307 308 309 310 311
        ["Check file" python-check
         :help "Check file for errors"]
        ["Help on symbol" python-eldoc-at-point
         :help "Get help on symbol at point"]
        ["Complete symbol" completion-at-point
         :help "Complete symbol before point"]))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
312 313 314 315 316 317
    map)
  "Keymap for `python-mode'.")


;;; Python specialized rx

318 319
(eval-when-compile
  (defconst python-rx-constituents
320
    `((block-start          . ,(rx symbol-start
321 322 323
                                   (or "def" "class" "if" "elif" "else" "try"
                                       "except" "finally" "for" "while" "with")
                                   symbol-end))
324
      (decorator            . ,(rx line-start (* space) ?@ (any letter ?_)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
325
                                   (* (any word ?_))))
326 327
      (defun                . ,(rx symbol-start (or "def" "class") symbol-end))
      (if-name-main         . ,(rx line-start "if" (+ space) "__name__"
328 329 330
                                   (+ space) "==" (+ space)
                                   (any ?' ?\") "__main__" (any ?' ?\")
                                   (* space) ?:))
331 332 333 334 335 336
      (symbol-name          . ,(rx (any letter ?_) (* (any word ?_))))
      (open-paren           . ,(rx (or "{" "[" "(")))
      (close-paren          . ,(rx (or "}" "]" ")")))
      (simple-operator      . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))
      ;; FIXME: rx should support (not simple-operator).
      (not-simple-operator  . ,(rx
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
337 338
                                (not
                                 (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
339 340
      ;; FIXME: Use regexp-opt.
      (operator             . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
341 342
                                       "=" "%" "**" "//" "<<" ">>" "<=" "!="
                                       "==" ">=" "is" "not")))
343 344
      ;; FIXME: Use regexp-opt.
      (assignment-operator  . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
345 346 347 348 349 350 351 352 353 354 355 356 357 358
                                       ">>=" "<<=" "&=" "^=" "|=")))
      (string-delimiter . ,(rx (and
                                ;; Match even number of backslashes.
                                (or (not (any ?\\ ?\' ?\")) point
                                    ;; Quotes might be preceded by a escaped quote.
                                    (and (or (not (any ?\\)) point) ?\\
                                         (* ?\\ ?\\) (any ?\' ?\")))
                                (* ?\\ ?\\)
                                ;; Match single or triple quotes of any kind.
                                (group (or  "\"" "\"\"\"" "'" "'''"))))))
    "Additional Python specific sexps for `python-rx'")

  (defmacro python-rx (&rest regexps)
    "Python mode specialized rx macro.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
359
This variant of `rx' supports common python named REGEXPS."
360 361 362 363 364 365 366
    (let ((rx-constituents (append python-rx-constituents rx-constituents)))
      (cond ((null regexps)
             (error "No regexp"))
            ((cdr regexps)
             (rx-to-string `(and ,@regexps) t))
            (t
             (rx-to-string (car regexps) t))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
367 368 369


;;; Font-lock and syntax
370 371 372 373 374

(defun python-syntax-context (type &optional syntax-ppss)
  "Return non-nil if point is on TYPE using SYNTAX-PPSS.
TYPE can be `comment', `string' or `paren'.  It returns the start
character address of the specified TYPE."
375 376 377 378 379 380 381 382 383 384 385 386
  (declare (compiler-macro
            (lambda (form)
              (pcase type
                (`'comment
                 `(let ((ppss (or ,syntax-ppss (syntax-ppss))))
                    (and (nth 4 ppss) (nth 8 ppss))))
                (`'string
                 `(let ((ppss (or ,syntax-ppss (syntax-ppss))))
                    (and (nth 3 ppss) (nth 8 ppss))))
                (`'paren
                 `(nth 1 (or ,syntax-ppss (syntax-ppss))))
                (_ form)))))
387
  (let ((ppss (or syntax-ppss (syntax-ppss))))
388 389 390 391 392
    (pcase type
      (`comment (and (nth 4 ppss) (nth 8 ppss)))
      (`string (and (nth 3 ppss) (nth 8 ppss)))
      (`paren (nth 1 ppss))
      (_ nil))))
393 394 395 396 397 398 399 400 401 402 403 404 405 406

(defun python-syntax-context-type (&optional syntax-ppss)
  "Return the context type using SYNTAX-PPSS.
The type returned can be `comment', `string' or `paren'."
  (let ((ppss (or syntax-ppss (syntax-ppss))))
    (cond
     ((nth 8 ppss) (if (nth 4 ppss) 'comment 'string))
     ((nth 1 ppss) 'paren))))

(defsubst python-syntax-comment-or-string-p ()
  "Return non-nil if point is inside 'comment or 'string."
  (nth 8 (syntax-ppss)))

(define-obsolete-function-alias
407
  'python-info-ppss-context #'python-syntax-context "24.3")
408 409

(define-obsolete-function-alias
410
  'python-info-ppss-context-type #'python-syntax-context-type "24.3")
411 412 413

(define-obsolete-function-alias
  'python-info-ppss-comment-or-string-p
414
  #'python-syntax-comment-or-string-p "24.3")
415

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
416 417 418
(defvar python-font-lock-keywords
  ;; Keywords
  `(,(rx symbol-start
419 420 421 422 423 424 425 426 427 428 429 430
         (or
          "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
          "assert" "else" "if" "pass" "yield" "break" "except" "import" "class"
          "in" "raise" "continue" "finally" "is" "return" "def" "for" "lambda"
          "try"
          ;; Python 2:
          "print" "exec"
          ;; Python 3:
          ;; False, None, and True are listed as keywords on the Python 3
          ;; documentation, but since they also qualify as constants they are
          ;; fontified like that in order to keep font-lock consistent between
          ;; Python versions.
431 432 433
          "nonlocal"
          ;; Extra:
          "self")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
434 435 436 437 438 439 440 441
         symbol-end)
    ;; functions
    (,(rx symbol-start "def" (1+ space) (group (1+ (or word ?_))))
     (1 font-lock-function-name-face))
    ;; classes
    (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_))))
     (1 font-lock-type-face))
    ;; Constants
442
    (,(rx symbol-start
443 444 445 446 447
          (or
           "Ellipsis" "False" "None" "NotImplemented" "True" "__debug__"
           ;; copyright, license, credits, quit and exit are added by the site
           ;; module and they are not intended to be used in programs
           "copyright" "credits" "exit" "license" "quit")
448
          symbol-end) . font-lock-constant-face)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
449 450 451 452 453 454
    ;; Decorators.
    (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
                                            (0+ "." (1+ (or word ?_)))))
     (1 font-lock-type-face))
    ;; Builtin Exceptions
    (,(rx symbol-start
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
          (or
           "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
           "DeprecationWarning" "EOFError" "EnvironmentError" "Exception"
           "FloatingPointError" "FutureWarning" "GeneratorExit" "IOError"
           "ImportError" "ImportWarning" "IndexError" "KeyError"
           "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
           "NotImplementedError" "OSError" "OverflowError"
           "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
           "RuntimeWarning" "StopIteration" "SyntaxError" "SyntaxWarning"
           "SystemError" "SystemExit" "TypeError" "UnboundLocalError"
           "UnicodeDecodeError" "UnicodeEncodeError" "UnicodeError"
           "UnicodeTranslateError" "UnicodeWarning" "UserWarning" "VMSError"
           "ValueError" "Warning" "WindowsError" "ZeroDivisionError"
           ;; Python 2:
           "StandardError"
           ;; Python 3:
           "BufferError" "BytesWarning" "IndentationError" "ResourceWarning"
           "TabError")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
473 474
          symbol-end) . font-lock-type-face)
    ;; Builtins
475
    (,(rx symbol-start
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
          (or
           "abs" "all" "any" "bin" "bool" "callable" "chr" "classmethod"
           "compile" "complex" "delattr" "dict" "dir" "divmod" "enumerate"
           "eval" "filter" "float" "format" "frozenset" "getattr" "globals"
           "hasattr" "hash" "help" "hex" "id" "input" "int" "isinstance"
           "issubclass" "iter" "len" "list" "locals" "map" "max" "memoryview"
           "min" "next" "object" "oct" "open" "ord" "pow" "print" "property"
           "range" "repr" "reversed" "round" "set" "setattr" "slice" "sorted"
           "staticmethod" "str" "sum" "super" "tuple" "type" "vars" "zip"
           "__import__"
           ;; Python 2:
           "basestring" "cmp" "execfile" "file" "long" "raw_input" "reduce"
           "reload" "unichr" "unicode" "xrange" "apply" "buffer" "coerce"
           "intern"
           ;; Python 3:
           "ascii" "bytearray" "bytes" "exec"
           ;; Extra:
           "__all__" "__doc__" "__name__" "__package__")
494
          symbol-end) . font-lock-builtin-face)
Paul Eggert's avatar
Paul Eggert committed
495
    ;; assignments
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
496 497
    ;; support for a = b = c = 5
    (,(lambda (limit)
498 499
        (let ((re (python-rx (group (+ (any word ?. ?_)))
                             (? ?\[ (+ (not (any  ?\]))) ?\]) (* space)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
500 501
                             assignment-operator)))
          (when (re-search-forward re limit t)
502
            (while (and (python-syntax-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
503
                        (re-search-forward re limit t)))
504 505
            (if (not (or (python-syntax-context 'paren)
                         (equal (char-after (point-marker)) ?=)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
506 507 508 509 510 511 512 513 514 515 516
                t
              (set-match-data nil)))))
     (1 font-lock-variable-name-face nil nil))
    ;; support for a, b, c = (1, 2, 3)
    (,(lambda (limit)
        (let ((re (python-rx (group (+ (any word ?. ?_))) (* space)
                             (* ?, (* space) (+ (any word ?. ?_)) (* space))
                             ?, (* space) (+ (any word ?. ?_)) (* space)
                             assignment-operator)))
          (when (and (re-search-forward re limit t)
                     (goto-char (nth 3 (match-data))))
517
            (while (and (python-syntax-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
518 519
                        (re-search-forward re limit t))
              (goto-char (nth 3 (match-data))))
520
            (if (not (python-syntax-context 'paren))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
521 522 523 524
                t
              (set-match-data nil)))))
     (1 font-lock-variable-name-face nil nil))))

525 526
(defconst python-syntax-propertize-function
  (syntax-propertize-rules
527
   ((python-rx string-delimiter)
528
    (0 (ignore (python-syntax-stringify))))))
529 530 531 532 533 534 535 536 537 538

(defsubst python-syntax-count-quotes (quote-char &optional point limit)
  "Count number of quotes around point (max is 3).
QUOTE-CHAR is the quote char to count.  Optional argument POINT is
the point where scan starts (defaults to current point) and LIMIT
is used to limit the scan."
  (let ((i 0))
    (while (and (< i 3)
                (or (not limit) (< (+ point i) limit))
                (eq (char-after (+ point i)) quote-char))
539
      (setq i (1+ i)))
540 541 542 543
    i))

(defun python-syntax-stringify ()
  "Put `syntax-table' property correctly on single/triple quotes."
544
  (let* ((num-quotes (length (match-string-no-properties 1)))
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
         (ppss (prog2
                   (backward-char num-quotes)
                   (syntax-ppss)
                 (forward-char num-quotes)))
         (string-start (and (not (nth 4 ppss)) (nth 8 ppss)))
         (quote-starting-pos (- (point) num-quotes))
         (quote-ending-pos (point))
         (num-closing-quotes
          (and string-start
               (python-syntax-count-quotes
                (char-before) string-start quote-starting-pos))))
    (cond ((and string-start (= num-closing-quotes 0))
           ;; This set of quotes doesn't match the string starting
           ;; kind. Do nothing.
           nil)
          ((not string-start)
           ;; This set of quotes delimit the start of a string.
           (put-text-property quote-starting-pos (1+ quote-starting-pos)
                              'syntax-table (string-to-syntax "|")))
          ((= num-quotes num-closing-quotes)
           ;; This set of quotes delimit the end of a string.
           (put-text-property (1- quote-ending-pos) quote-ending-pos
                              'syntax-table (string-to-syntax "|")))
          ((> num-quotes num-closing-quotes)
           ;; This may only happen whenever a triple quote is closing
           ;; a single quoted string. Add string delimiter syntax to
           ;; all three quotes.
           (put-text-property quote-starting-pos quote-ending-pos
                              'syntax-table (string-to-syntax "|"))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
574 575 576 577 578 579

(defvar python-mode-syntax-table
  (let ((table (make-syntax-table)))
    ;; Give punctuation syntax to ASCII that normally has symbol
    ;; syntax or has word syntax and isn't a letter.
    (let ((symbol (string-to-syntax "_"))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
580
          (sst (standard-syntax-table)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
581
      (dotimes (i 128)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
582 583 584
        (unless (= i ?_)
          (if (equal symbol (aref sst i))
              (modify-syntax-entry i "." table)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
    (modify-syntax-entry ?$ "." table)
    (modify-syntax-entry ?% "." table)
    ;; exceptions
    (modify-syntax-entry ?# "<" table)
    (modify-syntax-entry ?\n ">" table)
    (modify-syntax-entry ?' "\"" table)
    (modify-syntax-entry ?` "$" table)
    table)
  "Syntax table for Python files.")

(defvar python-dotty-syntax-table
  (let ((table (make-syntax-table python-mode-syntax-table)))
    (modify-syntax-entry ?. "w" table)
    (modify-syntax-entry ?_ "w" table)
    table)
  "Dotty syntax table for Python files.
It makes underscores and dots word constituent chars.")


;;; Indentation

(defcustom python-indent-offset 4
  "Default indentation offset for Python."
  :group 'python
  :type 'integer
  :safe 'integerp)

(defcustom python-indent-guess-indent-offset t
  "Non-nil tells Python mode to guess `python-indent-offset' value."
  :type 'boolean
615 616
  :group 'python
  :safe 'booleanp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
617

618 619 620 621 622 623
(defcustom python-indent-trigger-commands
  '(indent-for-tab-command yas-expand yas/expand)
  "Commands that might trigger a `python-indent-line' call."
  :type '(repeat symbol)
  :group 'python)

624
(define-obsolete-variable-alias
625
  'python-indent 'python-indent-offset "24.3")
626 627

(define-obsolete-variable-alias
628
  'python-guess-indent 'python-indent-guess-indent-offset "24.3")
629

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
630 631 632 633 634 635 636 637 638 639 640
(defvar python-indent-current-level 0
  "Current indentation level `python-indent-line-function' is using.")

(defvar python-indent-levels '(0)
  "Levels of indentation available for `python-indent-line-function'.")

(defvar python-indent-dedenters '("else" "elif" "except" "finally")
  "List of words that should be dedented.
These make `python-indent-calculate-indentation' subtract the value of
`python-indent-offset'.")

641 642 643 644 645 646
(defvar python-indent-block-enders '("return" "pass")
  "List of words that mark the end of a block.
These make `python-indent-calculate-indentation' subtract the
value of `python-indent-offset' when `python-indent-context' is
AFTER-LINE.")

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
647
(defun python-indent-guess-indent-offset ()
648
  "Guess and set `python-indent-offset' for the current buffer."
649
  (interactive)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
650 651 652 653 654 655 656 657 658
  (save-excursion
    (save-restriction
      (widen)
      (goto-char (point-min))
      (let ((block-end))
        (while (and (not block-end)
                    (re-search-forward
                     (python-rx line-start block-start) nil t))
          (when (and
659
                 (not (python-syntax-context-type))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
                 (progn
                   (goto-char (line-end-position))
                   (python-util-forward-comment -1)
                   (if (equal (char-before) ?:)
                       t
                     (forward-line 1)
                     (when (python-info-block-continuation-line-p)
                       (while (and (python-info-continuation-line-p)
                                   (not (eobp)))
                         (forward-line 1))
                       (python-util-forward-comment -1)
                       (when (equal (char-before) ?:)
                         t)))))
            (setq block-end (point-marker))))
        (let ((indentation
               (when block-end
                 (goto-char block-end)
                 (python-util-forward-comment)
                 (current-indentation))))
          (if indentation
680
              (set (make-local-variable 'python-indent-offset) indentation)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
681 682
            (message "Can't guess python-indent-offset, using defaults: %s"
                     python-indent-offset)))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
683

684 685 686 687
(defun python-indent-context ()
  "Get information on indentation context.
Context information is returned with a cons with the form:
    \(STATUS . START)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702

Where status can be any of the following symbols:
 * inside-paren: If point in between (), {} or []
 * inside-string: If point is inside a string
 * after-backslash: Previous line ends in a backslash
 * after-beginning-of-block: Point is after beginning of block
 * after-line: Point is after normal line
 * no-indent: Point is at beginning of buffer or other special case
START is the buffer position where the sexp starts."
  (save-restriction
    (widen)
    (let ((ppss (save-excursion (beginning-of-line) (syntax-ppss)))
          (start))
      (cons
       (cond
703
        ;; Beginning of buffer
704 705 706
        ((save-excursion
           (goto-char (line-beginning-position))
           (bobp))
707
         'no-indent)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
708
        ;; Inside string
709
        ((setq start (python-syntax-context 'string ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
710
         'inside-string)
711 712 713
        ;; Inside a paren
        ((setq start (python-syntax-context 'paren ppss))
         'inside-paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
714
        ;; After backslash
715 716
        ((setq start (when (not (or (python-syntax-context 'string ppss)
                                    (python-syntax-context 'comment ppss)))
717 718 719
                       (let ((line-beg-pos (line-number-at-pos)))
                         (python-info-line-ends-backslash-p
                          (1- line-beg-pos)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
720 721 722
         'after-backslash)
        ;; After beginning of block
        ((setq start (save-excursion
723 724 725 726 727 728 729 730 731 732
                       (when (progn
                               (back-to-indentation)
                               (python-util-forward-comment -1)
                               (equal (char-before) ?:))
                         ;; Move to the first block start that's not in within
                         ;; a string, comment or paren and that's not a
                         ;; continuation line.
                         (while (and (re-search-backward
                                      (python-rx block-start) nil t)
                                     (or
733
                                      (python-syntax-context-type)
734 735
                                      (python-info-continuation-line-p))))
                         (when (looking-at (python-rx block-start))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
736 737 738 739
                           (point-marker)))))
         'after-beginning-of-block)
        ;; After normal line
        ((setq start (save-excursion
740
                       (back-to-indentation)
741
                       (skip-chars-backward (rx (or whitespace ?\n)))
742
                       (python-nav-beginning-of-statement)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
743 744 745 746 747 748 749 750 751 752 753 754 755 756
                       (point-marker)))
         'after-line)
        ;; Do not indent
        (t 'no-indent))
       start))))

(defun python-indent-calculate-indentation ()
  "Calculate correct indentation offset for the current line."
  (let* ((indentation-context (python-indent-context))
         (context-status (car indentation-context))
         (context-start (cdr indentation-context)))
    (save-restriction
      (widen)
      (save-excursion
757 758
        (pcase context-status
          (`no-indent 0)
759 760
          ;; When point is after beginning of block just add one level
          ;; of indentation relative to the context-start
761
          (`after-beginning-of-block
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
762 763
           (goto-char context-start)
           (+ (current-indentation) python-indent-offset))
764 765 766
          ;; When after a simple line just use previous line
          ;; indentation, in the case current line starts with a
          ;; `python-indent-dedenters' de-indent one level.
767
          (`after-line
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
768 769 770 771
           (-
            (save-excursion
              (goto-char context-start)
              (current-indentation))
772 773 774 775 776 777 778
            (if (or (save-excursion
                      (back-to-indentation)
                      (looking-at (regexp-opt python-indent-dedenters)))
                    (save-excursion
                      (python-util-forward-comment -1)
                      (python-nav-beginning-of-statement)
                      (member (current-word) python-indent-block-enders)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
779 780
                python-indent-offset
              0)))
781 782 783
          ;; When inside of a string, do nothing. just use the current
          ;; indentation.  XXX: perhaps it would be a good idea to
          ;; invoke standard text indentation here
784
          (`inside-string
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
785 786
           (goto-char context-start)
           (current-indentation))
Paul Eggert's avatar
Paul Eggert committed
787
          ;; After backslash we have several possibilities.
788
          (`after-backslash
789 790 791 792 793 794 795
           (cond
            ;; Check if current line is a dot continuation.  For this
            ;; the current line must start with a dot and previous
            ;; line must contain a dot too.
            ((save-excursion
               (back-to-indentation)
               (when (looking-at "\\.")
796 797 798 799 800
                 ;; If after moving one line back point is inside a paren it
                 ;; needs to move back until it's not anymore
                 (while (prog2
                            (forward-line -1)
                            (and (not (bobp))
801
                                 (python-syntax-context 'paren))))
802
                 (goto-char (line-end-position))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
803 804
                 (while (and (re-search-backward
                              "\\." (line-beginning-position) t)
805
                             (python-syntax-context-type)))
806
                 (if (and (looking-at "\\.")
807
                          (not (python-syntax-context-type)))
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
                     ;; The indentation is the same column of the
                     ;; first matching dot that's not inside a
                     ;; comment, a string or a paren
                     (current-column)
                   ;; No dot found on previous line, just add another
                   ;; indentation level.
                   (+ (current-indentation) python-indent-offset)))))
            ;; Check if prev line is a block continuation
            ((let ((block-continuation-start
                    (python-info-block-continuation-line-p)))
               (when block-continuation-start
                 ;; If block-continuation-start is set jump to that
                 ;; marker and use first column after the block start
                 ;; as indentation value.
                 (goto-char block-continuation-start)
                 (re-search-forward
                  (python-rx block-start (* space))
                  (line-end-position) t)
                 (current-column))))
            ;; Check if current line is an assignment continuation
            ((let ((assignment-continuation-start
                    (python-info-assignment-continuation-line-p)))
               (when assignment-continuation-start
                 ;; If assignment-continuation is set jump to that
                 ;; marker and use first column after the assignment
                 ;; operator as indentation value.
                 (goto-char assignment-continuation-start)
                 (current-column))))
            (t
             (forward-line -1)
Paul Eggert's avatar
Paul Eggert committed
838
             (goto-char (python-info-beginning-of-backslash))
839 840 841
             (if (save-excursion
                   (and
                    (forward-line -1)
842
                    (goto-char
Paul Eggert's avatar
Paul Eggert committed
843
                     (or (python-info-beginning-of-backslash) (point)))
844 845 846 847 848 849 850 851 852 853
                    (python-info-line-ends-backslash-p)))
                 ;; The two previous lines ended in a backslash so we must
                 ;; respect previous line indentation.
                 (current-indentation)
               ;; What happens here is that we are dealing with the second
               ;; line of a backslash continuation, in that case we just going
               ;; to add one indentation level.
               (+ (current-indentation) python-indent-offset)))))
          ;; When inside a paren there's a need to handle nesting
          ;; correctly
854
          (`inside-paren
855
           (cond
Paul Eggert's avatar
Paul Eggert committed
856
            ;; If current line closes the outermost open paren use the
857 858 859 860 861 862
            ;; current indentation of the context-start line.
            ((save-excursion
               (skip-syntax-forward "\s" (line-end-position))
               (when (and (looking-at (regexp-opt '(")" "]" "}")))
                          (progn
                            (forward-char 1)
863
                            (not (python-syntax-context 'paren))))
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
                 (goto-char context-start)
                 (current-indentation))))
            ;; If open paren is contained on a line by itself add another
            ;; indentation level, else look for the first word after the
            ;; opening paren and use it's column position as indentation
            ;; level.
            ((let* ((content-starts-in-newline)
                    (indent
                     (save-excursion
                       (if (setq content-starts-in-newline
                                 (progn
                                   (goto-char context-start)
                                   (forward-char)
                                   (save-restriction
                                     (narrow-to-region
                                      (line-beginning-position)
                                      (line-end-position))
                                     (python-util-forward-comment))
                                   (looking-at "$")))
                           (+ (current-indentation) python-indent-offset)
                         (current-column)))))
               ;; Adjustments
               (cond
                ;; If current line closes a nested open paren de-indent one
                ;; level.
                ((progn
890
                   (back-to-indentation)
891 892 893 894 895 896 897 898 899 900 901 902 903
                   (looking-at (regexp-opt '(")" "]" "}"))))
                 (- indent python-indent-offset))
                ;; If the line of the opening paren that wraps the current
                ;; line starts a block add another level of indentation to
                ;; follow new pep8 recommendation. See: http://ur1.ca/5rojx
                ((save-excursion
                   (when (and content-starts-in-newline
                              (progn
                                (goto-char context-start)
                                (back-to-indentation)
                                (looking-at (python-rx block-start))))
                     (+ indent python-indent-offset))))
                (t indent)))))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
904 905 906 907 908 909

(defun python-indent-calculate-levels ()
  "Calculate `python-indent-levels' and reset `python-indent-current-level'."
  (let* ((indentation (python-indent-calculate-indentation))
         (remainder (% indentation python-indent-offset))
         (steps (/ (- indentation remainder) python-indent-offset)))
910
    (setq python-indent-levels (list 0))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
911
    (dotimes (step steps)
912
      (push (* python-indent-offset (1+ step)) python-indent-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
913
    (when (not (eq 0 remainder))
914
      (push (+ (* python-indent-offset steps) remainder) python-indent-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
915 916 917 918 919 920 921 922 923 924 925 926 927
    (setq python-indent-levels (nreverse python-indent-levels))
    (setq python-indent-current-level (1- (length python-indent-levels)))))

(defun python-indent-toggle-levels ()
  "Toggle `python-indent-current-level' over `python-indent-levels'."
  (setq python-indent-current-level (1- python-indent-current-level))
  (when (< python-indent-current-level 0)
    (setq python-indent-current-level (1- (length python-indent-levels)))))

(defun python-indent-line (&optional force-toggle)
  "Internal implementation of `python-indent-line-function'.
Uses the offset calculated in
`python-indent-calculate-indentation' and available levels
928 929
indicated by the variable `python-indent-levels' to set the
current indentation.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
930

931 932 933 934 935 936 937 938 939 940 941 942 943
When the variable `last-command' is equal to one of the symbols
inside `python-indent-trigger-commands' or FORCE-TOGGLE is
non-nil it cycles levels indicated in the variable
`python-indent-levels' by setting the current level in the
variable `python-indent-current-level'.

When the variable `last-command' is not equal to one of the
symbols inside `python-indent-trigger-commands' and FORCE-TOGGLE
is nil it calculates possible indentation levels and saves it in
the variable `python-indent-levels'.  Afterwards it sets the
variable `python-indent-current-level' correctly so offset is
equal to (`nth' `python-indent-current-level'
`python-indent-levels')"
944
  (or
945
   (and (or (and (memq this-command python-indent-trigger-commands)
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
                 (eq last-command this-command))
            force-toggle)
        (not (equal python-indent-levels '(0)))
        (or (python-indent-toggle-levels) t))
   (python-indent-calculate-levels))
  (let* ((starting-pos (point-marker))
         (indent-ending-position
          (+ (line-beginning-position) (current-indentation)))
         (follow-indentation-p
          (or (bolp)
              (and (<= (line-beginning-position) starting-pos)
                   (>= indent-ending-position starting-pos))))
         (next-indent (nth python-indent-current-level python-indent-levels)))
    (unless (= next-indent (current-indentation))
      (beginning-of-line)
      (delete-horizontal-space)
      (indent-to next-indent)
      (goto-char starting-pos))
    (and follow-indentation-p (back-to-indentation)))
965
  (python-info-closing-block-message))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
966 967 968

(defun python-indent-line-function ()
  "`indent-line-function' for Python mode.
969
See `python-indent-line' for details."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
970 971 972
  (python-indent-line))

(defun python-indent-dedent-line ()
973
  "De-indent current line."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
974
  (interactive "*")
975
  (when (and (not (python-syntax-comment-or-string-p))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
976 977 978 979 980 981 982 983
             (<= (point-marker) (save-excursion
                                  (back-to-indentation)
                                  (point-marker)))
             (> (current-column) 0))
    (python-indent-line t)
    t))

(defun python-indent-dedent-line-backspace (arg)
984
  "De-indent current line.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
985
Argument ARG is passed to `backward-delete-char-untabify' when
986
point is  not in between the indentation."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
987 988 989
  (interactive "*p")
  (when (not (python-indent-dedent-line))
    (backward-delete-char-untabify arg)))
990
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
991 992 993 994 995

(defun python-indent-region (start end)
  "Indent a python region automagically.

Called from a program, START and END specify the region to indent."
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
  (let ((deactivate-mark nil))
    (save-excursion
      (goto-char end)
      (setq end (point-marker))
      (goto-char start)
      (or (bolp) (forward-line 1))
      (while (< (point) end)
        (or (and (bolp) (eolp))
            (let (word)
              (forward-line -1)
              (back-to-indentation)
              (setq word (current-word))
              (forward-line 1)
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018
              (when (and word
                         ;; Don't mess with strings, unless it's the
                         ;; enclosing set of quotes.
                         (or (not (python-syntax-context 'string))
                             (eq
                              (syntax-after
                               (+ (1- (point))
                                  (current-indentation)
                                  (python-syntax-count-quotes (char-after) (point))))
                              (string-to-syntax "|"))))
1019 1020 1021 1022 1023
                (beginning-of-line)
                (delete-horizontal-space)
                (indent-to (python-indent-calculate-indentation)))))
        (forward-line 1))
      (move-marker end nil))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1024 1025 1026

(defun python-indent-shift-left (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
1027 1028 1029 1030
COUNT defaults to `python-indent-offset'.  If region isn't
active, the current line is shifted.  The shifted region includes
the lines in which START and END lie.  An error is signaled if
any lines in the region are indented less than COUNT columns."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1031 1032 1033 1034 1035 1036 1037 1038
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
  (if count
      (setq count (prefix-numeric-value count))
    (setq count python-indent-offset))
  (when (> count 0)
1039 1040 1041 1042 1043 1044 1045 1046 1047
    (let ((deactivate-mark nil))
      (save-excursion
        (goto-char start)
        (while (< (point) end)
          (if (and (< (current-indentation) count)
                   (not (looking-at "[ \t]*$")))
              (error "Can't shift all lines enough"))
          (forward-line))
        (indent-rigidly start end (- count))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1048 1049 1050 1051 1052

(add-to-list 'debug-ignored-errors "^Can't shift all lines enough")

(defun python-indent-shift-right (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
1053 1054 1055
COUNT defaults to `python-indent-offset'.  If region isn't
active, the current line is shifted.  The shifted region includes
the lines in which START and END lie."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1056 1057 1058 1059
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
1060 1061 1062 1063 1064
  (let ((deactivate-mark nil))
    (if count
        (setq count (prefix-numeric-value count))
      (setq count python-indent-offset))
    (indent-rigidly start end count)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1065

1066
(defun python-indent-electric-colon (arg)
1067 1068 1069
  "Insert a colon and maybe de-indent the current line.
With numeric ARG, just insert that many colons.  With
\\[universal-argument], just insert a single colon."
1070 1071
  (interactive "*P")
  (self-insert-command (if (not (integerp arg)) 1 arg))
1072 1073 1074
  (when (and (not arg)
             (eolp)
             (not (equal ?: (char-after (- (point-marker) 2))))
1075
             (not (python-syntax-comment-or-string-p)))
1076 1077
    (let ((indentation (current-indentation))
          (calculated-indentation (python-indent-calculate-indentation)))
1078
      (python-info-closing-block-message)
1079 1080 1081
      (when (> indentation calculated-indentation)
        (save-excursion
          (indent-line-to calculated-indentation)
1082
          (when (not (python-info-closing-block-message))
1083
            (indent-line-to indentation)))))))
1084 1085
(put 'python-indent-electric-colon 'delete-selection t)

1086 1087 1088 1089 1090 1091 1092 1093 1094
(defun python-indent-post-self-insert-function ()
  "Adjust closing paren line indentation after a char is added.
This function is intended to be added to the
`post-self-insert-hook.'  If a line renders a paren alone, after
adding a char before it, the line will be re-indented
automatically if needed."
  (when (and (eq (char-before) last-command-event)
             (not (bolp))
             (memq (char-after) '(?\) ?\] ?\})))
1095 1096 1097 1098
    (save-excursion
      (goto-char (line-beginning-position))
      ;; If after going to the beginning of line the point
      ;; is still inside a paren it's ok to do the trick
1099
      (when (python-syntax-context 'paren)
1100 1101 1102
        (let ((indentation (python-indent-calculate-indentation)))
          (when (< (current-indentation) indentation)
            (indent-line-to indentation)))))))
1103

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1104 1105 1106

;;; Navigation

1107
(defvar python-nav-beginning-of-defun-regexp
1108
  (python-rx line-start (* space) defun (+ space) (group symbol-name))
1109
  "Regexp matching class or function definition.
1110 1111
The name of the defun should be grouped so it can be retrieved
via `match-string'.")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1112

1113 1114 1115
(defun python-nav--beginning-of-defun (&optional arg)
  "Internal implementation of `python-nav-beginning-of-defun'.
With positive ARG search backwards, else search forwards."
1116 1117 1118 1119 1120 1121 1122
  (when (or (null arg) (= arg 0)) (setq arg 1))
  (let* ((re-search-fn (if (> arg 0)
                           #'re-search-backward
                         #'re-search-forward))
         (line-beg-pos (line-beginning-position))
         (line-content-start (+ line-beg-pos (current-indentation)))
         (pos (point-marker))
1123 1124 1125
         (beg-indentation
          (and (> arg 0)
               (save-excursion
1126 1127 1128 1129 1130 1131
                 (while (and
                         (not (python-info-looking-at-beginning-of-defun))
                         (python-nav-backward-block)))
                 (or (and (python-info-looking-at-beginning-of-defun)
                          (+ (current-indentation) python-indent-offset))
                     0))))
1132 1133 1134 1135 1136 1137 1138
         (found
          (progn
            (when (and (< arg 0)
                       (python-info-looking-at-beginning-of-defun))
              (end-of-line 1))
            (while (and (funcall re-search-fn
                                 python-nav-beginning-of-defun-regexp nil t)
1139 1140 1141 1142 1143 1144
                        (or (python-syntax-context-type)
                            ;; Handle nested defuns when moving
                            ;; backwards by checking indentation.
                            (and (> arg 0)
                                 (not (= (current-indentation) 0))
                                 (>= (current-indentation) beg-indentation)))))
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154
            (and (python-info-looking-at-beginning-of-defun)
                 (or (not (= (line-number-at-pos pos)
                             (line-number-at-pos)))
                     (and (>= (point) line-beg-pos)
                          (<= (point) line-content-start)
                          (> pos line-content-start)))))))
    (if found
        (or (beginning-of-line 1) t)
      (and (goto-char pos) nil))))

1155 1156 1157 1158 1159 1160 1161
(defun python-nav-beginning-of-defun (&optional arg)
  "Move point to `beginning-of-defun'.
With positive ARG search backwards else search forward.  When ARG
is nil or 0 defaults to 1.  When searching backwards nested
defuns are handled with care depending on current point
position.  Return non-nil if point is moved to
`beginning-of-defun'."
1162
  (when (or (null arg) (= arg 0)) (setq arg 1))
1163 1164 1165 1166 1167
  (let ((found))
    (cond ((and (eq this-command 'mark-defun)
                (python-info-looking-at-beginning-of-defun)))
          (t
           (dotimes (i (if (> arg 0) arg (- arg)))
1168
             (when (and (python-nav--beginning-of-defun arg)
1169 1170 1171
                        (not found))
               (setq found t)))))
    found))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1172

1173
(defun python-nav-end-of-defun ()
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1174 1175
  "Move point to the end of def or class.
Returns nil if point is not in a def or class."