upstream/ipython Files · IPython/utils/tz.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:

r11144:e8549ce5


                r24067:fcbe9bad

Download file

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

      # encoding: utf-8

      """

      Timezone utilities

      Just UTC-awareness right now

      """

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

      #  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 datetime import tzinfo, timedelta, datetime

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

      # Code

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

      # constant for zero offset

      ZERO = timedelta(0)

      class tzUTC(tzinfo):

          """tzinfo object for UTC (zero offset)"""

          def utcoffset(self, d):

              return ZERO

          def dst(self, d):

              return ZERO

      UTC = tzUTC()

      def utc_aware(unaware):

          """decorator for adding UTC tzinfo to datetime's utcfoo methods"""

          def utc_method(*args, **kwargs):

              dt = unaware(*args, **kwargs)

              return dt.replace(tzinfo=UTC)

          return utc_method

      utcfromtimestamp = utc_aware(datetime.utcfromtimestamp)

      utcnow = utc_aware(datetime.utcnow)

	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
				"""
				Timezone utilities

				Just UTC-awareness right now
				"""

				#-----------------------------------------------------------------------------
				# 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 datetime import tzinfo, timedelta, datetime

				#-----------------------------------------------------------------------------
				# Code
				#-----------------------------------------------------------------------------
				# constant for zero offset
				ZERO = timedelta(0)

				class tzUTC(tzinfo):
				"""tzinfo object for UTC (zero offset)"""

				def utcoffset(self, d):
				return ZERO

				def dst(self, d):
				return ZERO

				UTC = tzUTC()

				def utc_aware(unaware):
				"""decorator for adding UTC tzinfo to datetime's utcfoo methods"""
				def utc_method(args, *kwargs):
				dt = unaware(args, *kwargs)
				return dt.replace(tzinfo=UTC)
				return utc_method

				utcfromtimestamp = utc_aware(datetime.utcfromtimestamp)
				utcnow = utc_aware(datetime.utcnow)