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

typing: make `bundlerepository` subclass `localrepository` while type checking...

typing: make `bundlerepository` subclass `localrepository` while type checking Currently, `mercurial/bundlerepo.py` is excluded from pytype, mostly because it complains that various `ui` and `vfs` fields in `localrepository` are missing. (`bundlerepository` dynamically subclasses `localrepository` when it is instantiated, so it works at runtime.) This makes that class hierarchy known to pytype. Having a protocol for `Repository` is probably the right thing to do, but that will be a lot of work and this still reflects the class at runtime. Subclassing also has the benefit of making sure any method overrides have a matching signature, so maybe this is a situation where we do both of these things. (I'm not sure how clear the diagnostics are if a class *almost* implements a protocol, but is missing a method argument or similar.) The subclassing is not done outside of type checking runs to avoid any side effects on already complex code.

Matt Harbison - - Load All Authors

File last commit:

r52755:607e94e0 default


                r52763:9d4ad05b

default

Download file

             txnutil.py
        
                    33 lines
            
             | 978 B
            
                | 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 annotations

      from . import encoding

      def mayhavepending(root):

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

          visible to this process.

          """

          return root == encoding.environ.get(b'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(b'%s.pending' % filename, **kwargs), True)

              except FileNotFoundError:

                  pass

          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 annotations

				from . import encoding


				def mayhavepending(root):
				"""return whether 'root' may have pending changes, which are
				visible to this process.
				"""
				return root == encoding.environ.get(b'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(b'%s.pending' % filename, **kwargs), True)
				except FileNotFoundError:
				pass
				return (vfs(filename, **kwargs), False)