fabfile.py

# -*- coding: utf-8 -*

"""
Simple fabric file to test oinspect output
"""

# Stdlib imports
import webbrowser

# 3rd party imports
from IPython.core.oinspect import Inspector, object_info

# Local imports
import oinspect as oi
import oinspect.sphinxify as spxy


# Main inspector instance
inspector = Inspector()


def _show_page(url):
    webbrowser.open_new_tab(url)


def test_basic():
    """Test with an empty context"""
    oinfo = object_info()
    oinfo['docstring'] = 'A test'
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_math():
    """Test a docstring with Latex on it"""
    oinfo = object_info()
    oinfo['docstring'] = 'This is some math :math:`a^2 = b^2 + c^2`'
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_no_render_math():
    """Test a docstring with Latex on it but without rendering it"""
    oinfo = object_info()
    oinfo['docstring'] = 'This is a rational number :math:`\\frac{x}{y}`'
    oi.options['render_math'] = False
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_numpy_sin():
    """Test for numpy.sin docstring"""
    import numpy as np
    oinfo = inspector.info(np.sin)
    oinfo['name'] = 'sin'
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_collapse():
    """Test the collapse option"""
    import numpy as np
    oinfo = inspector.info(np.sin)
    oinfo['name'] = 'sin'
    oi.options['collapse_sections'] = True
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_outline():
    """Test the outline option"""
    import numpy as np
    oinfo = inspector.info(np.sin)
    oinfo['name'] = 'sin'
    oi.options['outline'] = True
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_plot():
    """Test the outline option"""
    docstring = """
.. plot::

   >>> import matplotlib.pyplot as plt
   >>> plt.plot([1,2,3], [4,5,6])
"""
    oinfo = object_info()
    oinfo['docstring'] = docstring
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_docs_py():
    """Test the outline option"""
    import subprocess as sp
    oinfo = inspector.info(sp.Popen)
    oinfo['name'] = 'Popen'
    url = spxy.rich_repr(oinfo)
    _show_page(url)


def test_all():
    """Run all tests"""
    test_basic()
    test_math()
    test_no_render_math()
    test_numpy_sin()
    test_collapse()
    test_outline()
    test_plot()