Rev 978: Add API for RepositoryLayout. in file:///data/jelmer/bzr-svn/layout/

[Jelmer Vernooij]

At file:///data/jelmer/bzr-svn/layout/

------------------------------------------------------------
revno: 978
revision-id: jelmer at samba.org-20080325001434-31may4n43ac656vh
parent: jelmer at samba.org-20080323165329-7qm8907p2dbha64f
committer: Jelmer Vernooij <jelmer at samba.org>
branch nick: layout
timestamp: Tue 2008-03-25 01:14:34 +0100
message:
  Add API for RepositoryLayout.
added:
  layout.py                      layout.py-20080323165407-y9qw8nx4oykvoe1k-1
=== added file 'layout.py'
--- a/layout.py	1970-01-01 00:00:00 +0000
+++ b/layout.py	2008-03-25 00:14:34 +0000
@@ -0,0 +1,53 @@
+# Copyright (C) 2005-2007 Jelmer Vernooij <jelmer at samba.org>
+ 
+# 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 3 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, see <http://www.gnu.org/licenses/>.
+
+
+class RepositoryLayout:
+    """Describes a repository layout."""
+    def get_tag_path(self, name, project=""):
+        """Return the path at which the tag with specified name should be found.
+
+        :param name: Name of the tag. 
+        :param project: Optional name of the project the tag is for. Can include slashes.
+        :return: Path of the tag."
+        """
+        raise NotImplementedError
+
+    def get_branch_path(self, name, project=""):
+        """Return the path at which the branch with specified name should be found.
+
+        :param name: Name of the branch. 
+        :param project: Optional name of the project the branch is for. Can include slashes.
+        :return: Path of the branch.
+        """
+        raise NotImplementedError
+
+    def parse(self, path):
+        """Parse a path.
+
+        :return: Tuple with type ('tag' or 'branch'), project name, branch name and path 
+            inside the branch
+        """
+        raise NotImplementedError
+
+    def get_branches(self, project="", revnum=None):
+        """Retrieve a list of paths that refer to branches in a specific revision.
+        """
+        raise NotImplementedError
+
+    def get_tags(self, project="", revnum=None):
+        """Retrieve a list of paths that refer to tags in a specific revision.
+        """
+        raise NotImplementedError