Merge pull request #2635 from cgohlke/windows-startmenu

Improve Windows start menu shortcuts

* Create Windows start menu shortcuts with better names.
* Add shortcuts for IPython Notebook and online documentation.
* Add icons for IPython console and notebook.
* Apply PEP8 to ipython_win_post_install.py.
* Tested on win32-py2.7, win-amd64-py2.7, win-amd64-py3.3, Windows 8.

scripts/ipython_win_post_install.py

@@ -1,56 +1,79 b''
 #!python
-"""Windows-specific part of the installation"""
+"""Distutils post installation script for Windows.
+
+http://docs.python.org/2/distutils/builtdist.html#the-postinstallation-script
+
+"""
 
 from __future__ import print_function
 
-import os, sys, shutil
-pjoin = os.path.join
+import os
+import sys
+import shutil
 
-# import setuptools if we can
 try:
     import setuptools
+    have_setuptools = True
 except ImportError:
-    pass
+    have_setuptools = False
+
+
+pjoin = os.path.join
+
+# suffix for start menu folder names
+pyver = "(Py%i.%i %i bit)" % (sys.version_info[0], sys.version_info[1],
+                              (32, 64)[sys.maxsize > 2**32])
 
 
-def mkshortcut(target,description,link_file,*args,**kw):
-    """make a shortcut if it doesn't exist, and register its creation"""
-    
-    create_shortcut(target, description, link_file,*args,**kw)
-    file_created(link_file)
+def mkshortcut(target, description, linkdir, arguments="", iconpath='',
+               workdir="%HOMEDRIVE%%HOMEPATH%", iconindex=0):
+    """Make a shortcut if it doesn't exist and register its creation."""
+    filename = pjoin(linkdir, description + '.lnk')
+    description = "%s %s" % (description, pyver)
+    create_shortcut(target, description, filename, arguments, workdir,
+                    iconpath, iconindex)
+    file_created(filename)
+
+
+def arguments(scriptsdir, script, scriptargs=''):
+    """Return command line arguments to be passed to the python executable."""
+    cmdbase = suffix(pjoin(scriptsdir, script))
+    if have_setuptools:
+        cmdbase += '-script.py'
+    return '"%s" %s' % (cmdbase, scriptargs)
+
 
 def suffix(s):
-    """add '3' suffix to programs for Python 3"""
+    """Add '3' suffix to programs for Python 3."""
     if sys.version_info[0] == 3:
-        s = s+'3'
+        s = s + '3'
     return s
 
+
 def install():
     """Routine to be run by the win32 installer with the -install switch."""
-    
     # Get some system constants
-    prefix = sys.prefix
-    python = pjoin(prefix, 'python.exe')
-    pythonw = pjoin(prefix, 'pythonw.exe')
-    have_setuptools = 'setuptools' in sys.modules
-    
+    python = pjoin(sys.prefix, 'python.exe')
+    pythonw = pjoin(sys.prefix, 'pythonw.exe')
+
     if not have_setuptools:
         # This currently doesn't work without setuptools,
         # so don't bother making broken links
-        print("Distribute (setuptools) is required to create Start Menu items.", file=sys.stderr)
-        print("Re-run this installer after installing distribute to get Start Menu items.", file=sys.stderr)
+        print("Distribute (setuptools) is required to"
+              " create Start Menu items.", file=sys.stderr)
+        print("Re-run this installer after installing"
+              " distribute to get Start Menu items.", file=sys.stderr)
         return
-    
+
     # Lookup path to common startmenu ...
     ip_start_menu = pjoin(get_special_folder_path('CSIDL_COMMON_PROGRAMS'),
-                          'IPython (Py%i.%i %i bit)' % (sys.version_info[0],
-                                                        sys.version_info[1],
-                                                        8*tuple.__itemsize__))
+                          'IPython %s' % pyver)
+
     # Create IPython entry ...
     if not os.path.isdir(ip_start_menu):
         os.mkdir(ip_start_menu)
         directory_created(ip_start_menu)
-    
+
     # Create .py and .bat files to make things available from
     # the Windows command line.  Thanks to the Twisted project
     # for this logic!
@@ -60,10 +83,10 b' def install():'
         'ipcontroller',
         'ipengine',
         'ipcluster',
-        'irunner'
+        'irunner',
     ]
-    programs = [ suffix(p) for p in programs ]
-    scripts = pjoin(prefix,'scripts')
+    programs = [suffix(p) for p in programs]
+    scripts = pjoin(sys.prefix, 'scripts')
     if not have_setuptools:
         # only create .bat files if we don't have setuptools
         for program in programs:
@@ -73,66 +96,38 b' def install():'
             # Create .py versions of the scripts
             shutil.copy(raw, py)
             # Create .bat files for each of the scripts
-            bat_file = file(bat,'w')
+            bat_file = file(bat, 'w')
             bat_file.write("@%s %s %%*" % (python, py))
             bat_file.close()
 
-    # Now move onto setting the Start Menu up
-    ipybase = suffix(pjoin(scripts, 'ipython'))
-    if have_setuptools:
-        # let setuptools take care of the scripts:
-        ipybase = ipybase + '-script.py'
-    workdir = "%HOMEDRIVE%%HOMEPATH%"
-
-    link = pjoin(ip_start_menu, 'IPython.lnk')
-    cmd = '"%s"' % ipybase
-    mkshortcut(python, 'IPython', link, cmd, workdir)
-    
+    # Create Start Menu shortcuts
+    iconpath = pjoin(scripts, 'ipython.ico')
+    mkshortcut(python, 'IPython', ip_start_menu,
+               arguments(scripts, 'ipython'), iconpath)
+    mkshortcut(python, 'IPython (pylab mode)', ip_start_menu,
+               arguments(scripts, 'ipython', '--pylab'), iconpath)
+    mkshortcut(python, 'IPython Controller', ip_start_menu,
+               arguments(scripts, 'ipcontroller'), iconpath)
+    mkshortcut(python, 'IPython Engine', ip_start_menu,
+               arguments(scripts, 'ipengine'), iconpath)
+    mkshortcut(pythonw, 'IPython Qt Console', ip_start_menu,
+               arguments(scripts, 'ipython', 'qtconsole'), iconpath)
+
+    iconpath = pjoin(scripts, 'ipython_nb.ico')
+    mkshortcut(python, 'IPython Notebook', ip_start_menu,
+               arguments(scripts, 'ipython', 'notebook'), iconpath)
+
+    mkshortcut(pythonw, 'IPython Documentation', ip_start_menu,
+               '-m webbrowser -t "http://ipython.org/documentation.html',
+               iconpath='url.dll')
+
     # Disable pysh Start item until the profile restores functionality
     # Most of this code is in IPython/deathrow, and needs to be updated
     # to 0.11 APIs
-    
-    # link = pjoin(ip_start_menu, 'pysh.lnk')
-    # cmd = '"%s" profile=pysh --init' % ipybase
-    # mkshortcut(python, 'IPython (command prompt mode)', link, cmd, workdir)
-    
-    link = pjoin(ip_start_menu, 'pylab.lnk')
-    cmd = '"%s" --pylab' % ipybase
-    mkshortcut(python, 'IPython (pylab mode)', link, cmd, workdir)
-        
-    link = pjoin(ip_start_menu, 'ipcontroller.lnk')
-    cmdbase = suffix(pjoin(scripts, 'ipcontroller'))
-    if have_setuptools:
-        cmdbase += '-script.py'
-    cmd = '"%s"' % cmdbase
-    mkshortcut(python, 'IPython controller', link, cmd, workdir)
-    
-    link = pjoin(ip_start_menu, 'ipengine.lnk')
-    cmdbase = suffix(pjoin(scripts, 'ipengine'))
-    if have_setuptools:
-        cmdbase += '-script.py'
-    cmd = '"%s"' % cmdbase
-    mkshortcut(python, 'IPython engine', link, cmd, workdir)
+    #mkshortcut(python, 'IPython%s (command prompt mode)', ip_start_menu,
+    #           arguments(scripts, 'ipython', 'profile=pysh --init'))
+
 
-    link = pjoin(ip_start_menu, 'ipythonqt.lnk')
-    cmdbase = suffix(pjoin(scripts, 'ipython'))
-    if have_setuptools:
-        cmdbase += '-script.py'
-    cmd = '"%s" qtconsole' % cmdbase
-    mkshortcut(pythonw, 'IPython Qt Console', link, cmd, workdir)
-
-    # FIXME: These below are commented out because we don't ship the html built
-    # docs anymore.  We should make the shortcut to continue existing, but as a
-    # URL to the online the docs for the right version of IPython.  The stable
-    # URLs have the pattern:
-    # http://ipython.org/ipython-doc/rel-X.Y.Z/html
-    # For IPython version X.Y.Z.
-    
-    ## # Create documentation shortcuts ...
-    ## t = prefix + r'\share\doc\ipython\manual\index.html'
-    ## f = ip_start_menu + r'\Manual in HTML.lnk'
-    ## mkshortcut(t,'IPython Manual - HTML-Format',f)
-    
 def remove():
     """Routine to be run by the win32 installer with the -remove switch."""
     pass
@@ -144,8 +139,10 b' if len(sys.argv) > 1:'
         try:
             install()
         except OSError:
-            print("Failed to create Start Menu items, try running installer as administrator.", file=sys.stderr)
+            print("Failed to create Start Menu items, try running the"
+                  " installer as administrator.", file=sys.stderr)
     elif sys.argv[1] == '-remove':
         remove()
     else:
-        print("Script was called with option %s" % sys.argv[1], file=sys.stderr)
+        print("Script was called with option %s" % sys.argv[1],
+              file=sys.stderr)

setup.py

@@ -174,7 +174,7 b' from distutils.command.sdist import sdist'
 from distutils.command.upload import upload
 
 class UploadWindowsInstallers(upload):
-    
+
     description = "Upload Windows installers to PyPI (only used from tools/release_windows.py)"
     user_options = upload.user_options + [
         ('files=', 'f', 'exe file (or glob) to upload')
@@ -187,7 +187,7 b' class UploadWindowsInstallers(upload):'
             version=meta.get_version()
         )
         self.files = os.path.join('dist', '%s.*.exe' % base)
-    
+
     def run(self):
         for dist_file in glob(self.files):
             self.upload_file('bdist_wininst', 'any', dist_file)
@@ -256,11 +256,13 b" if 'setuptools' in sys.modules:"
                ('sdist' in sys.argv or 'bdist_rpm' in sys.argv):
             print >> sys.stderr, "ERROR: bdist_wininst must be run alone. Exiting."
             sys.exit(1)
+        setup_args['data_files'].append(
+            ['Scripts', ('scripts/ipython.ico', 'scripts/ipython_nb.ico')])
         setup_args['scripts'] = [pjoin('scripts','ipython_win_post_install.py')]
         setup_args['options'] = {"bdist_wininst":
                                  {"install_script":
                                   "ipython_win_post_install.py"}}
-    
+
     if PY3:
         setuptools_extra_args['use_2to3'] = True
         # we try to make a 2.6, 2.7, and 3.1 to 3.3 python compatible code