upstream/mercurial-mirror Files · mercurial/txnutil.py

scmutil: add a simple key-value file helper...

scmutil: add a simple key-value file helper The purpose of the added class is to serve purposes like save files of shelve or state files of shelve, rebase and histedit. Keys of these files can be alphanumeric and start with letters, while values must not contain newlines. In light of Mercurial's reluctancy to use Python's json module, this tries to provide a reasonable alternative for a non-nested named data. Comparing to current approach of storing state in plain text files, where semantic meaning of lines of text is only determined by their oreder, simple key-value file allows for reordering lines and thus helps handle optional values. Initial use-case I see for this is obs-shelve's shelve files. Later we can possibly migrate state files to this approach. The test is in a new file beause I did not figure out where to put it within existing test suite. If you give me a better idea, I will gladly follow it.

FUJIWARA Katsunori - - Load All Authors

File last commit:

r31050:20653270 default


                r31553:56acc425

default

Download file

             txnutil.py
        
                    36 lines
            
             | 1.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / mercurial / txnutil.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # txnutil.py - transaction related utilities

      #

      #  Copyright FUJIWARA Katsunori <foozy@lares.dti.ne.jp> and others

      #

      # This software may be used and distributed according to the terms of the

      # GNU General Public License version 2 or any later version.

      from __future__ import absolute_import

      import errno

      from . import (

          encoding,

      )

      def mayhavepending(root):

          '''return whether 'root' may have pending changes, which are

          visible to this process.

          '''

          return root == encoding.environ.get('HG_PENDING')

      def trypending(root, vfs, filename, **kwargs):

          '''Open  file to be read according to HG_PENDING environment variable

          This opens '.pending' of specified 'filename' only when HG_PENDING

          is equal to 'root'.

          This returns '(fp, is_pending_opened)' tuple.

          '''

          if mayhavepending(root):

              try:

                  return (vfs('%s.pending' % filename, **kwargs), True)

              except IOError as inst:

                  if inst.errno != errno.ENOENT:

                      raise

          return (vfs(filename, **kwargs), False)

	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

				# txnutil.py - transaction related utilities
				#
				# Copyright FUJIWARA Katsunori <foozy@lares.dti.ne.jp> and others
				#
				# This software may be used and distributed according to the terms of the
				# GNU General Public License version 2 or any later version.

				from __future__ import absolute_import

				import errno

				from . import (
				encoding,
				)

				def mayhavepending(root):
				'''return whether 'root' may have pending changes, which are
				visible to this process.
				'''
				return root == encoding.environ.get('HG_PENDING')

				def trypending(root, vfs, filename, **kwargs):
				'''Open file to be read according to HG_PENDING environment variable

				This opens '.pending' of specified 'filename' only when HG_PENDING
				is equal to 'root'.

				This returns '(fp, is_pending_opened)' tuple.
				'''
				if mayhavepending(root):
				try:
				return (vfs('%s.pending' % filename, **kwargs), True)
				except IOError as inst:
				if inst.errno != errno.ENOENT:
				raise
				return (vfs(filename, **kwargs), False)