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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wxc-6.2.7.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.7.tar.gz
Algorithm Hash digest
SHA256 13ca58f9d645313c584e766371f891675bde9753f41614163dd8188352c00ad3
MD5 8ebc087e206ed0df25ef1b25fef54180
BLAKE2b-256 9600e85d3ae620797b1bbdb44759ca328b69d4d9cdfefed272c12a87fc959498

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wxc-6.2.7-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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 ea7876c7cc49204e203356f9a28af6e3805c0febb9355530f70c0c29170ae4c1
MD5 8a64c197be7f5dacf9dc489ce111c451
BLAKE2b-256 c7e10307ea41e327c8ef7aed8311ce5485aff5972c173d70cbeb6884b2f6bed2

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