Skip to main content

A fully functional command-line completion module built to directly interface with libedit.

Project description

This is a package which is a replacement for GNU Readline for use as shell-completion support. It is designed to:

  • link to libedit.so on the host system (This covers most *BSD based systems and Linux if you install libedit2 package)

  • if no host libedit.so is available, libedit will be directly compiled into the extension itself

All code is released under the BSD-3 license, which makes this an alternative in cases where GNU-based readline is a problem.

Usage

After a standard, uneventful installation, you should automatically have tab-completion using editline. This is configured in a sitecustomize.py file added to your install or virtual-env.

This extension has more extensive features than readline such as:

  • tab-completion of imports by default

  • tab-completion across arrays (so you can see/pick a valid index)

  • tab-completion across dictionaries (displays available keys)

  • Right-side prompts

  • Arbitrary input/output/error streams so you can have multiple interpreters on a single Python instance which are fully independent. (‘readline’ uses C globals so you are stuck with just one instance)

The system is broken down in 3 components:

_editline.so:

the C interface to libedit

editline.py:

a Python subclass of _editline which implements much of the string parsing/manipulation

lineeditor.py:

a general module which extends rlcompleter’s functionality and provides additional features.

Again, by default this is entirely hidden.

Installation

Handy tips for installation. 99.9% of folks will be able to use the default install (… by SDIST!). It will customize your build based on finding stuff.

In the (odd) case where you have libedit.so and you really want to have editline use the built-in version (say, your distro’s libedit.so is borked) you can adjust the installer.

Run the pip install like this:

pip install --global-option="build" --global-option="--builtin-libedit"  pyeditline

That will bypass the use of your local libedit.so. (… and if anyone has a better way to do this, I’m all ears.)

Gory Details?

Have a look at the README in the source repo or in readthedocs.io .

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyeditline-2.0.1.tar.gz (217.3 kB view details)

Uploaded Source

File details

Details for the file pyeditline-2.0.1.tar.gz.

File metadata

  • Download URL: pyeditline-2.0.1.tar.gz
  • Upload date:
  • Size: 217.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.6

File hashes

Hashes for pyeditline-2.0.1.tar.gz
Algorithm Hash digest
SHA256 171ce150489a7516031d8070a9da9a3f2c5d1c2a13e59c0e88e7c68d4905996a
MD5 2699e52d7d0cede16e9238de7d2f8231
BLAKE2b-256 686b2fb61c72bc28198be5b4fdd45c695eeb36eb01680c6514453ebb7c44538a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page