python.el 98.9 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 53 54 55 56 57
;; properly implemented.  Also there are specialized
;; `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.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
58 59 60 61 62

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

;; Here is a complete example of the settings you would use for
71
;; iPython 0.11:
72 73 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]+\\]: "
;;  python-shell-completion-setup-code ""
;;  python-shell-completion-string-code
80 81 82 83 84 85 86
;;  "';'.join(get_ipython().Completer.all_completions('''%s'''))\n")

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

88 89 90 91 92 93
;; 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.

94 95
;; Shell virtualenv support: The shell also contains support for
;; virtualenvs and other special environment modifications thanks to
96 97
;; `python-shell-process-environment' and `python-shell-exec-path'.
;; These two variables allows you to modify execution paths and
98
;; environment variables to make easy for you to setup virtualenv rules
99
;; or behavior modifications when running shells.  Here is an example
100 101 102 103 104 105 106 107 108 109 110 111 112 113
;; 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/"))

114 115 116 117 118 119 120 121 122
;; 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/")

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
123 124 125 126
;; 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
127
;; Symbol completion: you can complete the symbol at point.  It uses
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
128 129 130
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.

131 132 133 134 135 136 137
;; 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.

138 139 140 141
;; 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.

142 143
;; Code check: Check the current file for errors with `python-check'
;; using the program defined in `python-check-command'.
144

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

150 151
;; imenu: This mode supports imenu.  It builds a plain or tree menu
;; depending on the value of `python-imenu-make-tree'.  Also you can
152 153 154
;; customize if menu items should include its type using
;; `python-imenu-include-defun-type'.

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
;; 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
170 171 172 173 174 175 176 177 178 179 180 181
;;; Installation:

;; Add this to your .emacs:

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

;;; TODO:

;;; Code:

(require 'ansi-color)
182
(require 'comint)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
183 184

(eval-when-compile
185 186 187 188 189
  (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
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

(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)))
209 210 211 212 213 214 215
    ;; 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)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
216 217 218 219 220
    ;; 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)
221
    (define-key map ":" 'python-indent-electric-colon)
222 223 224 225 226 227 228
    ;; 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
229 230 231 232 233 234 235
    ;; 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)
236 237
    ;; Some util commands
    (define-key map "\C-c\C-v" 'python-check)
238
    (define-key map "\C-c\C-f" 'python-eldoc-at-point)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
    ;; Utilities
    (substitute-key-definition 'complete-symbol 'completion-at-point
			       map global-map)
    (easy-menu-define python-menu map "Python Mode menu"
      `("Python"
	: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"]
	"-"
	["Mark def/class" mark-defun
	 :help "Mark outermost definition around point"]
	"-"
	["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"]
        "-"
258 259
	("Skeletons")
        "-"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
	["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"]
        "-"
276 277
	["Check file" python-check
	 :help "Check file for errors"]
278 279
	["Help on symbol" python-eldoc-at-point
	 :help "Get help on symbol at point"]
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
280 281 282 283 284 285 286 287
	["Complete symbol" completion-at-point
	 :help "Complete symbol before point"]))
    map)
  "Keymap for `python-mode'.")


;;; Python specialized rx

288 289 290 291 292 293 294
(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))
295 296
     `(decorator            . ,(rx line-start (* space) ?@ (any letter ?_)
                                    (* (any word ?_))))
297
     `(defun                . ,(rx symbol-start (or "def" "class") symbol-end))
298
     `(symbol-name          . ,(rx (any letter ?_) (* (any word ?_))))
299 300 301 302 303 304 305 306
     `(open-paren           . ,(rx (or "{" "[" "(")))
     `(close-paren          . ,(rx (or "}" "]" ")")))
     `(simple-operator      . ,(rx (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%)))
     `(not-simple-operator  . ,(rx (not (any ?+ ?- ?/ ?& ?^ ?~ ?| ?* ?< ?> ?= ?%))))
     `(operator             . ,(rx (or "+" "-" "/" "&" "^" "~" "|" "*" "<" ">"
                                       "=" "%" "**" "//" "<<" ">>" "<=" "!="
                                       "==" ">=" "is" "not")))
     `(assignment-operator  . ,(rx (or "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
307 308
                                       ">>=" "<<=" "&=" "^=" "|="))))
    "Additional Python specific sexps for `python-rx'"))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
309 310

(defmacro python-rx (&rest regexps)
311
 "Python mode specialized rx macro which supports common python named REGEXPS."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
 (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)))))


;;; 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
338 339 340 341 342 343
    (,(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
344 345 346 347 348 349 350 351 352 353 354 355
    ;; 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"
356
              "NotImplementedError" "OSError" "OverflowError"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
357 358 359 360 361 362 363 364
              "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
365 366 367 368 369 370 371 372 373 374 375 376 377 378
    (,(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
379 380 381
    ;; asignations
    ;; support for a = b = c = 5
    (,(lambda (limit)
382 383
        (let ((re (python-rx (group (+ (any word ?. ?_)))
                             (? ?\[ (+ (not (any  ?\]))) ?\]) (* space)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
384 385
                             assignment-operator)))
          (when (re-search-forward re limit t)
386
            (while (and (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
387
                        (re-search-forward re limit t)))
388
            (if (and (not (python-info-ppss-context 'paren))
389
                     (not (equal (char-after (point-marker)) ?=)))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
390 391 392 393 394 395 396 397 398 399 400
                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))))
401
            (while (and (python-info-ppss-context 'paren)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
402 403
                        (re-search-forward re limit t))
              (goto-char (nth 3 (match-data))))
404
            (if (not (python-info-ppss-context 'paren))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
405 406 407 408 409
                t
              (set-match-data nil)))))
     (1 font-lock-variable-name-face nil nil))))

(defconst python-font-lock-syntactic-keywords
410 411
  ;; 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
412
  ;; First avoid a sequence preceded by an odd number of backslashes.
413 414 415 416 417
  `((,(concat "\\(?:\\([RUru]\\)[Rr]?\\|^\\|[^\\]\\(?:\\\\.\\)*\\)" ;Prefix.
            "\\(?:\\('\\)'\\('\\)\\|\\(?2:\"\\)\"\\(?3:\"\\)\\)")
     (3 (python-quote-syntax)))))

(defun python-quote-syntax ()
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
  "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))
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
    (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.
        (goto-char (nth 8 syntax))	; fence position
        (skip-chars-forward "uUrR")	; skip any prefix
        ;; 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
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494

(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 "_"))
	  (sst (standard-syntax-table)))
      (dotimes (i 128)
	(unless (= i ?_)
	  (if (equal symbol (aref sst i))
	      (modify-syntax-entry i "." table)))))
    (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
495 496
  :group 'python
  :safe 'booleanp)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
497 498 499 500 501 502 503 504 505 506 507 508 509

(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 ()
510
  "Guess and set `python-indent-offset' for the current buffer."
511 512 513 514 515 516 517 518
    (save-excursion
      (save-restriction
        (widen)
        (goto-char (point-min))
        (let ((found-block))
          (while (and (not found-block)
                      (re-search-forward
                       (python-rx line-start block-start) nil t))
519 520
            (when (and (not (python-info-ppss-context 'string))
                       (not (python-info-ppss-context 'comment))
521 522
                       (progn
                         (goto-char (line-end-position))
523
                         (forward-comment -9999)
524 525 526 527 528 529 530 531 532 533 534
                         (eq ?: (char-before))))
              (setq found-block t)))
          (if (not found-block)
              (message "Can't guess python-indent-offset, using defaults: %s"
                       python-indent-offset)
            (while (and (progn
                          (goto-char (line-end-position))
                          (python-info-continuation-line-p))
                        (not (eobp)))
              (forward-line 1))
            (forward-line 1)
535
            (forward-comment 9999)
536 537 538
            (let ((indent-offset (current-indentation)))
              (when (> indent-offset 0)
                (setq python-indent-offset indent-offset))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
539

540 541 542 543
(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
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

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
559
        ;; Beginning of buffer
560 561 562
        ((save-excursion
           (goto-char (line-beginning-position))
           (bobp))
563
         'no-indent)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
564
        ;; Inside a paren
565
        ((setq start (python-info-ppss-context 'paren ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
566 567
         'inside-paren)
        ;; Inside string
568
        ((setq start (python-info-ppss-context 'string ppss))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
569 570
         'inside-string)
        ;; After backslash
571 572
        ((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
573 574 575 576 577 578 579 580 581
                       (let ((line-beg-pos (line-beginning-position)))
                         (when (eq ?\\ (char-before (1- line-beg-pos)))
                           (- line-beg-pos 2)))))
         'after-backslash)
        ;; After beginning of block
        ((setq start (save-excursion
                       (let ((block-regexp (python-rx block-start))
                             (block-start-line-end ":[[:space:]]*$"))
                         (back-to-indentation)
582
                         (forward-comment -9999)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
583 584 585 586 587 588 589 590 591 592
                         (back-to-indentation)
                         (when (or (python-info-continuation-line-p)
                                   (and (not (looking-at block-regexp))
                                        (save-excursion
                                          (re-search-forward
                                           block-start-line-end
                                           (line-end-position) t))))
                           (while (and (forward-line -1)
                                       (python-info-continuation-line-p)
                                       (not (bobp))))
593
                           (back-to-indentation)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
594 595 596 597 598 599 600
                           (when (not (looking-at block-regexp))
                             (forward-line 1)))
                         (back-to-indentation)
                         (when (and (looking-at block-regexp)
                                    (or (re-search-forward
                                         block-start-line-end
                                         (line-end-position) t)
601 602 603
                                        (save-excursion
                                          (goto-char (line-end-position))
                                          (python-info-continuation-line-p))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
604 605 606 607
                           (point-marker)))))
         'after-beginning-of-block)
        ;; After normal line
        ((setq start (save-excursion
608 609
                       (back-to-indentation)
                       (forward-comment -9999)
610
                       (python-nav-sentence-start)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
                       (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)
          ('after-beginning-of-block
           (goto-char context-start)
           (+ (current-indentation) python-indent-offset))
          ('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)))
          ('inside-string
           (goto-char context-start)
           (current-indentation))
          ('after-backslash
           (let* ((block-continuation
                   (save-excursion
                     (forward-line -1)
                     (python-info-block-continuation-line-p)))
                  (assignment-continuation
                   (save-excursion
                     (forward-line -1)
                     (python-info-assignment-continuation-line-p)))
652 653 654 655 656
                  (dot-continuation
                   (save-excursion
                     (back-to-indentation)
                     (when (looking-at "\\.")
                       (forward-line -1)
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
                       (goto-char (line-end-position))
                       (while (and (re-search-backward "\\." (line-beginning-position) t)
                                   (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))))
                           (current-column)
                         (+ (current-indentation) python-indent-offset)))))
                  (indentation (cond
                                (dot-continuation
                                 dot-continuation)
                                (block-continuation
                                 (goto-char block-continuation)
                                 (re-search-forward
                                  (python-rx block-start (* space))
                                  (line-end-position) t)
                                 (current-column))
                                (assignment-continuation
                                 (goto-char assignment-continuation)
                                 (re-search-forward
                                  (python-rx simple-operator)
                                  (line-end-position) t)
                                 (forward-char 1)
                                 (re-search-forward
                                  (python-rx (* space))
                                  (line-end-position) t)
                                 (current-column))
                                (t
                                 (goto-char context-start)
689 690 691 692 693
                                 (if (not
                                      (save-excursion
                                        (back-to-indentation)
                                        (looking-at
                                         "\\(?:return\\|from\\|import\\)\s+")))
694 695
                                     (current-indentation)
                                   (+ (current-indentation)
696 697
                                      (length
                                       (match-string-no-properties 0))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
698 699
             indentation))
          ('inside-paren
700
           (or (save-excursion
701
                 (skip-syntax-forward "\s" (line-end-position))
702 703 704
                 (when (and (looking-at (regexp-opt '(")" "]" "}")))
                            (not (forward-char 1))
                            (not (python-info-ppss-context 'paren)))
705 706 707 708 709 710 711 712 713 714 715
                   (goto-char context-start)
                   (back-to-indentation)
                   (current-column)))
               (-
                (save-excursion
                  (goto-char context-start)
                  (forward-char)
                  (save-restriction
                    (narrow-to-region
                     (line-beginning-position)
                     (line-end-position))
716
                    (forward-comment 9999))
717 718
                  (if (looking-at "$")
                      (+ (current-indentation) python-indent-offset)
719
                    (forward-comment 9999)
720 721 722 723 724 725
                    (current-column)))
                (if (progn
                      (back-to-indentation)
                      (looking-at (regexp-opt '(")" "]" "}"))))
                    python-indent-offset
                  0)))))))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
726 727 728 729 730 731

(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)))
732
    (setq python-indent-levels (list 0))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
733
    (dotimes (step steps)
734
      (push (* python-indent-offset (1+ step)) python-indent-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
735
    (when (not (eq 0 remainder))
736
      (push (+ (* python-indent-offset steps) remainder) python-indent-levels))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
737 738 739 740 741 742 743 744 745 746 747 748 749
    (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
750 751
indicated by the variable `python-indent-levels' to set the
current indentation.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
752 753

When the variable `last-command' is equal to
754 755 756 757
`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
758 759

When the variable `last-command' is not equal to
760 761 762 763 764
`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
765 766 767
  (if (or (and (eq this-command 'indent-for-tab-command)
               (eq last-command this-command))
          force-toggle)
768 769 770
      (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
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
    (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.
787
See `python-indent-line' for details."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
788 789 790
  (python-indent-line))

(defun python-indent-dedent-line ()
791
  "De-indent current line."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
792
  (interactive "*")
793 794
  (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
795 796 797 798 799 800 801 802
             (<= (point-marker) (save-excursion
                                  (back-to-indentation)
                                  (point-marker)))
             (> (current-column) 0))
    (python-indent-line t)
    t))

(defun python-indent-dedent-line-backspace (arg)
803
  "De-indent current line.
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
804
Argument ARG is passed to `backward-delete-char-untabify' when
805
point is  not in between the indentation."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
806 807 808
  (interactive "*p")
  (when (not (python-indent-dedent-line))
    (backward-delete-char-untabify arg)))
809
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
810 811 812 813 814

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

Called from a program, START and END specify the region to indent."
815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
  (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
834 835 836

(defun python-indent-shift-left (start end &optional count)
  "Shift lines contained in region START END by COUNT columns to the left.
837 838 839 840
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
841 842 843 844 845 846 847 848
  (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)
849 850 851 852 853 854 855 856 857
    (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
858 859 860 861 862

(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.
863 864 865
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
866 867 868 869
  (interactive
   (if mark-active
       (list (region-beginning) (region-end) current-prefix-arg)
     (list (line-beginning-position) (line-end-position) current-prefix-arg)))
870 871 872 873 874
  (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
875

876
(defun python-indent-electric-colon (arg)
877 878 879
  "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."
880 881
  (interactive "*P")
  (self-insert-command (if (not (integerp arg)) 1 arg))
882 883 884 885 886 887 888 889 890 891 892 893
  (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)))))))
894 895
(put 'python-indent-electric-colon 'delete-selection t)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
896 897 898

;;; Navigation

899
(defvar python-nav-beginning-of-defun-regexp
900 901
  (python-rx line-start (* space) defun (+ space) (group symbol-name))
  "Regular expresion matching beginning of class or function.
902 903
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
904

905
(defun python-nav-beginning-of-defun (&optional nodecorators)
906
  "Move point to `beginning-of-defun'.
907 908
When NODECORATORS is non-nil decorators are not included.  This
is the main part of`python-beginning-of-defun-function'
909
implementation.  Return non-nil if point is moved to the
910
`beginning-of-defun'."
911 912 913
  (let ((indent-pos (save-excursion
                      (back-to-indentation)
                      (point-marker)))
914
        (found)
915 916
        (include-decorators
         (lambda ()
917 918 919 920 921 922 923 924
           (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)))))))
925 926 927 928
    (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
929
        (progn
930
          (goto-char (line-beginning-position))
931 932
          (funcall include-decorators)
          (setq found t))
933
      (goto-char (line-beginning-position))
934 935
      (when (re-search-backward python-nav-beginning-of-defun-regexp nil t)
        (setq found t))
936
      (goto-char (or (python-info-ppss-context 'string) (point)))
937 938
      (funcall include-decorators))
    found))
939

940
(defun python-beginning-of-defun-function (&optional arg nodecorators)
941 942
  "Move point to the beginning of def or class.
With positive ARG move that number of functions forward.  With
943
negative do the same but backwards.  When NODECORATORS is non-nil
944
decorators are not included.  Return non-nil if point is moved to the
945
`beginning-of-defun'."
946 947
  (when (or (null arg) (= arg 0)) (setq arg 1))
  (if (> arg 0)
948 949 950 951
      (dotimes (i arg (python-nav-beginning-of-defun nodecorators)))
    (let ((found))
      (dotimes (i (- arg) found)
        (python-end-of-defun-function)
952
        (forward-comment 9999)
953 954 955 956
        (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
957 958 959 960

(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."
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
  (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))))
976
    (forward-comment 9999)
977
    (goto-char (line-beginning-position))))
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
978

979 980 981 982 983 984 985 986 987
(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))
988
                     (python-info-ppss-context 'string)
989 990 991 992 993 994 995 996 997 998
                     (python-info-ppss-context 'paren))
                  (forward-line -1)))))

(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)
999
                     (python-info-ppss-context 'string)
1000 1001 1002
                     (python-info-ppss-context 'paren))
                  (forward-line 1)))))

1003
(defun python-nav-backward-sentence (&optional arg)
1004
  "Move backward to start of sentence.  With ARG, do it arg times.
1005 1006 1007 1008 1009 1010
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)
1011
  "Move forward to next end of sentence.  With ARG, repeat.
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
With negative argument, move backward repeatedly to start of sentence."
  (interactive "^p")
  (or arg (setq arg 1))
  (while (> arg 0)
    (forward-comment 9999)
    (python-nav-sentence-end)
    (forward-line 1)
    (setq arg (1- arg)))
  (while (< arg 0)
    (python-nav-sentence-end)
    (forward-comment -9999)
    (python-nav-sentence-start)
    (forward-line -1)
    (setq arg (1+ arg))))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1027 1028 1029

;;; Shell integration

1030 1031 1032 1033 1034
(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
1035 1036 1037 1038

(defcustom python-shell-interpreter "python"
  "Default Python interpreter for shell."
  :type 'string
1039
  :group 'python
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1040 1041
  :safe 'stringp)

1042 1043 1044 1045 1046
(defcustom python-shell-internal-buffer-name "Python Internal"
  "Default buffer name for the Internal Python interpreter."
  :type 'string
  :group 'python
  :safe 'stringp)
1047

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1048 1049 1050
(defcustom python-shell-interpreter-args "-i"
  "Default arguments for the Python interpreter."
  :type 'string
1051
  :group 'python
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1052 1053 1054
  :safe 'stringp)

(defcustom python-shell-prompt-regexp ">>> "
1055 1056
  "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
1057 1058 1059 1060 1061
  :type 'string
  :group 'python
  :safe 'stringp)

(defcustom python-shell-prompt-block-regexp "[.][.][.] "
1062 1063
  "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
1064 1065 1066 1067
  :type 'string
  :group 'python
  :safe 'stringp)

1068
(defcustom python-shell-prompt-output-regexp ""
1069 1070
  "Regular Expression matching output prompt of python shell.
It should not contain a caret (^) at the beginning."
1071 1072 1073 1074
  :type 'string
  :group 'python
  :safe 'stringp)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1075
(defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ "
1076 1077
  "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
1078 1079 1080 1081
  :type 'string
  :group 'python
  :safe 'stringp)

1082 1083 1084 1085
(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."
1086
  :type 'integer
1087
  :group 'python
1088
  :safe 'integerp)
1089

1090
(defcustom python-shell-process-environment nil
1091 1092
  "List of environment variables for Python shell.
This variable follows the same rules as `process-environment'
1093 1094
since it merges with it before the process creation routines are
called.  When this variable is nil, the Python shell is run with
1095
the default `process-environment'."
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
  :type '(repeat string)
  :group 'python
  :safe 'listp)

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

1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
(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)

1120 1121 1122 1123
(defcustom python-shell-setup-codes '(python-shell-completion-setup-code
                                      python-ffap-setup-code
                                      python-eldoc-setup-code)
  "List of code run by `python-shell-send-setup-codes'.
1124
Each variable can contain either a simple string with the code to
1125 1126 1127 1128 1129 1130 1131
execute or a cons with the form (CODE . DESCRIPTION), where CODE
is a string with the code to execute and DESCRIPTION is the
description of it."
  :type '(repeat symbol)
  :group 'python
  :safe 'listp)

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
(defcustom python-shell-compilation-regexp-alist
  `((,(rx line-start (1+ (any " \t")) "File \""
	  (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c
	  "\", line " (group (1+ digit)))
     1 2)
    (,(rx " in file " (group (1+ not-newline)) " on line "
	  (group (1+ digit)))
     1 2)
    (,(rx line-start "> " (group (1+ (not (any "(\"<"))))
	  "(" (group (1+ digit)) ")" (1+ (not (any "("))) "()")
     1 2))
  "`compilation-error-regexp-alist' for inferior Python."
  :type '(alist string)
  :group 'python)

(defun python-shell-get-process-name (dedicated)
  "Calculate the appropiate process name for inferior Python process.
If DEDICATED is t and the variable `buffer-file-name' is non-nil
returns a string with the form
`python-shell-buffer-name'[variable `buffer-file-name'] else
1152 1153 1154
returns the value of `python-shell-buffer-name'.  After
calculating the process name adds the buffer name for the process
in the `same-window-buffer-names' list."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1155 1156 1157 1158 1159 1160 1161 1162 1163
  (let ((process-name
         (if (and dedicated
                  buffer-file-name)
             (format "%s[%s]" python-shell-buffer-name buffer-file-name)
           (format "%s" python-shell-buffer-name))))
    (add-to-list 'same-window-buffer-names (purecopy
                                            (format "*%s*" process-name)))
    process-name))

1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
(defun python-shell-internal-get-process-name ()
  "Calculate the appropiate process name for Internal Python process.
The name is calculated from `python-shell-global-buffer-name' and
a hash of all relevant global shell settings in order to ensure
uniqueness for different types of configurations."
  (format "%s [%s]"
          python-shell-internal-buffer-name
          (md5
           (concat
            (python-shell-parse-command)
            (mapconcat #'symbol-value python-shell-setup-codes "")
            (mapconcat #'indentity python-shell-process-environment "")
1176
            (or python-shell-virtualenv-path "")
1177 1178
            (mapconcat #'indentity python-shell-exec-path "")))))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1179
(defun python-shell-parse-command ()
1180
  "Calculate the string used to execute the inferior Python process."
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1181 1182
  (format "%s %s" python-shell-interpreter python-shell-interpreter-args))

1183 1184
(defun python-shell-calculate-process-environment ()
  "Calculate process environment given `python-shell-virtualenv-path'."
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
  (let ((env (python-util-merge 'list python-shell-process-environment
                                process-environment 'string=))
        (virtualenv (if python-shell-virtualenv-path
                        (directory-file-name python-shell-virtualenv-path)
                      nil)))
    (if (not virtualenv)
        env
      (dolist (envvar env)
        (let* ((split (split-string envvar "=" t))
               (name (nth 0 split))
               (value (nth 1 split)))
          (when (not (string= name "PYTHONHOME"))
            (when (string= name "PATH")
              (setq value (format "%s/bin:%s" virtualenv value)))
            (setq env (cons (format "%s=%s" name value) env)))))
      (cons (format "VIRTUAL_ENV=%s" virtualenv) env))))

(defun python-shell-calculate-exec-path ()
  "Calculate exec path given `python-shell-virtualenv-path'."
  (let ((path (python-util-merge 'list python-shell-exec-path
                                 exec-path 'string=)))
    (if (not python-shell-virtualenv-path)
        path
      (cons (format "%s/bin"
                    (directory-file-name python-shell-virtualenv-path))
            path))))

Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
(defun python-comint-output-filter-function (output)
  "Hook run after content is put into comint buffer.
OUTPUT is a string with the contents of the buffer."
  (ansi-color-filter-apply output))

(defvar inferior-python-mode-current-file nil
  "Current file from which a region was sent.")
(make-variable-buffer-local 'inferior-python-mode-current-file)

(define-derived-mode inferior-python-mode comint-mode "Inferior Python"
1222
  "Major mode for Python inferior process.
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
Runs a Python interpreter as a subprocess of Emacs, with Python
I/O through an Emacs buffer.  Variables
`python-shell-interpreter' and `python-shell-interpreter-args'
controls which Python interpreter is run.  Variables
`python-shell-prompt-regexp',
`python-shell-prompt-output-regexp',
`python-shell-prompt-block-regexp',
`python-shell-completion-setup-code',
`python-shell-completion-string-code', `python-eldoc-setup-code',
`python-eldoc-string-code', `python-ffap-setup-code' and
`python-ffap-string-code' can customize this mode for different
Python interpreters.

You can also add additional setup code to be run at
initialization of the interpreter via `python-shell-setup-codes'
variable.

\(Type \\[describe-mode] in the process buffer for a list of commands.)"
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
  (set-syntax-table python-mode-syntax-table)
  (setq mode-line-process '(":%s"))
  (setq comint-prompt-regexp (format "^\\(?:%s\\|%s\\|%s\\)"
                                     python-shell-prompt-regexp
                                     python-shell-prompt-block-regexp
                                     python-shell-prompt-pdb-regexp))
  (make-local-variable 'comint-output-filter-functions)
  (add-hook 'comint-output-filter-functions
            'python-comint-output-filter-function)
  (add-hook 'comint-output-filter-functions
            'python-pdbtrack-comint-output-filter-function)
  (set (make-local-variable 'compilation-error-regexp-alist)
       python-shell-compilation-regexp-alist)
1254 1255 1256 1257
  (define-key inferior-python-mode-map [remap complete-symbol]
    'completion-at-point)
  (add-hook 'completion-at-point-functions
            'python-shell-completion-complete-at-point nil 'local)
1258 1259 1260 1261
  (add-to-list (make-local-variable 'comint-dynamic-complete-functions)
               'python-shell-completion-complete-at-point)
  (define-key inferior-python-mode-map (kbd "<tab>")
    'python-shell-completion-complete-or-indent)
Fabián Ezequiel Gallina's avatar
Fabián Ezequiel Gallina committed
1262 1263
  (compilation-shell-minor-mode 1))

1264
(defun python-shell-make-comint (cmd proc-name &optional pop)
1265
  "Create a python shell comint buffer.
1266
CMD is the python command to be executed and PROC-NAME is the
1267
process name the comint buffer will get.  After the comint buffer
1268 1269
is created the `inferior-python-mode' is activated.  If POP is
non-nil the buffer is shown."
1270 1271
  (save-excursion
    (let* ((proc-buffer-name (format "*%s*" proc-name))
1272
           (process-environment (python-shell-calculate-process-environment))
1273 1274
           (exec-path (python-shell-calculate-exec-path)))
      (when (not (comint-check-proc proc-buffer-name))
1275 1276 1277
        (let* ((cmdlist (split-string-and-unquote cmd))
               (buffer (apply 'make-comint proc-name (car cmdlist) nil
                              (cdr cmdlist)))
1278
               (current-buffer (current-buffer)))
1279 1280
          (with-current-buffer buffer
            (inferior-python-mode)
1281
            (python-util-clone-local-variables current-buffer))))
1282
      (when pop