lib/wlrepo/__init__.py

   1 # -*- encoding: utf-8 -*-
   2 __author__="Łukasz Rekucki"
   3 __date__ ="$2009-09-18 10:49:24$"
   4 __doc__ = """Main module for the Repository Abstraction Layer"""
   5
   6 class Library(object):
   7
   8     def __init__(self, create=False):
   9         """Open an existing library, or create a new one. By default, fails if
  10         the library doesn't exist."""
  11         self.create = create
  12
  13     def documents(self):
  14         """List all documents in the library."""
  15         pass
  16
  17     def document_for_rev(self, rev):
  18         """Retrieve a document in the specified revision."""
  19         pass
  20
  21     def document(self, docid, user=None, rev='latest'):
  22         """Retrieve a document from a library."""
  23         pass
  24
  25     def get_revision(self, revid):
  26         """Retrieve a handle to a specified revision."""
  27         return None
  28
  29     def document_create(self, docid):
  30         """Create a new document. The document will have it's own branch."""
  31
  32
  33 class Document(object):
  34     """A class representing a document package boundled with a revision."""
  35
  36     def __init__(self, library, revision):
  37         """_library_ should be an instance of a Library."""
  38         self._library = library
  39         if isinstance(revision, Revision):
  40             self._revision = revision
  41         else:
  42             self._revision = library.get_revision(revision)
  43
  44
  45     def take(self, user):
  46         """Make a user copy of the document. This is persistant."""
  47         pass
  48
  49     def giveback(self):
  50         """Informs the library, that the user no longer needs this document.
  51         Should be called on the user version of document. If not, it doesn nothing."""
  52
  53     def data(self, entry):
  54         """Returns the specified entry as a unicode data."""
  55         pass
  56
  57     @property
  58     def library(self):
  59         return self._library
  60
  61     @property
  62     def revision(self):
  63         return self._revision
  64
  65     @property
  66     def id(self):
  67         return self._revision.document_name
  68
  69     @property
  70     def owner(self):
  71         return self._revision.user_name
  72
  73     def parentof(self, other):
  74         return self._revision.parentof(other._revision)
  75
  76     def has_parent_from(self, other):
  77         return self._revision.has_parent_from(other._revision)
  78
  79     def ancestorof(self, other):
  80         return self._revision.ancestorof(other._revision)
  81
  82
  83 class Revision(object):
  84
  85     def __init__(self, lib):
  86         self._library = lib
  87
  88     def parentof(self, other):
  89         return False
  90
  91     def ancestorof(self, other):
  92         return False
  93
  94     @property
  95     def document_name(self):
  96         raise ValueError()
  97
  98     @property
  99     def user_name(self):
 100         raise ValueError()
 101
 102 #
 103 # Exception classes
 104 #
 105
 106 class LibraryException(Exception):
 107     def __init__(self, msg, cause=None):
 108         Exception.__init__(self, msg)
 109         self.cause = cause
 110
 111 class UpdateException(LibraryException):
 112     pass
 113
 114 class RevisionNotFound(LibraryException):
 115     def __init__(self, rev):
 116         LibraryException.__init__(self, "Revision %r not found." % rev)
 117
 118 class RevisionMismatch(LibraryException):
 119     def __init__(self, fdi, rev):
 120         LibraryException.__init__(self, "No revision %r for document %r." % (rev, fdi))
 121
 122 class EntryNotFound(LibraryException):
 123     def __init__(self, rev, entry, guesses=[]):
 124         LibraryException.__init__(self, \
 125             u"Entry '%s' at revision %r not found. %s" % (entry, rev, \
 126             (u"Posible values:\n" + u',\n'.join(guesses)) if len(guesses) else u'') )
 127
 128 class DocumentAlreadyExists(LibraryException):
 129     pass
 130
 131 # import backends to local namespace
 132
 133 def open_library(path, proto, *args, **kwargs):
 134     if proto == 'hg':
 135         import wlrepo.mercurial_backend.library
 136         return wlrepo.mercurial_backend.library.MercurialLibrary(path, *args, **kwargs)
 137
 138     raise NotImplemented()