maint(fix): Add deprecation warning for accidental imports

oscarbenjamin · oscarbenjamin · commit 4924845fa731 · 2020-05-15T23:39:17.000+01:00
This commit clarifies the comments about what will or will not be
importable in future.
diff --git a/sympy/__init__.py b/sympy/__init__.py
@@ -506,7 +506,8 @@ def __sympy_debug():
 #
 # This happened implicitly because there was no __all__ defined in this
 # __init__.py file. Not every package is imported. The list matches what
-# would have been imported before.
+# would have been imported before. It is possible that these packages will
+# not be imported by a star-import from sympy in future.
 #
 #=======================================================================
 
@@ -527,7 +528,6 @@ def __sympy_debug():
     'multipledispatch',
     'ntheory',
     'parsing',
-    # 'physics',
     'plotting',
     'polys',
     'printing',
@@ -540,13 +540,15 @@ def __sympy_debug():
 
 #=======================================================================
 #
-# XXX: The names below were importable before sympy 1.6 using
+# XXX: The names listed in _DEPREACTED_IMPORTS below were importable before
+# sympy 1.6 using
 #
 #          from sympy import *
 #
 # This happened implicitly because there was no __all__ defined in this
 # __init__.py file. The plan is to remove them but for now they remain
-# importable but will give a deprecation warning when used.
+# importable but will give a deprecation warning when used. In future these
+# names will be removed and will not be importable from here.
 #
 #=======================================================================
 

Original file line number	Diff line number	Diff line change
`@@ -506,7 +506,8 @@ def __sympy_debug():`
`506`	`506`	`#`
`507`	`507`	`# This happened implicitly because there was no __all__ defined in this`
`508`	`508`	`# __init__.py file. Not every package is imported. The list matches what`
`509`		`-# would have been imported before.`
	`509`	`+# would have been imported before. It is possible that these packages will`
	`510`	`+# not be imported by a star-import from sympy in future.`
`510`	`511`	`#`
`511`	`512`	`#=======================================================================`
`512`	`513`
`@@ -527,7 +528,6 @@ def __sympy_debug():`
`527`	`528`	`'multipledispatch',`
`528`	`529`	`'ntheory',`
`529`	`530`	`'parsing',`
`530`		`- # 'physics',`
`531`	`531`	`'plotting',`
`532`	`532`	`'polys',`
`533`	`533`	`'printing',`
`@@ -540,13 +540,15 @@ def __sympy_debug():`
`540`	`540`
`541`	`541`	`#=======================================================================`
`542`	`542`	`#`
`543`		`-# XXX: The names below were importable before sympy 1.6 using`
	`543`	`+# XXX: The names listed in _DEPREACTED_IMPORTS below were importable before`
	`544`	`+# sympy 1.6 using`
`544`	`545`	`#`
`545`	`546`	`# from sympy import *`
`546`	`547`	`#`
`547`	`548`	`# This happened implicitly because there was no __all__ defined in this`
`548`	`549`	`# __init__.py file. The plan is to remove them but for now they remain`
`549`		`-# importable but will give a deprecation warning when used.`
	`550`	`+# importable but will give a deprecation warning when used. In future these`
	`551`	`+# names will be removed and will not be importable from here.`
`550`	`552`	`#`
`551`	`553`	`#=======================================================================`
`552`	`554`