Skip to main content

A CLI facility to inspect Python environments.

Project description

wxc

PyPI codecov pre-commit.ci status Code style: black

wxc (pronounced "which") is a command line tool to query the current Python environment, wrapping functionalities from the very useful but fragile builtin module inspect.

In essence,

$ wxc pandas

is equivalent to

$ python -c "import pandas; print(pandas.__file__)"

wxc can also be used to navigate source code, by locating classes and functions by file:line number

$ wxc pandas.DataFrame
/path/to/your/env/site-packages/pandas/core/frame.py:319

which is extremely convenient when combined with augmented terminal applications such as iterm2.

Installation

$ pip install wxc

Note that wxc should never be installed in isolation (for instance via pipx) since it would completely defeat the purpose.

Usage

Examples

$ wxc numpy
/path/to/your/env/site-packages/numpy

$ wxc pandas --version
1.0.3

$ wxc stdlib_list --full
source = /path/to/your/env/site-packages/stdlib_list/__init__.py:0
version = v0.8.0
in_stdlib = False
name = stdlib_list

Known limitations

wxc currently is not able to go past inheritance and will not point to the exact location of methods defined outside the queried scope/

wxc is also unable to query the origin of compiled code binded into Python. It should however correctly point to the compiled file that an object is imported from.

Notes

  • the Python api is tested on macOS, Linux, for Python 3.6 and 3.9
  • wxc relies on stdlib_list to determine which packages are part of the standard library.
  • this project was formerly named "whych" and renamed to avoid confusion with the pypi-available package of the same name.

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

wxc-6.0.2.tar.gz (16.7 kB view hashes)

Uploaded Source

Built Distribution

wxc-6.0.2-py3-none-any.whl (16.9 kB view hashes)

Uploaded Python 3

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