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
|
.. _tricked_out_emacs:
===================================
Tricked out emacs for python coding
===================================
Various ways to configure your emacs that you might find useful.
See emacs_python_mode_ for a good summary.
.. _rst_emacs:
ReST mode
---------
For editing ReST documents like this one. You may need a recent
version of the rst.el_ file from the docutils_ site.
.. _rst.el: http://docutils.sourceforge.net/tools/editors/emacs/rst.el
``rst`` mode automates many important ReST tasks like building and updateing
table-of-contents, and promoting or demoting section headings. Here
is the basic ``.emacs`` configuration::
(require 'rst)
(setq auto-mode-alist
(append '(("\\.txt$" . rst-mode)
("\\.rst$" . rst-mode)
("\\.rest$" . rst-mode)) auto-mode-alist))
Some helpful functions::
C-c TAB - rst-toc-insert
Insert table of contents at point
C-c C-u - rst-toc-update
Update the table of contents at point
C-c C-l rst-shift-region-left
Shift region to the left
C-c C-r rst-shift-region-right
Shift region to the right
On - for example - Ubuntu, the default ``M-x rst-compile`` command
uses ``rst2html.py`` whereas the command installed is ``rst2html``.
Time for a symlink.
doctest mode
-------------
This useful mode for writing doctests (``doctest-mode.el``) came with
my ``python-mode`` package in Ubuntu. Or see doctest-mode_ project page.
code checkers
-------------
Code checkers within emacs can be useful to check code for errors,
unused variables, imports and so on. Alternatives are pychecker_,
pylint_ and pyflakes_. Note that rope_ (below) also does some code
checking. pylint_ and pyflakes_ work best with emacs flymake_,
which usually comes with emacs.
pychecker_
``````````
This appears to be plumbed in with ``python-mode``, just do ``M-x
py-pychecker-run``. If you try this, and pychecker_ is not installed,
you will get an error. You can install it using your package manager
(``pychecker`` in Ubuntu) or from the pychecker_ webpage.
pylint_
```````
Install pylint_. Ubuntu packages pylint_ as ``pylint``. Put the
`flymake .emacs snippet`_ in your ``.emacs`` file. You will see, in the
emacs_python_mode_ page, that you will need to save this::
#!/usr/bin/env python
import re
import sys
from subprocess import *
p = Popen("pylint -f parseable -r n --disable-msg-cat=C,R %s" %
sys.argv[1], shell = True, stdout = PIPE).stdout
for line in p.readlines():
match = re.search("\\[([WE])(, (.+?))?\\]", line)
if match:
kind = match.group(1)
func = match.group(3)
if kind == "W":
msg = "Warning"
else:
msg = "Error"
if func:
line = re.sub("\\[([WE])(, (.+?))?\\]",
"%s (%s):" % (msg, func), line)
else:
line = re.sub("\\[([WE])?\\]", "%s:" % msg, line)
print line,
p.close()
as ``epylint`` somewhere on your system path, and test that ``epylint
somepyfile.py`` works.
pyflakes
````````
Install pyflakes_. Maybe your package manager again? (``apt-get
install pyflakes``). Install the `flymake .emacs snippet`_ in your
``.emacs`` file.
flymake .emacs snippet
``````````````````````
Add this to your .emacs file::
;; code checking via flymake
;; set code checker here from "epylint", "pyflakes"
(setq pycodechecker "pyflakes")
(when (load "flymake" t)
(defun flymake-pycodecheck-init ()
(let* ((temp-file (flymake-init-create-temp-buffer-copy
'flymake-create-temp-inplace))
(local-file (file-relative-name
temp-file
(file-name-directory buffer-file-name))))
(list pycodechecker (list local-file))))
(add-to-list 'flymake-allowed-file-name-masks
'("\\.py\\'" flymake-pycodecheck-init)))
and set which of pylint_ ("epylint") or pyflakes_ ("pyflakes") you
want to use.
You may also consider using the ``flymake-cursor`` functions, see the
``pyflakes`` section of the emacs_python_mode_ page for details.
ropemacs_
---------
rope_ is a python refactoring library, and ropemacs_ is an emacs
interface to it, that uses pymacs_. pymacs_ is an interface between
emacs lisp and python that allows emacs to call into python and python
to call back into emacs.
Install
````````
- rope_ - by downloading from the link, and running ``python setup.py
install`` in the usual way.
- pymacs_ - probably via your package manager - for example ``apt-get
install pymacs``
- ropemacs_ - download from link, ``python setup.py install``
You may need to make sure your gnome etc sessions have the correct
python path settings - for example settings in ``.gnomerc`` as well as
the usual ``.bashrc``.
Make sure you can `import ropemacs` from python (which should drop you
into something lispey). Add these lines somewhere in your `.emacs` file::
(require 'pymacs)
(pymacs-load "ropemacs" "rope-")
and restart emacs. When you open a python file, you should have a
``rope`` menu. Note `C-c g` - the excellent `goto-definition` command.
Switching between modes
-----------------------
You may well find it useful to be able to switch fluidly between
python mode, doctest mode, ReST mode and flymake mode (pylint_). You
can attach these modes to function keys in your ``.emacs`` file with
something like::
(global-set-key [f8] 'flymake-mode)
(global-set-key [f9] 'python-mode)
(global-set-key [f10] 'doctest-mode)
(global-set-key [f11] 'rst-mode)
emacs code browser
------------------
Not really python specific, but a rather nice set of windows for
browsing code directories, and code - see the ECB_ page. Again, your
package manager may help you (``apt-get install ecb``).
.. include:: ../../links_names.txt
|
