#1074 closed defect

get rid of tahoe.exe launcher — at Version 8

Reported by: zooko Owned by: davidsarah
Priority: major Milestone: 1.8β
Component: packaging Version: 1.6.1
Keywords: windows win64 setuptools unicode reviewed Cc: sneves
Launchpad Bug:

Description (last modified by davidsarah)

There is a binary (cli.exe) in the Tahoe-LAFS source tree under revision control. It is built from launcher.c in zetuptoolz:

http://tahoe-lafs.org/trac/zetuptoolz/browser/launcher.c

source:setup.py copies it to bin\tahoe.exe when building.

There are several reasons to get rid of this launcher:

  • it mangles any non-ASCII arguments, preventing us from fixing #565 on Windows;
  • it does not work on Win64;
  • it adds a small amount of overhead to running CLI commands;
  • it's unnecessary complexity;
  • it isn't in the spirit of open source to have a binary that is not compiled from source as part of our build process -- getting rid of it fixes this without complicating the build or requiring a C compiler;
  • a Python script called tahoe.py can be run just fine on Windows as tahoe, provided that the PATHEXT environment variable includes ".py".

Change History (9)

comment:1 Changed at 2010-06-08T18:56:09Z by davidsarah

  • Description modified (diff)
  • Owner changed from somebody to davidsarah
  • Status changed from new to assigned
  • Summary changed from there is a binary (cli.exe) in the Tahoe-LAFS source tree under revision control to get rid of tahoe.exe launcher

Changed at 2010-06-08T23:29:51Z by davidsarah

Attaching my work-in-progress for Unicode argument support on Windows and removal of tahoe.exe, so that it doesn't get lost.

comment:2 Changed at 2010-06-12T20:49:01Z by davidsarah

  • Milestone changed from 1.8.0 to 1.7.1

comment:3 follow-up: Changed at 2010-07-01T03:46:26Z by zooko

Is this going to require users to edit their PATHEXT environment variables in order to run Tahoe-LAFS? Or will installing Python do that for them? If we're going to make this change for v1.7.1 let us make it early in the release cycle so that users on Windows have plenty of time t let us know if it changes the behavior in a way that causes them problems.

comment:4 in reply to: ↑ 3 ; follow-up: Changed at 2010-07-01T19:27:35Z by davidsarah

Replying to zooko:

Is this going to require users to edit their PATHEXT environment variables in order to run Tahoe-LAFS? Or will installing Python do that for them?

Installing Python does not edit PATHEXT. But it's very easy to do so without going through the GUI:

setx PATHEXT "%PATHEXT%;.PY"

This takes effect for any new instances of cmd.exe run by the current user. (There is an /m option to set the variable for all users on the current machine, but it will typically fail on Vista and later unless you run setx with elevation, and I don't think we need to do that anyway.)

setx.exe is an executable in %SystemRoot%\system32, it's not a cmd.exe builtin. To set PATHEXT for the current cmd.exe instance as well (e.g. in a batch file), also do set "PATHEXT=%PATHEXT%;.PY", which is a builtin.

Installing Python does associate the .py extension with that Python interpreter, so even without the setx command, it's sufficient to run tahoe.py from the command-line instead of tahoe.

If we're going to make this change for v1.7.1 let us make it early in the release cycle so that users on Windows have plenty of time to let us know if it changes the behavior in a way that causes them problems.

OK, that makes sense.

comment:5 in reply to: ↑ 4 Changed at 2010-07-01T19:35:37Z by davidsarah

Replying to davidsarah:

Replying to zooko:

Is this going to require users to edit their PATHEXT environment variables in order to run Tahoe-LAFS? Or will installing Python do that for them?

Installing Python does not edit PATHEXT. But it's very easy to do so without going through the GUI:

setx PATHEXT "%PATHEXT%;.PY"

On WinXP Service Pack 2 and later, apparently. But we can probably assume that. (If any system running earlier Windows is connected to the Internet and still usably free of malware, I'd be surprised.)

comment:6 Changed at 2010-07-08T04:52:19Z by zooko

  • Priority changed from major to critical

This issue appears to be blocking some of our buildbots from working (unless I misunderstand):

http://tahoe-lafs.org/buildbot/builders/Soultcer%20Win7-64%20py2.6 http://tahoe-lafs.org/buildbot/builders/Dcoder%20Win7-64%20py2.6

Also I think it is blocking #565. Let's prioritize this ticket! What's the next step? I think it is to decide if we want the new install docs to instruct all users on all platforms to execute a file named "tahoe.py" instead of a file named "tahoe", or if we want the install docs to differ depending on platform here, or what.

I don't fully understand how things would change at this level -- install docs and user experience -- if we got rid of tahoe.exe.

comment:7 follow-up: Changed at 2010-07-10T19:48:40Z by zeromus

I don't speak for every windows user, but I can try to. Once a windows user has gone to the trouble to install python and build tahoe, I don't think he cares whether he has to double click tahoe.exe or tahoe.py. It is going to feel gross to him, and very likely unacceptably so, compared to a redistributable zipfile with an executable in it, e.g. a py2exe frozen thingy.

I advise you not to sweat this exe at all and focus on making sure the py2exe process is working instead.

Folks who use python and windows will have a different opinion, because they're used to this.

comment:8 in reply to: ↑ 7 Changed at 2010-07-10T21:00:42Z by davidsarah

  • Description modified (diff)
  • Keywords win64 added

Replying to zeromus:

I don't speak for every windows user, but I can try to. Once a windows user has gone to the trouble to install python and build tahoe, I don't think he cares whether he has to double click tahoe.exe or tahoe.py.

This is the command-line interface. The user isn't double-clicking anything; they're typing "tahoe ...args..." at a Command Prompt. (Or a cygwin shell prompt; we don't support cygwin, but I don't want to break Tahoe on cygwin unnecessarily.)

Apart possibly from running an extra command in the install process to set up PATHEXT, the difference between tahoe.exe and tahoe.py is an implementation detail that doesn't affect the user interface.

For bbfreeze, which is similar to py2exe, see #585 -- but I think that's a distraction as far as this ticket is concerned, since we don't want to create a dependency on bbfreeze (or py2exe).

Note: See TracTickets for help on using tickets.