Merge pull request sympy#20250 from asmeurer/restore-ccode

oscarbenjamin · web-flow · commit 99701a55707a · 2020-10-17T11:18:31.000+01:00
Restore sympy.printing.{ccode,fcode,cxxcode} for backwards compatibility
diff --git a/sympy/printing/ccode.py b/sympy/printing/ccode.py
@@ -0,0 +1,17 @@
+"""
+This is a shim file to provide backwards compatibility (ccode.py was renamed
+to c.py in SymPy 1.7).
+"""
+
+from sympy.utilities.exceptions import SymPyDeprecationWarning
+
+SymPyDeprecationWarning(
+    feature="importing from sympy.printing.ccode",
+    useinstead="Import from sympy.printing.c",
+    issue=20256,
+    deprecated_since_version="1.7").warn()
+
+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,15 @@
+"""
+This is a shim file to provide backwards compatibility (cxxcode.py was renamed
+to cxx.py in SymPy 1.7).
+"""
+
+from sympy.utilities.exceptions import SymPyDeprecationWarning
+
+SymPyDeprecationWarning(
+    feature="importing from sympy.printing.cxxcode",
+    useinstead="Import from sympy.printing.cxx",
+    issue=20256,
+    deprecated_since_version="1.7").warn()
+
+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,14 @@
+"""
+This is a shim file to provide backwards compatibility (fcode.py was renamed
+to fortran.py in SymPy 1.7).
+"""
+
+from sympy.utilities.exceptions import SymPyDeprecationWarning
+
+SymPyDeprecationWarning(
+    feature="importing from sympy.printing.fcode",
+    useinstead="Import from sympy.printing.fortran",
+    issue=20256,
+    deprecated_since_version="1.7").warn()
+
+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
@@ -10,7 +10,7 @@
 from sympy.sets import Range
 from sympy.logic import ITE
 from sympy.codegen import For, aug_assign, Assignment
-from sympy.testing.pytest import raises, XFAIL
+from sympy.testing.pytest import raises, XFAIL, warns_deprecated_sympy
 from sympy.printing.c import C89CodePrinter, C99CodePrinter, get_math_macros
 from sympy.codegen.ast import (
     AddAugmentedAssignment, Element, Type, FloatType, Declaration, Pointer, Variable, value_const, pointer_const,
@@ -835,3 +835,8 @@ def test_ccode_codegen_ast():
         'pwer(x);',
         'return x;',
     ])
+
+def test_ccode_submodule():
+    # Test the compatibility sympy.printing.ccode module imports
+    with warns_deprecated_sympy():
+        import sympy.printing.ccode # noqa:F401
diff --git a/sympy/printing/tests/test_cxx.py b/sympy/printing/tests/test_cxx.py
@@ -3,6 +3,8 @@
 from sympy.printing.cxx import CXX98CodePrinter, CXX11CodePrinter, CXX17CodePrinter, cxxcode
 from sympy.codegen.cfunctions import log1p
 
+from sympy.testing.pytest import warns_deprecated_sympy
+
 x, y = symbols('x y')
 
 
@@ -54,3 +56,8 @@ 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
+    with warns_deprecated_sympy():
+        import sympy.printing.cxxcode # noqa:F401
diff --git a/sympy/printing/tests/test_fortran.py b/sympy/printing/tests/test_fortran.py
@@ -14,7 +14,7 @@
 from sympy.printing.fortran import fcode, FCodePrinter
 from sympy.tensor import IndexedBase, Idx
 from sympy.utilities.lambdify import implemented_function
-from sympy.testing.pytest import raises
+from sympy.testing.pytest import raises, warns_deprecated_sympy
 
 
 def test_printmethod():
@@ -804,3 +804,8 @@ 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
+    with warns_deprecated_sympy():
+        import sympy.printing.fcode # noqa:F401
diff --git a/sympy/testing/runtests.py b/sympy/testing/runtests.py
@@ -675,6 +675,9 @@ def _get_doctest_blacklist():
         "sympy/matrices/densearith.py", # raises deprecation warning
         "sympy/matrices/densesolve.py", # raises deprecation warning
         "sympy/matrices/densetools.py", # raises deprecation warning
+        "sympy/printing/ccode.py", # backwards compatibility shim, importing it breaks the codegen doctests
+        "sympy/printing/fcode.py", # backwards compatibility shim, importing it breaks the codegen doctests
+        "sympy/printing/cxxcode.py", # backwards compatibility shim, importing it breaks the codegen doctests
         "sympy/parsing/autolev/_antlr/autolevlexer.py", # generated code
         "sympy/parsing/autolev/_antlr/autolevparser.py", # generated code
         "sympy/parsing/autolev/_antlr/autolevlistener.py", # generated code
