This is an archive of the discontinued Mercurial Phabricator instance.

Differential D7214

fsmonitor: normalize exception types to bytes
ClosedPublic

Authored by indygreg on Nov 2 2019, 6:03 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG9a8f8c6ed965: fsmonitor: normalize exception types to bytes
Summary

Unavailable.msg should now always be bytes.

We also rename Unavailable.str to bytes as it always
returns bytes. We make str a simple wrapper that decodes that
result to str.

There's probably some excessive strutil.forcebytestr() in
fsmonitor/__init__.py now. But at least the exceptions around
type coercion should now be gone.

Diff Detail

Repository
rHG Mercurial
Branch
stable
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

indygreg created this revision.Nov 2 2019, 6:03 PM
indygreg added a commit: rHG9a8f8c6ed965: fsmonitor: normalize exception types to bytes.Nov 4 2019, 11:28 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG9a8f8c6ed965: fsmonitor: normalize exception types to bytes (authored by indygreg). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/fsmonitor/watchmanclient.py (20 lines)

Diff 17512

hgext/fsmonitor/watchmanclient.py

# watchmanclient.py - Watchman client for the fsmonitor extension # watchmanclient.py - Watchman client for the fsmonitor extension
# #
# Copyright 2013-2016 Facebook, Inc. # Copyright 2013-2016 Facebook, Inc.
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
from __future__ import absolute_import from __future__ import absolute_import
import getpass import getpass
from mercurial import util from mercurial import (
from mercurial.utils import procutil encoding,
util,
)
from mercurial.utils import (
procutil,
stringutil,
)
from . import pywatchman from . import pywatchman
class Unavailable(Exception): class Unavailable(Exception):
def __init__(self, msg, warn=True, invalidate=False): def __init__(self, msg, warn=True, invalidate=False):
self.msg = msg self.msg = msg
self.warn = warn self.warn = warn
if self.msg == b'timed out waiting for response': if self.msg == b'timed out waiting for response':
self.warn = False self.warn = False
self.invalidate = invalidate self.invalidate = invalidate
def __str__(self): def __bytes__(self):
if self.warn: if self.warn:
return b'warning: Watchman unavailable: %s' % self.msg return b'warning: Watchman unavailable: %s' % self.msg
else: else:
return b'Watchman unavailable: %s' % self.msg return b'Watchman unavailable: %s' % self.msg
__str__ = encoding.strmethod(__bytes__)
class WatchmanNoRoot(Unavailable): class WatchmanNoRoot(Unavailable):
def __init__(self, root, msg): def __init__(self, root, msg):
self.root = root self.root = root
super(WatchmanNoRoot, self).__init__(msg) super(WatchmanNoRoot, self).__init__(msg)
class client(object): class client(object):
self._watchmanclient = pywatchman.client( self._watchmanclient = pywatchman.client(
timeout=self._timeout, timeout=self._timeout,
useImmutableBser=True, useImmutableBser=True,
binpath=procutil.tonativestr(watchman_exe), binpath=procutil.tonativestr(watchman_exe),
) )
return self._watchmanclient.query(*watchmanargs) return self._watchmanclient.query(*watchmanargs)
except pywatchman.CommandError as ex: except pywatchman.CommandError as ex:
if b'unable to resolve root' in ex.msg: if b'unable to resolve root' in ex.msg:
raise WatchmanNoRoot(self._root, ex.msg) raise WatchmanNoRoot(
self._root, stringutil.forcebytestr(ex.msg)
)
raise Unavailable(ex.msg) raise Unavailable(ex.msg)
except pywatchman.WatchmanError as ex: except pywatchman.WatchmanError as ex:
raise Unavailable(str(ex)) raise Unavailable(stringutil.forcebytestr(ex))
def command(self, *args): def command(self, *args):
try: try:
try: try:
return self._command(*args) return self._command(*args)
except WatchmanNoRoot: except WatchmanNoRoot:
# this 'watch' command can also raise a WatchmanNoRoot if # this 'watch' command can also raise a WatchmanNoRoot if
# watchman refuses to accept this root # watchman refuses to accept this root
self._command(b'watch') self._command(b'watch')
return self._command(*args) return self._command(*args)
except Unavailable: except Unavailable:
# this is in an outer scope to catch Unavailable form any of the # this is in an outer scope to catch Unavailable form any of the
# above _command calls # above _command calls
self._watchmanclient = None self._watchmanclient = None
raise raise