Skip to main content

Pretty inspect object

Project description

Pretty inspect

Build Status Coverage Status Documentation Status

Inspired by the complexity of Neo.

When browsing/inspecting an object, you want to collect all methods and attributes that match the key.

Example

Browsing the documentation of neo.io.BlackrockIO and looking for the ways of extracting Epochs, you found read_epoch() method. But calling this method raises AssertionError. You need to go deeper.

  1. Run pip install pinspect neo
  2. Download BlackRock sampledata.zip
wget http://www.blackrockmicro.com/wp-content/software/sampledata.zip
unzip sampledata.zip
  1. In python,
from neo.io import BlackrockIO
from pinspect import find

session = BlackrockIO('sampleData')
graph = find(session, 'epoch', verbose=True)

Output:

BlackrockIO.rescale_epoch_duration() -> 'TypeError'
BlackrockIO.read_epoch() -> 'AssertionError'
BlackrockIO._rescale_epoch_duration() -> 'TypeError'
BlackrockIO.read()[0].segments[0].epochs -> 'list of size 0'
BlackrockIO.read()[0].segments[0].events[0].to_epoch() -> 'Epoch'

The last two lines are candidates to explore manually.

Graph visualization

You can pass visualize=True and enjoy the beautiful networkx with pyvis interacting graph rendering. Hover over the nodes (objects) and edges (methods and attributes) to explore the graph in details and inspect how a particular object has been generated.

Unfiltered graph

Below is the full unfiltered graph of neo.BlackRockIO of all possible method and attribute calls. Can you find the green dot?

Requirements

  1. Python 3.6+
  2. requirements.txt

Alternative

Another package to inspect python variables is objbrowser.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pinspect, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size pinspect-0.0.2-py3-none-any.whl (8.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pinspect-0.0.2.tar.gz (8.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page