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, 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.6.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wxc-6.2.6.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

File hashes

Hashes for wxc-6.2.6.tar.gz
Algorithm Hash digest
SHA256 9d7aba45561ec752f062880b1e01b25d3f16871e3871f2fd5bb1527f0b1d521e
MD5 2c2ec955ceb2fdbd550bd0167dde79a8
BLAKE2b-256 8096562944bd569db9678b46ef9c9c84973413ee81f5056177ef6e327b79463e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wxc-6.2.6-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

File hashes

Hashes for wxc-6.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 b90d487a0083a6f19c0b6fbb2b7a5b8214a19dc6cd028f7b9801db4770f90dc8
MD5 df2231dffc52a951ffae2f038cce7bca
BLAKE2b-256 4ad5bbf0e2b8d0f39b79d27460c25eb825c34551817d99ae5192e72eea301a93

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