Clint: Command Line Interface Tools for Python

Common errors

• SyntaxError: invalid syntax (often related to 'print' statement)

  cause Attempting to run a Clint version with Python 2 `print` statements on a Python 3 interpreter. This was a common issue before Clint was updated for Python 3 compatibility. [5, 10, 21]
  fix Ensure you have Clint version 0.3.0 or newer installed, as these versions include Python 3 compatibility fixes. If you're stuck on an older codebase, consider manually running `2to3` on the Clint source or upgrading to a newer version of the library. [5, 6]

• ModuleNotFoundError: No module named 'clint'

  cause The `clint` package is not installed in the Python environment where the script is being executed. [15]
  fix Install the library using pip: `pip install clint`. If using a virtual environment, ensure it is activated before installation. [2, 6, 15]

• AttributeError: 'module' object has no attribute 'textui'

  cause This usually happens if you have a file named `clint.py` in your project directory or Python path, which shadows the installed `clint` package. [17]
  fix Rename any local file named `clint.py` to something else to avoid module name conflicts. Clear your Python environment's `.pyc` files if the issue persists.

Warnings

• breaking Clint's GitHub repository was archived in March 2024, and its last release (0.5.1) was in 2013. This indicates the library is no longer maintained, which may lead to compatibility issues with newer Python versions or security vulnerabilities that will not be addressed. [4, 6]
  Fix: Consider migrating to actively maintained CLI libraries like `Typer`, `Click`, `Rich`, or ` вопрос` for new projects. For existing projects, thoroughly test compatibility with current Python environments.
• gotcha Early versions of Clint (pre-0.3.0) had significant Python 3 compatibility issues due to Python 2 'print' statements and string handling. While version 0.3.0 and later addressed many of these, subtle incompatibilities might still arise with very recent Python 3 versions. [5, 6]
  Fix: Ensure you are using Clint 0.3.0 or higher. If encountering `SyntaxError` with `print`, verify your Python environment is correctly running a Python 3 compatible version of Clint. Manually converting with `2to3` was a common workaround for older versions. [5]
• gotcha Color output in the terminal might not appear as expected if the output stream is not a TTY (e.g., when piping output to a file or another command). Clint automatically detects TTY status and disables colors. [2]
  Fix: To force color output regardless of TTY detection, set the environment variable `CLINT_FORCE_COLOR=1` before running your application. For Windows, ensure `colorama` (which Clint leverages) is compatible or installed if colors are missing in certain environments. [2]

Install

• pip install clint Install with pip

Imports

• puts, colored

  from clint.textui import puts, colored

• indent

  from clint.textui import indent

• prompt, validators

  from clint.textui import prompt, validators

• Args
  wrong:

  from clint import args

  correct:

  from clint.args import Args

  While `from clint import args` works, `from clint.args import Args` is more direct for accessing the argument parser instance.

Quickstart

This quickstart demonstrates key features like colored text, indented output, and user prompting. For actual progress bars, import `progress.bar` from `clint.textui` and wrap an iterable. [1, 2, 6]

from clint.textui import puts, colored, indent, prompt, validators
import os

puts(colored.green('Hello, Clint!'))

puts('This text is not indented.')
with indent(4, quote=' > '):
    puts(colored.blue('This text is indented and quoted.'))
    puts('This is also indented.')

# Example of using a progress bar (requires an iterable)
puts('\nProcessing items:')
items = range(1, 6)
# In a real scenario, you'd import progress.bar for this, e.g., from clint.textui import progress
# For quickstart, a simple loop for demonstration.
for i in items:
    puts(f'  Processing item {i}...')
    # Simulate work
    # time.sleep(0.1)

# Example of prompting for input
# To demonstrate, we'll get a dummy value or use an environment variable for non-interactive tests.
username = prompt.query('Enter your username:', default=os.environ.get('CLINT_USERNAME', 'guest'))
puts(f'Welcome, {username}!')