python.el 221 KB
Newer Older
1
;;; python.el --- Python's flying circus support for Emacs -*- lexical-binding: t -*-
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
2

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

5
;; Author: Fabián E. Gallina <fgallina@gnu.org>
6
;; URL: https://github.com/fgallina/python.el
7
;; Version: 0.26.1
8
;; Package-Requires: ((emacs "24.1") (cl-lib "1.0"))
9
;; Maintainer: emacs-devel@gnu.org
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
10 11 12
;; Created: Jul 2010
;; Keywords: languages

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

15 16 17 18
;; 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
19

20 21 22 23
;; 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
24 25

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

;;; 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
35
;; interaction, Shell completion, Shell virtualenv support, Shell
36 37
;; package support, Shell syntax highlighting, Pdb tracking, Symbol
;; completion, Skeletons, FFAP, Code Check, Eldoc, Imenu.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
38 39 40 41 42 43

;; 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
44 45 46
;; indentation by hitting <tab> several times.  Also electric-indent-mode
;; is supported such that when inserting a colon the current line is
;; dedented automatically if needed.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
47 48

;; Movement: `beginning-of-defun' and `end-of-defun' functions are
49
;; properly implemented.  There are also specialized
50 51 52 53
;; `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',
54 55
;; `python-nav-backward-statement',
;; `python-nav-beginning-of-statement', `python-nav-end-of-statement',
56 57 58 59 60 61
;; `python-nav-beginning-of-block', `python-nav-end-of-block' and
;; `python-nav-if-name-main' are included but no bound to any key.  At
;; last but not least the 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':
62 63 64

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

66 67 68 69 70 71 72
;; Shell interaction: is provided and allows opening Python shells
;; inside Emacs and executing any block of code of your current buffer
;; in that inferior Python process.

;; Besides that only the standard CPython (2.x and 3.x) shell and
;; IPython are officially supported out of the box, the interaction
;; should support any other readline based Python shells as well
73
;; (e.g. Jython and PyPy have been reported to work).  You can change
74 75 76 77 78 79 80 81 82
;; your default interpreter and commandline arguments by setting the
;; `python-shell-interpreter' and `python-shell-interpreter-args'
;; variables.  This example enables IPython globally:

;; (setq python-shell-interpreter "ipython"
;;       python-shell-interpreter-args "-i")

;; Using the "console" subcommand to start IPython in server-client
;; mode is known to fail intermittently due a bug on IPython itself
83
;; (see URL `https://debbugs.gnu.org/cgi/bugreport.cgi?bug=18052#27').
84 85 86 87 88 89 90 91 92 93
;; There seems to be a race condition in the IPython server (A.K.A
;; kernel) when code is sent while it is still initializing, sometimes
;; causing the shell to get stalled.  With that said, if an IPython
;; kernel is already running, "console --existing" seems to work fine.

;; Running IPython on Windows needs more tweaking.  The way you should
;; set `python-shell-interpreter' and `python-shell-interpreter-args'
;; is as follows (of course you need to modify the paths according to
;; your system):

94
;; (setq python-shell-interpreter "C:/Python27/python.exe"
95
;;       python-shell-interpreter-args
96
;;       "-i C:/Python27/Scripts/ipython-script.py")
97

98 99
;; Missing or delayed output used to happen due to differences between
;; Operating Systems' pipe buffering (e.g. CPython 3.3.4 in Windows 7.
100
;; See URL `https://debbugs.gnu.org/cgi/bugreport.cgi?bug=17304').  To
101 102 103 104
;; avoid this, the `python-shell-unbuffered' defaults to non-nil and
;; controls whether `python-shell-calculate-process-environment'
;; should set the "PYTHONUNBUFFERED" environment variable on startup:
;; See URL `https://docs.python.org/3/using/cmdline.html#cmdoption-u'.
105

106 107 108 109 110 111 112 113
;; The interaction relies upon having prompts for input (e.g. ">>> "
;; and "... " in standard Python shell) and output (e.g. "Out[1]: " in
;; IPython) detected properly.  Failing that Emacs may hang but, in
;; the case that happens, you can recover with \\[keyboard-quit].  To
;; avoid this issue, a two-step prompt autodetection mechanism is
;; provided: the first step is manual and consists of a collection of
;; regular expressions matching common prompts for Python shells
;; stored in `python-shell-prompt-input-regexps' and
114 115 116 117 118 119 120
;; `python-shell-prompt-output-regexps', and dir-local friendly vars
;; `python-shell-prompt-regexp', `python-shell-prompt-block-regexp',
;; `python-shell-prompt-output-regexp' which are appended to the
;; former automatically when a shell spawns; the second step is
;; automatic and depends on the `python-shell-prompt-detect' helper
;; function.  See its docstring for details on global variables that
;; modify its behavior.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
121 122

;; Shell completion: hitting tab will try to complete the current
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
;; word.  The two built-in mechanisms depend on Python's readline
;; module: the "native" completion is tried first and is activated
;; when `python-shell-completion-native-enable' is non-nil, the
;; current `python-shell-interpreter' is not a member of the
;; `python-shell-completion-native-disabled-interpreters' variable and
;; `python-shell-completion-native-setup' succeeds; the "fallback" or
;; "legacy" mechanism works by executing Python code in the background
;; and enables auto-completion for shells that do not support
;; receiving escape sequences (with some limitations, i.e. completion
;; in blocks does not work).  The code executed for the "fallback"
;; completion can be found in `python-shell-completion-setup-code' and
;; `python-shell-completion-string-code' variables.  Their default
;; values enable completion for both CPython and IPython, and probably
;; any readline based shell (it's known to work with PyPy).  If your
;; Python installation lacks readline (like CPython for Windows),
;; installing pyreadline (URL `http://ipython.org/pyreadline.html')
;; should suffice.  To troubleshoot why you are not getting any
;; completions, you can try the following in your Python shell:
141 142 143 144 145

;; >>> import readline, rlcompleter

;; If you see an error, then you need to either install pyreadline or
;; setup custom code that avoids that dependency.
146

147 148
;; Shell virtualenv support: The shell also contains support for
;; virtualenvs and other special environment modifications thanks to
149 150
;; `python-shell-process-environment' and `python-shell-exec-path'.
;; These two variables allows you to modify execution paths and
151
;; environment variables to make easy for you to setup virtualenv rules
152
;; or behavior modifications when running shells.  Here is an example
153 154 155 156 157 158 159 160 161 162 163 164 165 166
;; 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
167
;; Since the above is cumbersome and can be programmatically
168
;; calculated, the variable `python-shell-virtualenv-root' is
169 170 171 172 173
;; 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:

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

176 177 178 179
;; Also the `python-shell-extra-pythonpaths' variable have been
;; introduced as simple way of adding paths to the PYTHONPATH without
;; affecting existing values.

180 181 182 183
;; Shell package support: you can enable a package in the current
;; shell so that relative imports work properly using the
;; `python-shell-package-enable' command.

184 185 186 187 188 189
;; Shell remote support: remote Python shells are started with the
;; correct environment for files opened remotely through tramp, also
;; respecting dir-local variables provided `enable-remote-dir-locals'
;; is non-nil.  The logic for this is transparently handled by the
;; `python-shell-with-environment' macro.

190 191 192 193 194 195
;; Shell syntax highlighting: when enabled current input in shell is
;; highlighted.  The variable `python-shell-font-lock-enable' controls
;; activation of this feature globally when shells are started.
;; Activation/deactivation can be also controlled on the fly via the
;; `python-shell-font-lock-toggle' command.

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
196 197 198 199
;; 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
200
;; Symbol completion: you can complete the symbol at point.  It uses
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
201 202 203
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.

204 205 206
;; Skeletons: skeletons are provided for simple inserting of things like class,
;; def, for, import, if, try, and while.  These skeletons are
;; integrated with abbrev.  If you have `abbrev-mode' activated and
207 208
;; `python-skeleton-autoinsert' is set to t, then whenever you type
;; the name of any of those defined and hit SPC, they will be
209
;; automatically expanded.  As an alternative you can use the defined
210
;; skeleton commands: `python-skeleton-<foo>'.
211

212 213 214 215
;; 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.

216 217
;; Code check: Check the current file for errors with `python-check'
;; using the program defined in `python-check-command'.
218

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

224 225 226
;; Imenu: There are two index building functions to be used as
;; `imenu-create-index-function': `python-imenu-create-index' (the
;; default one, builds the alist in form of a tree) and
227
;; `python-imenu-create-flat-index'.  See also
228 229 230 231
;; `python-imenu-format-item-label-function',
;; `python-imenu-format-parent-item-label-function',
;; `python-imenu-format-parent-item-jump-label-function' variables for
;; changing the way labels are formatted in the tree version.
232

233 234 235
;; If you used python-mode.el you may miss auto-indentation when
;; inserting newlines.  To achieve the same behavior you have two
;; options:
236

237 238 239
;; 1) Enable the minor-mode `electric-indent-mode' (enabled by
;;    default) and use RET.  If this mode is disabled use
;;    `newline-and-indent', bound to C-j.
240 241 242 243 244 245 246 247 248 249

;; 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
250 251 252 253 254 255 256 257 258 259 260 261
;;; Installation:

;; Add this to your .emacs:

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

;;; TODO:

;;; Code:

(require 'ansi-color)
262
(require 'cl-lib)
263
(require 'comint)
264
(require 'json)
265
(require 'tramp-sh)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
266

267 268 269 270
;; 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
271 272

(autoload 'comint-mode "comint")
273
(autoload 'help-function-arglist "help-fns")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
274 275

;;;###autoload
276
(add-to-list 'auto-mode-alist (cons (purecopy "\\.py[iw]?\\'") 'python-mode))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
277
;;;###autoload
278
(add-to-list 'interpreter-mode-alist (cons (purecopy "python[0-9.]*") 'python-mode))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
279 280 281 282

(defgroup python nil
  "Python Language's flying circus support for Emacs."
  :group 'languages
283
  :version "24.3"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
284 285
  :link '(emacs-commentary-link "python"))

286 287 288 289

;;; 24.x Compat


290 291 292 293 294 295 296 297 298 299 300 301 302 303
(eval-and-compile
  (unless (fboundp 'prog-first-column)
    (defun prog-first-column ()
      0))
  (unless (fboundp 'file-local-name)
    (defun file-local-name (file)
      "Return the local name component of FILE.
It returns a file name which can be used directly as argument of
`process-file', `start-file-process', or `shell-command'."
      (or (file-remote-p file 'localname) file))))

;; In Emacs 24.3 and earlier, `define-derived-mode' does not define
;; the hook variable, it only puts documentation on the symbol.
(defvar inferior-python-mode-hook)
304

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
305 306 307 308 309

;;; Bindings

(defvar python-mode-map
  (let ((map (make-sparse-keymap)))
310
    ;; Movement
311 312 313
    (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)
314
    (define-key map [remap mark-defun] 'python-mark-defun)
315
    (define-key map "\C-c\C-j" 'imenu)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
316 317 318 319 320
    ;; 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)
321 322 323 324 325
    ;; 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)
326
    (define-key map "\C-c\C-tm" 'python-skeleton-import)
327 328
    (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
329
    ;; Shell interaction
330
    (define-key map "\C-c\C-p" 'run-python)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
331 332 333 334 335 336
    (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)
337 338
    ;; Some util commands
    (define-key map "\C-c\C-v" 'python-check)
339
    (define-key map "\C-c\C-f" 'python-eldoc-at-point)
340
    (define-key map "\C-c\C-d" 'python-describe-at-point)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
341 342
    ;; Utilities
    (substitute-key-definition 'complete-symbol 'completion-at-point
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
343
                               map global-map)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
344
    (easy-menu-define python-menu map "Python Mode menu"
345
      '("Python"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
346 347 348 349 350 351 352 353 354 355 356 357
        :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"]
358
        ["Jump to def/class" imenu
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
359
         :help "Jump to a class or function definition"]
360
        "--"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
361
        ("Skeletons")
362
        "---"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
        ["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"]
378
        "----"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
379 380 381 382 383 384
        ["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
385 386 387 388 389 390
    map)
  "Keymap for `python-mode'.")


;;; Python specialized rx

391
(eval-and-compile
392
  (defconst python-rx-constituents
393
    `((block-start          . ,(rx symbol-start
394
                                   (or "def" "class" "if" "elif" "else" "try"
Lele Gaifax's avatar
Lele Gaifax committed
395 396 397 398
                                       "except" "finally" "for" "while" "with"
                                       ;; Python 3.5+ PEP492
                                       (and "async" (+ space)
                                            (or "def" "for" "with")))
399
                                   symbol-end))
400 401 402 403 404 405 406
      (dedenter            . ,(rx symbol-start
                                   (or "elif" "else" "except" "finally")
                                   symbol-end))
      (block-ender         . ,(rx symbol-start
                                  (or
                                   "break" "continue" "pass" "raise" "return")
                                  symbol-end))
407
      (decorator            . ,(rx line-start (* space) ?@ (any letter ?_)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
408
                                   (* (any word ?_))))
Lele Gaifax's avatar
Lele Gaifax committed
409 410 411 412 413
      (defun                . ,(rx symbol-start
                                   (or "def" "class"
                                       ;; Python 3.5+ PEP492
                                       (and "async" (+ space) "def"))
                                   symbol-end))
414
      (if-name-main         . ,(rx line-start "if" (+ space) "__name__"
415 416 417
                                   (+ space) "==" (+ space)
                                   (any ?' ?\") "__main__" (any ?' ?\")
                                   (* space) ?:))
418 419 420 421 422 423
      (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
424 425
                                (not
                                 (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
426 427
      ;; FIXME: Use regexp-opt.
      (operator             . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
428 429
                                       "=" "%" "**" "//" "<<" ">>" "<=" "!="
                                       "==" ">=" "is" "not")))
430 431
      ;; FIXME: Use regexp-opt.
      (assignment-operator  . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
432 433 434 435
                                       ">>=" "<<=" "&=" "^=" "|=")))
      (string-delimiter . ,(rx (and
                                ;; Match even number of backslashes.
                                (or (not (any ?\\ ?\' ?\")) point
436
                                    ;; Quotes might be preceded by an escaped quote.
437 438 439 440
                                    (and (or (not (any ?\\)) point) ?\\
                                         (* ?\\ ?\\) (any ?\' ?\")))
                                (* ?\\ ?\\)
                                ;; Match single or triple quotes of any kind.
441
                                (group (or  "\"\"\"" "\"" "'''" "'")))))
442 443 444 445 446 447 448 449 450 451 452
      (coding-cookie . ,(rx line-start ?# (* space)
                            (or
                             ;; # coding=<encoding name>
                             (: "coding" (or ?: ?=) (* space) (group-n 1 (+ (or word ?-))))
                             ;; # -*- coding: <encoding name> -*-
                             (: "-*-" (* space) "coding:" (* space)
                                (group-n 1 (+ (or word ?-))) (* space) "-*-")
                             ;; # vim: set fileencoding=<encoding name> :
                             (: "vim:" (* space) "set" (+ space)
                                "fileencoding" (* space) ?= (* space)
                                (group-n 1 (+ (or word ?-))) (* space) ":")))))
453 454 455 456
    "Additional Python specific sexps for `python-rx'")

  (defmacro python-rx (&rest regexps)
    "Python mode specialized rx macro.
457
This variant of `rx' supports common Python named REGEXPS."
458 459 460 461 462 463 464
    (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
465 466 467


;;; Font-lock and syntax
468

469
(eval-and-compile
470 471
  (defun python-syntax--context-compiler-macro (form type &optional syntax-ppss)
    (pcase type
472
      (''comment
473 474
       `(let ((ppss (or ,syntax-ppss (syntax-ppss))))
          (and (nth 4 ppss) (nth 8 ppss))))
475
      (''string
476 477
       `(let ((ppss (or ,syntax-ppss (syntax-ppss))))
          (and (nth 3 ppss) (nth 8 ppss))))
478
      (''paren
479 480 481
       `(nth 1 (or ,syntax-ppss (syntax-ppss))))
      (_ form))))

482 483 484 485
(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."
486
  (declare (compiler-macro python-syntax--context-compiler-macro))
487
  (let ((ppss (or syntax-ppss (syntax-ppss))))
488
    (pcase type
489 490 491
      ('comment (and (nth 4 ppss) (nth 8 ppss)))
      ('string (and (nth 3 ppss) (nth 8 ppss)))
      ('paren (nth 1 ppss))
492
      (_ nil))))
493 494 495 496 497 498 499 500 501

(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))))

502
(defsubst python-syntax-comment-or-string-p (&optional ppss)
503
  "Return non-nil if PPSS is inside comment or string."
504 505 506 507
  (nth 8 (or ppss (syntax-ppss))))

(defsubst python-syntax-closing-paren-p ()
  "Return non-nil if char after point is a closing paren."
Juanma Barranquero's avatar
Juanma Barranquero committed
508 509
  (eql (syntax-class (syntax-after (point)))
       (syntax-class (string-to-syntax ")"))))
510 511

(define-obsolete-function-alias
512
  'python-info-ppss-context #'python-syntax-context "24.3")
513 514

(define-obsolete-function-alias
515
  'python-info-ppss-context-type #'python-syntax-context-type "24.3")
516 517 518

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

521
(defun python-font-lock-syntactic-face-function (state)
522
  "Return syntactic face given STATE."
523
  (if (nth 3 state)
524
      (if (python-info-docstring-p state)
525 526 527 528
          font-lock-doc-face
        font-lock-string-face)
    font-lock-comment-face))

529 530 531 532 533 534 535 536 537 538 539 540 541
(defvar python-font-lock-keywords-level-1
  `((,(rx symbol-start "def" (1+ space) (group (1+ (or word ?_))))
     (1 font-lock-function-name-face))
    (,(rx symbol-start "class" (1+ space) (group (1+ (or word ?_))))
     (1 font-lock-type-face)))
  "Font lock keywords to use in python-mode for level 1 decoration.

This is the minimum decoration level, including function and
class declarations.")

(defvar python-font-lock-keywords-level-2
  `(,@python-font-lock-keywords-level-1
    ,(rx symbol-start
542 543 544 545 546 547 548 549 550 551 552 553
         (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.
554
          "nonlocal"
Lele Gaifax's avatar
Lele Gaifax committed
555 556
          ;; Python 3.5+ PEP492
          (and "async" (+ space) (or "def" "for" "with"))
557
          "await"
558 559
          ;; Extra:
          "self")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
560
         symbol-end)
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
    ;; Builtins
    (,(rx symbol-start
          (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:
578
           "ascii" "breakpoint" "bytearray" "bytes" "exec"
579 580 581 582 583 584 585 586 587 588 589
           ;; Extra:
           "__all__" "__doc__" "__name__" "__package__")
          symbol-end) . font-lock-builtin-face))
  "Font lock keywords to use in python-mode for level 2 decoration.

This is the medium decoration level, including everything in
`python-font-lock-keywords-level-1', as well as keywords and
builtins.")

(defvar python-font-lock-keywords-maximum-decoration
  `(,@python-font-lock-keywords-level-2
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
590
    ;; Constants
591
    (,(rx symbol-start
592 593 594 595 596
          (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")
597
          symbol-end) . font-lock-constant-face)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
598 599 600 601 602 603
    ;; Decorators.
    (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
                                            (0+ "." (1+ (or word ?_)))))
     (1 font-lock-type-face))
    ;; Builtin Exceptions
    (,(rx symbol-start
604
          (or
605
           ;; Python 2 and 3:
606
           "ArithmeticError" "AssertionError" "AttributeError" "BaseException"
607 608 609 610 611 612 613 614 615 616 617 618
           "BufferError" "BytesWarning" "DeprecationWarning" "EOFError"
           "EnvironmentError" "Exception" "FloatingPointError" "FutureWarning"
           "GeneratorExit" "IOError" "ImportError" "ImportWarning"
           "IndentationError" "IndexError" "KeyError" "KeyboardInterrupt"
           "LookupError" "MemoryError" "NameError" "NotImplementedError"
           "OSError" "OverflowError" "PendingDeprecationWarning"
           "ReferenceError" "RuntimeError" "RuntimeWarning" "StopIteration"
           "SyntaxError" "SyntaxWarning" "SystemError" "SystemExit" "TabError"
           "TypeError" "UnboundLocalError" "UnicodeDecodeError"
           "UnicodeEncodeError" "UnicodeError" "UnicodeTranslateError"
           "UnicodeWarning" "UserWarning" "ValueError" "Warning"
           "ZeroDivisionError"
619 620 621
           ;; Python 2:
           "StandardError"
           ;; Python 3:
622 623 624 625 626 627 628 629 630
           "BlockingIOError" "BrokenPipeError" "ChildProcessError"
           "ConnectionAbortedError" "ConnectionError" "ConnectionRefusedError"
           "ConnectionResetError" "FileExistsError" "FileNotFoundError"
           "InterruptedError" "IsADirectoryError" "NotADirectoryError"
           "PermissionError" "ProcessLookupError" "RecursionError"
           "ResourceWarning" "StopAsyncIteration" "TimeoutError"
           ;; OS specific
           "VMSError" "WindowsError"
           )
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
631
          symbol-end) . font-lock-type-face)
Paul Eggert's avatar
Paul Eggert committed
632
    ;; assignments
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
633 634
    ;; support for a = b = c = 5
    (,(lambda (limit)
635 636
        (let ((re (python-rx (group (+ (any word ?. ?_)))
                             (? ?\[ (+ (not (any  ?\]))) ?\]) (* space)
637 638 639 640
                             assignment-operator))
              (res nil))
          (while (and (setq res (re-search-forward re limit t))
                      (or (python-syntax-context 'paren)
641
                          (equal (char-after (point)) ?=))))
642
          res))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
643 644 645 646 647 648
     (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)
649 650 651 652 653 654
                             assignment-operator))
              (res nil))
          (while (and (setq res (re-search-forward re limit t))
                      (goto-char (match-end 1))
                      (python-syntax-context 'paren)))
          res))
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
     (1 font-lock-variable-name-face nil nil)))
  "Font lock keywords to use in python-mode for maximum decoration.

This decoration level includes everything in
`python-font-lock-keywords-level-2', as well as constants,
decorators, exceptions, and assignments.")

(defvar python-font-lock-keywords
  '(python-font-lock-keywords-level-1   ; When `font-lock-maximum-decoration' is nil.
    python-font-lock-keywords-level-1   ; When `font-lock-maximum-decoration' is 1.
    python-font-lock-keywords-level-2   ; When `font-lock-maximum-decoration' is 2.
    python-font-lock-keywords-maximum-decoration ; When `font-lock-maximum-decoration'
                                                 ; is more than 1, or t (which it is,
                                                 ; by default).
    )
  "List of font lock keyword specifications to use in python-mode.

Which one will be chosen depends on the value of
`font-lock-maximum-decoration'.")

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
675

676 677
(defconst python-syntax-propertize-function
  (syntax-propertize-rules
678
   ((rx (or "\"\"\"" "'''"))
679
    (0 (ignore (python-syntax-stringify))))))
680

681 682 683
(define-obsolete-variable-alias 'python--prettify-symbols-alist
  'python-prettify-symbols-alist "26.1")

684
(defvar python-prettify-symbols-alist
685 686
  '(("lambda"  . ?λ)
    ("and" . ?∧)
687 688 689
    ("or" . ?∨))
  "Value for `prettify-symbols-alist' in `python-mode'.")

690 691 692
(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
693
the point where scan starts (defaults to current point), and LIMIT
694 695 696 697 698
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))
699
      (setq i (1+ i)))
700 701 702 703
    i))

(defun python-syntax-stringify ()
  "Put `syntax-table' property correctly on single/triple quotes."
704 705 706 707 708 709 710 711 712 713
  (let* ((ppss (save-excursion (backward-char 3) (syntax-ppss)))
         (string-start (and (eq t (nth 3 ppss)) (nth 8 ppss)))
         (quote-starting-pos (- (point) 3))
         (quote-ending-pos (point)))
    (cond ((or (nth 4 ppss)             ;Inside a comment
               (and string-start
                    ;; Inside of a string quoted with different triple quotes.
                    (not (eql (char-after string-start)
                              (char-after quote-starting-pos)))))
           ;; Do nothing.
714
           nil)
715 716 717 718
          ((nth 5 ppss)
           ;; The first quote is escaped, so it's not part of a triple quote!
           (goto-char (1+ quote-starting-pos)))
          ((null string-start)
719 720 721
           ;; 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 "|")))
722
          (t
723 724 725
           ;; 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 "|"))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
726 727 728 729 730 731

(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
732
          (sst (standard-syntax-table)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
733
      (dotimes (i 128)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
734 735 736
        (unless (= i ?_)
          (if (equal symbol (aref sst i))
              (modify-syntax-entry i "." table)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
    (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

758 759 760
(define-obsolete-variable-alias
  'python-indent 'python-indent-offset "24.3")

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
761 762 763 764 765 766
(defcustom python-indent-offset 4
  "Default indentation offset for Python."
  :group 'python
  :type 'integer
  :safe 'integerp)

767 768 769
(define-obsolete-variable-alias
  'python-guess-indent 'python-indent-guess-indent-offset "24.3")

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
770 771 772
(defcustom python-indent-guess-indent-offset t
  "Non-nil tells Python mode to guess `python-indent-offset' value."
  :type 'boolean
773 774
  :group 'python
  :safe 'booleanp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
775

776 777
(defcustom python-indent-guess-indent-offset-verbose t
  "Non-nil means to emit a warning when indentation guessing fails."
Glenn Morris's avatar
Glenn Morris committed
778
  :version "25.1"
779 780 781 782
  :type 'boolean
  :group 'python
  :safe' booleanp)

783 784 785 786 787 788
(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)

789 790 791 792 793 794
(defcustom python-indent-def-block-scale 2
  "Multiplier applied to indentation inside multi-line def blocks."
  :version "26.1"
  :type 'integer
  :safe 'natnump)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
795
(defvar python-indent-current-level 0
796
  "Deprecated var available for compatibility.")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
797 798

(defvar python-indent-levels '(0)
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
  "Deprecated var available for compatibility.")

(make-obsolete-variable
 'python-indent-current-level
 "The indentation API changed to avoid global state.
The function `python-indent-calculate-levels' does not use it
anymore.  If you were defadvising it and or depended on this
variable for indentation customizations, refactor your code to
work on `python-indent-calculate-indentation' instead."
 "24.5")

(make-obsolete-variable
 'python-indent-levels
 "The indentation API changed to avoid global state.
The function `python-indent-calculate-levels' does not use it
anymore.  If you were defadvising it and or depended on this
variable for indentation customizations, refactor your code to
work on `python-indent-calculate-indentation' instead."
 "24.5")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
818 819

(defun python-indent-guess-indent-offset ()
820
  "Guess and set `python-indent-offset' for the current buffer."
821
  (interactive)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
822 823
  (save-excursion
    (save-restriction
Dmitry Gutov's avatar
Dmitry Gutov committed
824
      (widen)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
825 826 827 828 829 830
      (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
831
                 (not (python-syntax-context-type))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
                 (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))))
851
          (if (and indentation (not (zerop indentation)))
852
              (set (make-local-variable 'python-indent-offset) indentation)
853 854 855
            (when python-indent-guess-indent-offset-verbose
              (message "Can't guess python-indent-offset, using defaults: %s"
                       python-indent-offset))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
856

857
(defun python-indent-context ()
858 859 860 861 862 863 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 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
  "Get information about the current indentation context.
Context is returned in a cons with the form (STATUS . START).

STATUS can be one of the following:

keyword
-------

:after-comment
 - Point is after a comment line.
 - START is the position of the \"#\" character.
:inside-string
 - Point is inside string.
 - START is the position of the first quote that starts it.
:no-indent
 - No possible indentation case matches.
 - START is always zero.

:inside-paren
 - Fallback case when point is inside paren.
 - START is the first non space char position *after* the open paren.
:inside-paren-at-closing-nested-paren
 - Point is on a line that contains a nested paren closer.
 - START is the position of the open paren it closes.
:inside-paren-at-closing-paren
 - Point is on a line that contains a paren closer.
 - START is the position of the open paren.
:inside-paren-newline-start
 - Point is inside a paren with items starting in their own line.
 - START is the position of the open paren.
:inside-paren-newline-start-from-block
 - Point is inside a paren with items starting in their own line
   from a block start.
 - START is the position of the open paren.

:after-backslash
 - Fallback case when point is after backslash.
 - START is the char after the position of the backslash.
:after-backslash-assignment-continuation
 - Point is after a backslashed assignment.
 - START is the char after the position of the backslash.
:after-backslash-block-continuation
 - Point is after a backslashed block continuation.
 - START is the char after the position of the backslash.
:after-backslash-dotted-continuation
 - Point is after a backslashed dotted continuation.  Previous
   line must contain a dot to align with.
 - START is the char after the position of the backslash.
:after-backslash-first-line
 - First line following a backslashed continuation.
 - START is the char after the position of the backslash.

:after-block-end
 - Point is after a line containing a block ender.
 - START is the position where the ender starts.
:after-block-start
 - Point is after a line starting a block.
 - START is the position where the block starts.
:after-line
 - Point is after a simple line.
 - START is the position where the previous line starts.
:at-dedenter-block-start
 - Point is on a line starting a dedenter block.
 - START is the position where the dedenter block starts."
    (let ((ppss (save-excursion
                  (beginning-of-line)
                  (syntax-ppss))))
      (cond
       ;; Beginning of buffer.
       ((= (line-number-at-pos) 1)
        (cons :no-indent 0))
       ;; Inside a string.
       ((let ((start (python-syntax-context 'string ppss)))
          (when start
932 933 934
            (cons (if (python-info-docstring-p)
                      :inside-docstring
                    :inside-string) start))))
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
       ;; Inside a paren.
       ((let* ((start (python-syntax-context 'paren ppss))
               (starts-in-newline
                (when start
                  (save-excursion
                    (goto-char start)
                    (forward-char)
                    (not
                     (= (line-number-at-pos)
                        (progn
                          (python-util-forward-comment)
                          (line-number-at-pos))))))))
          (when start
            (cond
             ;; Current line only holds the closing paren.
             ((save-excursion
                (skip-syntax-forward " ")
                (when (and (python-syntax-closing-paren-p)
                           (progn
                             (forward-char 1)
                             (not (python-syntax-context 'paren))))
                  (cons :inside-paren-at-closing-paren start))))
             ;; Current line only holds a closing paren for nested.
             ((save-excursion
                (back-to-indentation)
                (python-syntax-closing-paren-p))
              (cons :inside-paren-at-closing-nested-paren start))
962
             ;; This line starts from an opening block in its own line.
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
             ((save-excursion
                (goto-char start)
                (when (and
                       starts-in-newline
                       (save-excursion
                         (back-to-indentation)
                         (looking-at (python-rx block-start))))
                  (cons
                   :inside-paren-newline-start-from-block start))))
             (starts-in-newline
              (cons :inside-paren-newline-start start))
             ;; General case.
             (t (cons :inside-paren
                      (save-excursion
                        (goto-char (1+ start))
                        (skip-syntax-forward "(" 1)
                        (skip-syntax-forward " ")
                        (point))))))))
       ;; After backslash.
       ((let ((start (when (not (python-syntax-comment-or-string-p ppss))
                       (python-info-line-ends-backslash-p
                        (1- (line-number-at-pos))))))
          (when start
            (cond
             ;; Continuation of dotted expression.
             ((save-excursion
                (back-to-indentation)
                (when (eq (char-after) ?\.)
                  ;; Move point back until it's not inside a paren.
                  (while (prog2
                             (forward-line -1)
                             (and (not (bobp))
                                  (python-syntax-context 'paren))))
                  (goto-char (line-end-position))
                  (while (and (search-backward
                               "." (line-beginning-position) t)
                              (python-syntax-context-type)))
                  ;; Ensure previous statement has dot to align with.
                  (when (and (eq (char-after) ?\.)
                             (not (python-syntax-context-type)))
                    (cons :after-backslash-dotted-continuation (point))))))
             ;; Continuation of block definition.
             ((let ((block-continuation-start
                     (python-info-block-continuation-line-p)))
                (when block-continuation-start
                  (save-excursion
                    (goto-char block-continuation-start)
                    (re-search-forward
                     (python-rx block-start (* space))
                     (line-end-position) t)
                    (cons :after-backslash-block-continuation (point))))))
             ;; Continuation of assignment.
             ((let ((assignment-continuation-start
                     (python-info-assignment-continuation-line-p)))
                (when assignment-continuation-start
                  (save-excursion
                    (goto-char assignment-continuation-start)
                    (cons :after-backslash-assignment-continuation (point))))))
             ;; First line after backslash continuation start.
             ((save-excursion
                (goto-char start)
                (when (or (= (line-number-at-pos) 1)
                          (not (python-info-beginning-of-backslash
                                (1- (line-number-at-pos)))))
                  (cons :after-backslash-first-line start))))
             ;; General case.
             (t (cons :after-backslash start))))))
       ;; After beginning of block.
       ((let ((start (save-excursion
                       (back-to-indentation)
                       (python-util-forward-comment -1)
                       (when (equal (char-before) ?:)
                         (python-nav-beginning-of-block)))))
          (when start
            (cons :after-block-start start))))
       ;; At dedenter statement.
       ((let ((start (python-info-dedenter-statement-p)))
          (when start
            (cons :at-dedenter-block-start start))))
1042 1043 1044 1045
       ;; After normal line, comment or ender (default case).
       ((save-excursion
          (back-to-indentation)
          (skip-chars-backward " \t\n")
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
          (if (bobp)
              (cons :no-indent 0)
            (python-nav-beginning-of-statement)
            (cons
             (cond ((python-info-current-line-comment-p)
                    :after-comment)
                   ((save-excursion
                      (goto-char (line-end-position))
                      (python-util-forward-comment -1)
                      (python-nav-beginning-of-statement)
                      (looking-at (python-rx block-ender)))
                    :after-block-end)
                   (t :after-line))
Dmitry Gutov's avatar
Dmitry Gutov committed
1059
             (point))))))))
1060 1061 1062 1063 1064 1065

(defun python-indent--calculate-indentation ()
  "Internal implementation of `python-indent-calculate-indentation'.
May return an integer for the maximum possible indentation at
current context or a list of integers.  The latter case is only
happening for :at-dedenter-block-start context since the
Paul Eggert's avatar
Paul Eggert committed
1066
possibilities can be narrowed to specific indentation points."
1067 1068
    (save-excursion
      (pcase (python-indent-context)
1069
        (`(:no-indent . ,_) (prog-first-column)) ; usually 0
1070 1071 1072 1073 1074 1075 1076 1077 1078
        (`(,(or :after-line
                :after-comment
                :inside-string
                :after-backslash
                :inside-paren-at-closing-paren
                :inside-paren-at-closing-nested-paren) . ,start)
         ;; Copy previous indentation.
         (goto-char start)
         (current-indentation))
1079 1080 1081 1082 1083 1084
        (`(:inside-docstring . ,start)
         (let* ((line-indentation (current-indentation))
                (base-indent (progn
                               (goto-char start)
                               (current-indentation))))
           (max line-indentation base-indent)))
1085 1086
        (`(,(or :after-block-start
                :after-backslash-first-line
1087
                :after-backslash-assignment-continuation
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
                :inside-paren-newline-start) . ,start)
         ;; Add one indentation level.
         (goto-char start)
         (+ (current-indentation) python-indent-offset))
        (`(,(or :inside-paren
                :after-backslash-block-continuation
                :after-backslash-dotted-continuation) . ,start)
         ;; Use the column given by the context.
         (goto-char start)
         (current-column))
        (`(:after-block-end . ,start)
         ;; Subtract one indentation level.
         (goto-char start)
         (- (current-indentation) python-indent-offset))
        (`(:at-dedenter-block-start . ,_)
         ;; List all possible indentation levels from opening blocks.
         (let ((opening-block-start-points
                (python-info-dedenter-opening-block-positions)))
           (if (not opening-block-start-points)
1107
               (prog-first-column) ; if not found default to first column
1108 1109 1110 1111 1112 1113 1114
             (mapcar (lambda (pos)
                       (save-excursion
                         (goto-char pos)
                         (current-indentation)))
                     opening-block-start-points))))
        (`(,(or :inside-paren-newline-start-from-block) . ,start)
         (goto-char start)
1115 1116
         (+ (current-indentation)
            (* python-indent-offset python-indent-def-block-scale))))))
1117 1118 1119 1120 1121 1122 1123 1124

(defun python-indent--calculate-levels (indentation)
  "Calculate levels list given INDENTATION.
Argument INDENTATION can either be an integer or a list of
integers.  Levels are returned in ascending order, and in the
case INDENTATION is a list, this order is enforced."
  (if (listp indentation)
      (sort (copy-sequence indentation) #'<)
1125 1126 1127
    (nconc (number-sequence (prog-first-column) (1- indentation)
                            python-indent-offset)
           (list indentation))))
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147

(defun python-indent--previous-level (levels indentation)
  "Return previous level from LEVELS relative to INDENTATION."
  (let* ((levels (sort (copy-sequence levels) #'>))
         (default (car levels)))
    (catch 'return
      (dolist (level levels)
        (when (funcall #'< level indentation)
          (throw 'return level)))
      default)))

(defun python-indent-calculate-indentation (&optional previous)
  "Calculate indentation.
Get indentation of PREVIOUS level when argument is non-nil.
Return the max level of the cycle when indentation reaches the
minimum."
  (let* ((indentation (python-indent--calculate-indentation))
         (levels (python-indent--calculate-levels indentation)))
    (if previous
        (python-indent--previous-level levels (current-indentation))
1148 1149
      (if levels
          (apply #'max levels)
1150
        (prog-first-column)))))
1151 1152

(defun python-indent-line (&optional previous)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1153
  "Internal implementation of `python-indent-line-function'.
1154
Use the PREVIOUS level when argument is non-nil, otherwise indent
Paul Eggert's avatar
Paul Eggert committed
1155
to the maximum available level.  When indentation is the minimum
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
possible and PREVIOUS is non-nil, cycle back to the maximum
level."
  (let ((follow-indentation-p
         ;; Check if point is within indentation.
         (and (<= (line-beginning-position) (point))
              (>= (+ (line-beginning-position)
                     (current-indentation))
                  (point)))))
    (save-excursion
      (indent-line-to
       (python-indent-calculate-indentation previous))
      (python-info-dedenter-opening-block-message))
    (when follow-indentation-p
      (back-to-indentation))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1170

1171 1172 1173 1174
(defun python-indent-calculate-levels ()
  "Return possible indentation levels."
  (python-indent--calculate-levels
   (python-indent--calculate-indentation)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1175 1176 1177

(defun python-indent-line-function ()
  "`indent-line-function' for Python mode.
1178 1179 1180 1181 1182 1183
When the variable `last-command' is equal to one of the symbols
inside `python-indent-trigger-commands' it cycles possible
indentation levels from right to left."
  (python-indent-line
   (and (memq this-command python-indent-trigger-commands)
        (eq last-command this-command))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1184 1185

(defun python-indent-dedent-line ()
1186
  "De-indent current line."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1187
  (interactive "*")
1188 1189
  (when (and (not (bolp))
           (not (python-syntax-comment-or-string-p))
1190
           (= (current-indentation) (current-column)))
1191 1192
      (python-indent-line t)
      t))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1193 1194

(defun python-indent-dedent-line-backspace (arg)
1195
  "De-indent current line.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1196
Argument ARG is passed to `backward-delete-char-untabify' when
1197
point is not in between the indentation."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1198
  (interactive "*p")
1199
  (unless (python-indent-dedent-line)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1200
    (backward-delete-char-untabify arg)))
1201

1202
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1203 1204

(defun python-indent-region (start end)
1205
  "Indent a Python region automagically.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1206 1207

Called from a program, START and END specify the region to indent."
1208 1209 1210 1211 1212 1213 1214 1215
  (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))
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227
            (when (and
                   ;; Skip if previous line is empty or a comment.
                   (save-excursion
                     (let ((line-is-comment-p
                            (python-info-current-line-comment-p)))
                       (forward-line -1)
                       (not
                        (or (and (python-info-current-line-comment-p)
                                 ;; Unless this line is a comment too.
                                 (not line-is-comment-p))
                            (python-info-current-line-empty-p)))))
                   ;; Don't mess with strings, unless it's the
1228
                   ;; enclosing set of quotes or a docstring.
1229 1230 1231 1232 1233 1234
                   (or (not (python-syntax-context 'string))
                       (eq
                        (syntax-after
                         (+ (1- (point))
                            (current-indentation)
                            (python-syntax-count-quotes (char-after) (point))))
1235 1236
                        (string-to-syntax "|"))
                       (python-info-docstring-p))
1237 1238 1239 1240 1241 1242 1243 1244
                   ;; Skip if current line is a block start, a
                   ;; dedenter or block ender.
                   (save-excursion
                     (back-to-indentation)
                     (not (looking-at
                           (python-rx
                            (or block-start dedenter block-ender))))))
              (python-indent-line)))
1245 1246
        (forward-line 1))
      (move-marker end nil))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1247 1248 1249

(defun python-indent-shift-left (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
1250 1251 1252 1253
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
1254 1255 1256 1257 1258 1259 1260 1261
  (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)
1262 1263 1264 1265 1266 1267
    (let ((deactivate-mark nil))
      (save-excursion
        (goto-char start)
        (while (< (point) end)
          (if (and (< (current-indentation) count)
                   (not (looking-at "[ \t]*$")))
1268
              (user-error "Can't shift all lines enough"))
1269 1270
          (forward-line))
        (indent-rigidly start end (- count))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1271 1272

(defun python-indent-shift-right (start end &optional count)
1273
  "Shift lines contained in region START END by COUNT columns to the right.
1274 1275 1276
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
1277 1278 1279 1280
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
1281
  (let ((deactivate-mark nil))
1282 1283
    (setq count (if count (prefix-numeric-value count)
                  python-indent-offset))
1284
    (indent-rigidly start end count)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1285

1286
(defun python-indent-post-self-insert-function ()
1287
  "Adjust indentation after insertion of some characters.
1288 1289 1290
This function is intended to be added to `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."
1291
  (when (and electric-indent-mode
1292 1293 1294 1295 1296
             (eq (char-before) last-command-event)
             (not (python-syntax-context 'string))
             (save-excursion
               (beginning-of-line)
               (not (python-syntax-context 'string (syntax-ppss)))))
1297
    (cond
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
     ;; Electric indent inside parens
     ((and
       (not (bolp))
       (let ((paren-start (python-syntax-context 'paren)))
         ;; Check that point is inside parens.
         (when paren-start
           (not
            ;; Filter the case where input is happening in the same
            ;; line where the open paren is.
            (= (line-number-at-pos)
               (line-number-at-pos paren-start)))))
       ;; When content has been added before the closing paren or a
       ;; comma has been inserted, it's ok to do the trick.
       (or
        (memq (char-after) '(?\) ?\] ?\}))
        (eq (char-before) ?,)))
1314 1315
      (save-excursion
        (goto-char (line-beginning-position))
1316
        (let ((indentation (python-indent-calculate-indentation)))
1317
          (when (and (numberp indentation) (< (current-indentation) indentation))
1318 1319
            (indent-line-to indentation)))))
     ;; Electric colon
1320 1321 1322
     ((and (eq ?: last-command-event)
           (memq ?: electric-indent-chars)
           (not current-prefix-arg)
1323
           ;; Trigger electric colon only at end of line
1324
           (eolp)
1325
           ;; Avoid re-indenting on extra colon
1326
           (not (equal ?: (char-before (1- (point)))))
1327 1328
           (not (python-syntax-comment-or-string-p)))
      ;; Just re-indent dedenters
1329
      (let ((dedenter-pos (python-info-dedenter-statement-p)))
1330
        (when dedenter-pos
1331 1332 1333 1334 1335 1336 1337 1338 1339
          (let ((start (copy-marker dedenter-pos))
                (end (point-marker)))
            (save-excursion
              (goto-char start)
              (python-indent-line)
              (unless (= (line-number-at-pos start)
                         (line-number-at-pos end))
                ;; Reindent region if this is a multiline statement
                (python-indent-region start end))))))))))
1340

1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355

;;; Mark

(defun python-mark-defun (&optional allow-extend)
  "Put mark at end of this defun, point at beginning.
The defun marked is the one that contains point or follows point.

Interactively (or with ALLOW-EXTEND non-nil), if this command is
repeated or (in Transient Mark mode) if the mark is active, it
marks the next defun after the ones already marked."
  (interactive "p")
  (when (python-info-looking-at-beginning-of-defun)
    (end-of-line 1))
  (mark-defun allow-extend))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1356 1357 1358

;;; Navigation

1359
(defvar python-nav-beginning-of-defun-regexp
1360
  (python-rx line-start (* space) defun (+ space) (group symbol-name))
1361
  "Regexp matching class or function definition.