Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/titusjan/objbrowser
GUI for Python object introspection
https://github.com/titusjan/objbrowser
inspection introspection objects python
Last synced: 13 days ago
JSON representation
GUI for Python object introspection
- Host: GitHub
- URL: https://github.com/titusjan/objbrowser
- Owner: titusjan
- License: mit
- Created: 2013-08-11T18:42:55.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-12-18T14:52:12.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T02:29:58.011Z (about 2 months ago)
- Topics: inspection, introspection, objects, python
- Language: Python
- Homepage:
- Size: 531 KB
- Stars: 129
- Watchers: 7
- Forks: 16
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.txt
- License: LICENSE.txt
Awesome Lists containing this project
README
objbrowser
==========
Extensible Python object inspection tool implemented in Qt.
Displays objects as trees and allows you to inspect their attributes
recursively (e.g. browse through a list of dictionaries). You can add
your own inspection methods as new columns to the tree view, or as radio buttons
to the details pane. Altering existing inspection methods is possible as well.
### Installation:
First install
[PyQt](https://www.riverbankcomputing.com/software/pyqt/download5)
or
[PySide2](https://wiki.qt.io/Qt_for_Python)
The object browser automatically detects which Qt bindings are installed. If both bindings are
installed it prefers PyQt over PySide. You can force the object browser to use a certain binding
by setting the `QT_API` environment variable to `pyqt5`, `pyqt4`, or `pyside2`.
Then install the object browser with:
%> pip install objbrowser
or use the installer:
%> python setup.py install
### User interface:
From the _View_ menu you can select some extra columns, for instance the
object's _id_ column. This can also be done by right-clicking on the table
header. An overview of the available columns, and their meanings, can be
found in [here](columns.md).
Callable objects (typically functions, methods and classes) are displayed
in blue. Objects that are an attribute of their parent (as opposed to a
list element or dictionary item) are displayed in _italics_.
If _Show callable attributes_ from the _View_ menu is checked, objects
that are callable and are an attribute are shown. Otherwise they are hidden.
If _Show dunder attributes_ from the _View_ menu is checked, objects
that are attributes, and have a name that starts and ends with two
underscores, are shown. Otherwise they are hidden.
The details pane at the bottom shows object properties that do not fit
on one line, such as the docstrings and the output of various functions
of the `inspect` module from the Python standard library.
### Usage examples:
The first parameter is the object to be inspected. For example you can
examine the dictionary with the local variables:
```Python
from objbrowser import browse
a = 67; pi = 3.1415
browse(locals())
```
The second parameter can be the name of the object. In that case the object
itself will be displayed in the root node.
```Python
browse(locals(), 'locals()')
```
By setting the `show_callable_attributes` and/or the `show_dunder_attributes`
parameters you can override the settings from the _View_ menu. The `reset`
parameter resets the persistent window settings (e.g. size and position)
```Python
s1 = 'Hello'
s2 = 'World'
browse({'s1': s1, 's2': s2},
show_callable_attributes = True,
show_dunder_attributes = False,
reset = True)
```
Some complete examples can be found in the [examples directory](examples). E.g.:
* [Define your own column](examples/simple_add_column.py)
* [Override the summary column](examples/override_summary.py)
* [Show two browser windows simultaneously](examples/modules.py)