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

Min RK - - Load All Authors

File last commit:

r20440:9e1db3ce


                r24067:fcbe9bad

Download file

             make_tarball.py
        
                    22 lines
            
             | 756 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / tools / make_tarball.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #!/usr/bin/env python

      """Simple script to create a tarball with proper git info.

      """

      import subprocess

      import os

      from toollib import cd, sh

      tag = subprocess.check_output('git describe --tags', shell=True).decode('utf8', 'replace').strip()

      base_name = 'ipython-%s' % tag

      tar_name = '%s.tgz' % base_name

      # git archive is weird:  Even if I give it a specific path, it still won't

      # archive the whole tree.  It seems the only way to get the whole tree is to cd

      # to the top of the tree.  There are long threads (since 2007) on the git list

      # about this and it still doesn't work in a sensible way...

      cd('..')

      git_tpl = 'git archive --format=tar --prefix={0}/ HEAD | gzip > {1}'

      sh(git_tpl.format(base_name, tar_name))

      sh('mv {0} tools/'.format(tar_name))

	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
				"""Simple script to create a tarball with proper git info.
				"""

				import subprocess
				import os

				from toollib import cd, sh

				tag = subprocess.check_output('git describe --tags', shell=True).decode('utf8', 'replace').strip()
				base_name = 'ipython-%s' % tag
				tar_name = '%s.tgz' % base_name

				# git archive is weird: Even if I give it a specific path, it still won't
				# archive the whole tree. It seems the only way to get the whole tree is to cd
				# to the top of the tree. There are long threads (since 2007) on the git list
				# about this and it still doesn't work in a sensible way...

				cd('..')
				git_tpl = 'git archive --format=tar --prefix={0}/ HEAD \| gzip > {1}'
				sh(git_tpl.format(base_name, tar_name))
				sh('mv {0} tools/'.format(tar_name))