iph - Ironic Python Helper

iph provides a visual representation of any object called in a Python script, and extracts any available documentation. It can be helpfull when you're dealing with huge .NET frameworks or Python modules.

You can apply this to :

• Inspect any object in the context of a running script, or applications like Revit:

  • Really helpfull if you have access to a shell/console (or by pluging the launcher with a macro)
  • It displays values of attributes (with a direct access to doc)
  • It replaces the usual print() by displaying much more details with one call
  • You can jump to any related attributes or classes by opening other tabs (click on the left icon on grid)

• Read APIs doc like a .chm reader:
  • It extracts internal doc of all classes and attributes
  • It offers an offline access to doc (faster ?)
  • It allows to focus/sort/filter specific names easily

i'm currently working to provide two ways of analysis : breakpoints and snapshots

• breakpoints go() pause the current script til window is closed
• snapshots snap() let the script run, and save/gather logged objects in tabs

Setup & Usage

Standalone

• ironpython must be installed
• copy the folder in a directory known by sys.path (default C:\Program Files (x86)\IronPython 2.7\Lib)
• launch the app with the Ironpython shell

import iph
iph.go()  # launch the reader

iph.go(any_object_in_a_script) # direct inspection 

• or copy the folder anywhere and use the launcher.py file :

  --> right-click > open with > ironpythonconsole

In Revit

Now iph displays the parameters names and values of the families objects.

Setup is easy inside RevitPythonShell or PyRevit :

• RPS :
  • just copy the main folder in a directory known by RPS
  • default path : ..AppData\Roaming\RevitPythonShell201*
  • then call it from the REPL or create a button in toolbar (external file)

import iph
iph.go()  # launch the reader

iph.go(doc) # analyses Document class

iph.go(selection) # analyses selected elements

iph.go(__revit__) # analyses Application class

• PyRevit :
  • clean way in progress

Debug/ Snapshots Mode

• ironpython must be installed
• copy the folder in a directory known by sys.path (default C:\Program Files (x86)\IronPython 2.7\Lib)
• or copy the folder in your python project, or next to your script
• use the following commands to trigger snapshots

breakpoint mode can be used with iph.go() but it's oneshot for now

import iph

iph.snap(var_before) # init the tracer and snapshot before code exec

# [...code running...]

iph.snap(var_halfway)

# [...code running...]

iph.snap(var_after) # snapshot after code exec

iph.go() # display results at the end


# short way:
import iph
iph.snap(var_before)
iph.go(var_after)

TIPS

• Use keyboard to focus nodes in the tree (first letter)

• Filter the rows in datagrid, or change the template to display all members

• The tree displays filtered members by default, select a node and change filter in the datagrid to display all members

• An index engine is available for autocompletion, still in work but it's quite effective. Please avoid this function on python modules, brakes are broken!

• Analysis and output details are based on templates, so it's easy to add new types/behaviors for more accuracy.

• if you want to test the debug mode to contribute :

  • launch iph with iph.debug() to activate the logger
  • press F10 on some selected controls to display details
  • unit tests are quite basic for now, but it helps to spot basic functionnal bugs.

• Change the API targets easily :

  • Enable existing target to display the base node in treeview
  • You can replace targets with any module (read from sys.modules or try an import)

NOTES AND WARNING

This module is written with IronPython which supports many DLL on windows, especially WPF, Winforms or Revit API. I used them a lot to build and test this tool itself.

I try to make this app display no lies about class members and details, the main approach may be too basic for your needs, please report anything going wrong. The whole code could change at any time.

I'm sorry if the present code offends you or anybody, warn me if you loose an eye.

All of this works thanks to IronPython reflexion. iph holds this mirror to inspect objects, you'll obtain basically the same informations with a dir()/getattr loop in a console.

The IronPython layer is sugar, but some limitations force to work around the base concept. I won't bore you with the Allegory of the Cave but it's quite the same, what you see is not really what you get.

Any contribution is welcome by the way.

Many Thanks to:

• IronPython Team
• Gui Talarico for the tool RPW
• Daren Thomas for the tool RPS
• Ehsan Iran-Nejad for the tool PyRevit
• Icon8 : some icons come from their collection