Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : readline.html

<!DOCTYPE html>

<title>16.8. readline — GNU readline interface &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="16.9. rlcompleter — Completion function for GNU readline" href="rlcompleter.html" />
 <link rel="prev" title="16.7. mmap — Memory-mapped file support" href="mmap.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/readline.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/readline.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="rlcompleter.html" title="16.9. rlcompleter — Completion function for GNU readline"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="mmap.html" title="16.7. mmap — Memory-mapped file support"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="someos.html" accesskey="U">16. Optional Operating System Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">16.8. <code class="xref py py-mod docutils literal notranslate">readline</code> — GNU readline interface</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-readline">
<h1>16.8. <a class="reference internal" href="#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate">readline</code></a> — GNU readline interface<a class="headerlink" href="#module-readline" title="Permalink to this headline">¶</a></h1>
The <a class="reference internal" href="#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate">readline</code></a> module defines a number of functions to facilitate
completion and reading/writing of history files from the Python interpreter.
This module can be used directly, or via the <a class="reference internal" href="rlcompleter.html#module-rlcompleter" title="rlcompleter: Python identifier completion, suitable for the GNU readline library."><code class="xref py py-mod docutils literal notranslate">rlcompleter</code></a> module, which
supports completion of Python identifiers at the interactive prompt. Settings
made using this module affect the behaviour of both the interpreter’s
interactive prompt and the prompts offered by the <a class="reference internal" href="functions.html#raw_input" title="raw_input"><code class="xref py py-func docutils literal notranslate">raw_input()</code></a> and
<a class="reference internal" href="functions.html#input" title="input"><code class="xref py py-func docutils literal notranslate">input()</code></a> built-in functions.
<div class="admonition note">
Note
The underlying Readline library API may be implemented by
the <code class="docutils literal notranslate">libedit</code> library instead of GNU readline.
On MacOS X the <a class="reference internal" href="#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate">readline</code></a> module detects which library is being used
at run time.
The configuration file for <code class="docutils literal notranslate">libedit</code> is different from that
of GNU readline. If you programmatically load configuration strings
you can check for the text “libedit” in <code class="xref py py-const docutils literal notranslate">readline.__doc__</code>
to differentiate between GNU readline and libedit.
</div>
Readline keybindings may be configured via an initialization file, typically
<code class="docutils literal notranslate">.inputrc</code> in your home directory. See <a class="reference external" href="https://cnswww.cns.cwru.edu/php/chet/readline/rluserman.html#SEC9">Readline Init File</a>
in the GNU Readline manual for information about the format and
allowable constructs of that file, and the capabilities of the
Readline library in general.
<section id="init-file">
<h2>16.8.1. Init file<a class="headerlink" href="#init-file" title="Permalink to this headline">¶</a></h2>
The following functions relate to the init file and user configuration:
<dl class="py function">
<dt class="sig sig-object py" id="readline.parse_and_bind">
readline.parse_and_bind(string)<a class="headerlink" href="#readline.parse_and_bind" title="Permalink to this definition">¶</a></dt>
<dd>Execute the init line provided in the string argument. This calls
<code class="xref c c-func docutils literal notranslate">rl_parse_and_bind()</code> in the underlying library.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.read_init_file">
readline.read_init_file([filename])<a class="headerlink" href="#readline.read_init_file" title="Permalink to this definition">¶</a></dt>
<dd>Execute a readline initialization file. The default filename is the last filename
used. This calls <code class="xref c c-func docutils literal notranslate">rl_read_init_file()</code> in the underlying library.
</dd></dl>

</section>
<section id="line-buffer">
<h2>16.8.2. Line buffer<a class="headerlink" href="#line-buffer" title="Permalink to this headline">¶</a></h2>
The following functions operate on the line buffer:
<dl class="py function">
<dt class="sig sig-object py" id="readline.get_line_buffer">
readline.get_line_buffer()<a class="headerlink" href="#readline.get_line_buffer" title="Permalink to this definition">¶</a></dt>
<dd>Return the current contents of the line buffer (<code class="xref c c-data docutils literal notranslate">rl_line_buffer</code>
in the underlying library).
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.insert_text">
readline.insert_text(string)<a class="headerlink" href="#readline.insert_text" title="Permalink to this definition">¶</a></dt>
<dd>Insert text into the line buffer at the cursor position. This calls
<code class="xref c c-func docutils literal notranslate">rl_insert_text()</code> in the underlying library, but ignores
the return value.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.redisplay">
readline.redisplay()<a class="headerlink" href="#readline.redisplay" title="Permalink to this definition">¶</a></dt>
<dd>Change what’s displayed on the screen to reflect the current contents of the
line buffer. This calls <code class="xref c c-func docutils literal notranslate">rl_redisplay()</code> in the underlying library.
</dd></dl>

</section>
<section id="history-file">
<h2>16.8.3. History file<a class="headerlink" href="#history-file" title="Permalink to this headline">¶</a></h2>
The following functions operate on a history file:
<dl class="py function">
<dt class="sig sig-object py" id="readline.read_history_file">
readline.read_history_file([filename])<a class="headerlink" href="#readline.read_history_file" title="Permalink to this definition">¶</a></dt>
<dd>Load a readline history file, and append it to the history list.
The default filename is <code class="file docutils literal notranslate">~/.history</code>. This calls
<code class="xref c c-func docutils literal notranslate">read_history()</code> in the underlying library.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.write_history_file">
readline.write_history_file([filename])<a class="headerlink" href="#readline.write_history_file" title="Permalink to this definition">¶</a></dt>
<dd>Save the history list to a readline history file, overwriting any
existing file. The default filename is <code class="file docutils literal notranslate">~/.history</code>. This calls
<code class="xref c c-func docutils literal notranslate">write_history()</code> in the underlying library.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.get_history_length">
readline.get_history_length()<a class="headerlink" href="#readline.get_history_length" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="readline.set_history_length">
readline.set_history_length(length)<a class="headerlink" href="#readline.set_history_length" title="Permalink to this definition">¶</a></dt>
<dd>Set or return the desired number of lines to save in the history file.
The <a class="reference internal" href="#readline.write_history_file" title="readline.write_history_file"><code class="xref py py-func docutils literal notranslate">write_history_file()</code></a> function uses this value to truncate
the history file, by calling <code class="xref c c-func docutils literal notranslate">history_truncate_file()</code> in
the underlying library. Negative values imply
unlimited history file size.
</dd></dl>

</section>
<section id="history-list">
<h2>16.8.4. History list<a class="headerlink" href="#history-list" title="Permalink to this headline">¶</a></h2>
The following functions operate on a global history list:
<dl class="py function">
<dt class="sig sig-object py" id="readline.clear_history">
readline.clear_history()<a class="headerlink" href="#readline.clear_history" title="Permalink to this definition">¶</a></dt>
<dd>Clear the current history. This calls <code class="xref c c-func docutils literal notranslate">clear_history()</code> in the
underlying library. The Python function only exists if Python was
compiled for a version of the library that supports it.
<div class="versionadded">
New in version 2.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.get_current_history_length">
readline.get_current_history_length()<a class="headerlink" href="#readline.get_current_history_length" title="Permalink to this definition">¶</a></dt>
<dd>Return the number of items currently in the history. (This is different from
<a class="reference internal" href="#readline.get_history_length" title="readline.get_history_length"><code class="xref py py-func docutils literal notranslate">get_history_length()</code></a>, which returns the maximum number of lines that will
be written to a history file.)
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.get_history_item">
readline.get_history_item(index)<a class="headerlink" href="#readline.get_history_item" title="Permalink to this definition">¶</a></dt>
<dd>Return the current contents of history item at index. The item index
is one-based. This calls <code class="xref c c-func docutils literal notranslate">history_get()</code> in the underlying library.
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.remove_history_item">
readline.remove_history_item(pos)<a class="headerlink" href="#readline.remove_history_item" title="Permalink to this definition">¶</a></dt>
<dd>Remove history item specified by its position from the history.
The position is zero-based. This calls <code class="xref c c-func docutils literal notranslate">remove_history()</code> in
the underlying library.
<div class="versionadded">
New in version 2.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.replace_history_item">
readline.replace_history_item(pos, line)<a class="headerlink" href="#readline.replace_history_item" title="Permalink to this definition">¶</a></dt>
<dd>Replace history item specified by its position with line.
The position is zero-based. This calls <code class="xref c c-func docutils literal notranslate">replace_history_entry()</code>
in the underlying library.
<div class="versionadded">
New in version 2.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.add_history">
readline.add_history(line)<a class="headerlink" href="#readline.add_history" title="Permalink to this definition">¶</a></dt>
<dd>Append line to the history buffer, as if it was the last line typed.
This calls <code class="xref c c-func docutils literal notranslate">add_history()</code> in the underlying library.
</dd></dl>

</section>
<section id="startup-hooks">
<h2>16.8.5. Startup hooks<a class="headerlink" href="#startup-hooks" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><div class="versionadded">
New in version 2.3.
</div>
</div></blockquote>
<dl class="py function">
<dt class="sig sig-object py" id="readline.set_startup_hook">
readline.set_startup_hook([function])<a class="headerlink" href="#readline.set_startup_hook" title="Permalink to this definition">¶</a></dt>
<dd>Set or remove the function invoked by the <code class="xref c c-data docutils literal notranslate">rl_startup_hook</code>
callback of the underlying library. If function is specified, it will
be used as the new hook function; if omitted or <code class="docutils literal notranslate">None</code>, any function
already installed is removed. The hook is called with no
arguments just before readline prints the first prompt.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.set_pre_input_hook">
readline.set_pre_input_hook([function])<a class="headerlink" href="#readline.set_pre_input_hook" title="Permalink to this definition">¶</a></dt>
<dd>Set or remove the function invoked by the <code class="xref c c-data docutils literal notranslate">rl_pre_input_hook</code>
callback of the underlying library. If function is specified, it will
be used as the new hook function; if omitted or <code class="docutils literal notranslate">None</code>, any
function already installed is removed. The hook is called
with no arguments after the first prompt has been printed and just before
readline starts reading input characters. This function only exists
if Python was compiled for a version of the library that supports it.
</dd></dl>

</section>
<section id="completion">
<h2>16.8.6. Completion<a class="headerlink" href="#completion" title="Permalink to this headline">¶</a></h2>
The following functions relate to implementing a custom word completion
function. This is typically operated by the Tab key, and can suggest and
automatically complete a word being typed. By default, Readline is set up
to be used by <a class="reference internal" href="rlcompleter.html#module-rlcompleter" title="rlcompleter: Python identifier completion, suitable for the GNU readline library."><code class="xref py py-mod docutils literal notranslate">rlcompleter</code></a> to complete Python identifiers for
the interactive interpreter. If the <a class="reference internal" href="#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate">readline</code></a> module is to be used
with a custom completer, a different set of word delimiters should be set.
<dl class="py function">
<dt class="sig sig-object py" id="readline.set_completer">
readline.set_completer([function])<a class="headerlink" href="#readline.set_completer" title="Permalink to this definition">¶</a></dt>
<dd>Set or remove the completer function. If function is specified, it will be
used as the new completer function; if omitted or <code class="docutils literal notranslate">None</code>, any completer
function already installed is removed. The completer function is called as
<code class="docutils literal notranslate">function(text, state)</code>, for state in <code class="docutils literal notranslate">0</code>, <code class="docutils literal notranslate">1</code>, <code class="docutils literal notranslate">2</code>, …, until it
returns a non-string value. It should return the next possible completion
starting with text.
The installed completer function is invoked by the entry_func callback
passed to <code class="xref c c-func docutils literal notranslate">rl_completion_matches()</code> in the underlying library.
The text string comes from the first parameter to the
<code class="xref c c-data docutils literal notranslate">rl_attempted_completion_function</code> callback of the
underlying library.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.get_completer">
readline.get_completer()<a class="headerlink" href="#readline.get_completer" title="Permalink to this definition">¶</a></dt>
<dd>Get the completer function, or <code class="docutils literal notranslate">None</code> if no completer function has been set.
<div class="versionadded">
New in version 2.3.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.get_completion_type">
readline.get_completion_type()<a class="headerlink" href="#readline.get_completion_type" title="Permalink to this definition">¶</a></dt>
<dd>Get the type of completion being attempted. This returns the
<code class="xref c c-data docutils literal notranslate">rl_completion_type</code> variable in the underlying library as
an integer.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.get_begidx">
readline.get_begidx()<a class="headerlink" href="#readline.get_begidx" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="readline.get_endidx">
readline.get_endidx()<a class="headerlink" href="#readline.get_endidx" title="Permalink to this definition">¶</a></dt>
<dd>Get the beginning or ending index of the completion scope.
These indexes are the start and end arguments passed to the
<code class="xref c c-data docutils literal notranslate">rl_attempted_completion_function</code> callback of the
underlying library.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.set_completer_delims">
readline.set_completer_delims(string)<a class="headerlink" href="#readline.set_completer_delims" title="Permalink to this definition">¶</a></dt>
<dt class="sig sig-object py" id="readline.get_completer_delims">
readline.get_completer_delims()<a class="headerlink" href="#readline.get_completer_delims" title="Permalink to this definition">¶</a></dt>
<dd>Set or get the word delimiters for completion. These determine the
start of the word to be considered for completion (the completion scope).
These functions access the <code class="xref c c-data docutils literal notranslate">rl_completer_word_break_characters</code>
variable in the underlying library.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="readline.set_completion_display_matches_hook">
readline.set_completion_display_matches_hook([function])<a class="headerlink" href="#readline.set_completion_display_matches_hook" title="Permalink to this definition">¶</a></dt>
<dd>Set or remove the completion display function. If function is
specified, it will be used as the new completion display function;
if omitted or <code class="docutils literal notranslate">None</code>, any completion display function already
installed is removed. This sets or clears the
<code class="xref c c-data docutils literal notranslate">rl_completion_display_matches_hook</code> callback in the
underlying library. The completion display function is called as
<code class="docutils literal notranslate">function(substitution, [matches], longest_match_length)</code> once
each time matches need to be displayed.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

</section>
<section id="example">
<h2>16.8.7. Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
The following example demonstrates how to use the <a class="reference internal" href="#module-readline" title="readline: GNU readline support for Python. (Unix)"><code class="xref py py-mod docutils literal notranslate">readline</code></a> module’s
history reading and writing functions to automatically load and save a history
file named <code class="file docutils literal notranslate">.pyhist</code> from the user’s home directory. The code below would
normally be executed automatically during interactive sessions from the user’s
<a class="reference internal" href="../using/cmdline.html#envvar-PYTHONSTARTUP"><code class="xref std std-envvar docutils literal notranslate">PYTHONSTARTUP</code></a> file.
<div class="highlight-default notranslate"><div class="highlight"><pre>import os
import readline
histfile = os.path.join(os.path.expanduser(&quot;~&quot;), &quot;.pyhist&quot;)
try:
 readline.read_history_file(histfile)
 # default history len is -1 (infinite), which may grow unruly
 readline.set_history_length(1000)
except IOError:
 pass
import atexit
atexit.register(readline.write_history_file, histfile)
del os, histfile
</pre></div>
</div>
The following example extends the <a class="reference internal" href="code.html#code.InteractiveConsole" title="code.InteractiveConsole"><code class="xref py py-class docutils literal notranslate">code.InteractiveConsole</code></a> class to
support history save/restore.
<div class="highlight-default notranslate"><div class="highlight"><pre>import code
import readline
import atexit
import os

class HistoryConsole(code.InteractiveConsole):
 def __init__(self, locals=None, filename=&quot;&lt;console&gt;&quot;,
 histfile=os.path.expanduser(&quot;~/.console-history&quot;)):
 code.InteractiveConsole.__init__(self, locals, filename)
 self.init_history(histfile)

def init_history(self, histfile):
 readline.parse_and_bind(&quot;tab: complete&quot;)
 if hasattr(readline, &quot;read_history_file&quot;):
 try:
 readline.read_history_file(histfile)
 except IOError:
 pass
 atexit.register(self.save_history, histfile)

def save_history(self, histfile):
 readline.set_history_length(1000)
 readline.write_history_file(histfile)
</pre></div>
</div>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">16.8. <code class="xref py py-mod docutils literal notranslate">readline</code> — GNU readline interface</a><ul>
<li><a class="reference internal" href="#init-file">16.8.1. Init file</a></li>
<li><a class="reference internal" href="#line-buffer">16.8.2. Line buffer</a></li>
<li><a class="reference internal" href="#history-file">16.8.3. History file</a></li>
<li><a class="reference internal" href="#history-list">16.8.4. History list</a></li>
<li><a class="reference internal" href="#startup-hooks">16.8.5. Startup hooks</a></li>
<li><a class="reference internal" href="#completion">16.8.6. Completion</a></li>
<li><a class="reference internal" href="#example">16.8.7. Example</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="mmap.html"
 title="previous chapter">16.7. <code class="xref py py-mod docutils literal notranslate">mmap</code> — Memory-mapped file support</a>
 <h4>Next topic</h4>
 <a href="rlcompleter.html"
 title="next chapter">16.9. <code class="xref py py-mod docutils literal notranslate">rlcompleter</code> — Completion function for GNU readline</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/readline.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="rlcompleter.html" title="16.9. rlcompleter — Completion function for GNU readline"
 >next</a> |</li>
 <li class="right" >
 <a href="mmap.html" title="16.7. mmap — Memory-mapped file support"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="someos.html" >16. Optional Operating System Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">16.8. <code class="xref py py-mod docutils literal notranslate">readline</code> — GNU readline interface</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : readline.html