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

scmutil: rewrite docstring for filecache...

scmutil: rewrite docstring for filecache The old docstring was incorrect in that it said that subsequent calls perform a stat() and refresh the object if things change. This is not how things work: __get__ populates obj.__dict__[self.sname] with the result of the decorated function and returns this value without validation on subsequent calls, if available. The correct usage of this type is kinda wonky. It would probably benefit from a refactor. But I don't have time to do that right now. But we can change the docstring so others aren't entrapped by its lies (like I was when using repofilecache in a Mozilla extension). Differential Revision: https://phab.mercurial-scm.org/D3943

FUJIWARA Katsunori - - Load All Authors

File last commit:

r31050:20653270 default


                r38698:3b072388

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)