Simplify epyccel import (pyccel#1855)

Move `epyccel.py` to `pyccel/commands/` folder. This allows a shortcut
to be introduced for the import of the most commonly used `epyccel`
function. It is now possible to do `from pyccel import epyccel`. Fixes
pyccel#1836.

---------

Co-authored-by: Yaman Güçlü <[email protected]>

Author: EmilyBourne

CHANGELOG.md

@@ -41,6 +41,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
+-   #1836 : Move `epyccel` module to `pyccel.commands.epyccel` and add support for shortcut import `from pyccel import epyccel`.
 -   #1720 : functions with the `@inline` decorator are no longer exposed to Python in the shared library.
 -   #1720 : Error raised when incompatible arguments are passed to an `inlined` function is now fatal.
 -   \[TESTS\] Filter out cast warnings in cast tests.

docs/quickstart.md

@@ -393,7 +393,7 @@ end module mod
 In addition to the `pyccel` command, the Pyccel library provides the `epyccel` Python function, whose name stands for "embedded Pyccel": given a pure Python function `f` with type annotations, `epyccel` returns a "pyccelised" function `f_fast` that can be used in the same Python session.
 For example:
 ```python
-from pyccel.epyccel import epyccel
+from pyccel import epyccel
 from mod import f
 
 f_fast = epyccel(f)
@@ -434,7 +434,7 @@ Finally we compare the timings obtained on an Intel Core 3 architecture.
 ```bash
 In [1]: from numpy.random import random
 In [2]: from mod import quicksort
-In [3]: from pyccel.epyccel import epyccel
+In [3]: from pyccel import epyccel
 
 In [4]: quicksort_fast = epyccel(quicksort)
 In [5]: x = random(100)

pyccel/__init__.py

@@ -1,2 +1,3 @@
 from .version import __version__
+from .commands.epyccel import epyccel
 from .commands.lambdify import lambdify

pyccel/epyccel.py renamed to pyccel/commands/epyccel.py

@@ -3,7 +3,8 @@
 # This file is part of Pyccel which is released under MIT License. See the LICENSE file or #
 # go to https://github.com/pyccel/pyccel/blob/master/LICENSE for full license details.     #
 #------------------------------------------------------------------------------------------#
-
+""" File containing functions for calling Pyccel interactively (epyccel and epyccel_seq)
+"""
 
 import inspect
 import importlib
@@ -24,23 +25,37 @@
 
 #==============================================================================
 def get_source_function(func):
+    """
+    Get the source code from a function.
+
+    Get a string containing the source code of a function from a function
+    object. Excessive indenting is stripped away.
+
+    Parameters
+    ----------
+    func : Function
+        A Python function.
+
+    Returns
+    -------
+    str
+        A string containing the source code.
+
+    Raises
+    ------
+    TypeError
+        A type error is raised if the object passed to the function is not
+        callable.
+    """
     if not callable(func):
         raise TypeError('Expecting a callable function')
 
-    lines = inspect.getsourcelines(func)
-    lines = lines[0]
+    lines, _ = inspect.getsourcelines(func)
     # remove indentation if the first line is indented
     a = lines[0]
     leading_spaces = len(a) - len(a.lstrip())
-    code = ''
-    for a in lines:
-        if leading_spaces > 0:
-            line = a[leading_spaces:]
-        else:
-            line = a
-        code = '{code}{line}'.format(code=code, line=line)
 
-    return code
+    return ''.join(a[leading_spaces:] for a in lines)
 
 #==============================================================================
 def get_unique_name(prefix, path):

pyccel/commands/lambdify.py

@@ -5,7 +5,7 @@
 import sympy as sp
 from packaging import version
 
-from pyccel.epyccel import epyccel
+from pyccel.commands.epyccel import epyccel
 from pyccel.utilities.strings import random_string
 
 if version.parse(sp.__version__) >= version.parse('1.8'):

tests/epyccel/recognised_functions/test_cmath_funcs.py

@@ -7,7 +7,7 @@
 from numpy.random import rand, uniform
 from numpy import isclose
 
-from pyccel.epyccel import epyccel
+from pyccel import epyccel
 from pyccel.decorators import template
 
 RTOL = sys.float_info.epsilon*1000

tests/epyccel/recognised_functions/test_epyccel_pyc_math.py

@@ -4,7 +4,7 @@
 from numpy.random import randint, uniform
 from numpy import isclose
 
-from pyccel.epyccel import epyccel
+from pyccel import epyccel
 
 RTOL = 2e-14
 ATOL = 1e-15

tests/epyccel/recognised_functions/test_math_funcs.py

@@ -6,7 +6,7 @@
 from numpy.random import rand, randint, uniform
 from numpy import isclose
 
-from pyccel.epyccel import epyccel
+from pyccel import epyccel
 from pyccel.decorators import template
 
 

tests/epyccel/recognised_functions/test_numpy_funcs.py

@@ -7,7 +7,7 @@
 import numpy as np
 
 from pyccel.decorators import template, types
-from pyccel.epyccel import epyccel
+from pyccel import epyccel
 
 min_int8 = iinfo('int8').min
 max_int8 = iinfo('int8').max

tests/epyccel/recognised_functions/test_numpy_types.py

@@ -10,7 +10,7 @@
 from test_numpy_funcs import matching_types
 
 from pyccel.decorators import template
-from pyccel.epyccel import epyccel
+from pyccel import epyccel
 
 numpy_basic_types_deprecated = tuple(int(v) for v in np.version.version.split('.'))>=(1,24,0)