|
|
"""A one-line description.
|
|
|
|
|
|
A longer description that spans multiple lines. Explain the purpose of the
|
|
|
file and provide a short list of the key classes/functions it contains. This
|
|
|
is the docstring shown when some does 'import foo;foo?' in IPython, so it
|
|
|
should be reasonably useful and informative.
|
|
|
"""
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Copyright (c) 2011, the IPython Development Team.
|
|
|
#
|
|
|
# Distributed under the terms of the Modified BSD License.
|
|
|
#
|
|
|
# The full license is in the file COPYING.txt, distributed with this software.
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Imports
|
|
|
#-----------------------------------------------------------------------------
|
|
|
from __future__ import print_function
|
|
|
|
|
|
# [remove this comment in production]
|
|
|
#
|
|
|
# List all imports, sorted within each section (stdlib/third-party/ipython).
|
|
|
# For 'import foo', use one import per line. For 'from foo.bar import a, b, c'
|
|
|
# it's OK to import multiple items, use the parenthesized syntax 'from foo
|
|
|
# import (a, b, ...)' if the list needs multiple lines.
|
|
|
|
|
|
# Stdlib imports
|
|
|
|
|
|
# Third-party imports
|
|
|
|
|
|
# Our own imports
|
|
|
|
|
|
|
|
|
# [remove this comment in production]
|
|
|
#
|
|
|
# Use broad section headers like this one that make it easier to navigate the
|
|
|
# file, with descriptive titles. For complex classes, simliar (but indented)
|
|
|
# headers are useful to organize the internal class structure.
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Globals and constants
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Local utilities
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Classes and functions
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
