forked from LBRYCommunity/lbry-sdk
dropped help, commands and resolve_name commands
This commit is contained in:
parent
f47a685734
commit
134338db4b
2 changed files with 2 additions and 79 deletions
|
@ -201,7 +201,7 @@ def get_argument_parser():
|
||||||
group_parser = sub.add_parser(group_name, group_name=group_name, help=api['groups'][group_name])
|
group_parser = sub.add_parser(group_name, group_name=group_name, help=api['groups'][group_name])
|
||||||
groups[group_name] = group_parser.add_subparsers(metavar='COMMAND')
|
groups[group_name] = group_parser.add_subparsers(metavar='COMMAND')
|
||||||
|
|
||||||
nicer_order = ['stop', 'get', 'publish', 'resolve', 'resolve_name']
|
nicer_order = ['stop', 'get', 'publish', 'resolve']
|
||||||
for command_name in sorted(api['commands']):
|
for command_name in sorted(api['commands']):
|
||||||
if command_name not in nicer_order:
|
if command_name not in nicer_order:
|
||||||
nicer_order.append(command_name)
|
nicer_order.append(command_name)
|
||||||
|
|
|
@ -295,8 +295,7 @@ class Daemon(metaclass=JSONRPCServerType):
|
||||||
@classmethod
|
@classmethod
|
||||||
def get_api_definitions(cls):
|
def get_api_definitions(cls):
|
||||||
prefix = 'jsonrpc_'
|
prefix = 'jsonrpc_'
|
||||||
skip = ['commands', 'help']
|
not_grouped = ['block_show', 'report_bug', 'routing_table_get']
|
||||||
not_grouped = ['block_show', 'report_bug', 'resolve_name', 'routing_table_get']
|
|
||||||
api = {
|
api = {
|
||||||
'groups': {
|
'groups': {
|
||||||
group_name[:-len('_DOC')].lower(): getattr(cls, group_name).strip()
|
group_name[:-len('_DOC')].lower(): getattr(cls, group_name).strip()
|
||||||
|
@ -307,8 +306,6 @@ class Daemon(metaclass=JSONRPCServerType):
|
||||||
for jsonrpc_method in dir(cls):
|
for jsonrpc_method in dir(cls):
|
||||||
if jsonrpc_method.startswith(prefix):
|
if jsonrpc_method.startswith(prefix):
|
||||||
full_name = jsonrpc_method[len(prefix):]
|
full_name = jsonrpc_method[len(prefix):]
|
||||||
if full_name in skip:
|
|
||||||
continue
|
|
||||||
method = getattr(cls, jsonrpc_method)
|
method = getattr(cls, jsonrpc_method)
|
||||||
if full_name in not_grouped:
|
if full_name in not_grouped:
|
||||||
name_parts = [full_name]
|
name_parts = [full_name]
|
||||||
|
@ -816,54 +813,6 @@ class Daemon(metaclass=JSONRPCServerType):
|
||||||
setattr(c, key, attr.deserialize(value))
|
setattr(c, key, attr.deserialize(value))
|
||||||
return self.jsonrpc_settings_get()
|
return self.jsonrpc_settings_get()
|
||||||
|
|
||||||
def jsonrpc_help(self, command=None):
|
|
||||||
"""
|
|
||||||
Return a useful message for an API command
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
help [<command> | --command=<command>]
|
|
||||||
|
|
||||||
Options:
|
|
||||||
--command=<command> : (str) command to retrieve documentation for
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
(str) Help message
|
|
||||||
"""
|
|
||||||
|
|
||||||
if command is None:
|
|
||||||
return {
|
|
||||||
'about': 'This is the LBRY JSON-RPC API',
|
|
||||||
'command_help': 'Pass a `command` parameter to this method to see ' +
|
|
||||||
'help for that command (e.g. `help command=resolve_name`)',
|
|
||||||
'command_list': 'Get a full list of commands using the `commands` method',
|
|
||||||
'more_info': 'Visit https://lbry.io/api for more info',
|
|
||||||
}
|
|
||||||
|
|
||||||
fn = self.callable_methods.get(command)
|
|
||||||
if fn is None:
|
|
||||||
raise Exception(
|
|
||||||
f"No help available for '{command}'. It is not a valid command."
|
|
||||||
)
|
|
||||||
|
|
||||||
return {
|
|
||||||
'help': textwrap.dedent(fn.__doc__ or '')
|
|
||||||
}
|
|
||||||
|
|
||||||
def jsonrpc_commands(self):
|
|
||||||
"""
|
|
||||||
Return a list of available commands
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
commands
|
|
||||||
|
|
||||||
Options:
|
|
||||||
None
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
(list) list of available commands
|
|
||||||
"""
|
|
||||||
return sorted([command for command in self.callable_methods.keys()])
|
|
||||||
|
|
||||||
WALLET_DOC = """
|
WALLET_DOC = """
|
||||||
Wallet management.
|
Wallet management.
|
||||||
"""
|
"""
|
||||||
|
@ -1460,32 +1409,6 @@ class Daemon(metaclass=JSONRPCServerType):
|
||||||
)
|
)
|
||||||
]
|
]
|
||||||
|
|
||||||
@requires(WALLET_COMPONENT)
|
|
||||||
async def jsonrpc_resolve_name(self, name, force=False):
|
|
||||||
"""
|
|
||||||
Resolve stream info from a LBRY name
|
|
||||||
|
|
||||||
Usage:
|
|
||||||
resolve_name (<name> | --name=<name>) [--force]
|
|
||||||
|
|
||||||
Options:
|
|
||||||
--name=<name> : (str) the name to resolve
|
|
||||||
--force : (bool) force refresh and do not check cache
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
(dict) Metadata dictionary from name claim, None if the name is not
|
|
||||||
resolvable
|
|
||||||
"""
|
|
||||||
|
|
||||||
try:
|
|
||||||
name = parse_lbry_uri(name).name
|
|
||||||
metadata = await self.wallet_manager.resolve(name, check_cache=not force)
|
|
||||||
if name in metadata:
|
|
||||||
metadata = metadata[name]
|
|
||||||
return metadata
|
|
||||||
except UnknownNameError:
|
|
||||||
log.info('Name %s is not known', name)
|
|
||||||
|
|
||||||
CLAIM_DOC = """
|
CLAIM_DOC = """
|
||||||
Claim management.
|
Claim management.
|
||||||
"""
|
"""
|
||||||
|
|
Loading…
Add table
Reference in a new issue