2007-06-03 Don Allingham <don@gramps-project.org>

* src/Simple/__init__.py: add



svn: r8531

ChangeLog

@@ -1,3 +1,6 @@
+2007-06-03  Don Allingham  <don@gramps-project.org>
+	* src/Simple/__init__.py: add
+
 2007-06-01  Alex Roitman  <shura@gramps-project.org>
 	* src/DbLoader.py (_OPEN_FORMATS): Remove grdb from the native
 	format list.

INSTALL

@@ -1,98 +1,236 @@
-$Id$
+Installation Instructions
+*************************
 
-This file contains some useful details on the installation from source code
+Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
-for GRAMPS. It does not cover installation of a pre-built binary package.
+Software Foundation, Inc.
-For that use your package manager, the rest is already done by the packager.
 
+This file is free documentation; the Free Software Foundation gives
+unlimited permission to copy, distribute and modify it.
 
-configure vs autogen scripts
+Basic Installation
-----------------------------
+==================
-If you are building from released tarball, you should be able to just
-run "./configure && make". However, if you're building from the SVN,
-the configure is not present. You should auto-generate it by
-running ./autogen.sh and then "make" and, finally, "make install".
 
-Running ./autogen.sh on this branch of gramps requires the following
+These are generic installation instructions.
-packages to be installed:
-   * automake-1.9
-   * gnome-common
-   * intltool
-   * libglib2.0-dev (may be called differently on other distros) and
-maybe something else. If autogen.sh fails, it should inform you what's
-missing.
 
+   The `configure' shell script attempts to guess correct values for
+various system-dependent variables used during compilation.  It uses
+those values to create a `Makefile' in each directory of the package.
+It may also create one or more `.h' files containing system-dependent
+definitions.  Finally, it creates a shell script `config.status' that
+you can run in the future to recreate the current configuration, and a
+file `config.log' containing compiler output (useful mainly for
+debugging `configure').
 
-Regular vs local installation
+   It can also use an optional file (typically called `config.cache'
------------------------------
+and enabled with `--cache-file=config.cache' or simply `-C') that saves
-This version of gramps requires, among others, the two things to be done:
+the results of its tests to speed up reconfiguring.  (Caching is
-gconf schemas and mime types for gramps MUST be properly installed.
+disabled by default to prevent problems with accidental use of stale
-The usual ./configure, make, and make install as a root should do the trick.
+cache files.)
-But be careful if you're using the non-default options or would like
-to install without being root.
 
-The latter is possible, but you should supply additional arguments to
+   If you need to do unusual things to compile the package, please try
-autogen or configure:
+to figure out how `configure' could check whether to do them, and mail
-   --with-gconf-source=xml::$HOME/.gconf
+diffs or instructions to the address given in the `README' so they can
-   --with-gconf-schema-file-dir=$HOME
+be considered for the next release.  If you are using the cache, and at
-   --with-mime-dir=$HOME/.local/share/mime
+some point `config.cache' contains results you don't want to keep, you
-   --disable-scrollkeeper
+may remove or edit it.
-Most likely, such local install will also need some prefix with write
-permissions for you:
-   --prefix=$HOME/my_gramps_path
 
-Whether you're doing local install or regular install,
+   The file `configure.ac' (or `configure.in') is used to create
-YOU MUST INSTALL GCONF SCHEMAS AND MIME TYPES.
+`configure' by a program called `autoconf'.  You only need
-YOU HAVE BEEN WARNED!
+`configure.ac' if you want to change it or regenerate `configure' using
+a newer version of `autoconf'.
 
+The simplest way to compile this package is:
 
-Installing under non-default prefix
+  1. `cd' to the directory containing the package's source code and type
------------------------------------
+     `./configure' to configure the package for your system.  If you're
-As hinted above, the gconf schemas and mime types for gramps
+     using `csh' on an old version of System V, you might need to type
-MUST be properly installed. The "proper install" means installing
+     `sh ./configure' instead to prevent `csh' from trying to execute
-them where gconfd and shared mime system, respectively, will
+     `configure' itself.
-find them.
 
-By default, gconfd will look in these places:
+     Running `configure' takes awhile.  While running, it prints some
-   1. Whatever is returned by running:
+     messages telling which features it is checking for.
-      $ gconftool-2 --get-default-source
-   2. The xml::$HOME/.gconf        : this is a per-user setup, not system-wide
-      or  xml:merged:$HOME/.gconf  : this is a per-user setup, not system-wide
-There is a number of ways to let gconfd know where else
-to look, but this is outside the scope of installing gramps.
 
-By default, the shared mime systems will look in these places:
+  2. Type `make' to compile the package.
-   1. /usr/share/mime
-   2. /usr/local/share/mime   : this may be broken on some systems
-   3. $HOME/.local/share/mime : this is a per-user setup, not system-wide
-Likewise, there's a number of ways to instruct the shared mime system
-to look in other places, but this is the whole other story.
 
-So if you install some place other than /usr/share, you will most
+  3. Optionally, type `make check' to run any self-tests that come with
-likely need to add this option to autogen.sh/configure scripts:
+     the package.
-   --with-mime-dir=/usr/share/mime
 
-Using the --prefix=/usr/share and installing as a root will most
+  4. Type `make install' to install the programs and any data files and
-likely do everything correctly, so no extra care needs to be
+     documentation.
-taken. You should take extra care only if you are installing under
-something like --prefix=/usr/local/my_gramps, /var/gramps123/blah, etc.
 
+  5. You can remove the program binaries and object files from the
+     source code directory by typing `make clean'.  To also remove the
+     files that `configure' created (so you can compile the package for
+     a different kind of computer), type `make distclean'.  There is
+     also a `make maintainer-clean' target, but that is intended mainly
+     for the package's developers.  If you use it, you may have to get
+     all sorts of other programs in order to regenerate files that came
+     with the distribution.
 
-Packager's issues
+Compilers and Options
-------------------
+=====================
-The above mentioned gconf schemas and mime types must be installed.
+
-However, the update-mime-database and the gconftool-2 calls to process
+Some systems require unusual options for compilation or linking that the
-the newly installed types and schemas must be done in POST-INSTALLATION.
+`configure' script does not know about.  Run `./configure --help' for
-In packager's world, the install happens on packager's machine
+details on some of the pertinent environment variables.
-into something like /tmp/gramps-tmp. However, the postinstall
+
-should happen on the user's machine.
+   You can give `configure' initial values for configuration parameters
+by setting variables in the command line or in the environment.  Here
+is an example:
+
+     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
+
+   *Note Defining Variables::, for more details.
+
+Compiling For Multiple Architectures
+====================================
+
+You can compile the package for more than one kind of computer at the
+same time, by placing the object files for each architecture in their
+own directory.  To do this, you must use a version of `make' that
+supports the `VPATH' variable, such as GNU `make'.  `cd' to the
+directory where you want the object files and executables to go and run
+the `configure' script.  `configure' automatically checks for the
+source code in the directory that `configure' is in and in `..'.
+
+   If you have to use a `make' that does not support the `VPATH'
+variable, you have to compile the package for one architecture at a
+time in the source code directory.  After you have installed the
+package for one architecture, use `make distclean' before reconfiguring
+for another architecture.
+
+Installation Names
+==================
+
+By default, `make install' installs the package's commands under
+`/usr/local/bin', include files under `/usr/local/include', etc.  You
+can specify an installation prefix other than `/usr/local' by giving
+`configure' the option `--prefix=PREFIX'.
+
+   You can specify separate installation prefixes for
+architecture-specific files and architecture-independent files.  If you
+pass the option `--exec-prefix=PREFIX' to `configure', the package uses
+PREFIX as the prefix for installing programs and libraries.
+Documentation and other data files still use the regular prefix.
+
+   In addition, if you use an unusual directory layout you can give
+options like `--bindir=DIR' to specify different values for particular
+kinds of files.  Run `configure --help' for a list of the directories
+you can set and what kinds of files go in them.
+
+   If the package supports it, you can cause programs to be installed
+with an extra prefix or suffix on their names by giving `configure' the
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+
+Optional Features
+=================
+
+Some packages pay attention to `--enable-FEATURE' options to
+`configure', where FEATURE indicates an optional part of the package.
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE
+is something like `gnu-as' or `x' (for the X Window System).  The
+`README' should mention any `--enable-' and `--with-' options that the
+package recognizes.
+
+   For packages that use the X Window System, `configure' can usually
+find the X include and library files automatically, but if it doesn't,
+you can use the `configure' options `--x-includes=DIR' and
+`--x-libraries=DIR' to specify their locations.
+
+Specifying the System Type
+==========================
+
+There may be some features `configure' cannot figure out automatically,
+but needs to determine by the type of machine the package will run on.
+Usually, assuming the package is built to be run on the _same_
+architectures, `configure' can figure that out, but if it prints a
+message saying it cannot guess the machine type, give it the
+`--build=TYPE' option.  TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name which has the form:
+
+     CPU-COMPANY-SYSTEM
+
+where SYSTEM can have one of these forms:
+
+     OS KERNEL-OS
+
+   See the file `config.sub' for the possible values of each field.  If
+`config.sub' isn't included in this package, then this package doesn't
+need to know the machine type.
+
+   If you are _building_ compiler tools for cross-compiling, you should
+use the option `--target=TYPE' to select the type of system they will
+produce code for.
+
+   If you want to _use_ a cross compiler, that generates code for a
+platform different from the build platform, you should specify the
+"host" platform (i.e., that on which the generated programs will
+eventually be run) with `--host=TYPE'.
+
+Sharing Defaults
+================
+
+If you want to set default values for `configure' scripts to share, you
+can create a site shell script called `config.site' that gives default
+values for variables like `CC', `cache_file', and `prefix'.
+`configure' looks for `PREFIX/share/config.site' if it exists, then
+`PREFIX/etc/config.site' if it exists.  Or, you can set the
+`CONFIG_SITE' environment variable to the location of the site script.
+A warning: not all `configure' scripts look for a site script.
+
+Defining Variables
+==================
+
+Variables not defined in a site shell script can be set in the
+environment passed to `configure'.  However, some packages may run
+configure again during the build, and the customized values of these
+variables may be lost.  In order to avoid this problem, you should set
+them in the `configure' command line, using `VAR=value'.  For example:
+
+     ./configure CC=/usr/local2/bin/gcc
+
+causes the specified `gcc' to be used as the C compiler (unless it is
+overridden in the site shell script).  Here is a another example:
+
+     /bin/bash ./configure CONFIG_SHELL=/bin/bash
+
+Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
+configuration-related scripts to be executed by `/bin/bash'.
+
+`configure' Invocation
+======================
+
+`configure' recognizes the following options to control how it operates.
+
+`--help'
+`-h'
+     Print a summary of the options to `configure', and exit.
+
+`--version'
+`-V'
+     Print the version of Autoconf used to generate the `configure'
+     script, and exit.
+
+`--cache-file=FILE'
+     Enable the cache: use and save the results of the tests in FILE,
+     traditionally `config.cache'.  FILE defaults to `/dev/null' to
+     disable caching.
+
+`--config-cache'
+`-C'
+     Alias for `--cache-file=config.cache'.
+
+`--quiet'
+`--silent'
+`-q'
+     Do not print messages saying which checks are being made.  To
+     suppress all normal output, redirect it to `/dev/null' (any error
+     messages will still be shown).
+
+`--srcdir=DIR'
+     Look for the package's source code in directory DIR.  Usually
+     `configure' can determine that directory automatically.
+
+`configure' also accepts some other, not widely useful, options.  Run
+`configure --help' for more details.
 
-To assist with that, there's an argument available in configure
-(or autogen, which will pass it to configure) which disables
-the gconf schema and mime type processing:
-   --enable-packager-mode
-This argument should disable postinstall calls made during
-make install, and print a nasty warning during configure.
-IT IS PACKAGER'S RESPONSIBILITY to follow the advice given
-by the configure output and to copy the appropriate code
-from the src/data/Makefile.am into the post-install (and post-uninstall)
-of the particular packaging system.

src/BasicUtils/BasicUtils.py

@@ -46,7 +46,7 @@ class UpdateCallback:
     things during lenghty operations.
     """
 
-    def __init__(self,callback,interval=1):
+    def __init__(self, callback, interval=1):
         """
         @param callback: a function with one arg to execute every so often
         @type callback: function

src/DateHandler/Makefile.am

@@ -29,6 +29,15 @@ MOSTLYCLEANFILES = *pyc *pyo
 
 GRAMPS_PY_MODPATH = ".."
 
+docfiles=\
+	_DateDisplay.py\
+	_DateParser.py\
+	_DateHandler.py\
+	_DateUtils.py
+
+docs:
+	export PYTHONPATH='..'; epydoc --graph=umlclasstree -o ../html --url http://gramps-project.org --name GRAMPS --html $(docfiles)
+
 pycheck: 
 	(export PYTHONPATH=$(GRAMPS_PY_MODPATH); \
 	pychecker $(pkgdata_PYTHON));

src/DbLoader.py

@@ -75,7 +75,7 @@ _KNOWN_FORMATS = {
     const.app_gedcom        : _('GEDCOM'), 
 }
 
-_OPEN_FORMATS = [const.app_gramps_xml, const.app_gedcom]
+OPEN_FORMATS = [const.app_gramps_xml, const.app_gedcom]
 
 #-------------------------------------------------------------------------
 #
@@ -101,7 +101,7 @@ class DbLoader:
         add_xml_filter(choose)
         add_gedcom_filter(choose)
 
-        (box, type_selector) = format_maker(_OPEN_FORMATS)
+        (box, type_selector) = format_maker(OPEN_FORMATS)
         choose.set_extra_widget(box)
 
         choose.set_current_folder(get_default_dir())
@@ -117,7 +117,7 @@ class DbLoader:
                 filetype = Mime.get_type(filename)
             (the_path, the_file) = os.path.split(filename)
             choose.destroy()
-            if filetype in _OPEN_FORMATS:
+            if filetype in OPEN_FORMATS:
                 self.read_file(filename, filetype)
                 try:
                     os.chdir(os.path.dirname(filename))
@@ -213,7 +213,7 @@ class DbLoader:
         add_xml_filter(choose)
         add_gedcom_filter(choose)
 
-        (box, type_selector) = format_maker(_OPEN_FORMATS)
+        (box, type_selector) = format_maker(OPEN_FORMATS)
         choose.set_extra_widget(box)
 
         default_dir = get_default_dir()
@@ -246,7 +246,7 @@ class DbLoader:
                         str(msg))
                     return ('','')
             # First we try our best formats
-            if filetype not in _OPEN_FORMATS:
+            if filetype not in OPEN_FORMATS:
                 QuestionDialog.ErrorDialog(
                     _("Could not open file: %s") % filename,
                     _("Unknown type: %s") % filetype
@@ -290,7 +290,7 @@ class DbLoader:
         add_xml_filter(choose)
         add_gedcom_filter(choose)
 
-        format_list = _OPEN_FORMATS[:]
+        format_list = OPEN_FORMATS
 
         # Add more data type selections if opening existing db
         for data in import_list:
@@ -336,7 +336,7 @@ class DbLoader:
                     return False
                     
             # First we try our best formats
-            if filetype in _OPEN_FORMATS:
+            if filetype in OPEN_FORMATS:
                 importer = GrampsDbUtils.gramps_db_reader_factory(filetype)
                 self.do_import(choose, importer, filename)
                 return True
@@ -549,7 +549,7 @@ def add_gramps_files_filter(chooser):
     """
     mime_filter = gtk.FileFilter()
     mime_filter.set_name(_('All GRAMPS files'))
-    for fmt in _OPEN_FORMATS:
+    for fmt in OPEN_FORMATS:
         mime_filter.add_mime_type(fmt)
     chooser.add_filter(mime_filter)
 

src/GrampsDb/Makefile.am

@@ -9,6 +9,7 @@ pkgdata_PYTHON = \
 	_DbUtils.py \
 	_GrampsBSDDB.py\
 	_GrampsDbBase.py\
+	_GrampsCursor.py\
 	_GrampsDBCallback.py\
 	_GrampsDbExceptions.py\
 	_GrampsDbFactories.py\

src/GrampsDb/_GrampsDBDir.py

@@ -51,6 +51,7 @@ from _DbUtils import db_copy
 import _GrampsDbConst as const
 from _GrampsDbExceptions import FileVersionError
 from BasicUtils import UpdateCallback
+from _GrampsCursor import GrampsCursor
 
 _MINVERSION = 9
 _DBVERSION = 13
@@ -1168,42 +1169,42 @@ class GrampsDBDir(GrampsDbBase,UpdateCallback):
             transaction.add(key,handle,old_data,None)
             del_list.append(handle)
 
-    def _del_person(self,handle):
+    def __del_person(self,handle):
         self.person_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.person_map.sync()
 
-    def _del_source(self,handle):
+    def __del_source(self,handle):
         self.source_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.source_map.sync()
 
-    def _del_repository(self,handle):
+    def __del_repository(self,handle):
         self.repository_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.repository_map.sync()
 
-    def _del_note(self,handle):
+    def __del_note(self,handle):
         self.note_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.note_map.sync()
 
-    def _del_place(self,handle):
+    def __del_place(self,handle):
         self.place_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.place_map.sync()
 
-    def _del_media(self,handle):
+    def __del_media(self,handle):
         self.media_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.media_map.sync()
 
-    def _del_family(self,handle):
+    def __del_family(self,handle):
         self.family_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.family_map.sync()
 
-    def _del_event(self,handle):
+    def __del_event(self,handle):
         self.event_map.delete(str(handle),txn=self.txn)
         if not self.UseTXN:
             self.event_map.sync()
@@ -1325,7 +1326,7 @@ class GrampsDBDir(GrampsDbBase,UpdateCallback):
         return self._get_obj_from_gramps_id(val,self.nid_trans,Note,
                                             self.note_map)
 
-    def _commit_base(self, obj, data_map, key, update_list, add_list,
+    def __commit_base(self, obj, data_map, key, update_list, add_list,
                      transaction, change_time):
         """
         Commits the specified object to the database, storing the changes

src/GrampsDb/_GrampsInMemDB.py

@@ -39,6 +39,7 @@ import time
 #-------------------------------------------------------------------------
 from RelLib import *
 from _GrampsDbBase import *
+from _GrampsCursor import GrampsCursor
 
 class GrampsInMemCursor(GrampsCursor):
     """
@@ -81,26 +82,7 @@ class GrampsInMemDB(GrampsDbBase):
     def __init__(self):
         """creates a new GrampsDB"""
         GrampsDbBase.__init__(self)
-        self.person_map       = {}
-        self.name_group       = {}
-        self.family_map       = {}
-        self.place_map        = {}
-        self.source_map       = {}
-        self.repository_map   = {}
-        self.note_map         = {}
-        self.media_map        = {}
-        self.event_map        = {}
-        self.metadata         = {}
         self.filename         = ""
-        self.id_trans         = {}
-        self.pid_trans        = {}
-        self.fid_trans        = {}
-        self.eid_trans        = {}
-        self.sid_trans        = {}
-        self.rid_trans        = {}
-        self.nid_trans        = {}
-        self.oid_trans        = {}
-        self.undodb           = []
 
     def load(self,name,callback,mode="w"):
         self.full_name = name
@@ -181,42 +163,42 @@ class GrampsInMemDB(GrampsDbBase):
         if do_remove:
             self.surname_list.remove(unicode(name))
 
-    def _del_person(self,handle):
+    def __del_person(self,handle):
         person = self.get_person_from_handle(str(handle))
         del self.id_trans[person.get_gramps_id()]
         del self.person_map[str(handle)]
 
-    def _del_source(self,handle):
+    def __del_source(self,handle):
         source = self.get_source_from_handle(str(handle))
         del self.sid_trans[source.get_gramps_id()]
         del self.source_map[str(handle)]
 
-    def _del_repository(self,handle):
+    def __del_repository(self,handle):
         repository = self.get_repository_from_handle(str(handle))
         del self.rid_trans[repository.get_gramps_id()]
         del self.repository_map[str(handle)]
 
-    def _del_note(self,handle):
+    def __del_note(self,handle):
         note = self.get_note_from_handle(str(handle))
         del self.nid_trans[note.get_gramps_id()]
         del self.note_map[str(handle)]
 
-    def _del_place(self,handle):
+    def __del_place(self,handle):
         place = self.get_place_from_handle(str(handle))
         del self.pid_trans[place.get_gramps_id()]
         del self.place_map[str(handle)]
 
-    def _del_media(self,handle):
+    def __del_media(self,handle):
         obj = self.get_object_from_handle(str(handle))
         del self.oid_trans[obj.get_gramps_id()]
         del self.media_map[str(handle)]
 
-    def _del_family(self,handle):
+    def __del_family(self,handle):
         family = self.get_family_from_handle(str(handle))
         del self.fid_trans[family.get_gramps_id()]
         del self.family_map[str(handle)]
 
-    def _del_event(self,handle):
+    def __del_event(self,handle):
         event = self.get_event_from_handle(str(handle))
         del self.eid_trans[event.get_gramps_id()]
         del self.event_map[str(handle)]
@@ -263,7 +245,7 @@ class GrampsInMemDB(GrampsDbBase):
             trans_map[data[self.ID_INDEX]] = str(handle)
             self.emit(signal, ([handle], ))
     
-    def _commit_inmem_base(self,obj,db_map,trans_map):
+    def __commit_inmem_base(self,obj,db_map,trans_map):
         if self.readonly or not obj or not obj.get_handle():
             return False
         gid = obj.gramps_id
@@ -276,44 +258,44 @@ class GrampsInMemDB(GrampsDbBase):
         return True
 
     def commit_person(self,person,transaction,change_time=None):
-        if not self._commit_inmem_base(person,self.person_map,self.id_trans):
+        if not self.__commit_inmem_base(person,self.person_map,self.id_trans):
             return
         GrampsDbBase.commit_person(self,person,transaction,change_time)
 
     def commit_place(self,place,transaction,change_time=None):
-        if not self._commit_inmem_base(place,self.place_map,self.pid_trans):
+        if not self.__commit_inmem_base(place,self.place_map,self.pid_trans):
             return
         GrampsDbBase.commit_place(self,place,transaction,change_time)
 
     def commit_family(self,family,transaction,change_time=None):
-        if not self._commit_inmem_base(family,self.family_map,self.fid_trans):
+        if not self.__commit_inmem_base(family,self.family_map,self.fid_trans):
             return
         GrampsDbBase.commit_family(self,family,transaction,change_time)
 
     def commit_event(self,event,transaction,change_time=None):
-        if not self._commit_inmem_base(event,self.event_map,self.eid_trans):
+        if not self.__commit_inmem_base(event,self.event_map,self.eid_trans):
             return
         GrampsDbBase.commit_event(self,event,transaction,change_time)
 
     def commit_media_object(self,obj,transaction,change_time=None):
-        if not self._commit_inmem_base(obj,self.media_map,self.oid_trans):
+        if not self.__commit_inmem_base(obj,self.media_map,self.oid_trans):
             return
         GrampsDbBase.commit_media_object(self,obj,transaction,change_time)
 
     def commit_source(self,source,transaction,change_time=None):
-        if not self._commit_inmem_base(source,self.source_map,self.sid_trans):
+        if not self.__commit_inmem_base(source,self.source_map,self.sid_trans):
             return
         GrampsDbBase.commit_source(self,source,transaction,change_time)
 
     def commit_repository(self,repository,transaction,change_time=None):
-        if not self._commit_inmem_base(repository,self.repository_map,
+        if not self.__commit_inmem_base(repository,self.repository_map,
                                        self.rid_trans):
             return
         GrampsDbBase.commit_repository(self,repository,transaction,change_time)
 
     def commit_note(self,note,transaction,change_time=None):
-        if not self._commit_inmem_base(note, self.note_map,
+        if not self.__commit_inmem_base(note, self.note_map,
-                                       self.nid_trans):
+                                        self.nid_trans):
             return
         GrampsDbBase.commit_note(self,note,transaction,change_time)
 

src/GrampsDb/_ProgressMonitor.py

@@ -1,3 +1,23 @@
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2007  Richard Taylor
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+
 """
 This module provides a progess dialog for displaying the status of 
 long running operations.
@@ -45,7 +65,7 @@ class ProgressMonitor(object):
                  popup_time = None):
         """
         @param dialog_class: A class used to display the progress dialog.
-        @type dialog_class: L{_GtkProgressDialog} or the same interface.
+        @type dialog_class: _GtkProgressDialog or the same interface.
         
         @param dialog_class_params: A tuple that will be used as the initial
         arguments to the dialog_class, this might be used for passing in 
@@ -138,4 +158,4 @@ class ProgressMonitor(object):
         facade.status_obj.disconnect(facade.end_cb_id)
         del self._status_stack[idx]
         
-        
+        

src/Makefile.am

@@ -84,7 +84,7 @@ gdir_PYTHON = \
 MOSTLYCLEANFILES = *pyc *pyo
 
 # Which modules to document
-docmodules = RelLib DateHandler GrampsDb Filters ReportBase GrampsDbUtils 
+docmodules = RelLib DateHandler GrampsDb Simple #Filters ReportBase GrampsDbUtils 
 
 pycheck: 
 	for d in $(SUBDIRS) ; do \
@@ -93,8 +93,7 @@ pycheck:
 	pychecker $(gdir_PYTHON)
 
 docs:
-	epydoc -o doc --url http://gramps-project.org --name GRAMPS --html $(docmodules)
+	epydoc -v -o html --html --exclude gtk --no-private --show-imports --url=http://gramps-project.org  --graph=umlclasstree $(docmodules)
-	epydoc --pdf $(docmodules)
 
 cmdplug:
 	./build_cmdplug

src/Simple/_SimpleAccess.py

@@ -542,9 +542,6 @@ class SimpleAccess:
 
         @param obj: Person or Family
         @type obj: L{RelLib.Person} or L{RelLib.Family}
-        @param restrict: Optional list of strings that will limit the types
-        of events to those of the specfied types.
-        @type restrict: list
         @return: list of events assocated with the object
         @rtype: list
         """

src/Simple/__init__.py

@@ -0,0 +1,31 @@
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2001  David R. Hampton
+# Copyright (C) 2001-2006  Donald N. Allingham
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+
+# $Id: __init__.py 7972 2007-01-24 19:45:57Z pez4brian $
+
+"Simple access routines"
+
+__author__ =  "Donald N. Allingham"
+__version__ = "$Revision: 7972 $"
+
+from _SimpleAccess import *
+from _SimpleDoc import *
+