spacemacs/contrib/lang/python
syl20bnr 0051aa73c4 Update conventions for help/doc key bindings
`m d` goes under help commands so it is now `m h d`
2014-12-21 22:52:57 -05:00
..
extensions Add nose and pylookup as regular directories 2014-11-14 23:12:47 -05:00
README.md Light refactor of python layer README 2014-12-11 20:10:40 -05:00
extensions.el Update conventions for help/doc key bindings 2014-12-21 22:52:57 -05:00
funcs.el separated python settings into a contrib 2014-11-14 22:41:45 -05:00
packages.el Update conventions for help/doc key bindings 2014-12-21 22:52:57 -05:00
python.png Update Python readme 2014-12-09 23:36:33 -05:00

README.md

Python contribution layer for Spacemacs

logo

Table of Contents

Description

This layer adds support for the Python language.

Features:

Install

To use this contribution add it to your ~/.spacemacs

(setq-default dotspacemacs-configuration-layers '(python)
  "List of contribution to load."
)

Key Bindings

Inferior REPL process

Start a Python or iPython inferior REPL process with SPC m i. If ipython is available in system executable search paths, ipython will be used to launch python shell; otherwise, default python interpreter will be used. You may change your system executable search path by activating a virtual environment.

Send code to inferior process commands:

Key Binding     |                 Description

--------------------|------------------------------------------------------------ SPC m b | send buffer and keep code buffer focused SPC m B | send buffer and switch to REPL in insert mode SPC m f | send function and keep code buffer focused SPC m F | send function and switch to REPL in insert mode SPC m r | send region and keep code buffer focused SPC m R | send region and switch to REPL in insert mode CTRL+j | next item in REPL history CTRL+k | previous item in REPL history

Testing in Python

Spacemacs uses nose as a test runner. An improved version of nose.el is shipped with Spacemacs, this version adds:

  • windows support
  • test suite support

The root of the project is detected with a .git directory or a setup.cfg file.

Test commands (start with m t or m T):

No Debug         |                 Description

---------------------|------------------------------------------------------------ SPC m t a | launch all tests of the project SPC m t b | launch all tests of the current buffer (same as module) SPC m t m | launch all tests of the current module SPC m t s | launch all tests of the current suite SPC m t t | launch the current test (function)

 Debug           |                 Description

---------------------|------------------------------------------------------------ SPC m T a | launch all tests of the project in debug mode SPC m T b | launch all tests of the current buffer (module) in debug mode SPC m T m | launch all tests of the current module in debug mode SPC m T s | launch all tests of the current suite in debug mode SPC m T t | launch the current test (function) in debug mode

Other Python commands

Key Binding      |                 Description

---------------------|------------------------------------------------------------ SPC m d | quick documentation using anaconda SPC m D | open documentation in firefox using pylookup SPC m g | go to definition using anaconda-mode-goto (C-o to jump back) SPC m t b | toggle a breakpoint SPC m v | activate a virtual environment with pyvenv