changeset 123:cdde1656346f

client: add 'hidden' property to show hidden changesets. This enables interactions with the obsolete changesets in the repository: - add the attribute in client class - add the keyword to the relevant commands - enable log without hidden changesets even when self.hidden is True - add a few tests with the hidden keyword This changeset mirrors the behavior of the mercurial global command --hidden: an attribute is added to the client library. If set at True, adds the hidden keyword to all command which can use it to show hidden changesets. The alternative would be to add the keyword in rawcommand, but the hidden flag is not relevant for commands such as add or branch.
author Paul Tonelli <paul.tonelli@logilab.fr>
date Thu, 22 May 2014 15:23:12 +0200
parents e05b0cf920bb
children cc7569bffb26
files hglib/client.py tests/test-hidden.py
diffstat 2 files changed, 85 insertions(+), 23 deletions(-) [+]
line wrap: on
line diff
--- a/hglib/client.py	Wed Apr 30 16:44:59 2014 +0200
+++ b/hglib/client.py	Thu May 22 15:23:12 2014 +0200
@@ -54,6 +54,8 @@
 
         self.server = None
         self._version = None
+        #include the hidden changesets if True 
+        self.hidden = None
 
         if connect:
             self.open()
@@ -282,7 +284,8 @@
 
         args = cmdbuilder('annotate', r=rev, no_follow=nofollow, a=text,
                           u=user, f=file, d=date, n=number, c=changeset,
-                          l=line, v=verbose, I=include, X=exclude, *files)
+                          l=line, v=verbose, I=include, X=exclude,
+                          hidden=self.hidden, *files)
 
         out = self.rawcommand(args)
 
@@ -324,7 +327,8 @@
         exclude - exclude names matching the given patterns
         """
         args = cmdbuilder('archive', dest, r=rev, no_decode=nodecode, p=prefix,
-                          t=type, S=subrepos, I=include, X=exclude)
+                          t=type, S=subrepos, I=include, X=exclude,
+                          hidden=self.hidden)
 
         self.rawcommand(args)
 
@@ -351,7 +355,8 @@
             raise ValueError("cannot specify both a message and a logfile")
 
         args = cmdbuilder('backout', r=rev, merge=merge, parent=parent, t=tool,
-                          m=message, l=logfile, d=date, u=user)
+                          m=message, l=logfile, d=date, u=user,
+                          hidden=self.hidden)
 
         self.rawcommand(args)
 
@@ -380,7 +385,8 @@
 
         If there isn't a current one, -1 is returned as the index.
         """
-        out = self.rawcommand(['bookmarks'])
+        args = cmdbuilder('bookmarks', hidden=self.hidden)
+        out = self.rawcommand(args)
 
         bms = []
         current = -1
@@ -429,7 +435,7 @@
         active - show only branches that have unmerged heads
         closed - show normal and closed branches
         """
-        args = cmdbuilder('branches', a=active, c=closed)
+        args = cmdbuilder('branches', a=active, c=closed, hidden=self.hidden)
         out = self.rawcommand(args)
 
         branches = []
@@ -469,7 +475,7 @@
         """
         args = cmdbuilder('bundle', file, destrepo, f=force, r=rev, b=branch,
                           base=base, a=all, t=type, e=ssh, remotecmd=remotecmd,
-                          insecure=insecure)
+                          insecure=insecure, hidden=self.hidden)
 
         eh = util.reterrorhandler(args)
         self.rawcommand(args, eh=eh)
@@ -490,7 +496,7 @@
         "%d"  dirname of file being printed, or '.' if in repository root
         "%p"  root-relative path name of file being printed
         """
-        args = cmdbuilder('cat', r=rev, o=output, *files)
+        args = cmdbuilder('cat', r=rev, o=output, hidden=self.hidden, *files)
         out = self.rawcommand(args)
 
         if not output:
@@ -643,7 +649,8 @@
                           p=showfunction, reverse=reverse,
                           w=ignoreallspace, b=ignorespacechange,
                           B=ignoreblanklines, U=unified, stat=stat,
-                          S=subrepos, I=include, X=exclude, *files)
+                          S=subrepos, I=include, X=exclude, hidden=self.hidden,
+                          *files)
 
         return self.rawcommand(args)
 
@@ -673,7 +680,8 @@
         if not isinstance(revs, list):
             revs = [revs]
         args = cmdbuilder('export', o=output, switch_parent=switchparent,
-                          a=text, g=git, nodates=nodates, *revs)
+                          a=text, g=git, nodates=nodates, hidden=self.hidden,
+                          *revs)
 
         out = self.rawcommand(args)
 
@@ -732,7 +740,8 @@
 
         args = cmdbuilder('grep', all=all, a=text, f=follow, i=ignorecase,
                           l=fileswithmatches, n=line, u=user, d=date,
-                          I=include, X=exclude, *[pattern] + files)
+                          I=include, X=exclude, hidden=self.hidden,
+                          *[pattern] + files)
         args.append('-0')
 
         def eh(ret, out, err):
@@ -773,7 +782,8 @@
             rev = [rev]
 
         args = cmdbuilder('heads', r=startrev, t=topological, c=closed,
-                          template=templates.changeset, *rev)
+                          template=templates.changeset, hidden=self.hidden,
+                          *rev)
 
         def eh(ret, out, err):
             if ret != 1:
@@ -804,7 +814,7 @@
         bookmarks - show bookmarks
         """
         args = cmdbuilder('identify', source, r=rev, n=num, i=id, b=branch, t=tags,
-                          B=bookmarks)
+                          B=bookmarks, hidden=self.hidden)
 
         return self.rawcommand(args)
 
@@ -902,7 +912,7 @@
 
     def log(self, revrange=None, files=[], follow=False, followfirst=False,
             date=None, copies=False, keyword=None, removed=False, onlymerges=False,
-            user=None, branch=None, prune=None, hidden=False, limit=None,
+            user=None, branch=None, prune=None, hidden=None, limit=None,
             nomerges=False, include=None, exclude=None):
         """
         Return the revision history of the specified files or the entire project.
@@ -941,11 +951,14 @@
         include - include names matching the given patterns
         exclude - exclude names matching the given patterns
         """
+        if hidden is None:
+            hidden = self.hidden
         args = cmdbuilder('log', template=templates.changeset,
                           r=revrange, f=follow, follow_first=followfirst,
                           d=date, C=copies, k=keyword, removed=removed,
-                          m=onlymerges, u=user, b=branch, P=prune, hidden=hidden,
-                          l=limit, M=nomerges, I=include, X=exclude, *files)
+                          m=onlymerges, u=user, b=branch, P=prune,
+                          l=limit, M=nomerges, I=include, X=exclude,
+                          hidden=hidden, *files)
 
         out = self.rawcommand(args)
         out = out.split('\0')[:-1]
@@ -962,7 +975,8 @@
         When all is True, all files from all revisions are yielded (just the name).
         This includes deleted and renamed files.
         """
-        args = cmdbuilder('manifest', r=rev, all=all, debug=True)
+        args = cmdbuilder('manifest', r=rev, all=all, debug=True,
+                          hidden=self.hidden)
 
         out = self.rawcommand(args)
 
@@ -1094,7 +1108,8 @@
         in which the file was last changed (before the working directory revision
         or the revision specified by rev) is returned.
         """
-        args = cmdbuilder('parents', file, template=templates.changeset, r=rev)
+        args = cmdbuilder('parents', file, template=templates.changeset, r=rev,
+                          hidden=self.hidden)
 
         out = self.rawcommand(args)
         if not out:
@@ -1277,7 +1292,7 @@
 
         args = cmdbuilder('revert', r=rev, a=all, d=date,
                           no_backup=nobackup, n=dryrun, I=include, X=exclude,
-                          *files)
+                          hidden=self.hidden, *files)
 
         eh = util.reterrorhandler(args)
         self.rawcommand(args, eh=eh)
@@ -1327,7 +1342,8 @@
 
         args = cmdbuilder('status', rev=rev, change=change, A=all, m=modified,
                           a=added, r=removed, d=deleted, c=clean, u=unknown,
-                          i=ignored, C=copies, S=subrepos, I=include, X=exclude)
+                          i=ignored, C=copies, S=subrepos, I=include,
+                          X=exclude, hidden=self.hidden)
 
         args.append('-0')
 
@@ -1366,7 +1382,8 @@
             names = [names]
 
         args = cmdbuilder('tag', r=rev, m=message, f=force, l=local,
-                          remove=remove, d=date, u=user, *names)
+                          remove=remove, d=date, u=user, hidden=self.hidden,
+                          *names)
 
         self.rawcommand(args)
 
@@ -1402,7 +1419,7 @@
 
             unparsed entries will be of them form key : value
         """
-        args = cmdbuilder('summary', remote=remote)
+        args = cmdbuilder('summary', remote=remote, hidden=self.hidden)
 
         out = self.rawcommand(args).splitlines()
 
@@ -1474,7 +1491,8 @@
         changeset most recently added to the repository (and therefore the most
         recently changed head).
         """
-        args = cmdbuilder('tip', template=templates.changeset)
+        args = cmdbuilder('tip', template=templates.changeset,
+                          hidden=self.hidden)
         out = self.rawcommand(args)
         out = out.split('\0')
 
@@ -1494,7 +1512,8 @@
         if clean and check:
             raise ValueError('clean and check cannot both be True')
 
-        args = cmdbuilder('update', r=rev, C=clean, c=check, d=date)
+        args = cmdbuilder('update', r=rev, C=clean, c=check, d=date,
+                          hidden=self.hidden)
 
         def eh(ret, out, err):
             if ret == 1:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/tests/test-hidden.py	Thu May 22 15:23:12 2014 +0200
@@ -0,0 +1,43 @@
+import common, hglib, datetime
+from hglib.error import CommandError
+
+class test_obsolete_reference(common.basetest):
+    '''make sure obsolete changesets are disabled'''
+    def test_debugobsolete_failure(self):
+        f = open('gna1','w')
+        f.write('g')
+        f.close()
+        self.client.add('gna1')
+        cs = self.client.commit('gna1')[1] #get id
+        with self.assertRaises(CommandError):
+            self.client.rawcommand(['debugobsolete', cs])
+
+
+class test_obsolete(common.basetest):
+    '''test a few client methods with obsolete changesets enabled'''
+    def setUp(self):
+        #create an extension which only activates obsolete
+        super(test_obsolete, self).setUp()
+        self.append('.hg/obs.py','''import mercurial.obsolete\nmercurial.obsolete._enabled = True''')
+        self.append('.hg/hgrc','\n[extensions]\nobs=.hg/obs.py')
+
+    def test_debugobsolete_success(self):
+        self.append('gna1','ga')
+        self.client.add('gna1')
+        cs = self.client.commit('gna1')[1] #get id
+        self.client.rawcommand(['debugobsolete', cs])
+
+    def test_obsolete_in(self):
+        self.append('gna1','ga')
+        self.client.add('gna1')
+        cs0 = self.client.commit('gna1')[1] #get id
+        self.append('gna2','gaaa')
+        self.client.add('gna2')
+        cs1 = self.client.commit('gna2')[1] #get id
+        self.client.rawcommand(['debugobsolete', cs1])
+        self.client.update(cs0)
+        self.assertFalse(cs1 in self.client)
+        self.assertTrue(cs0 in self.client)
+        self.client.hidden = True
+        self.assertTrue(cs1 in self.client)
+