upstream/mercurial-mirror Files · contrib/debugshell.py

cmdutil: add class to restore dirstate during unexpected failure...

cmdutil: add class to restore dirstate during unexpected failure Before this patch, after "dirstate.write()" execution, there was no way to restore dirstate to the original status before "dirstate.write()". In some code paths, "dirstate.invalidate()" is used as a kind of "restore .hg/dirstate to the original status", but it just avoids writing changes in memory out, and doesn't actually restore the ".hg/dirstate" file. To fix the issue that the recent (in memory) dirstate isn't visible to external processes (e.g. "precommit" hooks), "dirstate.write()" should be invoked before invocation of external processes. But at the same time, ".hg/dirstate" should be restored to its content before "dirstate.write()" during an unexpected failure in some cases. This patch adds the class "dirstateguard" to easily restore ".hg/dirstate" during unexpected failures. Typical usecase of it is: # (1) build dirstate up .... # (2) write dirstate out, and backup ".hg/dirstate" dsguard = dirstateguard(repo, 'scopename') try: # (3) execute somethig to do: # this may imply making some additional changes on dirstate .... # (4) unlink backed-up dirstate file at the end of dsguard scope dsguard.close() finally: # (5) if execution is aborted before "dsguard.close()", # ".hg/dirstate" is restored from the backup dsguard.release() For this kind of issue, an "extending transaction" approach (in https://titanpad.com/mercurial32-sprint) seems to not be suitable, because: - transaction nesting occurs in some cases (e.g. "shelve => rebase"), and - "dirstate" may be already modified since the beginning of OUTER transaction scope, then - dirstate should be backed up into the file other than "dirstate.journal" at the beginning of INNER transaction scope, but - such alternative backup files are useless for transaction itself, and increases complication of its implementation "transaction" and "dirstateguard" differ from each other also in "what it should do for .hg/dirstate" in cases other than success. ============== ======= ======== ============= type success fail "hg rollback" ============== ======= ======== ============= transaction keep keep restore dirstateguard keep restore (not implied) ============== ======= ======== ============= Some collaboration between transaction and dirstate will probably be introduced in the future. But this layer is needed in all cases.

Gregory Szorc - - Load All Authors

File last commit:

r21243:8b5c039f default


                r24991:4169a4f8

default

Download file

             debugshell.py
        
                    54 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / contrib / debugshell.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # debugshell extension

      """a python shell with repo, changelog & manifest objects"""

      import sys

      import mercurial

      import code

      from mercurial import cmdutil

      cmdtable = {}

      command = cmdutil.command(cmdtable)

      def pdb(ui, repo, msg, **opts):

          objects = {

              'mercurial': mercurial,

              'repo': repo,

              'cl': repo.changelog,

              'mf': repo.manifest,

          }

          code.interact(msg, local=objects)

      def ipdb(ui, repo, msg, **opts):

          import IPython

          cl = repo.changelog

          mf = repo.manifest

          cl, mf # use variables to appease pyflakes

          IPython.embed()

      @command('debugshell|dbsh', [])

      def debugshell(ui, repo, **opts):

          bannermsg = "loaded repo : %s\n" \

                      "using source: %s" % (repo.root,

                                            mercurial.__path__[0])

          pdbmap = {

              'pdb'  : 'code',

              'ipdb' : 'IPython'

          }

          debugger = ui.config("ui", "debugger")

          if not debugger:

              debugger = 'pdb'

          # if IPython doesn't exist, fallback to code.interact

          try:

              __import__(pdbmap[debugger])

          except ImportError:

              ui.warn("%s debugger specified but %s module was not found\n"

                      % (debugger, pdbmap[debugger]))

              debugger = 'pdb'

          getattr(sys.modules[__name__], debugger)(ui, repo, bannermsg, **opts)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# debugshell extension
				"""a python shell with repo, changelog & manifest objects"""

				import sys
				import mercurial
				import code
				from mercurial import cmdutil

				cmdtable = {}
				command = cmdutil.command(cmdtable)

				def pdb(ui, repo, msg, **opts):
				objects = {
				'mercurial': mercurial,
				'repo': repo,
				'cl': repo.changelog,
				'mf': repo.manifest,
				}

				code.interact(msg, local=objects)

				def ipdb(ui, repo, msg, **opts):
				import IPython

				cl = repo.changelog
				mf = repo.manifest
				cl, mf # use variables to appease pyflakes

				IPython.embed()

				@command('debugshell\|dbsh', [])
				def debugshell(ui, repo, **opts):
				bannermsg = "loaded repo : %s\n" \
				"using source: %s" % (repo.root,
				mercurial.__path__[0])

				pdbmap = {
				'pdb' : 'code',
				'ipdb' : 'IPython'
				}

				debugger = ui.config("ui", "debugger")
				if not debugger:
				debugger = 'pdb'

				# if IPython doesn't exist, fallback to code.interact
				try:
				__import__(pdbmap[debugger])
				except ImportError:
				ui.warn("%s debugger specified but %s module was not found\n"
				% (debugger, pdbmap[debugger]))
				debugger = 'pdb'

				getattr(sys.modules[__name__], debugger)(ui, repo, bannermsg, **opts)