upstream/ipython Files · tools/check_sources.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.

Paul Ivanov - - Load All Authors

File last commit:

r22963:2961b531


                r24067:fcbe9bad

Download file

             check_sources.py
        
                    54 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / tools / check_sources.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #!/usr/bin/env python

      """Utility to look for hard tabs and \r characters in all sources.

      Usage:

      ./check_sources.py

      It prints summaries and if chosen, line-by-line info of where \\t or \\r

      characters can be found in our source tree.

      """

      # Config

      # If true, all lines that have tabs are printed, with line number

      full_report_tabs = True

      # If true, all lines that have tabs are printed, with line number

      full_report_rets = False

      # Code begins

      from IPython.external.path import path

      rets = []

      tabs = []

      for f in path('..').walkfiles('*.py'):

          errs = ''

          cont = f.bytes()

          if '\t' in cont:

              errs+='t'

              tabs.append(f)

          if '\r' in cont:

              errs+='r'

              rets.append(f)

          if errs:

              print("%3s" % errs, f)

          if 't' in errs and full_report_tabs:

              for ln,line in enumerate(f.lines()):

                  if '\t' in line:

                      print('TAB:',ln,':',line, end=' ')

          if 'r' in errs and full_report_rets:

              for ln,line in enumerate(open(f.abspath(),'rb')):

                  if '\r' in line:

                      print('RET:',ln,':',line, end=' ')

      # Summary at the end, to call cleanup tools if necessary

      if tabs:

          print('Hard tabs found. These can be cleaned with untabify:')

          for f in tabs: print(f, end=' ')

      if rets:

          print('Carriage returns (\\r) found in:')

          for f in rets: print(f, end=' ')

	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

				#!/usr/bin/env python
				"""Utility to look for hard tabs and \r characters in all sources.

				Usage:

				./check_sources.py

				It prints summaries and if chosen, line-by-line info of where \\t or \\r
				characters can be found in our source tree.
				"""

				# Config
				# If true, all lines that have tabs are printed, with line number
				full_report_tabs = True
				# If true, all lines that have tabs are printed, with line number
				full_report_rets = False

				# Code begins
				from IPython.external.path import path

				rets = []
				tabs = []

				for f in path('..').walkfiles('*.py'):
				errs = ''
				cont = f.bytes()
				if '\t' in cont:
				errs+='t'
				tabs.append(f)

				if '\r' in cont:
				errs+='r'
				rets.append(f)

				if errs:
				print("%3s" % errs, f)

				if 't' in errs and full_report_tabs:
				for ln,line in enumerate(f.lines()):
				if '\t' in line:
				print('TAB:',ln,':',line, end=' ')

				if 'r' in errs and full_report_rets:
				for ln,line in enumerate(open(f.abspath(),'rb')):
				if '\r' in line:
				print('RET:',ln,':',line, end=' ')

				# Summary at the end, to call cleanup tools if necessary
				if tabs:
				print('Hard tabs found. These can be cleaned with untabify:')
				for f in tabs: print(f, end=' ')
				if rets:
				print('Carriage returns (\\r) found in:')
				for f in rets: print(f, end=' ')