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") 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
  • for Python versions older than 3.10, 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.2.2.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

wxc-6.2.2-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wxc-6.2.2.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for wxc-6.2.2.tar.gz
Algorithm Hash digest
SHA256 148dbc4791e83616c5b383bb804f6e6951c5f5f4ba782444d6bd060f34bacd84
MD5 daf9d4f86f659f3f782af518c399ee8d
BLAKE2b-256 3078b169a38d2e35696903b088a1a079044871e01ca7860c4f84fbb1e4c492f3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wxc-6.2.2-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for wxc-6.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9082cd53dd30d22221729d6c4bcb7ec75242d3b984870c224a9cec0315f2ce1f
MD5 1da2ad8ce5e9700092bfe9a4db4f3327
BLAKE2b-256 8c3c622df5fd7621302c34957fc0034afd7c9fbb14e3a46fda5061679f8c358b

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