https://github.com/dizcza/pinspect

Python graphical pretty object inspect (visualization)
https://github.com/dizcza/pinspect

graph inspect networkx python pyvis visualization

Last synced: 11 months ago
JSON representation

Python graphical pretty object inspect (visualization)

• Host: GitHub
• URL: https://github.com/dizcza/pinspect
• Owner: dizcza
• License: mit
• Created: 2019-11-03T22:23:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-17T23:26:25.000Z (over 6 years ago)
• Last Synced: 2025-06-29T12:53:09.479Z (11 months ago)
• Topics: graph, inspect, networkx, python, pyvis, visualization
• Language: Python
• Homepage: https://pinspect.readthedocs.io/
• Size: 678 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Pretty inspect

[![Build Status](https://travis-ci.org/dizcza/pinspect.svg?branch=master)](https://travis-ci.org/dizcza/pinspect)

[![Coverage Status](https://coveralls.io/repos/github/dizcza/pinspect/badge.svg?branch=master)](https://coveralls.io/github/dizcza/pinspect?branch=master)

[![Documentation Status](https://readthedocs.org/projects/pinspect/badge/?version=latest)](https://pinspect.readthedocs.io/en/latest/?badge=latest)

Inspired by the complexity of [Neo](https://github.com/NeuralEnsemble/python-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 `Epoch`s, 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](http://www.blackrockmicro.com/wp-content/software/sampledata.zip)

```

wget http://www.blackrockmicro.com/wp-content/software/sampledata.zip

unzip sampledata.zip

```

3. In python,

```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` interactive 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.

![](screenshots/neo_BlackRockIO_Epoch.png)

#### Unfiltered graph

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

![](screenshots/neo_BlackRockIO.png)

### Requirements

1. Python 3.6+

2. [requirements.txt](requirements.txt)

### Alternative

Another package to inspect python variables is [objbrowser](https://github.com/titusjan/objbrowser).