-
-
Notifications
You must be signed in to change notification settings - Fork 39
/
python.el
1649 lines (1466 loc) · 64.8 KB
/
python.el
1
2
3
4
5
6
7
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
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
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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
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
652
653
654
655
656
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
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
737
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
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; python.el -- Python's flying circus support for Emacs
;; Copyright (C) 2010 Free Software Foundation, Inc.
;; Author: Fabián E. Gallina <fabian@anue.biz>
;; 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
;; interaction, Shell completion, Pdb tracking, Symbol completion,
;; Eldoc.
;; 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
;; indentation by hitting <tab> several times.
;; Movement: `beginning-of-defun' and `end-of-defun' functions are
;; properly implemented. A `beginning-of-innermost-defun' is defined
;; to navigate nested defuns.
;; 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
;; word. Shell completion is implemented in a manner that if you
;; change the `python-shell-interpreter' to any other (for example
;; IPython) it should be easy to integrate another way to calculate
;; completions. You just need to especify your custom
;; `python-shell-completion-setup-code' and
;; `python-shell-completion-strings-code'
;; 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.
;; Symbol completion: you can complete the symbol at point. It uses
;; the shell completion in background so you should run
;; `python-shell-send-buffer' from time to time to get better results.
;; Eldoc: returns documentation for object at point by using the
;; inferior python subprocess to inspect its documentation. As you
;; might guessed you should run `python-shell-send-buffer' from time
;; to time to get better results too.
;;; Installation:
;; Add this to your .emacs:
;; (add-to-list 'load-path "/folder/containing/file")
;; (require 'python)
;;; TODO:
;; Ordered by priority:
;; Better decorator support for beginning of defun
;; Review code and cleanup
;; (Perhaps) python-check
;; (Perhaps) ffap support
;; (Perhaps) some skeletons (I never use them because of yasnippet)
;;; Code:
(require 'comint)
(require 'ansi-color)
(require 'outline)
(eval-when-compile
(require 'cl))
(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)))
;; 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)
;; 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)
;; 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"]
["Start of def/class" python-beginning-of-innermost-defun
:help "Go to start of innermost definition around point"]
["End of def/class" end-of-defun
:help "Go to end of definition around point"]
"-"
["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"]
"-"
["Complete symbol" completion-at-point
:help "Complete symbol before point"]))
map)
"Keymap for `python-mode'.")
;;; Python specialized rx
(defconst python-rx-constituents
(list
`(block-start . ,(rx symbol-start
(or "def" "class" "if" "elif" "else" "try"
"except" "finally" "for" "while" "with")
symbol-end))
`(defun . ,(rx symbol-start (or "def" "class") symbol-end))
`(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 "=" "+=" "-=" "*=" "/=" "//=" "%=" "**="
">>=" "<<=" "&=" "^=" "|=")))))
(defmacro python-rx (&rest regexps)
"Python mode especialized rx macro which 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)))))
;;; 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
(,(rx symbol-start (group "None" symbol-end))
(1 font-lock-constant-face))
;; 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"
"NotImplemented" "NotImplementedError" "OSError" "OverflowError"
"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
(,(rx (or line-start (not (any ". \t"))) (* (any " \t")) symbol-start
(group
(or "_" "__debug__" "__doc__" "__import__" "__name__" "__package__"
"abs" "all" "any" "apply" "basestring" "bin" "bool" "buffer"
"bytearray" "bytes" "callable" "chr" "classmethod" "cmp" "coerce"
"compile" "complex" "copyright" "credits" "delattr" "dict" "dir"
"divmod" "enumerate" "eval" "execfile" "exit" "file" "filter"
"float" "format" "frozenset" "getattr" "globals" "hasattr" "hash"
"help" "hex" "id" "input" "int" "intern" "isinstance" "issubclass"
"iter" "len" "license" "list" "locals" "long" "map" "max" "min"
"next" "object" "oct" "open" "ord" "pow" "print" "property" "quit"
"range" "raw_input" "reduce" "reload" "repr" "reversed" "round"
"set" "setattr" "slice" "sorted" "staticmethod" "str" "sum"
"super" "tuple" "type" "unichr" "unicode" "vars" "xrange" "zip"
"True" "False" "Ellipsis")) symbol-end)
(1 font-lock-builtin-face))
;; asignations
;; support for a = b = c = 5
(,(lambda (limit)
(let ((re (python-rx (group (+ (any word ?. ?_))) (* space)
assignment-operator)))
(when (re-search-forward re limit t)
(while (and (not (equal (nth 0 (syntax-ppss)) 0))
(re-search-forward re limit t)))
(if (equal (nth 0 (syntax-ppss)) 0)
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))))
(while (and (not (equal (nth 0 (syntax-ppss)) 0))
(re-search-forward re limit t))
(goto-char (nth 3 (match-data))))
(if (equal (nth 0 (syntax-ppss)) 0)
t
(set-match-data nil)))))
(1 font-lock-variable-name-face nil nil))))
;; Fixme: Is there a better way?
(defconst python-font-lock-syntactic-keywords
;; First avoid a sequence preceded by an odd number of backslashes.
`((,(rx (not (any ?\\))
?\\ (* (and ?\\ ?\\))
(group (syntax string-quote))
(backref 1)
(group (backref 1)))
(2 ,(string-to-syntax "\""))) ; dummy
(,(rx (group (optional (any "uUrR"))) ; prefix gets syntax property
(optional (any "rR")) ; possible second prefix
(group (syntax string-quote)) ; maybe gets property
(backref 2) ; per first quote
(group (backref 2))) ; maybe gets property
(1 (python-quote-syntax 1))
(2 (python-quote-syntax 2))
(3 (python-quote-syntax 3))))
"Make outer chars of triple-quote strings into generic string delimiters.")
(defun python-quote-syntax (n)
"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))
(cond
;; Consider property for the last char if in a fenced string.
((= n 3)
(let* ((font-lock-syntactic-keywords nil)
(syntax (syntax-ppss)))
(when (eq t (nth 3 syntax)) ; after unclosed fence
(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)))
(eval-when-compile (string-to-syntax "|"))))))
;; Consider property for initial char, accounting for prefixes.
((or (and (= n 2) ; leading quote (not prefix)
(= (match-beginning 1) (match-end 1))) ; prefix is null
(and (= n 1) ; prefix
(/= (match-beginning 1) (match-end 1)))) ; non-empty
(let ((font-lock-syntactic-keywords nil))
(unless (eq 'string (syntax-ppss-context (syntax-ppss)))
(eval-when-compile (string-to-syntax "|")))))
;; Otherwise (we're in a non-matching string) the property is
;; nil, which is OK.
)))
(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
:group 'python)
(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 ()
"Guess and set `python-indent-offset' for the current buffer."
(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))
(when (and (not (syntax-ppss-context (syntax-ppss)))
(progn
(goto-char (line-end-position))
(forward-comment -1)
(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)
(forward-comment 1)
(setq python-indent-offset (current-indentation)))))))
(defun python-indent-context (&optional stop)
"Return information on indentation context.
Optional argument STOP serves to stop recursive calls.
Returns a cons with the form:
\(STATUS . START)
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
;; Beginning of buffer
((save-excursion
(goto-char (line-beginning-position))
(bobp))
'no-indent)
;; Inside a paren
((setq start (nth 1 ppss))
'inside-paren)
;; Inside string
((setq start (when (and (nth 3 ppss))
(nth 8 ppss)))
'inside-string)
;; After backslash
((setq start (when (not (syntax-ppss-context ppss))
(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)
(while (and (forward-comment -1) (not (bobp))))
(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))))
(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)
(python-info-continuation-line-p)))
(point-marker)))))
'after-beginning-of-block)
;; After normal line
((setq start (save-excursion
(while (and (forward-comment -1) (not (bobp))))
(while (and (not (back-to-indentation))
(not (bobp))
(if (> (nth 0 (syntax-ppss)) 0)
(forward-line -1)
(if (save-excursion
(forward-line -1)
(python-info-line-ends-backslash-p))
(forward-line -1)))))
(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)))
(indentation (cond (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)
(current-indentation)))))
indentation))
('inside-paren
(-
(save-excursion
(goto-char context-start)
(forward-char)
(save-restriction
(narrow-to-region
(line-beginning-position)
(line-end-position))
(forward-comment 1))
(if (looking-at "$")
(+ (current-indentation) python-indent-offset)
(forward-comment 1)
(current-column)))
(if (progn
(back-to-indentation)
(looking-at (regexp-opt '(")" "]" "}"))))
python-indent-offset
0))))))))
(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)))
(setq python-indent-levels '())
(setq python-indent-levels (cons 0 python-indent-levels))
(dotimes (step steps)
(setq python-indent-levels
(cons (* python-indent-offset (1+ step)) python-indent-levels)))
(when (not (eq 0 remainder))
(setq python-indent-levels
(cons (+ (* python-indent-offset steps) remainder)
python-indent-levels)))
(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
indicated by the variable `python-indent-levels'.
When the variable `last-command' is equal to
`indent-for-tab-command' or FORCE-TOGGLE is non-nil:
* Cycles levels indicated in the variable `python-indent-levels'
by setting the current level in the variable
`python-indent-current-level'.
When the variable `last-command' is not equal to
`indent-for-tab-command' and FORCE-TOGGLE is nil:
* calculates possible indentation levels and saves it in the
variable `python-indent-levels'.
* sets the variable `python-indent-current-level' correctly so
offset is equal to (`nth' `python-indent-current-level'
`python-indent-levels')"
(if (or (and (eq this-command 'indent-for-tab-command)
(eq last-command this-command))
force-toggle)
(python-indent-toggle-levels)
(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.
Internally just calls `python-indent-line'."
(python-indent-line))
(defun python-indent-dedent-line ()
"Dedent current line."
(interactive "*")
(when (and (not (syntax-ppss-context (syntax-ppss)))
(<= (point-marker) (save-excursion
(back-to-indentation)
(point-marker)))
(> (current-column) 0))
(python-indent-line t)
t))
(defun python-indent-dedent-line-backspace (arg)
"Dedent current line.
Argument ARG is passed to `backward-delete-char-untabify' when
point is not in between the indentation."
(interactive "*p")
(when (not (python-indent-dedent-line))
(backward-delete-char-untabify arg)))
(put 'python-indent-dedent-line-backspace 'delete-selection 'supersede)
(defun python-indent-region (start end)
"Indent a python region automagically.
Called from a program, START and END specify the region to indent."
(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)))
(defun python-indent-shift-left (start end &optional count)
"Shift lines contained in region START END by COUNT columns to the left.
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."
(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)
(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)))))
(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.
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."
(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))
(indent-rigidly start end count))
;;; Navigation
(defvar python-beginning-of-defun-regexp
"^\\(def\\|class\\)[[:space:]]+[[:word:]]+"
"Regular expresion matching beginning of outermost class or function.")
(defvar python-beginning-of-innermost-defun-regexp
"^[[:space:]]*\\(def\\|class\\)[[:space:]]+[[:word:]]+"
"Regular expresion matching beginning of innermost class or function.")
(defun python-beginning-of-defun (&optional innermost)
"Move point to the beginning of innermost/outermost def or class.
If INNERMOST is non-nil then move to the beginning of the
innermost definition."
(let ((starting-point (point-marker))
(nonblank-line-indent)
(defun-indent)
(defun-point)
(regexp (if innermost
python-beginning-of-innermost-defun-regexp
python-beginning-of-defun-regexp)))
(back-to-indentation)
(if (and (not (looking-at "@"))
(not (looking-at regexp)))
(forward-comment -1)
(while (and (not (eobp))
(forward-line 1)
(not (back-to-indentation))
(looking-at "@"))))
(when (not (looking-at regexp))
(re-search-backward regexp nil t))
(setq nonblank-line-indent (+ (current-indentation) python-indent-offset))
(setq defun-indent (current-indentation))
(setq defun-point (point-marker))
(if (> nonblank-line-indent defun-indent)
(progn
(goto-char defun-point)
(forward-line -1)
(while (and (looking-at "@")
(forward-line -1)
(not (bobp))
(not (back-to-indentation))))
(unless (bobp)
(forward-line 1))
(point-marker))
(if innermost
(python-beginning-of-defun)
(goto-char starting-point)
nil))))
(defun python-beginning-of-defun-function ()
"Move point to the beginning of outermost def or class.
Returns nil if point is not in a def or class."
(python-beginning-of-defun nil))
(defun python-beginning-of-innermost-defun ()
"Move point to the beginning of innermost def or class.
Returns nil if point is not in a def or class."
(interactive)
(python-beginning-of-defun t))
(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."
(let ((starting-point (point-marker))
(defun-regexp (python-rx defun))
(beg-defun-indent))
(back-to-indentation)
(if (looking-at "@")
(while (and (not (eobp))
(forward-line 1)
(not (back-to-indentation))
(looking-at "@")))
(while (and (not (bobp))
(not (progn (back-to-indentation) (current-word)))
(forward-line -1))))
(when (or (not (equal (current-indentation) 0))
(string-match defun-regexp (current-word)))
(setq beg-defun-indent (save-excursion
(or (looking-at defun-regexp)
(python-beginning-of-innermost-defun))
(current-indentation)))
(while (and (forward-line 1)
(not (eobp))
(or (not (current-word))
(> (current-indentation) beg-defun-indent))))
(while (and (forward-comment -1)
(not (bobp))))
(forward-line 1)
(point-marker))))
;;; Shell integration
(defvar python-shell-buffer-name "Python"
"Default buffer name for Python interpreter.")
(defcustom python-shell-interpreter "python"
"Default Python interpreter for shell."
:group 'python
:type 'string
:safe 'stringp)
(defcustom python-shell-interpreter-args "-i"
"Default arguments for the Python interpreter."
:group 'python
:type 'string
:safe 'stringp)
(defcustom python-shell-prompt-regexp ">>> "
"Regex matching top\-level input prompt of python shell.
The regex should not contain a caret (^) at the beginning."
:type 'string
:group 'python
:safe 'stringp)
(defcustom python-shell-prompt-block-regexp "[.][.][.] "
"Regex matching block input prompt of python shell.
The regex should not contain a caret (^) at the beginning."
:type 'string
:group 'python
:safe 'stringp)
(defcustom python-shell-prompt-pdb-regexp "[(<]*[Ii]?[Pp]db[>)]+ "
"Regex matching pdb input prompt of python shell.
The regex should not contain a caret (^) at the beginning."
:type 'string
:group 'python
:safe 'stringp)
(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
returns the value of `python-shell-buffer-name'.
After calculating the process name add the buffer name for the
process in the `same-window-buffer-names' list"
(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))
(defun python-shell-parse-command ()
"Calculates the string used to execute the inferior Python process."
(format "%s %s" python-shell-interpreter python-shell-interpreter-args))
(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)
(defvar inferior-python-mode-current-temp-file nil
"Current temp file sent to process.")
(make-variable-buffer-local 'inferior-python-mode-current-file)
(define-derived-mode inferior-python-mode comint-mode "Inferior Python"
"Major mode for Python inferior process."
(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)
(compilation-shell-minor-mode 1))
(defun run-python (dedicated cmd)
"Run an inferior Python process.
Input and output via buffer *\\[python-shell-buffer-name]*.
If there is a process already running in
*\\[python-shell-buffer-name]*, switch to that buffer.
With argument, allows you to:
* Define DEDICATED so a dedicated process for the current buffer
is open.
* Define CMD so you can edit the command used to call the
interpreter (default is value of `python-shell-interpreter' and
arguments defined in `python-shell-interpreter-args').
Runs the hook `inferior-python-mode-hook' (after the
`comint-mode-hook' is run).
\(Type \\[describe-mode] in the process buffer for a list of
commands.)"
(interactive
(if current-prefix-arg
(list
(y-or-n-p "Make dedicated process? ")
(read-string "Run Python: " (python-shell-parse-command)))
(list nil (python-shell-parse-command))))
(let* ((proc-name (python-shell-get-process-name dedicated))
(proc-buffer-name (format "*%s*" proc-name)))
(when (not (comint-check-proc proc-buffer-name))
(let ((cmdlist (split-string-and-unquote cmd)))
(set-buffer
(apply 'make-comint proc-name (car cmdlist) nil
(cdr cmdlist)))
(inferior-python-mode)))
(pop-to-buffer proc-buffer-name))
dedicated)
(defun python-shell-get-process ()
"Get inferior Python process for current buffer and return it."
(let* ((dedicated-proc-name (python-shell-get-process-name t))
(dedicated-proc-buffer-name (format "*%s*" dedicated-proc-name))
(global-proc-name (python-shell-get-process-name nil))
(global-proc-buffer-name (format "*%s*" global-proc-name))
(dedicated-running (comint-check-proc dedicated-proc-buffer-name))
(global-running (comint-check-proc global-proc-buffer-name)))
;; Always prefer dedicated
(get-buffer-process (or (and dedicated-running dedicated-proc-buffer-name)
(and global-running global-proc-buffer-name)))))