signature_function/gaknot/utility.py

import importlib
import os
import sys
import re
import math
import logging

def mod_one(n):
    r"""calculates the fractional part of the argument

    Argument:
        a number
    Return:
        the fractional part of the argument
    Examples:
        sage: mod_one(9 + 3/4)
        3/4
        sage: mod_one(-9 + 3/4)
        3/4
        sage: mod_one(-3/4)
        1/4
    """
    return n - math.floor(n)


def import_sage(module_name, package=None, path=''):
    r"""Import or reload SageMath modules with preparse if the sage file exist.

    Arguments:
        module_name - name of the module (without file extension!)
        package - use only if module is used as a part of a package
    Return:
        module
    Examples:

        from utility import import_sage

        # equivalent to import module_name as my_prefered_shortcut}
        my_prefered_shortcut = import_sage('module_name')
    """
    sage_name = module_name + ".sage"
    python_name = module_name + ".sage.py"

    logging.info("\n\nimport_sage called with arguments:" +
                 "\n\tmodule_name: " + module_name +
                 "\n\tpackage: " + str(package) +
                 "\n\tpath: " + path)



    if package is not None:

        path_from_package_name = re.sub(r'\.', r'\\', package)
        path = os.path.join(path, path_from_package_name)

        logging.info("path with package name: " + str(path))


    sage_path = os.path.join(path, sage_name)
    python_path = os.path.join(path, python_name)
    module_path = os.path.join(path, module_name)

    if os.path.isfile(sage_path):
        logging.info("\nPreparsing sage file " + sage_name + ".")
        os.system('sage --preparse {}'.format(sage_path));
        os.system('mv {} {}.py'.format(python_path, module_path))
    else:
        logging.info("sage file not found: " + str(sage_path))



    if package is not None:
        module_name = package + "." + module_name

    if module_name in sys.modules:
        logging.info("\nmodule " + module_name + " was found.")
        return importlib.reload(sys.modules[module_name])
    return importlib.import_module(module_name, package=package)


def parse_sage(module_name):

    dir = os.path.dirname(__file__)

    sage_name = os.path.join(dir, module_name + ".sage")
    python_name = os.path.join(dir, module_name + ".sage.py")
    module_name = os.path.join(dir, module_name + ".py")

    os.system('sage --preparse {}'.format(sage_name))
    os.system('mv {} {}'.format(python_name, module_name))