python-sagenb 1.0.1+ds1-2 / usr / lib / python2.7 / dist-packages / sagenb / misc / format.py

# -*- coding: utf-8 -*-
"""
Code formatting functions for the notebook

Functions used to format code to be used in the notebook.

AUTHORS:

 - William Stein (?) - Initial revision

 - Tim Dumol (Oct. 16, 2009) - Added additional formatting functions
"""

import ast
import re
from sagenb.misc.misc import unicode_str

_futureimport_re = re.compile(r'((?:from __future__ import [^;\n]+)+)(?:;\s*)?(.*)')
def relocate_future_imports(string):
    """
    Relocates imports from __future__ to the beginning of the
    file. Raises ``SyntaxError`` if the string does not have proper
    syntax.

    OUTPUT:

    - (string, string) -- a tuple consisting of the string without
      ``__future__`` imports and the ``__future__`` imports.
    
    EXAMPLES::

        sage: from sagenb.misc.format import relocate_future_imports
        sage: relocate_future_imports('')
        '\n'
        sage: relocate_future_imports('foobar')
        '\nfoobar'
        sage: relocate_future_imports('from __future__ import division\nprint("Hi!")')
        'from __future__ import division\n\nprint("Hi!")'
        sage: relocate_future_imports('from __future__ import division;print("Testing")')
        'from __future__ import division\nprint("Testing")'
        sage: relocate_future_imports('from __future__ import division\nprint("Testing!") # from __future__ import division does Blah')
        'from __future__ import division\n\nprint("Testing!") # from __future__ import division does Blah'
        sage: relocate_future_imports('# -*- coding: utf-8 -*-\nprint("Testing!")\nfrom __future__ import division, operator\nprint("Hey!")')
        'from __future__ import division,operator\n# -*- coding: utf-8 -*-\nprint("Testing!")\n\nprint("Hey!")'
    """
    lines = string.splitlines()
    import_lines = []
    parse_tree = ast.parse(string)
    future_imports = [x for x in parse_tree.body
                        if x.__class__ == ast.ImportFrom and
                           x.module == '__future__']
    for imp in future_imports:
        line = lines[imp.lineno - 1]
        lines[imp.lineno - 1] = line[:imp.col_offset] + re.sub(r'from\s+__future__\s+import\s+%s;?\s*' %
                                              ''.join([r'\s*%s\s*,?\s*' % name.name for name in imp.names]),
                                              '', line[imp.col_offset:], 1)
        import_lines.append('from __future__ import %s' % ','.join([name.name for name in imp.names]))

    return '\n'.join(import_lines) + '\n' + '\n'.join(lines)

def format_for_pexpect(string, prompt, number):
    """
    Formats a string for execution by the pexpect WorksheetProcess
    implementation.

    Currently does the following:

    * Adds a magic comment to enable utf-8 encoding
    * Moves all __future__ imports to start of file.
    * Changes system prompt to `prompt`
    * Prints a START message appended with `number`
    * Appends `string` after processing with :meth: `displayhook_hack`

    EXAMPLES::

        sage: from sagenb.misc.format import format_for_pexpect
        sage: print(format_for_pexpect('13', 'PROMPT', 1))
        # -*- coding: utf-8 -*-
        <BLANKLINE>
        <BLANKLINE>
        import sys
        sys.ps1 = "PROMPT"
        print("START1")
        exec compile(u'13' + '\n', '', 'single')
        sage: print(format_for_pexpect('class MyClass:\n    def __init__(self):\n        pass\na = MyClass()\na', 'PRMPT', 30))
        # -*- coding: utf-8 -*-
        <BLANKLINE>
        <BLANKLINE>
        import sys
        sys.ps1 = "PRMPT"
        print("START30")
        class MyClass:
            def __init__(self):
                pass
        a = MyClass()
        exec compile(u'a' + '\n', '', 'single')
        sage: print(format_for_pexpect('class MyClass:\n    def __init__(self):\n        pass\n', 'PRMPT', 30))
        # -*- coding: utf-8 -*-
        <BLANKLINE>
        <BLANKLINE>
        import sys
        sys.ps1 = "PRMPT"
        print("START30")
        exec compile(u'class MyClass:\n    def __init__(self):\n        pass' + '\n', '', 'single')
        sage: print(format_for_pexpect('from __future__ import division\nprint("Hey!")', 'MYPROMPT', 25))
        # -*- coding: utf-8 -*-
        from __future__ import division
        <BLANKLINE>
        import sys
        sys.ps1 = "MYPROMPT"
        print("START25")
        exec compile(u'print("Hey!")' + '\n', '', 'single')
        <BLANKLINE>
        sage: print(format_for_pexpect('from __future__ import division; print("Hello world!")\nprint("New line!")', 'MYPRMPT', 30))
        # -*- coding: utf-8 -*-
        from __future__ import division
        <BLANKLINE>
        import sys
        sys.ps1 = "MYPRMPT"
        print("START30")
        print("Hello world!")
        exec compile(u'print("New line!")' + '\n', '', 'single')
    """
    string =  """
import sys
sys.ps1 = "%s"
print("START%s")
%s
""" % (prompt, number, displayhook_hack(string).encode('utf-8', 'ignore'))
    try:
        string = '# -*- coding: utf-8 -*-\n' + relocate_future_imports(string)
    except SyntaxError:
        # Syntax error anyways, so no need to relocate future imports.
        string = '# -*- coding: utf-8 -*-\n' + string
    return string

def displayhook_hack(string):
    """
    Modified version of string so that ``exec``'ing it results in
    displayhook possibly being called.
    
    STRING:

        - ``string`` - a string

    OUTPUT:

        - string formated so that when exec'd last line is printed if
          it is an expression

    EXAMPLES::
    
        sage: from sagenb.misc.format import displayhook_hack
        sage: displayhook_hack('\n12\n')
        "\nexec compile(u'12' + '\\n', '', 'single')"
        sage: displayhook_hack('\ndef my_fun(foo):\n    print(foo)\n')
        '\ndef my_fun(foo):\n        print(foo)'
        sage: print(displayhook_hack('\nclass A:\n    def __init__(self, foo):\n        self.foo\nb = A(8)\nb'))
        <BLANKLINE>
        class A:
            def __init__(self, foo):
                self.foo
        b = A(8)
        exec compile(u'b' + '\n', '', 'single')
    """
    # This function is all so the last line (or single lines) will
    # implicitly print as they should, unless they are an assignment.
    # If anybody knows a better way to do this, please tell me!
    string = string.splitlines()
    i = len(string)-1
    if i >= 0:
        while len(string[i]) > 0 and string[i][0] in ' \t':
            i -= 1
        final_lines = unicode_str('\n'.join(string[i:]))
        if not final_lines.startswith('def '):
            try:
                compile(final_lines + '\n', '', 'single')
                string[i] = "exec compile(%r + '\\n', '', 'single')" % final_lines
                string = string[:i+1]
            except SyntaxError:
                pass
    return '\n'.join(string)