Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix docstrings related to the proxy databases so that they are correct.

Browse Source 
svn: r10885
This commit is contained in:
Brian Matherly
2008-07-20 22:15:15 +00:00
parent 97170b5251
commit ca62125e5b
3 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/gen/proxy/dbbase.py
View File

@@ -36,8 +36,12 @@ from gen.lib import *
class DbBase: class DbBase:
""" """
A proxy to a Gramps database. This proxy will act like a Gramps database, DbBase is intended to be an abstract base class for building classes that
but all data marked private will be hidden from the user. implement the Gramps database. All functions raise a NotImplementedError to
remind the developer to implement those functions.
Real database classes can inherit from this class to make sure the
database interface is properly implemented.
""" """
def set_prefixes(self, person, media, family, source, place, event, def set_prefixes(self, person, media, family, source, place, event,

3
src/gen/proxy/filter.py
View File

@@ -36,7 +36,8 @@ from proxybase import ProxyDbBase
class FilterProxyDb(ProxyDbBase): class FilterProxyDb(ProxyDbBase):
""" """
A proxy to a Gramps database. This proxy will act like a Gramps database, A proxy to a Gramps database. This proxy will act like a Gramps database,
but all data marked private will be hidden from the user. but all data that does not match the provided filters will be hidden from
the user.
""" """
def __init__(self, db, person_filter=None, event_filter=None): def __init__(self, db, person_filter=None, event_filter=None):

9
src/gen/proxy/proxybase.py
View File

@@ -33,8 +33,13 @@ from dbbase import DbBase
class ProxyDbBase(DbBase): class ProxyDbBase(DbBase):
""" """
A proxy to a Gramps database. This proxy will act like a Gramps database, ProxyDbBase is a base class for building a proxy to a Gramps database.
but all data marked private will be hidden from the user. This class attempts to implement functions that are likely to be common
among proxy classes. Functions that are not likely to be common raise a
NotImplementedError to remind the developer to implement those functions.
Real database proxy classes can inherit from this class to make sure the
database interface is properly implemented.
""" """
def __init__(self, db): def __init__(self, db):