Skip to main content

A small Python package to hide or show the terminal cursor

Project description

License: GPL v3

PyPI version


A small Python package to hide or show the terminal cursor. Works on Linux and Windows, on both Python 2 and Python 3.



The code is almost entirely a copy of James Spencer's answer on StackOverflow.


The preferred way of installing cursor is via pip. You can install pip with your package manager:

On Ubuntu:

sudo apt-get install python-pip
pip install --user cursor

On Arch:

git clone
cd python-cursor
makepkg -si


import cursor
cursor.hide() ## Hides the cursor ## Shows the cursor

Note that the cursor will stay hidden until you call — even after exiting your python script!

Because of that, pip will install two scripts, which can be run from the command line: cursor_hide and cursor_show.

An alternative is using the HiddenCursor() class in conjunction with Python's with statement. This will make sure that the cursor is shown again after running your code, even if exceptions are raised:

import cursor
with cursor.HiddenCursor():     ## Cursor will stay hidden
    import time                 ## while code is being executed;
    for a in range(1,100):      ## afterwards it will show up again

You could also use Python's atexit module:

import cursor
import atexit
import time

atexit.register(    ## Make sure is called
                                ## when exiting

cursor.hide()                   ## Hides cursor
for a in range(1,100):
exit()                          ## Cursor will show again


Manraj Singh: allowed setting a customisable stream

Alexander Seiler: packaging for Arch

Patrik Kopkan: packaging for Fedora

Projects using cursor

halo: beautiful terminal spinners in Python

pipenv: a tool that aims to bring the best of all packaging worlds to the Python world

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

cursor-1.3.5.tar.gz (15.7 kB view hashes)

Uploaded Source

Supported by

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