Features¶

• TODO

Submodules¶

palpatine.const module¶

This module defines several constants to use with functions that require options to use.

palpatine.const.AFTER = 0¶

Used with clear functions.

If supplied, the clear function will clear everything after the cursor.

Seealso:	screen.clear(), line.clear()

palpatine.const.ALL = 2¶

Used with clear functions.

If supplied, the clear function will clear the entire context (e.g. either the current line, or the whole screen).

Seealso:	screen.clear(), line.clear()

palpatine.const.BEFORE = 1¶

Used with clear functions.

If supplied, the clear function will clear everything before the cursor.

Seealso:	screen.clear(), line.clear()

palpatine.cursor module¶

palpatine.cursor.down(y=1, bol=False)[source]¶

Move the cursor down y lines.

If bol is set to True, the cursor will be put to the beginning of line. Otherwise it will maintain its current x position.

palpatine.cursor.hide()[source]¶

Hide the cursor from screen.

The cursor is still available, just not drawn.

Seealso:	show(), set_visible()

palpatine.cursor.hori(value, rel=True)[source]¶

Convinience function to move the cursor horizontally.

If value is positive, the cursor will be moved to the right; negative values move the cursor to the left. If value is 0, this is a no-op. If rel is set to False, this function moves the cursor to the absolute x position of the current line.

palpatine.cursor.left(x=1)[source]¶

Move the cursor x columns to the left.

palpatine.cursor.move(x, y)[source]¶

Move the cursor the absolute position (x, y) on screen.

palpatine.cursor.reset()[source]¶

Move the cursor to the top-left position on screen.

palpatine.cursor.right(x=1)[source]¶

Move the cursor x columns to the right.

palpatine.cursor.set_visible(visible)[source]¶

Set the cursor’s visibility on screen.

The cursor is always available, even if it is not visible.

Seealso:	show(), hide()

palpatine.cursor.show()[source]¶

Show the cursor from screen.

Seealso:	hide(), set_visible()

palpatine.cursor.up(y=1, bol=False)[source]¶

Move the cursor up y lines.

If bol is set to True, the cursor will be put to the beginning of line. Otherwise it will maintain its current x position.

palpatine.cursor.vert(value)[source]¶

Convinience function to move the cursor vertically.

If value is positive, the cursor will be moved down; negative values move the cursor up. If value is 0, this is a no-op.

palpatine.line module¶

palpatine.line.clear(clear_type=2)[source]¶

Clear part of, or all characters in the current line.

The cursor is not moved after the line is cleared. You will need to call cursor-moving functions (see cursor) to move it manually.

Parameters:	clear_type – What part of the current line should be cleared. See const for a list of possible choices.

palpatine.screen module¶

palpatine.screen.clear(clear_type=2)[source]¶

Clear a part, or all of the screen.

The cursor is not moved after the screen is cleared. You will need to call cursor-moving functions (see cursor) to move it manually.

Parameters:	clear_type – What part of the screen should be cleared. See const for a list of possible choices.

palpatine.screen.scroll(value)[source]¶

Scroll the screen.

Scroll the screen by value lines. If value is positive, the screen if scrolled down; negative values scroll the screen up. If value is 0, this is a no-op.

palpatine.utils module¶

palpatine.utils.init()[source]¶

Initialize Palpatine.

Call this at the start of your program to initialize Palpatine. Some monkey-patching will happen on certain systems (e.g. Windows) to make Palpatine work.

Seealso:	deinit().

palpatine.utils.deinit()[source]¶

De-initialization Palpatine.

Call this to disable Palpatine. This does not always disable Palpatine completely, but only restores some monkey-patched elements. Use it only if you run into problems with those monkey-patched things.

Seealso:	init(), reinit().

palpatine.utils.out(*params, **options)[source]¶

Outputs a ASCII escape command to console.

Palpatine works by sending ASCII escape sequences to your terminal. If you want to send your own sequences, maybe to achieve some advanced operations not covered by Palpatine, this is the function for you.

Seealso:	https://en.wikipedia.org/wiki/ANSI_escape_code

Module contents¶

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up palpatine for local development.

1. Fork the palpatine repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/palpatine.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv palpatine
   $ cd palpatine/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 palpatine tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/uranusjr/palpatine/pull_requests and make sure that the tests pass for all supported Python versions.

Contributors¶

• Tzu-ping Chung <uranusjr@gmail.com>