Recent changes to patches

Use `wx.FileHistory`

Marc 'BlackJack' Rintsch — Thu, 26 Aug 2010 22:50:36 -0000

`wx` comes with a class to handle an MRU list that can be attached to a menu for things like file histories. I sublassed it to get a more Python sequence like behaviour (len(), read only index access, iterable) and moved the code to save and load the list into that class. This eliminated a little bit code repetition. Downside: Changing the number of recent files in the preferences needs a restart to become effective.

Coding cookie recognition

Marc 'BlackJack' Rintsch — Thu, 26 Aug 2010 10:30:01 -0000

The code to recognize the coding cookie did not cover all variations described in `PEP 263 <http://www.python.org/dev/peps/pep-0263/>`_. See section `Defining the Encoding` for examples.

The PEP already proposes a regular expression to extract the information. And the cookie is limited to the very first two lines of the source code.

No self defined IDs anymore

Marc 'BlackJack' Rintsch — Thu, 26 Aug 2010 00:48:43 -0000

"Literal IDs" are error prone and most of the time unnecessary. Getting rid of them makes the source code shorter and easier to maintain. Standard IDs of `wx` should be used if possible. Then there is no need to give the text of buttons and menu items, and on some platforms appropriate icons will be shown automatically. And the IDs `wx.ID_OK` and `wx.ID_CANCEL` have special meaning in `wx.Dialog`\s.

First patch is for `drFileDialogPrefs.py`.

Command line parsing

Marc 'BlackJack' Rintsch — Wed, 25 Aug 2010 21:09:15 -0000

Added and used two functions to get a command line option (a "flag") and an option with a value in order to reduce repeated code.

In the long run command line parsing should be done central and with `optparse` (or maybe `wx.CmdLineParser`?). This might need some changes in the way plugins get at command line options though, because `optparse` needs to know all possible options before parsing the command line. One possibility would be an option for plugin options. For example::

--plugin-options 'opt1 "opt 1" opt2'

The option's value could be parsed with `shlex` and bound to `sys.argv` after parsing the options for the main program. This way there would be no difference for existing plugins. Although I think that all accepted options should be known at parsing time, that is very early in the application's life cycle. Applications should fail with misspelled options and not ignore them.

Open files with `open()`

Marc 'BlackJack' Rintsch — Sat, 14 Aug 2010 17:07:11 -0000

Current code uses `file()` and `open()` to open files. Guido and Python documentation favors `open()` to open files and `file` to subclass the type. So this patch replaces all calls to `file()` by calls to `open()`.

No explicit comparisons against `True` and `False`

Marc 'BlackJack' Rintsch — Sat, 14 Aug 2010 11:37:57 -0000

Removed three unnecessary, explicit comparisons against `True` or `False`.

Logging

Marc 'BlackJack' Rintsch — Sat, 14 Aug 2010 10:23:41 -0000

First steps to use `logging` instead of ``print``.

Added module `drLogging` as home for the log related stuff. Currently contains just documentation -- including a todo list -- and an `init()` function that sets up logging and registers a cleanup for program exit.

In the main file a logger is creared and application startup and shutdown are logged at INFO level.

`SysOutListener` and `SysErrListener` have a `flush()` method now, which is required by file like objects passed into the `logging` system.

`DrApp.OnInit()` now has some documentation and an unused local name removed.

Values of the local variable `useredirecttofile` in `main()` function are of type `bool` now.

The filename for communicating with a running DrPython instance is a module level constant now.

80 character line

Marc 'BlackJack' Rintsch — Tue, 10 Aug 2010 21:19:48 -0000

PEP8 recommends max. 80 characters per line, so I think the reminding vertical line in the editor should be on per default.

Makefile for generating API docs and cleanup

Marc 'BlackJack' Rintsch — Tue, 10 Aug 2010 18:38:54 -0000

Epydoc documentation helps me a lot to find my way through the code. So I wrote a Makefile to make it easier to create apidocs. And a `clean` target is there too to delete the apidocs, python bytecode and backup files.

BTW is it possible that there is no svn:ignore on *.pyc files!?

Do no eval...

Marc 'BlackJack' Rintsch — Mon, 09 Aug 2010 19:53:08 -0000

Patch to try to get rid of the evil `eval()` in the main application. I didn't look at the plugins. In the main application they where really unnecessary.

One `eval()` was in `drpython.drObject` for a test if the object has a given attribute. That's what the builtin function `hasattr()` is meant for. Because it is almost easier to use `hasattr()` in the places where `drObject.VariableExists()` was called I replaced the calls there and in the DrScript documentation.

This leaves us with a class with just one deprecated method. So I deprecated the class itself too and replaced its only instanciation in the main program by a dynamicalle created class and instance for the shared attributes of the DrScript scripts.

While replacing the calls to `drObject.VariableExists()` I noticed that the DrScript examples `SetTerminalArgs.py` and `RunInTerminal.py` didn't work. The `-e` option doesn't work this way with ``rxvt``. But it does with ``xterm``. Which is also to be more likely available on a standard Linux installation. I replaced the invoked terminal of the example and cleaned up the code a little bit.