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

Hide dynamically defined metaclass base from Sphinx....

Hide dynamically defined metaclass base from Sphinx. The inheritance diagram extension in Sphinx 1.2 stores class references, which Sphinx then tries to pickle. This chokes on our dynamically defined base classes from the with_metaclass function. Starting the name with an underscore makes Sphinx ignore the class. (Bug obscurity/fix simplicity) ratio is high.

Thomas Kluyver - - Load All Authors

File last commit:

r11127:0964ecd3


                r13584:cbe18349

Download file

             zmqrelated.py
        
                    46 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / zmqrelated.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """utilities for checking zmq versions"""

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

      #  Copyright (C) 2013  The IPython Development Team

      #

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

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

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

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

      # Verify zmq version dependency >= 2.1.11

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

      from IPython.utils.version import check_version

      def patch_pyzmq():

          """backport a few patches from newer pyzmq

          These can be removed as we bump our minimum pyzmq version

          """

          import zmq

          # fallback on stdlib json if jsonlib is selected, because jsonlib breaks things.

          # jsonlib support is removed from pyzmq >= 2.2.0

          from zmq.utils import jsonapi

          if jsonapi.jsonmod.__name__ == 'jsonlib':

              import json

              jsonapi.jsonmod = json

      def check_for_zmq(minimum_version, required_by='Someone'):

          try:

              import zmq

          except ImportError:

              raise ImportError("%s requires pyzmq >= %s"%(required_by, minimum_version))

          patch_pyzmq()

          pyzmq_version = zmq.__version__

          if not check_version(pyzmq_version, minimum_version):

              raise ImportError("%s requires pyzmq >= %s, but you have %s"%(

                              required_by, minimum_version, pyzmq_version))

	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

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

				#-----------------------------------------------------------------------------
				# Verify zmq version dependency >= 2.1.11
				#-----------------------------------------------------------------------------

				from IPython.utils.version import check_version


				def patch_pyzmq():
				"""backport a few patches from newer pyzmq

				These can be removed as we bump our minimum pyzmq version
				"""

				import zmq

				# fallback on stdlib json if jsonlib is selected, because jsonlib breaks things.
				# jsonlib support is removed from pyzmq >= 2.2.0

				from zmq.utils import jsonapi
				if jsonapi.jsonmod.__name__ == 'jsonlib':
				import json
				jsonapi.jsonmod = json


				def check_for_zmq(minimum_version, required_by='Someone'):
				try:
				import zmq
				except ImportError:
				raise ImportError("%s requires pyzmq >= %s"%(required_by, minimum_version))

				patch_pyzmq()

				pyzmq_version = zmq.__version__

				if not check_version(pyzmq_version, minimum_version):
				raise ImportError("%s requires pyzmq >= %s, but you have %s"%(
				required_by, minimum_version, pyzmq_version))