upstream/ipython Commit - r27294:ff8ba98b

reformat all of IPython.core

Matthias Bussonnier -

r27294:ff8ba98b

parent child

IPython/core/magics/basic.py

0 +5 -6

                 def _jsonable(self):
                     """turn magics dict into jsonable dict of the same structure
                     replaces object instances with their class names as strings
                     """
                     magic_dict = {}
                       In [6]: %whereami
                       Out[6]: u'/home/testuser'
                       In [7]: %alias_magic h history "-p -l 30" --line
                       Created `%h` as an alias for `%history -l 30`.
                     """
                     If called without arguments, acts as a toggle.
                     When in verbose mode the value --show (and --hide)
                     will respectively show (or hide) frames with ``__tracebackhide__ =
                     True`` value set.
                     """
                     If the passed parameter does not match any of the above and is a python
                     identifier, get said object from user namespace and set it as the
                     runner, and activate autoawait.
                     If the object is a fully qualified object name, attempt to import it and
                     set it as the runner, and activate autoawait.
                     The exact behavior of autoawait is experimental and subject to change
                     across version of IPython and Python.
                     """

IPython/core/magics/execution.py

0 +1 -3

                       In [6]: %timeit -n1 time.sleep(2)
                     The times reported by %timeit will be slightly higher than those
                     reported by the timeit.py script when variables are accessed. This is
                     due to the fact that %timeit executes the statement in the namespace
                     The CPU and wall clock times are printed, and the value of the
                     expression (if any) is returned.  Note that under Win32, system time
                     is always reported as 0, since it can not be measured.
                     This function can be used both as a line and cell magic:
                     - In line mode you can time a single-line statement (though multiple
                       CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
                       Wall time: 0.00
                     .. note::
                         The time needed by Python to compile the given expression will be
                         reported if it is more than 0.1s.

IPython/core/magics/extension.py

0 +1 -1

                 @line_magic
                 def unload_ext(self, module_str):
                     """Unload an IPython extension by its module name.
                     Not all extensions can be unloaded, only those which define an
                     ``unload_ipython_extension`` function.
                     """

IPython/core/magics/history.py

0 +2 -2

                     By default, all input history from the current session is displayed.
                     Ranges of history can be indicated using the syntax:
                     ``4``
                         Line 4, current session
                     ``4-6``
                     ``~8/1-~6/5``
                         From the first line of 8 sessions ago, to the fifth line of 6
                         sessions ago.
                     Multiple ranges can be entered, separated by spaces
                     The same syntax is used by %macro, %save, %edit, %rerun

IPython/core/magics/namespace.py

0 +4 -13

                       'builtin', 'user', 'user_global','internal', 'alias', where
                       'builtin' and 'user' are the search defaults.  Note that you should
                       not use quotes when specifying namespaces.
                       -l: List all available object types for object matching. This function
                       can be used without arguments.
                     Show objects beginning with a single _::
                       %psearch -a _*         list objects beginning with a single underscore
                     List available objects::
                       %psearch -l            list all available object types
                     """
                     # default namespaces to be searched
                     Examples
                     --------
                     Define two variables and list them with who_ls::
                       In [1]: alpha = 123
                     Examples
                     --------
                     Define two variables and list them with whos::
                       In [1]: alpha = 123
                     Parameters
                     ----------
                     -f : force reset without asking for confirmation.
                     -s : 'Soft' reset: Only clears your namespace, leaving history intact.
                         References to objects may be kept. By default (without this option),
                         we do a 'hard' reset, giving you a new session and removing all
                         references to objects from the current session.
+                    --aggressive : Try to aggressively remove modules from sys.modules ; this
-                    --aggressive: Try to aggressively remove modules from sys.modules ; this
                         may allow you to reimport Python modules that have been updated and
                         pick up changes, but can have unattended consequences.
                     in : reset input history
                     out : reset output history
                     dhist : reset directory history
                     array : reset only variables that are NumPy arrays
                     See Also
                     Examples
                     --------
                     We first fully reset the namespace so your output looks identical to
                     this example for pedagogical reasons; in practice you do not need a
                     full reset::

IPython/core/magics/osm.py

0 +4 -6

                 def _isexec_POSIX(self, file):
                     """
-                        Test for executable on a POSIX system
+                    Test for executable on a POSIX system
                     """
                     if os.access(file.path, os.X_OK):
                         # will fail on maxOS if access is not X_OK
                 def _isexec_WIN(self, file):
                     """
-                        Test for executable file on non POSIX system
+                    Test for executable file on non POSIX system
                     """
                     return file.is_file() and self.execre.match(file.name) is not None
                 def isexec(self, file):
                     """
-                        Test for executable file on non POSIX system
+                    Test for executable file on non POSIX system
                     """
                     if self.is_posix:
                         return self._isexec_POSIX(file)
                         ``cd <bookmark_name>`` is enough if there is no directory
                         ``<bookmark_name>``, but a bookmark with the name exists.
                     Options:
                     -q               Be quiet. Do not print the working directory after the
                        where ``!command`` runs is immediately discarded after executing
                        'command'.
                     Examples
                     --------
                     ::
                 @cell_magic
                 def writefile(self, line, cell):
                     """Write the contents of the cell to a file.
                     The file will be overwritten unless the -a (--append) flag is specified.
                     """
                     args = magic_arguments.parse_argstring(self.writefile, line)

IPython/core/magics/script.py

0 +4 -4

                 @dec_safe_watcher
                 def shebang(self, line, cell):
                     """Run a cell via a shell command
                     The `%%script` line is like the #! line of script,
                     specifying a program (bash, perl, ruby, etc.) with which to run.
                     The rest of the cell is run by that program.
                     Examples
                     --------
                     ::
                         In [1]: %%script bash
                            ...: for i in 1 2 3; do
                            ...:   echo $i

setup.cfg

0 +1 -1

             [velin]
             ignore_patterns =
-               IPython/core/tests,
+               IPython/core/tests
                IPython/testing
             [tool.black]

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages