IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

sphinx-quickstart: Convert to argparse

Browse Source 
Nothing unusual to see here.

Signed-off-by: Stephen Finucane <stephen@that.guru>
This commit is contained in:
Stephen Finucane 2017-09-28 18:48:54 +01:00
parent b506d87292
commit bca566244a
1 changed files with 69 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

167
sphinx/cmd/quickstart.py
View File

@ -11,13 +11,13 @@
from __future__ import print_function from __future__ import print_function
from __future__ import absolute_import from __future__ import absolute_import
import re import argparse
import os import os
import re
import sys import sys
import optparse
import time import time
from os import path
from io import open from io import open
from os import path
# try to import readline, unix specific enhancement # try to import readline, unix specific enhancement
try: try:
@ -509,23 +509,6 @@ where "builder" is one of the supported builders, e.g. html, latex or linkcheck.
''') ''')
def usage(argv, msg=None):
# type: (List[unicode], unicode) -> None
if msg:
print(msg, file=sys.stderr)
print(file=sys.stderr)
USAGE = """\
Sphinx v%s
Usage: %%prog [options] [projectdir]
""" % __display_version__
EPILOG = """\
For more information, visit <http://sphinx-doc.org/>.
"""
def valid_dir(d): def valid_dir(d):
# type: (Dict) -> bool # type: (Dict) -> bool
dir = d['path'] dir = d['path']
@ -556,100 +539,88 @@ def valid_dir(d):
return True return True
class MyFormatter(optparse.IndentedHelpFormatter):
def format_usage(self, usage): # type: ignore
# type: (str) -> str
return usage
def format_help(self, formatter):
result = []
if self.description:
result.append(self.format_description(formatter))
if self.option_list:
result.append(self.format_option_help(formatter))
return "\n".join(result)
def main(argv=sys.argv[1:]): def main(argv=sys.argv[1:]):
# type: (List[str]) -> int # type: (List[str]) -> int
if not color_terminal(): if not color_terminal():
nocolor() nocolor()
parser = optparse.OptionParser(USAGE, epilog=EPILOG, parser = argparse.ArgumentParser(
version='Sphinx v%s' % __display_version__, usage='%(prog)s [OPTIONS] <PROJECT_DIR>',
formatter=MyFormatter()) epilog='For more information, visit <http://sphinx-doc.org/>.')
parser.add_option('-q', '--quiet', action='store_true', dest='quiet',
default=False,
help='quiet mode')
group = parser.add_option_group('Structure options') parser.add_argument('-q', '--quiet', action='store_true', dest='quiet',
group.add_option('--sep', action='store_true', dest='sep', default=False,
help='if specified, separate source and build dirs') help='quiet mode')
group.add_option('--dot', metavar='DOT', dest='dot', parser.add_argument('--version', action='version', dest='show_version',
help='replacement for dot in _templates etc.') version='%%(prog)s %s' % __display_version__)
group = parser.add_option_group('Project basic options') parser.add_argument('path', metavar='PROJECT_DIR', default='.',
group.add_option('-p', '--project', metavar='PROJECT', dest='project', help='output path')
help='project name')
group.add_option('-a', '--author', metavar='AUTHOR', dest='author',
help='author names')
group.add_option('-v', metavar='VERSION', dest='version',
help='version of project')
group.add_option('-r', '--release', metavar='RELEASE', dest='release',
help='release of project')
group.add_option('-l', '--language', metavar='LANGUAGE', dest='language',
help='document language')
group.add_option('--suffix', metavar='SUFFIX', dest='suffix',
help='source file suffix')
group.add_option('--master', metavar='MASTER', dest='master',
help='master document name')
group.add_option('--epub', action='store_true', dest='epub',
default=False,
help='use epub')
group = parser.add_option_group('Extension options') group = parser.add_argument_group('Structure options')
group.add_argument('--sep', action='store_true',
help='if specified, separate source and build dirs')
group.add_argument('--dot', metavar='DOT',
help='replacement for dot in _templates etc.')
group = parser.add_argument_group('Project basic options')
group.add_argument('-p', '--project', metavar='PROJECT', dest='project',
help='project name')
group.add_argument('-a', '--author', metavar='AUTHOR', dest='author',
help='author names')
group.add_argument('-v', metavar='VERSION', dest='version', default='',
help='version of project')
group.add_argument('-r', '--release', metavar='RELEASE', dest='release',
help='release of project')
group.add_argument('-l', '--language', metavar='LANGUAGE', dest='language',
help='document language')
group.add_argument('--suffix', metavar='SUFFIX',
help='source file suffix')
group.add_argument('--master', metavar='MASTER',
help='master document name')
group.add_argument('--epub', action='store_true', default=False,
help='use epub')
group = parser.add_argument_group('Extension options')
for ext in EXTENSIONS: for ext in EXTENSIONS:
group.add_option('--ext-' + ext, action='store_true', group.add_argument('--ext-' + ext, action='store_true',
dest='ext_' + ext, default=False, dest='ext_' + ext, default=False,
help='enable %s extension' % ext) help='enable %s extension' % ext)
group.add_option('--extensions', metavar='EXTENSIONS', dest='extensions', group.add_argument('--extensions', metavar='EXTENSIONS', dest='extensions',
action='append', help='enable extensions') action='append', help='enable extensions')
group = parser.add_option_group('Makefile and Batchfile creation') # TODO(stephenfin): Consider using mutually exclusive groups here
group.add_option('--makefile', action='store_true', dest='makefile', group = parser.add_argument_group('Makefile and Batchfile creation')
default=False, group.add_argument('--makefile', action='store_true', default=False,
help='create makefile') help='create makefile')
group.add_option('--no-makefile', action='store_true', dest='no_makefile', group.add_argument('--no-makefile', action='store_true', default=False,
default=False, help='not create makefile')
help='not create makefile') group.add_argument('--batchfile', action='store_true', default=False,
group.add_option('--batchfile', action='store_true', dest='batchfile', help='create batchfile')
default=False, group.add_argument('--no-batchfile', action='store_true', default=False,
help='create batchfile') help='not create batchfile')
group.add_option('--no-batchfile', action='store_true', dest='no_batchfile', group.add_argument('-M', '--no-use-make-mode', action='store_false',
default=False, dest='make_mode', default=False,
help='not create batchfile') help='not use make-mode for Makefile/make.bat')
group.add_option('-M', '--no-use-make-mode', action='store_false', dest='make_mode', group.add_argument('-m', '--use-make-mode', action='store_true',
help='not use make-mode for Makefile/make.bat') dest='make_mode', default=True,
group.add_option('-m', '--use-make-mode', action='store_true', dest='make_mode', help='use make-mode for Makefile/make.bat')
default=True,
help='use make-mode for Makefile/make.bat')
group = parser.add_option_group('Project templating') group = parser.add_argument_group('Project templating')
group.add_option('-t', '--templatedir', metavar='TEMPLATEDIR', dest='templatedir', group.add_argument('-t', '--templatedir', metavar='TEMPLATEDIR',
help='template directory for template files') dest='templatedir',
group.add_option('-d', metavar='NAME=VALUE', action='append', dest='variables', help='template directory for template files')
help='define a template variable') group.add_argument('-d', metavar='NAME=VALUE', action='append',
dest='variables',
help='define a template variable')
# parse options # parse options
try: try:
opts, args = parser.parse_args(argv) args = parser.parse_args(argv)
except SystemExit as err: except SystemExit as err:
return err.code return err.code
if len(args) > 0: d = vars(args)
opts.ensure_value('path', args[0])
d = vars(opts)
# delete None or False value # delete None or False value
d = dict((k, v) for k, v in d.items() if not (v is None or v is False)) d = dict((k, v) for k, v in d.items() if not (v is None or v is False))
@ -707,7 +678,7 @@ def main(argv=sys.argv[1:]):
except ValueError: except ValueError:
print('Invalid template variable: %s' % variable) print('Invalid template variable: %s' % variable)
generate(d, templatedir=opts.templatedir) generate(d, templatedir=args.templatedir)
return 0 return 0