Introduction

Pygen is a package that allows the user to automatically generate Python code.

Installation

• State “TODO” from [2016-10-16 Sun 17:54]

This section still needs to be completed. Installation should shortly be available on MELPA.

Dependencies

Pygen leverages Elpy and python-mode. That’s the package called python-mode - not the mode itself. As of Emacs 24.5.1, python-mode is not the default Python mode but a separate package. The default package is python.el.

Pygen won’t work with a Python setup unless python-mode is installed and Elpy is active. However, the variable pygen-navigate-to-definition-command has been added to allow Elpy to be disabled - if you have another command that allows Pygen to navigate to function definitions.

Commands

It provides the following code generation commands. Scroll down for animated examples.

Command	Keychord	Description
pygen-generate-class	C-c C-= c	Generate a python class from the reference under point.
pygen-generate-function	C-c C-= f	Generate a python function from the reference under point.
pygen-generate-static-function	C-c C-= s	Generate a static python function from the reference under point.
pygen-extract-variable	C-c C-= v	Extract the current region into a variable.
pygen-make-keyword-argument	C-c C-= k	Adds a keyword argument to the current function.
pygen-make-sequence-argument	C-c C-= a	Adds a sequence argument to the current function.
pygen-add-decorator-to-function	C-c C-= @	Adds a decorator in front of the current function.
pygen-selfify-symbol	N/A	Puts the word self. in front of the current symbol.
pygen-unselfify-symbol	N/A	Removes the word self. from the current symbol (if it exists).
pygen-toggle-selfify-symbol	C-c C-= .	Toggles the word self in front of the current symbol.
pygen-insert-super	C-c C-= u	Inserts a proper call to the current method in the superclass. This is basically a wrapper for the built-in python-mode function that does the same thing.

Some of this functionality is implemented by Ropemacs. However, Ropemacs is slow and will not work if there are syntax errors in your code. Pymacs is faster and more robust against syntax errors elsewhere in your code. This comes at the cost of being less precise - in some situations, it won’t know where to generate code. Both packages can be used alongside one another.

Examples

Generating Classes & Functions

pygen-generate-class

C-c C-= c - Generate a python class from the reference under point.

It also works on member classes.

pygen-generate-function

C-c C-= f - Generate a python function from the reference under point.

It also works on member functions.

pygen-generate-static-function

C-c C-= s - Generate a static python function from the reference under point.

Generating Variables

pygen-extract-variable

C-c C-= v - Extract the current region into a variable.

pygen-make-keyword-argument

C-c C-= k - Adds a keyword argument to the current function.

pygen-make-sequence-argument

C-c C-= a - Adds a sequence argument to the current function.

Automatic Decorators

pygen-add-decorator-to-function

C-c C-= @ - Adds a decorator in front of the current function.

Modifying the “self” keyword:

pygen-selfify-symbol

Puts the word self. in front of the current symbol.

pygen-unselfify-symbol

Removes the word self. from the current symbol (if it exists).

pygen-toggle-selfify-symbol

C-c C-= . - Toggles the self. keyword in front of the current symbol.

Dynamic Boilerplate Code Generation

pygen-insert-super

C-c C-= u - Inserts a proper call to the current method in the superclass.