( )⚙ D8209 phabricator: avoid a stacktrace when command arguments are missing

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8209

phabricator: avoid a stacktrace when command arguments are missing
ClosedPublic

Authored by mharbison72 on Mar 4 2020, 12:58 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHG09f3e003fc2a: phabricator: avoid a stacktrace when command arguments are missing
Summary

Previously, the TypeError wasn't properly converted to a SignatureError when
improper arguments were supplied to the inner function, because the stack depth
is 2 inside the vcrcommand decorator. The __name__ and __doc__ attributes
need to be reassigned to the new wrapper so that the help summary is available.

Diff Detail

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

Event Timeline

mharbison72 created this revision.Mar 4 2020, 12:58 AM
mharbison72 added a commit: rHG09f3e003fc2a: phabricator: avoid a stacktrace when command arguments are missing.Mar 4 2020, 4:17 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG09f3e003fc2a: phabricator: avoid a stacktrace when command arguments are missing (authored by mharbison72). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/phabricator.py (8 lines)
Mmercurial/util.py (4 lines)
Mtests/test-phabricator.t (15 lines)

Diff 20439

hgext/phabricator.py

), ),
], ],
) )
vcr.register_matcher('hgmatcher', hgmatcher) vcr.register_matcher('hgmatcher', hgmatcher)
with vcr.use_cassette(cassette, match_on=['hgmatcher']): with vcr.use_cassette(cassette, match_on=['hgmatcher']):
return fn(*args, **kwargs) return fn(*args, **kwargs)
return fn(*args, **kwargs) return fn(*args, **kwargs)
inner.__name__ = fn.__name__ cmd = util.checksignature(inner, depth=2)
inner.__doc__ = fn.__doc__ cmd.__name__ = fn.__name__
cmd.__doc__ = fn.__doc__
return command( return command(
name, name,
fullflags, fullflags,
spec, spec,
helpcategory=helpcategory, helpcategory=helpcategory,
optionalrepo=optionalrepo, optionalrepo=optionalrepo,
)(inner) )(cmd)
return decorate return decorate
def urlencodenested(params): def urlencodenested(params):
"""like urlencode, but works with nested parameters. """like urlencode, but works with nested parameters.
For example, if params is {'a': ['b', 'c'], 'd': {'e': 'f'}}, it will be For example, if params is {'a': ['b', 'c'], 'd': {'e': 'f'}}, it will be

mercurial/util.py

b.reverse() b.reverse()
while a and b and a[-1] == b[-1]: while a and b and a[-1] == b[-1]:
a.pop() a.pop()
b.pop() b.pop()
b.reverse() b.reverse()
return pycompat.ossep.join(([b'..'] * len(a)) + b) or b'.' return pycompat.ossep.join(([b'..'] * len(a)) + b) or b'.'
def checksignature(func): def checksignature(func, depth=1):
'''wrap a function with code to check for calling errors''' '''wrap a function with code to check for calling errors'''
def check(*args, **kwargs): def check(*args, **kwargs):
try: try:
return func(*args, **kwargs) return func(*args, **kwargs)
except TypeError: except TypeError:
if len(traceback.extract_tb(sys.exc_info()[2])) == 1: if len(traceback.extract_tb(sys.exc_info()[2])) == depth:
raise error.SignatureError raise error.SignatureError
raise raise
return check return check
# a whilelist of known filesystems where hardlink works reliably # a whilelist of known filesystems where hardlink works reliably
_hardlinkfswhitelist = { _hardlinkfswhitelist = {

tests/test-phabricator.t

Error is handled reasonably. We override the phabtoken here so that Error is handled reasonably. We override the phabtoken here so that
when you're developing changes to phabricator.py you can edit the when you're developing changes to phabricator.py you can edit the
above config and have a real token in the test but not have to edit above config and have a real token in the test but not have to edit
this test. this test.
$ hg phabread --config auth.hgphab.phabtoken=cli-notavalidtoken \ $ hg phabread --config auth.hgphab.phabtoken=cli-notavalidtoken \
> --test-vcr "$VCR/phabread-conduit-error.json" D4480 | head > --test-vcr "$VCR/phabread-conduit-error.json" D4480 | head
abort: Conduit Error (ERR-INVALID-AUTH): API token "cli-notavalidtoken" has the wrong length. API tokens should be 32 characters long. abort: Conduit Error (ERR-INVALID-AUTH): API token "cli-notavalidtoken" has the wrong length. API tokens should be 32 characters long.
Missing arguments print the command help
$ hg phabread
hg phabread: invalid arguments
hg phabread DREVSPEC [OPTIONS]
print patches from Phabricator suitable for importing
options:
--stack read dependencies
(use 'hg phabread -h' to show more help)
[255]
Basic phabread: Basic phabread:
$ hg phabread --test-vcr "$VCR/phabread-4480.json" D4480 | head $ hg phabread --test-vcr "$VCR/phabread-4480.json" D4480 | head
# HG changeset patch # HG changeset patch
# Date 1536771503 0 # Date 1536771503 0
# Parent a5de21c9e3703f8e8eb064bd7d893ff2f703c66a # Parent a5de21c9e3703f8e8eb064bd7d893ff2f703c66a
exchangev2: start to implement pull with wire protocol v2 exchangev2: start to implement pull with wire protocol v2
Wire protocol version 2 will take a substantially different Wire protocol version 2 will take a substantially different