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

Change return type in docstring to literal tuple to avoid bogus cross-ref....

Change return type in docstring to literal tuple to avoid bogus cross-ref. Before this change the Sphinx tried to produce cross-reference links for the returned (stdout, stderr) tuple. The docs build produced a warning because there are 2 possible cross-ref objects for `stdout`, one in `IPython.testing.iptestcontroller.TestController`, the other in `IPython.utils.capture.CapturedIO`. Neither of those is correct in the context of the `ipexec()` function. Changing literal ``(stdout, stderr)`` avoids the warning by preventing the attempt to produce cross-references.

MinRK - - Load All Authors

File last commit:

r9318:ab1ae261


                r24067:fcbe9bad

Download file

             version.py
        
                    36 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.

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

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

      # Imports

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

      from distutils.version import LooseVersion

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

      # Code

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

      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.

          """

          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.
				#-----------------------------------------------------------------------------

				#-----------------------------------------------------------------------------
				# Imports
				#-----------------------------------------------------------------------------

				from distutils.version import LooseVersion

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------

				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.
				"""
				try:
				return LooseVersion(v) >= LooseVersion(check)
				except TypeError:
				return True