Clean up imports

cwrowley · cwrowley · commit c2bf84d93283 · 2015-04-26T19:16:07.000-04:00
Define __all__ variables in the modules so that
    from .&lt;module&gt; import *
imports only the functions/classes we use.  This is probably a little
better than listing them explicitly in __init__.py, since then if we add
a new function to a module, we only need to change the __all__ variable
in the same module, rather than edit __init__.py.  Furthermore it avoids
duplicating some of these listings in matlab/__init__.py.
diff --git a/control/__init__.py b/control/__init__.py
@@ -45,28 +45,26 @@
 """
 
 # Import functions from within the control system library
-# Should probably only import the exact functions we use...
-from .bdalg import series, parallel, negate, feedback
-from .delay import pade
+# Note: the functions we use are specified as __all__ variables in the modules
+from .bdalg import *
+from .delay import *
 from .dtime import *
-from .freqplot import bode_plot, nyquist_plot, gangof4_plot
-from .freqplot import bode, nyquist, gangof4
+from .freqplot import *
 from .lti import *
 from .margins import *
-from .mateqn import lyap, dlyap, care, dare
-from .modelsimp import hsvd, modred, balred, era, markov, minreal
+from .mateqn import *
+from .modelsimp import *
 from .nichols import *
-from .phaseplot import phase_plot, box_grid
-from .pzmap import pzmap
+from .phaseplot import *
+from .pzmap import *
 from .rlocus import *
-from .statefbk import place, lqr, ctrb, obsv, gram, acker
+from .statefbk import *
 from .statesp import *
-from .timeresp import forced_response, initial_response, step_response, \
-    impulse_response
+from .timeresp import *
 from .xferfcn import *
 from .ctrlutil import *
 from .frdata import *
-from .canonical import canonical_form, reachable_form
+from .canonical import *
 
 # Exceptions
 from .exception import *
@@ -77,16 +75,6 @@
 except ImportError:
     __version__ = "dev"
 
-# Import some of the more common (and benign) MATLAB shortcuts
-# By default, don't import conflicting commands here
-#! TODO (RMM, 4 Nov 2012): remove MATLAB dependencies from __init__.py
-#!
-#! Eventually, all functionality should be in modules *other* than matlab.
-#! This will allow inclusion of the matlab module to set up a different set
-#! of defaults from the main package.  At that point, the matlab module will
-#! allow provide compatibility with MATLAB but no package functionality.
-#!
-
 # The following is to use Numpy's testing framework
 # Tests go under directory tests/, benchmarks under directory benchmarks/
 from numpy.testing import Tester
diff --git a/control/bdalg.py b/control/bdalg.py
@@ -58,6 +58,8 @@
 from . import statesp as ss
 from . import frdata as frd
 
+__all__ = ['series', 'parallel', 'negate', 'feedback', 'append', 'connect']
+
 def series(sys1, sys2):
     """Return the series connection sys2 * sys1 for --> sys1 --> sys2 -->.
 
diff --git a/control/canonical.py b/control/canonical.py
@@ -9,6 +9,7 @@
 from numpy import zeros, shape, poly
 from numpy.linalg import inv
 
+__all__ = ['canonical_form', 'reachable_form']
 
 def canonical_form(xsys, form='reachable'):
     """Convert a system into canonical form
diff --git a/control/delay.py b/control/delay.py
@@ -44,6 +44,8 @@
 # Python 3 compatability (needs to go here)
 from __future__ import print_function
 
+__all__ = ['pade']
+
 def pade(T, n=1):
     """
     Create a linear system that approximates a delay.
diff --git a/control/freqplot.py b/control/freqplot.py
@@ -49,6 +49,9 @@
 from .bdalg import feedback
 from .lti import isdtime, timebaseEqual
 
+__all__ = ['bode_plot', 'nyquist_plot', 'gangof4_plot',
+           'bode', 'nyquist', 'gangof4']
+
 #
 # Main plotting functions
 #
diff --git a/control/mateqn.py b/control/mateqn.py
@@ -46,6 +46,8 @@
 from scipy.linalg import eigvals, solve_discrete_are
 from .exception import ControlSlycot, ControlArgument
 
+__all__ = ['lyap', 'dlyap', 'dare', 'care']
+
 #### Lyapunov equation solvers lyap and dlyap
 
 def lyap(A,Q,C=None,E=None):
diff --git a/control/matlab/__init__.py b/control/matlab/__init__.py
@@ -50,11 +50,6 @@
 
 """
 
-# Libraries that we make use of
-import scipy as sp              # SciPy library (used all over)
-import numpy as np              # NumPy library
-import re                       # regular expressions
-
 # Import MATLAB-like functions that are defined in other packages
 from scipy.signal import zpk2ss, ss2zpk, tf2zpk, zpk2tf
 from numpy import linspace, logspace
@@ -76,19 +71,19 @@
 from ..xferfcn import *
 from ..lti import *
 from ..frdata import *
-from ..dtime import sample_system
+from ..dtime import *
 from ..exception import ControlArgument
 
 # Import MATLAB-like functions that can be used as-is
 from ..ctrlutil import *
 from ..freqplot import nyquist, gangof4
-from ..nichols import nichols, nichols_grid
-from ..bdalg import series, parallel, negate, feedback, append, connect
-from ..pzmap import pzmap
-from ..statefbk import ctrb, obsv, gram, place, lqr
-from ..delay import pade
-from ..modelsimp import hsvd, balred, modred, minreal
-from ..mateqn import lyap, dlyap, dare, care
+from ..nichols import nichols
+from ..bdalg import *
+from ..pzmap import *
+from ..statefbk import *
+from ..delay import *
+from ..modelsimp import *
+from ..mateqn import *
 from ..margins import margin
 from ..rlocus import rlocus
 from ..dtime import c2d
diff --git a/control/modelsimp.py b/control/modelsimp.py
@@ -50,6 +50,8 @@
 from .statesp import StateSpace
 from .statefbk import gram
 
+__all__ = ['hsvd', 'balred', 'modred', 'era', 'markov', 'minreal']
+
 # Hankel Singular Value Decomposition
 #   The following returns the Hankel singular values, which are singular values
 #of the matrix formed by multiplying the controllability and observability
diff --git a/control/phaseplot.py b/control/phaseplot.py
@@ -43,6 +43,8 @@
 from scipy.integrate import odeint
 from .exception import ControlNotImplemented
 
+__all__ = ['phase_plot', 'box_grid']
+
 def phase_plot(odefun, X=None, Y=None, scale=1, X0=None, T=None,
               lingrid=None, lintime=None, logtime=None, timepts=None,
               parms=(), verbose=True):
diff --git a/control/pzmap.py b/control/pzmap.py
@@ -40,12 +40,11 @@
 #
 # $Id:pzmap.py 819 2009-05-29 21:28:07Z murray $
 
-import matplotlib.pyplot as plt
-#import scipy as sp
-#import numpy as np
 from numpy import real, imag
 from .lti import LTI
 
+__all__ = ['pzmap']
+
 # TODO: Implement more elegant cross-style axes. See:
 #    http://matplotlib.sourceforge.net/examples/axes_grid/demo_axisline_style.html
 #    http://matplotlib.sourceforge.net/examples/axes_grid/demo_curvelinear_grid.html
@@ -75,6 +74,7 @@ def pzmap(sys, Plot=True, title='Pole Zero Map'):
     zeros = sys.zero()
 
     if (Plot):
+        import matplotlib.pyplot as plt
         # Plot the locations of the poles and zeros
         if len(poles) > 0:
             plt.scatter(real(poles), imag(poles), s=50, marker='x')
diff --git a/control/statefbk.py b/control/statefbk.py
@@ -45,6 +45,8 @@
 from . import statesp
 from .exception import ControlSlycot, ControlArgument, ControlDimension
 
+__all__ = ['ctrb', 'obsv', 'gram', 'place', 'lqr', 'acker']
+
 # Pole placement
 def place(A, B, p):
     """Place closed loop eigenvalues

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,9 @@`
`49`	`49`	`from .bdalg import feedback`
`50`	`50`	`from .lti import isdtime, timebaseEqual`
`51`	`51`
	`52`	`+__all__ = ['bode_plot', 'nyquist_plot', 'gangof4_plot',`
	`53`	`+ 'bode', 'nyquist', 'gangof4']`
	`54`	`+`
`52`	`55`	`#`
`53`	`56`	`# Main plotting functions`
`54`	`57`	`#`