python.el 107 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) 2010, 2011 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 7
;; URL: https://github.com/fgallina/python.el
;; Version: 0.23.1
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
;; Maintainer: FSF
;; Created: Jul 2010
;; Keywords: languages

;; This file is NOT part of GNU Emacs.

;; python.el 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.

;; python.el 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.

;; You should have received a copy of the GNU General Public License
;; along with python.el.  If not, see <http://www.gnu.org/licenses/>.

;;; 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.

;; While it probably has less features than Dave Love's python.el and
;; PSF's python-mode.el it provides the main stuff you'll need while
;; keeping it simple :)

;; Implements Syntax highlighting, Indentation, Movement, Shell
38 39 40
;; interaction, Shell completion, Shell virtualenv support, Pdb
;; tracking, Symbol completion, Skeletons, FFAP, Code Check, Eldoc,
;; imenu.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
41 42 43 44 45 46

;; 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
47 48 49
;; 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
50 51

;; Movement: `beginning-of-defun' and `end-of-defun' functions are
52
;; properly implemented.  There are also specialized
53 54 55 56 57
;; `forward-sentence' and `backward-sentence' replacements
;; (`python-nav-forward-sentence', `python-nav-backward-sentence'
;; respectively).  Extra functions `python-nav-sentence-start' and
;; `python-nav-sentence-end' are included to move to the beginning and
;; to the end of a setence while taking care of multiline definitions.
58 59
;; `python-nav-jump-to-defun' is provided and allows jumping to a
;; function or class definition quickly in the current buffer.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
60

61
;; Shell interaction: is provided and allows you to execute easily any
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
62 63 64
;; 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
65
;; word.  Shell completion is implemented in a manner that if you
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
66 67
;; change the `python-shell-interpreter' to any other (for example
;; IPython) it should be easy to integrate another way to calculate
68
;; completions.  You just need to specify your custom
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
69
;; `python-shell-completion-setup-code' and
70
;; `python-shell-completion-string-code'.
71 72

;; Here is a complete example of the settings you would use for
73
;; iPython 0.11:
74 75 76 77 78 79

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

;; For iPython 0.10 everything would be the same except for
;; `python-shell-completion-string-code':

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

93 94 95 96 97 98 99 100 101 102 103 104
;; 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).

105 106 107 108 109 110
;; 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.

111 112
;; Shell virtualenv support: The shell also contains support for
;; virtualenvs and other special environment modifications thanks to
113 114
;; `python-shell-process-environment' and `python-shell-exec-path'.
;; These two variables allows you to modify execution paths and
115
;; environment variables to make easy for you to setup virtualenv rules
116
;; or behavior modifications when running shells.  Here is an example
117 118 119 120 121 122 123 124 125 126 127 128 129 130
;; 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/"))

131 132 133 134 135 136 137 138 139
;; Since the above is cumbersome and can be programatically
;; 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/")

140 141 142 143
;; 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
144 145 146 147
;; 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
148
;; Symbol completion: you can complete the symbol at point.  It uses
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
149 150 151
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.

152 153 154 155 156 157 158
;; 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
;; automatically expanded.

159 160 161 162
;; 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.

163 164
;; Code check: Check the current file for errors with `python-check'
;; using the program defined in `python-check-command'.
165

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

171 172
;; imenu: This mode supports imenu.  It builds a plain or tree menu
;; depending on the value of `python-imenu-make-tree'.  Also you can
173 174 175
;; customize if menu items should include its type using
;; `python-imenu-include-defun-type'.

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
;; 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
191 192 193 194 195 196 197 198 199 200 201 202
;;; Installation:

;; Add this to your .emacs:

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

;;; TODO:

;;; Code:

(require 'ansi-color)
203
(require 'comint)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
204 205

(eval-when-compile
206 207 208 209 210
  (require 'cl)
  ;; 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
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229

(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
  :version "23.2"
  :link '(emacs-commentary-link "python"))


;;; Bindings

(defvar python-mode-map
  (let ((map (make-sparse-keymap)))
230 231 232 233 234 235 236
    ;; Movement
    (substitute-key-definition 'backward-sentence
                               'python-nav-backward-sentence
                               map global-map)
    (substitute-key-definition 'forward-sentence
                               'python-nav-forward-sentence
                               map global-map)
237
    (define-key map "\C-c\C-j" 'python-nav-jump-to-defun)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
238 239 240 241 242
    ;; 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)
243
    (define-key map ":" 'python-indent-electric-colon)
244 245 246 247 248 249 250
    ;; 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
251 252 253 254 255 256 257
    ;; Shell interaction
    (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)
258 259
    ;; Some util commands
    (define-key map "\C-c\C-v" 'python-check)
260
    (define-key map "\C-c\C-f" 'python-eldoc-at-point)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
261 262
    ;; Utilities
    (substitute-key-definition 'complete-symbol 'completion-at-point
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
263
                               map global-map)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
264 265
    (easy-menu-define python-menu map "Python Mode menu"
      `("Python"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279
        :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"]
        ["Jump to def/class" python-nav-jump-to-defun
         :help "Jump to a class or function definition"]
280
        "--"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
281
        ("Skeletons")
282
        "---"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
        ["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"]
298
        "----"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
299 300 301 302 303 304
        ["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
305 306 307 308 309 310
    map)
  "Keymap for `python-mode'.")


;;; Python specialized rx

311 312 313 314 315 316 317
(eval-when-compile
  (defconst python-rx-constituents
    (list
     `(block-start          . ,(rx symbol-start
                                   (or "def" "class" "if" "elif" "else" "try"
                                       "except" "finally" "for" "while" "with")
                                   symbol-end))
318
     `(decorator            . ,(rx line-start (* space) ?@ (any letter ?_)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
319
                                   (* (any word ?_))))
320
     `(defun                . ,(rx symbol-start (or "def" "class") symbol-end))
321
     `(symbol-name          . ,(rx (any letter ?_) (* (any word ?_))))
322 323 324
     `(open-paren           . ,(rx (or "{" "[" "(")))
     `(close-paren          . ,(rx (or "}" "]" ")")))
     `(simple-operator      . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
325 326 327
     `(not-simple-operator  . ,(rx
                                (not
                                 (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
328 329 330 331
     `(operator             . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
                                       "=" "%" "**" "//" "<<" ">>" "<=" "!="
                                       "==" ">=" "is" "not")))
     `(assignment-operator  . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
332 333
                                       ">>=" "<<=" "&=" "^=" "|="))))
    "Additional Python specific sexps for `python-rx'"))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
334 335

(defmacro python-rx (&rest regexps)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
336 337 338 339 340 341 342 343 344
  "Python mode specialized rx macro.
This variant of `rx' supports common python named REGEXPS."
  (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
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363


;;; Font-lock and syntax

(defvar python-font-lock-keywords
  ;; Keywords
  `(,(rx symbol-start
         (or "and" "del" "from" "not" "while" "as" "elif" "global" "or" "with"
             "assert" "else" "if" "pass" "yield" "break" "except" "import"
             "print" "class" "exec" "in" "raise" "continue" "finally" "is"
             "return" "def" "for" "lambda" "try" "self")
         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
364 365 366 367 368 369
    (,(rx symbol-start
          ;; copyright, license, credits, quit, exit are added by the
          ;; site module and since they are not intended to be used in
          ;; programs they are not added here either.
          (or "None" "True" "False" "Ellipsis" "__debug__" "NotImplemented")
          symbol-end) . font-lock-constant-face)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
370 371 372 373 374 375 376 377 378 379 380 381
    ;; Decorators.
    (,(rx line-start (* (any " \t")) (group "@" (1+ (or word ?_))
                                            (0+ "." (1+ (or word ?_)))))
     (1 font-lock-type-face))
    ;; Builtin Exceptions
    (,(rx symbol-start
          (or "ArithmeticError" "AssertionError" "AttributeError"
              "BaseException" "BufferError" "BytesWarning" "DeprecationWarning"
              "EOFError" "EnvironmentError" "Exception" "FloatingPointError"
              "FutureWarning" "GeneratorExit" "IOError" "ImportError"
              "ImportWarning" "IndentationError" "IndexError" "KeyError"
              "KeyboardInterrupt" "LookupError" "MemoryError" "NameError"
382
              "NotImplementedError" "OSError" "OverflowError"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
383 384 385 386 387 388 389 390
              "PendingDeprecationWarning" "ReferenceError" "RuntimeError"
              "RuntimeWarning" "StandardError" "StopIteration" "SyntaxError"
              "SyntaxWarning" "SystemError" "SystemExit" "TabError" "TypeError"
              "UnboundLocalError" "UnicodeDecodeError" "UnicodeEncodeError"
              "UnicodeError" "UnicodeTranslateError" "UnicodeWarning"
              "UserWarning" "ValueError" "Warning" "ZeroDivisionError")
          symbol-end) . font-lock-type-face)
    ;; Builtins
391 392 393 394 395 396 397 398 399 400 401 402 403 404
    (,(rx symbol-start
          (or "_" "__doc__" "__import__" "__name__" "__package__" "abs" "all"
              "any" "apply" "basestring" "bin" "bool" "buffer" "bytearray"
              "bytes" "callable" "chr" "classmethod" "cmp" "coerce" "compile"
              "complex" "delattr" "dict" "dir" "divmod" "enumerate" "eval"
              "execfile" "file" "filter" "float" "format" "frozenset"
              "getattr" "globals" "hasattr" "hash" "help" "hex" "id" "input"
              "int" "intern" "isinstance" "issubclass" "iter" "len" "list"
              "locals" "long" "map" "max" "min" "next" "object" "oct" "open"
              "ord" "pow" "print" "property" "range" "raw_input" "reduce"
              "reload" "repr" "reversed" "round" "set" "setattr" "slice"
              "sorted" "staticmethod" "str" "sum" "super" "tuple" "type"
              "unichr" "unicode" "vars" "xrange" "zip")
          symbol-end) . font-lock-builtin-face)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
405 406 407
    ;; asignations
    ;; support for a = b = c = 5
    (,(lambda (limit)
408 409
        (let ((re (python-rx (group (+ (any word ?. ?_)))
                             (? ?\[ (+ (not (any  ?\]))) ?\]) (* space)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
410 411
                             assignment-operator)))
          (when (re-search-forward re limit t)
412
            (while (and (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
413
                        (re-search-forward re limit t)))
414
            (if (and (not (python-info-ppss-context 'paren))
415
                     (not (equal (char-after (point-marker)) ?=)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
416 417 418 419 420 421 422 423 424 425 426
                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))))
427
            (while (and (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
428 429
                        (re-search-forward re limit t))
              (goto-char (nth 3 (match-data))))
430
            (if (not (python-info-ppss-context 'paren))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
431 432 433 434 435
                t
              (set-match-data nil)))))
     (1 font-lock-variable-name-face nil nil))))

(defconst python-font-lock-syntactic-keywords
436 437
  ;; Make outer chars of matching triple-quote sequences into generic
  ;; string delimiters.  Fixme: Is there a better way?
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
438
  ;; First avoid a sequence preceded by an odd number of backslashes.
439
  `((,(concat "\\(?:\\([RUru]\\)[Rr]?\\|^\\|[^\\]\\(?:\\\\.\\)*\\)" ;Prefix.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
440
              "\\(?:\\('\\)'\\('\\)\\|\\(?2:\"\\)\"\\(?3:\"\\)\\)")
441 442 443
     (3 (python-quote-syntax)))))

(defun python-quote-syntax ()
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
  "Put `syntax-table' property correctly on triple quote.
Used for syntactic keywords.  N is the match number (1, 2 or 3)."
  ;; Given a triple quote, we have to check the context to know
  ;; whether this is an opening or closing triple or whether it's
  ;; quoted anyhow, and should be ignored.  (For that we need to do
  ;; the same job as `syntax-ppss' to be correct and it seems to be OK
  ;; to use it here despite initial worries.)  We also have to sort
  ;; out a possible prefix -- well, we don't _have_ to, but I think it
  ;; should be treated as part of the string.

  ;; Test cases:
  ;;  ur"""ar""" x='"' # """
  ;; x = ''' """ ' a
  ;; '''
  ;; x '"""' x """ \"""" x
  (save-excursion
    (goto-char (match-beginning 0))
461 462 463 464
    (let ((syntax (save-match-data (syntax-ppss))))
      (cond
       ((eq t (nth 3 syntax))           ; after unclosed fence
        ;; Consider property for the last char if in a fenced string.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
465 466
        (goto-char (nth 8 syntax))  ; fence position
        (skip-chars-forward "uUrR") ; skip any prefix
467 468 469 470 471 472 473 474 475 476 477 478 479
        ;; Is it a matching sequence?
        (if (eq (char-after) (char-after (match-beginning 2)))
            (put-text-property (match-beginning 3) (match-end 3)
                               'syntax-table (string-to-syntax "|"))))
       ((match-end 1)
        ;; Consider property for initial char, accounting for prefixes.
        (put-text-property (match-beginning 1) (match-end 1)
                           'syntax-table (string-to-syntax "|")))
       (t
        ;; Consider property for initial char, accounting for prefixes.
        (put-text-property (match-beginning 2) (match-end 2)
                           'syntax-table (string-to-syntax "|"))))
      )))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
480 481 482 483 484 485

(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
486
          (sst (standard-syntax-table)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
487
      (dotimes (i 128)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
488 489 490
        (unless (= i ?_)
          (if (equal symbol (aref sst i))
              (modify-syntax-entry i "." table)))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
    (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
521 522
  :group 'python
  :safe 'booleanp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
523 524 525 526 527 528 529 530 531 532 533 534 535

(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'.")

(defun python-indent-guess-indent-offset ()
536
  "Guess and set `python-indent-offset' for the current buffer."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
537 538 539 540 541 542 543 544 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
  (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
                 (not (python-info-ppss-context-type))
                 (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
              (setq python-indent-offset indentation)
            (message "Can't guess python-indent-offset, using defaults: %s"
                     python-indent-offset)))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
570

571 572 573 574
(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
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589

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
590
        ;; Beginning of buffer
591 592 593
        ((save-excursion
           (goto-char (line-beginning-position))
           (bobp))
594
         'no-indent)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
595
        ;; Inside a paren
596
        ((setq start (python-info-ppss-context 'paren ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
597 598
         'inside-paren)
        ;; Inside string
599
        ((setq start (python-info-ppss-context 'string ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
600 601
         'inside-string)
        ;; After backslash
602 603
        ((setq start (when (not (or (python-info-ppss-context 'string ppss)
                                    (python-info-ppss-context 'comment ppss)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
604
                       (let ((line-beg-pos (line-beginning-position)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
605 606
                         (when (python-info-line-ends-backslash-p
                                (1- line-beg-pos))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
607 608 609 610
                           (- line-beg-pos 2)))))
         'after-backslash)
        ;; After beginning of block
        ((setq start (save-excursion
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
                       (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
                                      (python-info-ppss-context 'string)
                                      (python-info-ppss-context 'comment)
                                      (python-info-ppss-context 'paren)
                                      (python-info-continuation-line-p))))
                         (when (looking-at (python-rx block-start))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
626 627 628 629
                           (point-marker)))))
         'after-beginning-of-block)
        ;; After normal line
        ((setq start (save-excursion
630
                       (back-to-indentation)
631
                       (python-util-forward-comment -1)
632
                       (python-nav-sentence-start)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
                       (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
        (case context-status
          ('no-indent 0)
649 650
          ;; When point is after beginning of block just add one level
          ;; of indentation relative to the context-start
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
651 652 653
          ('after-beginning-of-block
           (goto-char context-start)
           (+ (current-indentation) python-indent-offset))
654 655 656
          ;; 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.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
657 658 659 660 661 662 663 664 665 666
          ('after-line
           (-
            (save-excursion
              (goto-char context-start)
              (current-indentation))
            (if (progn
                  (back-to-indentation)
                  (looking-at (regexp-opt python-indent-dedenters)))
                python-indent-offset
              0)))
667 668 669
          ;; 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
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
670 671 672
          ('inside-string
           (goto-char context-start)
           (current-indentation))
673
          ;; After backslash we have several posibilities
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
674
          ('after-backslash
675 676 677 678 679 680 681 682 683
           (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 "\\.")
                 (forward-line -1)
                 (goto-char (line-end-position))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
684 685
                 (while (and (re-search-backward
                              "\\." (line-beginning-position) t)
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
                             (or (python-info-ppss-context 'comment)
                                 (python-info-ppss-context 'string)
                                 (python-info-ppss-context 'paren))))
                 (if (and (looking-at "\\.")
                          (not (or (python-info-ppss-context 'comment)
                                   (python-info-ppss-context 'string)
                                   (python-info-ppss-context 'paren))))
                     ;; 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)
             (if (save-excursion
                   (and
                    (python-info-line-ends-backslash-p)
                    (forward-line -1)
                    (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
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
737
          ('inside-paren
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
           (cond
            ;; If current line closes the outtermost open paren use the
            ;; 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)
                            (not (python-info-ppss-context 'paren))))
                 (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
773
                   (back-to-indentation)
774 775 776 777 778 779 780 781 782 783 784 785 786
                   (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
787 788 789 790 791 792

(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)))
793
    (setq python-indent-levels (list 0))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
794
    (dotimes (step steps)
795
      (push (* python-indent-offset (1+ step)) python-indent-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
796
    (when (not (eq 0 remainder))
797
      (push (+ (* python-indent-offset steps) remainder) python-indent-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
798 799 800 801 802 803 804 805 806 807 808 809 810
    (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
811 812
indicated by the variable `python-indent-levels' to set the
current indentation.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
813 814

When the variable `last-command' is equal to
815 816 817 818
`indent-for-tab-command' 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'.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
819 820

When the variable `last-command' is not equal to
821 822 823 824 825
`indent-for-tab-command' 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')"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
826 827 828
  (if (or (and (eq this-command 'indent-for-tab-command)
               (eq last-command this-command))
          force-toggle)
829 830 831
      (if (not (equal python-indent-levels '(0)))
          (python-indent-toggle-levels)
        (python-indent-calculate-levels))
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
    (python-indent-calculate-levels))
  (beginning-of-line)
  (delete-horizontal-space)
  (indent-to (nth python-indent-current-level python-indent-levels))
  (save-restriction
    (widen)
    (let ((closing-block-point (python-info-closing-block)))
      (when closing-block-point
        (message "Closes %s" (buffer-substring
                              closing-block-point
                              (save-excursion
                                (goto-char closing-block-point)
                                (line-end-position))))))))

(defun python-indent-line-function ()
  "`indent-line-function' for Python mode.
848
See `python-indent-line' for details."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
849 850 851
  (python-indent-line))

(defun python-indent-dedent-line ()
852
  "De-indent current line."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
853
  (interactive "*")
854 855
  (when (and (not (or (python-info-ppss-context 'string)
                      (python-info-ppss-context 'comment)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
856 857 858 859 860 861 862 863
             (<= (point-marker) (save-excursion
                                  (back-to-indentation)
                                  (point-marker)))
             (> (current-column) 0))
    (python-indent-line t)
    t))

(defun python-indent-dedent-line-backspace (arg)
864
  "De-indent current line.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
865
Argument ARG is passed to `backward-delete-char-untabify' when
866
point is  not in between the indentation."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
867 868 869
  (interactive "*p")
  (when (not (python-indent-dedent-line))
    (backward-delete-char-untabify arg)))
870
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
871 872 873 874 875

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

Called from a program, START and END specify the region to indent."
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
  (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)
              (when word
                (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
895 896 897

(defun python-indent-shift-left (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
898 899 900 901
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
902 903 904 905 906 907 908 909
  (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)
910 911 912 913 914 915 916 917 918
    (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
919 920 921 922 923

(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.
924 925 926
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
927 928 929 930
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
931 932 933 934 935
  (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
936

937
(defun python-indent-electric-colon (arg)
938 939 940
  "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."
941 942
  (interactive "*P")
  (self-insert-command (if (not (integerp arg)) 1 arg))
943 944 945 946 947 948 949 950 951 952 953 954
  (when (and (not arg)
             (eolp)
             (not (equal ?: (char-after (- (point-marker) 2))))
             (not (or (python-info-ppss-context 'string)
                      (python-info-ppss-context 'comment))))
    (let ((indentation (current-indentation))
          (calculated-indentation (python-indent-calculate-indentation)))
      (when (> indentation calculated-indentation)
        (save-excursion
          (indent-line-to calculated-indentation)
          (when (not (python-info-closing-block))
            (indent-line-to indentation)))))))
955 956
(put 'python-indent-electric-colon 'delete-selection t)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
957 958 959

;;; Navigation

960
(defvar python-nav-beginning-of-defun-regexp
961
  (python-rx line-start (* space) defun (+ space) (group symbol-name))
962
  "Regexp matching class or function definition.
963 964
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
965

966
(defun python-nav-beginning-of-defun (&optional nodecorators)
967
  "Move point to `beginning-of-defun'.
968 969
When NODECORATORS is non-nil decorators are not included.  This
is the main part of`python-beginning-of-defun-function'
970
implementation.  Return non-nil if point is moved to the
971
`beginning-of-defun'."
972 973 974
  (let ((indent-pos (save-excursion
                      (back-to-indentation)
                      (point-marker)))
975
        (found)
976 977
        (include-decorators
         (lambda ()
978 979 980 981 982 983 984 985
           (when (not nodecorators)
             (when (save-excursion
                     (forward-line -1)
                     (looking-at (python-rx decorator)))
               (while (and (not (bobp))
                           (forward-line -1)
                           (looking-at (python-rx decorator))))
               (when (not (bobp)) (forward-line 1)))))))
986 987 988 989
    (if (and (> (point) indent-pos)
             (save-excursion
               (goto-char (line-beginning-position))
               (looking-at python-nav-beginning-of-defun-regexp)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
990
        (progn
991
          (goto-char (line-beginning-position))
992 993
          (funcall include-decorators)
          (setq found t))
994
      (goto-char (line-beginning-position))
995 996
      (when (re-search-backward python-nav-beginning-of-defun-regexp nil t)
        (setq found t))
997
      (goto-char (or (python-info-ppss-context 'string) (point)))
998 999
      (funcall include-decorators))
    found))
1000

1001
(defun python-beginning-of-defun-function (&optional arg nodecorators)
1002 1003
  "Move point to the beginning of def or class.
With positive ARG move that number of functions forward.  With
1004
negative do the same but backwards.  When NODECORATORS is non-nil
1005
decorators are not included.  Return non-nil if point is moved to the
1006
`beginning-of-defun'."
1007 1008
  (when (or (null arg) (= arg 0)) (setq arg 1))
  (if (> arg 0)
1009 1010 1011 1012
      (dotimes (i arg (python-nav-beginning-of-defun nodecorators)))
    (let ((found))
      (dotimes (i (- arg) found)
        (python-end-of-defun-function)
1013
        (python-util-forward-comment)
1014 1015 1016 1017
        (goto-char (line-end-position))
        (when (not (eobp))
          (setq found
                (python-nav-beginning-of-defun nodecorators)))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1018 1019 1020 1021

(defun python-end-of-defun-function ()
  "Move point to the end of def or class.
Returns nil if point is not in a def or class."
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
  (interactive)
  (let ((beg-defun-indent)
        (decorator-regexp "[[:space:]]*@"))
    (when (looking-at decorator-regexp)
      (while (and (not (eobp))
                  (forward-line 1)
                  (looking-at decorator-regexp))))
    (when (not (looking-at python-nav-beginning-of-defun-regexp))
      (python-beginning-of-defun-function))
    (setq beg-defun-indent (current-indentation))
    (forward-line 1)
    (while (and (forward-line 1)
                (not (eobp))
                (or (not (current-word))
                    (> (current-indentation) beg-defun-indent))))
1037
    (python-util-forward-comment)
1038
    (goto-char (line-beginning-position))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1039

1040 1041 1042 1043 1044 1045 1046 1047 1048
(defun python-nav-sentence-start ()
  "Move to start of current sentence."
  (interactive "^")
  (while (and (not (back-to-indentation))
              (not (bobp))
              (when (or
                     (save-excursion
                       (forward-line -1)
                       (python-info-line-ends-backslash-p))
1049
                     (python-info-ppss-context 'string)
1050
                     (python-info-ppss-context 'paren))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1051
                (forward-line -1)))))
1052 1053 1054 1055 1056 1057 1058 1059

(defun python-nav-sentence-end ()
  "Move to end of current sentence."
  (interactive "^")
  (while (and (goto-char (line-end-position))
              (not (eobp))
              (when (or
                     (python-info-line-ends-backslash-p)
1060
                     (python-info-ppss-context 'string)
1061
                     (python-info-ppss-context 'paren))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1062
                (forward-line 1)))))
1063

1064
(defun python-nav-backward-sentence (&optional arg)
1065
  "Move backward to start of sentence.  With ARG, do it arg times.
1066 1067 1068 1069 1070 1071
See `python-nav-forward-sentence' for more information."
  (interactive "^p")
  (or arg (setq arg 1))
  (python-nav-forward-sentence (- arg)))

(defun python-nav-forward-sentence (&optional arg)
1072
  "Move forward to next end of sentence.  With ARG, repeat.
1073 1074 1075 1076
With negative argument, move backward repeatedly to start of sentence."
  (interactive "^p")
  (or arg (setq arg 1))
  (while (> arg 0)
1077
    (python-util-forward-comment)
1078 1079 1080 1081 1082
    (python-nav-sentence-end)
    (forward-line 1)
    (setq arg (1- arg)))
  (while (< arg 0)
    (python-nav-sentence-end)
1083
    (python-util-forward-comment -1)
1084 1085 1086 1087
    (python-nav-sentence-start)
    (forward-line -1)
    (setq arg (1+ arg))))

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
(defun python-nav-list-defun-positions (&optional include-type)
  "Make an Alist of defun names and point markers for current buffer.
When optional argument INCLUDE-TYPE is non-nil the type is
included the defun name."
  (let ((defs))
    (save-restriction
      (widen)
      (save-excursion
        (goto-char (point-max))
        (while (re-search-backward python-nav-beginning-of-defun-regexp nil t)
          (when (and (not (python-info-ppss-context 'string))
                     (not (python-info-ppss-context 'comment))
                     (not (python-info-ppss-context 'parent)))
            (add-to-list
             'defs (cons
                    (python-info-current-defun include-type)
                    (point-marker)))))
        defs))))

(defun python-nav-read-defun ()
  "Read a defun name of current buffer and return its point marker.
A cons cell with the form (DEFUN-NAME . POINT-MARKER) is returned
when defun is completed, else nil."
  (let ((defs (python-nav-list-defun-positions)))
    (minibuffer-with-setup-hook
        (lambda ()
          (setq minibuffer-completion-table (mapcar 'car defs)))
      (let ((stringdef
             (read-from-minibuffer
              "Jump to definition: " nil
              minibuffer-local-must-match-map)))
        (when (not (string= stringdef ""))
          (assoc-string stringdef defs))))))

(defun python-nav-jump-to-defun (def)
  "Jump to the definition of DEF in current file."
  (interactive
   (list (python-nav-read-defun)))
  (when (not (called-interactively-p 'interactive))
    (setq def (assoc-string def (python-nav-list-defun-positions))))
  (let ((def-marker (cdr def)))
    (when (markerp def-marker)
      (goto-char (marker-position def-marker))
      (back-to-indentation))))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1133 1134 1135

;;; Shell integration

1136 1137 1138 1139 1140
(defcustom python-shell-buffer-name "Python"
  "Default buffer name for Python interpreter."
  :type 'string
  :group 'python
  :safe 'stringp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1141 1142 1143 1144

(defcustom python-shell-interpreter "python"
  "Default Python interpreter for shell."
  :type 'string
1145
  :group 'python)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1146

1147 1148 1149 1150 1151
(defcustom python-shell-internal-buffer-name "Python Internal"
  "Default buffer name for the Internal Python interpreter."
  :type 'string
  :group 'python
  :safe 'stringp)
1152

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1153 1154 1155
(defcustom python-shell-interpreter-args "-i"
  "Default arguments for the Python interpreter."
  :type 'string
1156
  :group 'python)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1157 1158

(defcustom python-shell-prompt-regexp ">>> "
1159 1160
  "Regular Expression matching top\-level input prompt of python shell.
It should not contain a caret (^) at the beginning."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1161 1162 1163 1164 1165
  :type 'string
  :group 'python
  :safe 'stringp)

(defcustom python-shell-prompt-block-regexp "[.][.][.] "
1166 1167
  "Regular Expression matching block input prompt of python shell.
It should not contain a caret (^) at the beginning."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1168 1169 1170 1171
  :type 'string
  :group 'python
  :safe 'stringp)

1172
(defcustom python-shell-prompt-output-regexp ""
1173 1174
  "Regular Expression matching output prompt of python shell.
It should not contain a caret (^) at the beginning."
1175 1176 1177 1178
  :type 'string
  :group 'python
  :safe 'stringp)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1179
(defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ "
1180 1181
  "Regular Expression matching pdb input prompt of python shell.
It should not contain a caret (^) at the beginning."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1182 1183 1184 1185
  :type 'string
  :group 'python
  :safe 'stringp)

1186 1187 1188 1189
(defcustom python-shell-send-setup-max-wait 5
  "Seconds to wait for process output before code setup.
If output is received before the especified time then control is
returned in that moment and not after waiting."
1190
  :type 'integer
1191
  :group 'python
1192
  :safe 'integerp)
1193

1194
(defcustom python-shell-process-environment nil
1195 1196
  "List of environment variables for Python shell.
This variable follows the same rules as `process-environment'
1197 1198
since it merges with it before the process creation routines are
called.  When this variable is nil, the Python shell is run with
1199
the default `process-environment'."
1200 1201 1202 1203
  :type '(repeat string)
  :group 'python
  :safe 'listp)

1204 1205 1206 1207 1208 1209 1210 1211
(defcustom python-shell-extra-pythonpaths nil
  "List of extra pythonpaths for Python shell.
The values of this variable are added to the existing value of
PYTHONPATH in the `process-environment' variable."
  :type '(repeat string)
  :group 'python
  :safe 'listp)

1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
(defcustom python-shell-exec-path nil
  "List of path to search for binaries.
This variable follows the same rules as `exec-path' since it
merges with it before the process creation routines are called.
When this variable is nil, the Python shell is run with the
default `exec-path'."
  :type '(repeat string)
  :group 'python
  :safe 'listp)

1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
(defcustom python-shell-virtualenv-path nil
  "Path to virtualenv root.
This variable, when set to a string, makes the values stored in
`python-shell-process-environment' and `python-shell-exec-path'
to be modified properly so shells are started with the specified
virtualenv."
  :type 'string
  :group 'python
  :safe 'stringp)

1232 1233 1234
(defcustom python-shell-setup-codes '(python-shell-completion-setup-code
                                      python-ffap-setup-code
                                      python-eldoc-setup-code)
1235
  "List of code run by `python-shell-send-setup-codes'."
1236 1237 1238 1239
  :type '(repeat symbol)
  :group 'python
  :safe 'listp)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1240 1241
(defcustom python-shell-compilation-regexp-alist
  `((,(rx line-start (1+ (any " \t")) "File \""
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1242 1243
          (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
          "\", line " (group (1+ digit)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1244 1245
     1 2)
    (,(rx " in file " (group (1+ not-newline)) " on line "
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1246
          (group (1+ digit)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1247 1248
     1 2)
    (,(rx line-start "> " (group (1+ (not (any "(\"<"))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1249
          "(" (group (1+ digit)) ")" (1+ (not (any "("))) "()")
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1250 1251 1252 1253 1254 1255
     1 2))
  "`compilation-error-regexp-alist' for inferior Python."
  :type '(alist string)
  :group 'python)

(defun python-shell-get-process-name (dedicated)