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

typing: make the localrepo classes known to pytype...

typing: make the localrepo classes known to pytype and both mentioned making `bundlerepository` and `unionrepository` subclass `localrepository` during the type checking phase, but that didn't apply to pytype in practice. See and friends for how the zope interfaces confuse pytype, and end up converting the classes they decorate into `Any`. This commit is slightly more complex though, because `localrepository` has mixin classes applied to it when it is instantiated. Specifically, `RevlogFileStorage` is added, which adds `def file(f)` (which isn't defined on `localrepository`). Therefore a list of `localrepository` superclasses is provided during type checking to account for the mixins. Without this, the `bundlerepository` class gets flagged when it attempts to call its superclass implementation of `file()`. Note that pytype doesn't understand these mixin superclasses (it marks the superclass of `localrepository` as `Any`, because they are zope interfaces it doesn't understand), but that's enough to get it to not flag `bundlerepository`. PyCharm also stops flagging it as a missing function, though it seems like it is able to handle the zope interfaces.

Matt Harbison - - Load All Authors

File last commit:

r52757:1c5810ce default


                r52788:ee7e106b

default

Download file

             typelib.py
        
                    50 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.

      from __future__ import annotations

      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.

				from __future__ import annotations

				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]