#3482 Remove sphinx.stringify_annotations use

Author: sergisiso

.github/workflows/python-package.yml

@@ -119,8 +119,6 @@ jobs:
           # Uncomment the below to use the submodule version of fparser rather
           # than the latest release from pypi.
           # pip install external/fparser
-          # We need to install sphinx to get correct doc testing
-          pip install .[doc]
           pip install .[test,treesitter]
       - name: Lint with flake8
         run: |

doc/developer_guide/pip_requirements.txt

@@ -534,13 +534,8 @@ def create_docstring_data(args: List[str], desc: str,
 
     :returns: An object representing the input arg and desc.
     '''
-    # Import here to disable circular dependency if Sphinx isn't available.
-    try:
-        # pylint: disable=import-outside-toplevel
-        from sphinx.util.typing import stringify_annotation
-    except ImportError:
-        # pylint: disable=import-outside-toplevel
-        from psyclone.utils import stringify_annotation
+    # pylint: disable=import-outside-toplevel
+    from psyclone.utils import stringify_annotation
     # If its a param then we can create an ArgumentData for this.
     if args[0] == "param":
         if len(args) == 2:

src/psyclone/docstring_parser.py

@@ -51,11 +51,6 @@
 from typing import Any, Dict, Optional, Union
 import warnings
 
-try:
-    from sphinx.util.typing import stringify_annotation
-except ImportError:
-    # No Sphinx available so use our own, simpler version.
-    from psyclone.utils import stringify_annotation
 
 from psyclone.configuration import Config, LFRIC_API_NAMES, GOCEAN_API_NAMES
 from psyclone.core import AccessType
@@ -70,6 +65,7 @@
     ArgumentInterface, ArrayType, ContainerSymbol, DataSymbol, ScalarType,
     UnresolvedType, ImportInterface, RoutineSymbol)
 from psyclone.psyir.symbols.symbol_table import SymbolTable
+from psyclone.utils import stringify_annotation
 
 # The types of 'intent' that an argument to a Fortran subroutine
 # may have

src/psyclone/psyGen.py

@@ -596,35 +596,6 @@ def docstring_object2(param4):
     assert basedata3.desc is not None
 
 
-def test_no_sphinx():
-    '''
-    Test that we can still create docstring information if sphinx is
-    not installed.
-
-    '''
-    # Unload the docstring_parser
-    # Trick the import into thinking sphinx.util.typing is unavailable
-    with patch.dict(sys.modules):
-        del sys.modules['psyclone.docstring_parser']
-        sys.modules['sphinx.util.typing'] = None
-        sys.modules['sphinx'] = None
-        # pylint: disable=import-outside-toplevel
-        from psyclone.docstring_parser import (
-            create_docstring_data, ArgumentData
-        )
-
-        def test_function(param: DocstringData):
-            '''Empty function to test import.'''
-
-        data = create_docstring_data(["param", "param"],
-                                     "empty", test_function)
-        # This uses the PSyclone version of stringify_annotation so we get a
-        # different datatype expression
-        assert isinstance(data, ArgumentData)
-        assert (data.datatype ==
-                "<class 'psyclone.docstring_parser.DocstringData'>")
-
-
 def test_subarguments():
     '''
     Test that we can add sub arguments to a docstring data as expected.

src/psyclone/tests/docstring_parser_test.py

@@ -375,33 +375,6 @@ def apply(self, node, valid2: int = 1):
     assert options.get('options', None) is None
 
 
-def test_transformation_get_valid_options_no_sphinx():
-    '''Test that the get_valid_options method behaves in the expected
-    way when sphinx isn't available.'''
-    # Test that importing stringify_annotations works without sphinx.
-    # Trick the import into thinking sphinx.util.typing is unavailable
-    with patch.dict(sys.modules, {'sphinx.util.typing': None}):
-        # Unload the previously imported Transformation class
-        # pylint: disable=import-outside-toplevel
-        del sys.modules['psyclone.psyGen']
-        from psyclone.psyGen import Transformation
-
-        class TestTrans(Transformation):
-            '''Utility transformation to test methods of the abstract
-            Transformation class.'''
-
-            def apply(self, node, valid: bool = True, untyped=False):
-                '''Apply method of TestTrans.'''
-
-        options = TestTrans.get_valid_options()
-        assert options['valid'].default
-        assert options['valid'].type is bool
-        assert options['valid'].typename == "<class 'bool'>"
-        assert options['untyped'].default is False
-        assert options['untyped'].type is None
-        assert options['untyped'].typename is None
-
-
 def test_transformation_validate_options():
     '''Test that the validate_options function behaves as expected'''
     class TestTrans(Transformation):

src/psyclone/tests/psyGen_test.py

@@ -346,7 +346,7 @@ def func(temp: bool, temp2: Union[bool, int]):
         # For first parameter temp
         if "temp" == k:
             anno = stringify_annotation(v.annotation)
-            assert "<class 'bool'>" == anno
+            assert "bool" == anno
 
         # For second parameter temp2
         if "temp2" == k:

src/psyclone/tests/utils_test.py

@@ -37,7 +37,7 @@
 
 '''This module provides generic utility functions.'''
 
-from typing import Type, TYPE_CHECKING, Union
+from typing import Type, TYPE_CHECKING, Union, TypeAliasType
 from collections import OrderedDict
 import sys
 from psyclone.errors import InternalError
@@ -79,15 +79,16 @@ def a_or_an(string):
     return "a"
 
 
-def stringify_annotation(annotation) -> str:
+def stringify_annotation(annotation: Union[Type, TypeAliasType]) -> str:
     ''' Simple PSyclone method to turn a Python type annotation to a string
     when sphinx is not available.
 
-    :param annotation: The type annotation to convert to a string.
-    :type annotation: TypeAliasType
+    :param annotation: the type annotation to convert to a string.
 
     :returns: The string representation of annotation.
     '''
+    if isinstance(annotation, type):
+        return annotation.__name__
     return str(annotation)