upstream/ipython Files · IPython/utils/version.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Matthias Bussonnier - - Load All Authors

File last commit:

r27504:a96dd9e4


                r28197:ad452c1d

Download file

             version.py
        
                    43 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / version.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # encoding: utf-8

      """

      Utilities for version comparison

      It is a bit ridiculous that we need these.

      """

      #-----------------------------------------------------------------------------

      #  Copyright (C) 2013  The IPython Development Team

      #

      #  Distributed under the terms of the BSD License.  The full license is in

      #  the file COPYING, distributed as part of this software.

      #-----------------------------------------------------------------------------

      from warnings import warn

      warn(

          "The `IPython.utils.version` module has been deprecated since IPython 8.0.",

          DeprecationWarning,

      )

      def check_version(v, check):

          """check version string v >= check

          If dev/prerelease tags result in TypeError for string-number comparison,

          it is assumed that the dependency is satisfied.

          Users on dev branches are responsible for keeping their own packages up to date.

          """

          warn(

              "`check_version` function is deprecated as of IPython 8.0"

              "and will be removed in future versions.",

              DeprecationWarning,

              stacklevel=2,

          )

          from distutils.version import LooseVersion

          try:

              return LooseVersion(v) >= LooseVersion(check)

          except TypeError:

              return True

	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

				# encoding: utf-8
				"""
				Utilities for version comparison

				It is a bit ridiculous that we need these.
				"""

				#-----------------------------------------------------------------------------
				# Copyright (C) 2013 The IPython Development Team
				#
				# Distributed under the terms of the BSD License. The full license is in
				# the file COPYING, distributed as part of this software.
				#-----------------------------------------------------------------------------

				from warnings import warn

				warn(
				"The `IPython.utils.version` module has been deprecated since IPython 8.0.",
				DeprecationWarning,
				)


				def check_version(v, check):
				"""check version string v >= check

				If dev/prerelease tags result in TypeError for string-number comparison,
				it is assumed that the dependency is satisfied.
				Users on dev branches are responsible for keeping their own packages up to date.
				"""
				warn(
				"`check_version` function is deprecated as of IPython 8.0"
				"and will be removed in future versions.",
				DeprecationWarning,
				stacklevel=2,
				)

				from distutils.version import LooseVersion

				try:
				return LooseVersion(v) >= LooseVersion(check)
				except TypeError:
				return True