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

typing: add type hints to the `opener` attributes and arguments of revlog...

typing: add type hints to the `opener` attributes and arguments of revlog When making revlog and filelog classes visible to pytype, it got confused quite a bit in `mercurial/revlogutils/rewrite.py`, thinking it had a plain `Callable`, and flagging additional methods on it like `join()` and `rename()`. I couldn't figure out how it reduced to that (and PyCharm flagged `opener` references as `Any`), but this makes it happy. So make this change before making the classes visible. The vfs class hierarchy is a bit wonky (e.g. `filteredvfs` is not a `vfs`), so this may need to be revisited with a Protocol class that covers all of the `vfs` classes. But for now, everything works.

Matt Harbison - - Load All Authors

File last commit:

r52624:92845af3 default


                r52713:71fb6e0a

default

Download file

             typelib.py
        
                    48 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / mercurial / typelib.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # typelib.py - type hint aliases and support

      #

      # Copyright 2022 Matt Harbison <matt_harbison@yahoo.com>

      #

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

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

      import typing

      from typing import (

          Callable,

      )

      # Note: this is slightly different from pycompat.TYPE_CHECKING, as using

      # pycompat causes the BinaryIO_Proxy type to be resolved to ``object`` when

      # used as the base class during a pytype run.

      TYPE_CHECKING = typing.TYPE_CHECKING

      # The BinaryIO class provides empty methods, which at runtime means that

      # ``__getattr__`` on the proxy classes won't get called for the methods that

      # should delegate to the internal object.  So to avoid runtime changes because

      # of the required typing inheritance, just use BinaryIO when typechecking, and

      # ``object`` otherwise.

      if TYPE_CHECKING:

          from typing import (

              BinaryIO,

              Union,

          )

          from . import (

              node,

              posix,

              windows,

          )

          BinaryIO_Proxy = BinaryIO

          CacheStat = Union[posix.cachestat, windows.cachestat]

          NodeConstants = node.sha1nodeconstants

      else:

          from typing import Any

          BinaryIO_Proxy = object

          CacheStat = Any

          NodeConstants = Any

      # scmutil.getuipathfn() related callback.

      UiPathFn = Callable[[bytes], bytes]

	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

				# typelib.py - type hint aliases and support
				#
				# Copyright 2022 Matt Harbison <matt_harbison@yahoo.com>
				#
				# This software may be used and distributed according to the terms of the
				# GNU General Public License version 2 or any later version.

				import typing

				from typing import (
				Callable,
				)

				# Note: this is slightly different from pycompat.TYPE_CHECKING, as using
				# pycompat causes the BinaryIO_Proxy type to be resolved to ``object`` when
				# used as the base class during a pytype run.
				TYPE_CHECKING = typing.TYPE_CHECKING


				# The BinaryIO class provides empty methods, which at runtime means that
				# ``__getattr__`` on the proxy classes won't get called for the methods that
				# should delegate to the internal object. So to avoid runtime changes because
				# of the required typing inheritance, just use BinaryIO when typechecking, and
				# ``object`` otherwise.
				if TYPE_CHECKING:
				from typing import (
				BinaryIO,
				Union,
				)

				from . import (
				node,
				posix,
				windows,
				)

				BinaryIO_Proxy = BinaryIO
				CacheStat = Union[posix.cachestat, windows.cachestat]
				NodeConstants = node.sha1nodeconstants
				else:
				from typing import Any

				BinaryIO_Proxy = object
				CacheStat = Any
				NodeConstants = Any

				# scmutil.getuipathfn() related callback.
				UiPathFn = Callable[[bytes], bytes]