ipython-postfix-completion 0.1.0

Configurable postfix completion extension for IPython.

IPython Postfix Completion

Configurable postfix completion extension for IPython.

Install

From a local checkout:

python -m pip install -e .

From PyPI after publishing:

python -m pip install ipython-postfix-completion

Load

Inside IPython:

%load_ext ipython_postfix_completion

To load it automatically, add this to ipython_config.py:

c.InteractiveShellApp.extensions = ["ipython_postfix_completion"]

Runtime Templates

Add a template for the current session:

%postfix_template add forin "for item in {expr}:\n{indent}    "

Use it:

items.forin<Tab>

This expands to:

for item in items:
    

List effective templates:

%postfix_template list

Disable a template for the current session:

%postfix_template remove tuple

Reset one runtime change:

%postfix_template reset forin

Reset all runtime changes:

%postfix_template reset --all

Persistent Config

Add persistent templates in ipython_config.py:

c.PostfixCompletionConfig.templates = {
    "debug": "print({expr}=)",
    "forin": "for item in {expr}:\n{indent}    ",
}

c.PostfixCompletionConfig.disabled_templates = ["tuple"]

Template names must match [A-Za-z_][A-Za-z0-9_]*.

Templates must include {expr} and may also use {indent}. No other template fields are allowed.

Development

Run tests:

python -m pip install -e ".[test]"
python -m pytest

Build release artifacts:

python -m pip install build twine
python -m build
python -m twine check dist/*

Publish to TestPyPI:

python -m twine upload --repository testpypi dist/*

Publish to PyPI:

python -m twine upload dist/*