colcon-zsh

library0.5.0pypypi✓ verified 86d ago

An extension for the colcon build tool that provides Z shell (zsh) completion scripts. Version 0.5.0, maintained as part of colcon ecosystem, irregular releases.

devops

pip install colcon-zsh

github ↗package ↗homepage ↗changelog ↗

INSTALL

IMPORT

SIG · COLCON-ZSH

colcon-zsh

devopspythonv0.5.0

Install

5.0s avg

Import

—

Disk

40MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.5.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 37.4MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.0s · import 0.000s · 38MB

40MB installed

● package 40MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

colcon_zsh

✓ import colcon_zsh

✗ import colcon_zsh_shell

Common mistake: the package name is 'colcon-zsh' but the Python import is 'colcon_zsh' (underscore).

Generate zsh completion scripts using colcon's completion command provided by this extension.

import subprocess result = subprocess.run(['colcon', 'completion', '--shell', 'zsh'], capture_output=True, text=True) print(result.stdout)

Debug

Known issues

gotchacolcon-zsh is only a shell completion provider; it does not affect build behavior. You must source the generated completion script in your .zshrc to use zsh completions.

fix

Run 'colcon completion --shell zsh' and source the output, or redirect to a file and source it.

affects: all

deprecatedPython 3.6 support is deprecated as per requires_python; future versions may drop it.

fix

Use Python 3.8 or later.

affects: >=0.5.0

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'colcon_zsh'

colcon-zsh is not installed or installed in a different environment.

fix

Run 'pip install colcon-zsh' in the same environment where colcon is installed.

colcon: error: argument --shell: invalid choice: 'zsh' (choose from 'bash')

colcon-zsh extension is not loaded; colcon does not recognize zsh as a shell option.

fix

Ensure colcon-zsh is installed: 'pip install colcon-zsh' and verify with 'colcon extension list'.

Upgrade

Version history

0.5.0latest on PyPI · released Oct 6, 2023

Audit

Dependencies

colcon-corerequiredcolcon-zsh is an extension and requires colcon to be installed

Agent activity

7 hits · last 30 days

node

Resources

githubhttps://github.com/colcon/colcon-zsh ↗

packagehttps://pypi.org/project/colcon-zsh/ ↗

homepagehttps://colcon.readthedocs.io ↗

changeloghttps://github.com/colcon/colcon-zsh/milestones?direction=desc&sort=due_date&state=closed ↗