Restore sympy.printing.{ccode,fcode,cxxcode} for backwards compatibility

asmeurer · oscarbenjamin · commit a6575a920409 · 2020-10-17T11:24:16.000+01:00
They were renamed in sympy#19908, because the submodule sharing the same name as the function was causing issues in __init__.py. However, these modules also contained things that were not included in __init__.py but were nonetheless part of the public API, such as the printer classes. Consequently, renaming the imports broke the API. This restores the submodules as shims, which are not imported by default (and hence will not cause issues with conflicts in __init__.py). Note that after running import sympy.printing.ccode (or from sympy.printing.ccode import ...) any subsequent from sympy.printing import ccode (or sympy.printing.ccode) will result in the ccode submodule, not the function (this is why ccode.py was renamed to c.py in the first place). Hence, this shim should be avoided and is only provided for backwards compatibility. I haven't deprecated these shim modules in this commit, but I may do that in a later commit. See also the discussion on sympy#20234.
diff --git a/sympy/printing/ccode.py b/sympy/printing/ccode.py
@@ -0,0 +1,9 @@
+"""
+This is a shim file to provide backwards compatibility (ccode.py was renamed
+to c.py in SymPy 1.7).
+"""
+
+from .c import (ccode, print_ccode, known_functions_C89, known_functions_C99, # noqa:F401
+                reserved_words, reserved_words_c99, get_math_macros,
+                C89CodePrinter, C99CodePrinter, C11CodePrinter,
+                c_code_printers)
diff --git a/sympy/printing/cxxcode.py b/sympy/printing/cxxcode.py
@@ -0,0 +1,7 @@
+"""
+This is a shim file to provide backwards compatibility (cxxcode.py was renamed
+to cxx.py in SymPy 1.7).
+"""
+
+from .cxx import (cxxcode, reserved, CXX98CodePrinter, # noqa:F401
+                  CXX11CodePrinter, CXX17CodePrinter, cxx_code_printers)
diff --git a/sympy/printing/fcode.py b/sympy/printing/fcode.py
@@ -0,0 +1,6 @@
+"""
+This is a shim file to provide backwards compatibility (fcode.py was renamed
+to fortran.py in SymPy 1.7).
+"""
+
+from .fortran import fcode, print_fcode, known_functions, FCodePrinter # noqa:F401
diff --git a/sympy/printing/tests/test_c.py b/sympy/printing/tests/test_c.py
@@ -835,3 +835,7 @@ def test_ccode_codegen_ast():
         'pwer(x);',
         'return x;',
     ])
+
+def test_ccode_submodule():
+    # Test the compatibility sympy.printing.ccode module imports
+    import sympy.printing.ccode # noqa:F401
diff --git a/sympy/printing/tests/test_cxx.py b/sympy/printing/tests/test_cxx.py
@@ -54,3 +54,7 @@ def test_CXX17CodePrinter():
 
 def test_cxxcode():
     assert sorted(cxxcode(sqrt(x)*.5).split('*')) == sorted(['0.5', 'std::sqrt(x)'])
+
+def test_cxxcode_submodule():
+    # Test the compatibility sympy.printing.cxxcode module imports
+    import sympy.printing.cxxcode # noqa:F401
diff --git a/sympy/printing/tests/test_fortran.py b/sympy/printing/tests/test_fortran.py
@@ -804,3 +804,7 @@ def test_FunctionDefinition_print():
     # Should be changed to proper test once multi-line generation is working
     # see https://github.com/sympy/sympy/issues/15824
     raises(NotImplementedError, lambda: fcode(fd1))
+
+def test_fcode_submodule():
+    # Test the compatibility sympy.printing.fcode module imports
+    import sympy.printing.fcode # noqa:F401
