NataliaBondarenko
commented
6 years ago Argparse and help system.
make text blocks a bit shorter, if possible:
I do not know if this is possible, complex parsers have a pretty large help text.
maybe implement sub-parsers:
This can be done, for example, the git has a sub-parser help and also the usual --help.
git --help
git help <command> (Launching default browser to display HTML-file), git help -a, git help -g
I do not know how it is implemented there, but with a parser you can do something like this:
from argparse import ArgumentParser
import os
from textwrap import fill
# handlers
def foo(args):
print('ext:', args.file_extension, 'path:', args.path, 'preview:', args.preview)
# print start_message
"""print(fill(show_start_message(args.extension, args.case_sensitive,
recursive, include_hidden, location),
width=START_TEXT_WIDTH), end="\n\n")"""
print('the process of getting the list here')
def bar(args):
# here you can write anything and even make a responsive help text
# key-values may be stored in settings
arg_help = {
'desc': 'usage: test help <command>',
'path': 'path help',
'fe': 'file-extension help',
'file-extension': 'file-extension help'
}
print(fill(arg_help.get(args.argument, 'not implemented'), width=5))
parser = ArgumentParser(
prog='test',
description='desc'
)
# common arguments
parser.add_argument('path', nargs='?', default=os.getcwd(), type=str,
help='The path to the folder containing the files to be counted.')
parser.add_argument('-st', '--supported-types', action='store_true',
help='The list of currently supported file types for preview.')
subparsers = parser.add_subparsers(help='Usual sub-command help')
parser_bar = subparsers.add_parser('help', help='Help by certain argument name')
parser_bar.add_argument('-a', '--argument', type=str, default='desc',
choices=('desc', 'path', 'fe', 'file-extension'))
parser_bar.set_defaults(func=bar)
# special arguments
parser_search = subparsers.add_parser('search', help='File searching by extension help')
parser_search.add_argument('-fe', '--file-extension', type=str, required=True, # or set default='py',
help="Search files by file extension ...")
parser_search.add_argument('-p', '--preview', action='store_true', default=False,
help='Display a short preview (only available for text files.')
# parser_search.add_argument(...)
parser_search.set_defaults(func=foo)
def main(*args):
args = parser.parse_args(*args)
if args.supported_types:
parser.exit(status=0, message='supported_type_info_message')
if os.path.abspath(args.path) == os.getcwd():
location = os.getcwd()
loc_text = ' the current directory'
else:
location = os.path.expanduser(args.path)
loc_text = ':\n' + os.path.normpath(location)
if not os.path.exists(location):
parser.exit(status=1, message=f'The path {location} '
f'does not exist, or there may be a typo in it.')
# if not include_hidden and is_hidden_file_or_dir(location): ... parser.exit
args.path = location
args.func(args)
if __name__ == "__main__":
main()
it looks like this:
consider if we should move from argparse to other similar 3rd. party package:
this is possible if there is some especially important functional that is not present in the ArgumentParser.
Lets gather a few ideas of what kind of improvements we could consider to include in the next Count Files release. For now, this issue will function as simple brainstorming place in order to help us define priorities and plan ahead about where we should focus our working efforts.
To get things started, let me introduce some possible ideas:
Find out ways to simplify the help system:
Add file search by other criteria:
Add some new preview systems for common file types: