Блог

Я прочитал кучу вопросов, на которые уже даны ответы, но я не вижу, чтобы это было охвачено-по крайней мере, я не понял.

Я использую argparse, чтобы взять файл и преобразовать его в другой тип. Требуется ввести имя файла. Выходное имя файла НЕ требуется, так как необязательный аргумент должен обрабатывать это. Вот код до сих пор:

 import sys
import argparse
parser = argparse.ArgumentParser(description='Convert file to new type')
parser.add_argument('--json', type=str, help='Converts to json format')
parser.add_argument('--bibtex', type=str, help='Converts to bibtex format')
parser.add_argument('--html', type=str, help='Converts to html format')
parser.add_argument('inputfilename', type=str, help='enter the original filename')
args = parser.parse_args()
filename=args.filename
if args.json:
    print('Converting to json ...')
    #conversion code here
elif args.bibtex:
    print('Converting to bibtex ...')
    #conversion code here
elif args.html:
    print('Converting to html ...')
    #conversion code here
else:
    print('No conversion type indicated')
 

Проблема в том, что всякий раз, когда я использую один из этих флагов. Если я это сделаю

 $ ./orsconvert.py --json inputfilename
 

Я получаю сообщение об ошибке, говорящее

 orsconvert.py: error: the following arguments are required: inputfilename
 

Это происходит потому, что он интерпретирует предоставленный inputfilename файл как имя выходного файла, подключенное к --json . Он пытается заставить меня фактически указать выходное имя файла после необязательного аргумента и перед входным именем файла, аналогично этому:

 $ ./orsconvert.py --json outputfilename inputfileneame
 

Однако я не хочу этого делать, если есть способ обойти это. Я хочу, чтобы он принимал --json в качестве указания, что делать, а затем использовал inputfilename в качестве входных данных и автоматически сохранял его в outputfilename соответствии с тем, что будет указано в коде.

Да, я рассматриваю возможность объединения 3 необязательных аргументов в группу для упрощения кода … но это все еще не объясняет, как заставить его не требовать другого аргумента после необязательного и до окончательного inputfilename требуемого аргумента.

Есть ли что-то еще, что я могу добавить в parser.add_argument('...') поле, что перестанет требовать от меня указывать outputfilename ? Я хотел бы изменить код как можно меньше, потому что я уже раздвигаю границы своего понимания кода.

Проблема в том, что вы определили --json , что требуется аргумент, и в качестве этого аргумента используется имя входного файла. Ваши три конвертера должны использовать store_true действие, а не store действие по умолчанию.

 parser = argparse.ArgumentParser(description='Convert file to new type')
parser.add_argument('--json', action='store_true', help='Converts to json format')
parser.add_argument('--bibtex', action='store_true', help='Converts to bibtex format')
parser.add_argument('--html', action='store_true', help='Converts to html format')
parser.add_argument('inputfilename', help='enter the original filename')
args = parser.parse_args()
 

С этим изменением args.json et все являются логическими значениями, которые вы ожидаете от них. store_true Действие заботится об определении типа bool и значения по умолчанию false .

Еще лучше, однако, был бы один обязательный позиционный аргумент, который должен принимать значение json , bibtex , или html . Затем parse_args он сам определит, был ли задан неправильный или отсутствующий тип преобразования.

 parser = argparse.ArgumentParser(description='Convert file to new type')
parser.add_argument('inputfilename', help='enter the original filename')
parser.add_argument('conversion_type', choices=['json', 'bibtex', 'html'])
args = parser.parse_args()
filename = args.filename
conversion_type = args.conversion_type  # Guaranteed to be json, html, or bibtex
if conversion_type == "json":
    ...
elif conversion_type == "bibtex":
    ...
elif conversion_type == "html":
 

Если вам нужна опция со значением по умолчанию, пристегнитесь 🙂 Мы собираемся добавить 4 опции: одну, которая позволяет явно указать тип вывода, и три ярлыка для его настройки.

 p = argparse.ArgumentParser()
p.add_argument('inputfilename')
p.add_argument('--type', choices=['json', 'bibtex', 'html'], default='json')
p.add_argument('--json', action='store_const', const='json', dest='type')
p.add_argument('--html', action='store_const', const='html', dest='type')
p.add_argument('--bibtex', action='store_const', const='bibtex', dest='type')
 

--json , --bibtex , и --html имеют тот же эффект, --type json что и, --type bibtex , и --type html , соответственно. Как и прежде, --type может принимать в качестве аргумента только эти три значения. Если их несколько, вступает в силу последний из них.

argparse уже поставляется со всем необходимым, чтобы на самом деле иметь нужный вам API, а не тот, который, по вашему мнению, вам нужен.

• Тип должен быть одним из нескольких choices , а не тремя отдельными флагами.
• Это inputfilename должно быть обязательно.
• Это outputfilename должно быть необязательно.

 import argparse
parser = argparse.ArgumentParser(description='Convert file to new type')
parser.add_argument('format', choices=["json", "bibtex", "html"])
parser.add_argument('inputfilename', type=str)
parser.add_argument('outputfilename', type=str, nargs="?")
args = parser.parse_args()
print(args)
 

Это автоматически обеспечивает желаемое использование, не злоупотребляя опциями, но вместо этого получая обработку ошибок.

 $ ./converter json in.txt
Namespace(format='json', inputfilename='in.txt', outputfilename=None)
$ ./converter html in.txt out.html
Namespace(format='html', inputfilename='in.txt', outputfilename='out.html')
$ ./converter yaml in.txt         
usage: converter [-h] {json,bibtex,html} inputfilename [outputfilename]
converter: error: argument format: invalid choice: 'yaml' (choose from 'json', 'bibtex', 'html')