Skip to main content

A CLI facility to inspect Python environments.

Project description

wxc

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

wxc (pronounced "which") allows you to inspect source code in your Python environment from the command line. It is based on the inspect module from the standard library.

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 is not able to retrieve the source of compiled code binded into Python. It should however correctly point to the compiled file that an object is imported from.

Notes

  • wxc is tested on macOS, Linux, and partially on Windows, from Python 3.6 to 3.10 (beta)
  • from Python 3.10, wxc currently has no dependencies outside 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.2.8.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

wxc-6.2.8-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file wxc-6.2.8.tar.gz.

File metadata

  • Download URL: wxc-6.2.8.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for wxc-6.2.8.tar.gz
Algorithm Hash digest
SHA256 23e72cfd9fcfaae42b1ff6216f90c3b4570ff09667d584df77f07e118a5684d9
MD5 f4f94f97fc3f608b099456bc65ce5911
BLAKE2b-256 9f3e1a69eca768ee21531b07c3404be746693e50f948357a74ca0a599a678d68

See more details on using hashes here.

File details

Details for the file wxc-6.2.8-py3-none-any.whl.

File metadata

  • Download URL: wxc-6.2.8-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for wxc-6.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 846049574e12b3e4cc120f62f7105e4f02873d310822d687ed00d4797427ed0f
MD5 9aac386a484990221a254cc4373866b8
BLAKE2b-256 e3833909b3a4aff86b46c4c735bd2367b496f133a96a6c6f26107fd26cc1d8c0

See more details on using hashes here.

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