Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

Commit

Permalink
Progressive PEP-8 migration.
Browse files Browse the repository at this point in the history
  • Loading branch information
@todofixthis
todofixthis committed Jun 10, 2018
1 parent 4ad7219 commit 232e2fe
Showing 1 changed file with 152 additions and 151 deletions.
303 changes: 152 additions & 151 deletions iota/bin/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# coding=utf-8
from __future__ import absolute_import, division, print_function, \
unicode_literals
unicode_literals

import sys
from abc import ABCMeta, abstractmethod as abstract_method
Expand All @@ -16,162 +16,163 @@
from iota.crypto.types import Seed

__all__ = [
'IotaCommandLineApp',
'IotaCommandLineApp',
]


class IotaCommandLineApp(with_metaclass(ABCMeta)):
"""
Base functionality for a PyOTA-powered command-line application.
"""
requires_seed = True
"""
Whether the command requires the user to provide a seed.
"""

def __init__(self, stdout=sys.stdout, stderr=sys.stderr, stdin=sys.stdin):
# type: (StringIO, StringIO, StringIO) -> None
super(IotaCommandLineApp, self).__init__()

self.stdout = stdout
self.stderr = stderr
self.stdin = stdin

@abstract_method
def execute(self, api, **arguments):
# type: (Iota, **Any) -> Optional[int]
"""
Executes the command and (optionally) returns an exit code (used by
the shell to determine if the application exited cleanly).
:param api:
The API object used to communicate with the node.
:param arguments:
Command-line arguments parsed by the argument parser.
"""
raise NotImplementedError(
'Not implemented in {cls}.'.format(cls=type(self).__name__),
)

def main(self):
"""
Executes the command from :py:data:`sys.argv` and exits.
"""
exit(self.run_from_argv())

def run_from_argv(self, argv=None):
# type: (Optional[tuple]) -> int
Base functionality for a PyOTA-powered command-line application.
"""
Executes the command from a collection of arguments (e.g.,
:py:data`sys.argv`) and returns the exit code.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``.
requires_seed = True
"""
exit_code = self.execute(**self.parse_argv(argv))

if exit_code is None:
exit_code = 0

return exit_code

def parse_argv(self, argv=None):
# type: (Optional[tuple]) -> dict
Whether the command requires the user to provide a seed.
"""
Parses arguments for the command.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``.
"""
arguments = vars(self.create_argument_parser().parse_args(argv))

seed = None
if self.requires_seed:
seed_filepath = arguments.pop('seed_file')

seed = (
self.seed_from_filepath(seed_filepath)
if seed_filepath
else self.prompt_for_seed()
)

arguments['api'] =\
Iota(
adapter = arguments.pop('uri'),
seed = seed,
testnet = arguments.pop('testnet'),
)

return arguments

def create_argument_parser(self):
# type: () -> ArgumentParser
"""
Returns the argument parser that will be used to interpret
arguments and options from argv.
"""
parser = ArgumentParser(
description = self.__doc__,
epilog = 'PyOTA v{version}'.format(version=__version__),
)

parser.add_argument(
'--uri',
type = text_type,
default = 'http://localhost:14265/',

help =
'URI of the node to connect to '
'(defaults to http://localhost:14265/).',
)

if self.requires_seed:
parser.add_argument(
'--seed-file',
type = text_type,
dest = 'seed_file',

help =
'Path to a file containing your seed in cleartext. '
'If not provided, you will be prompted to enter your seed '
'via stdin.',
)

parser.add_argument(
'--testnet',
action = 'store_true',
default = False,
help = 'If set, use testnet settings (e.g., for PoW).',
)

return parser

@staticmethod
def seed_from_filepath(filepath):
# type: (Text) -> Seed
"""
Reads a seed from the first line of a text file.
Any lines after the first are ignored.
"""
with open(filepath, 'rb') as f_:
return Seed(f_.readline().strip())

@staticmethod
def prompt_for_seed():
# type: () -> Seed
"""
Prompts the user to enter their seed via stdin.
"""
seed = secure_input(
'Enter seed and press return (typing will not be shown).\n'
'If no seed is specified, a random one will be used instead.\n'
)

if isinstance(seed, text_type):
seed = seed.encode('ascii')

return Seed(seed) if seed else Seed.random()
def __init__(self, stdout=sys.stdout, stderr=sys.stderr, stdin=sys.stdin):
# type: (StringIO, StringIO, StringIO) -> None
super(IotaCommandLineApp, self).__init__()

self.stdout = stdout
self.stderr = stderr
self.stdin = stdin

@abstract_method
def execute(self, api, **arguments):
# type: (Iota, **Any) -> Optional[int]
"""
Executes the command and (optionally) returns an exit code (used by
the shell to determine if the application exited cleanly).
:param api:
The API object used to communicate with the node.
:param arguments:
Command-line arguments parsed by the argument parser.
"""
raise NotImplementedError(
'Not implemented in {cls}.'.format(cls=type(self).__name__),
)

def main(self):
"""
Executes the command from :py:data:`sys.argv` and exits.
"""
exit(self.run_from_argv())

def run_from_argv(self, argv=None):
# type: (Optional[tuple]) -> int
"""
Executes the command from a collection of arguments (e.g.,
:py:data`sys.argv`) and returns the exit code.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``.
"""
exit_code = self.execute(**self.parse_argv(argv))

if exit_code is None:
exit_code = 0

return exit_code

def parse_argv(self, argv=None):
# type: (Optional[tuple]) -> dict
"""
Parses arguments for the command.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``.
"""
arguments = vars(self.create_argument_parser().parse_args(argv))

seed = None
if self.requires_seed:
seed_filepath = arguments.pop('seed_file')

seed = (
self.seed_from_filepath(seed_filepath)
if seed_filepath
else self.prompt_for_seed()
)

arguments['api'] = Iota(
adapter=arguments.pop('uri'),
seed=seed,
testnet=arguments.pop('testnet'),
)

return arguments

def create_argument_parser(self):
# type: () -> ArgumentParser
"""
Returns the argument parser that will be used to interpret
arguments and options from argv.
"""
parser = ArgumentParser(
description=self.__doc__,
epilog='PyOTA v{version}'.format(version=__version__),
)

parser.add_argument(
'--uri',
type=text_type,
default='http://localhost:14265/',

help=(
'URI of the node to connect to '
'(defaults to http://localhost:14265/).'
),
)

if self.requires_seed:
parser.add_argument(
'--seed-file',
type=text_type,
dest='seed_file',

help=(
'Path to a file containing your seed in cleartext. '
'If not provided, you will be prompted to enter '
'your seed via stdin.'
),
)

parser.add_argument(
'--testnet',
action='store_true',
default=False,
help='If set, use testnet settings (e.g., for PoW).',
)

return parser

@staticmethod
def seed_from_filepath(filepath):
# type: (Text) -> Seed
"""
Reads a seed from the first line of a text file.
Any lines after the first are ignored.
"""
with open(filepath, 'rb') as f_:
return Seed(f_.readline().strip())

@staticmethod
def prompt_for_seed():
# type: () -> Seed
"""
Prompts the user to enter their seed via stdin.
"""
seed = secure_input(
'Enter seed and press return (typing will not be shown).\n'
'If no seed is specified, a random one will be used instead.\n'
)

if isinstance(seed, text_type):
seed = seed.encode('ascii')

return Seed(seed) if seed else Seed.random()

0 comments on commit 232e2fe

Please sign in to comment.