Типы путей каталога с помощью argparse
Мой python script должен читать файлы из каталога, переданного в командной строке. Я определил тип readable_dir, как показано ниже, для использования с argparse для проверки того, что каталог, переданный в командной строке, существует и доступен для чтения.
Кроме того, для аргумента каталога также указано значение по умолчанию (/tmp/non_existent_dir в приведенном ниже примере).
Проблема здесь в том, что argparse вызывает readable_dir() по значению по умолчанию даже в ситуации, когда аргумент каталога явно передается в командной строке. Это приводит к исчезновению script, поскольку путь по умолчанию /tmp/non _existent_dir не существует в контексте, в котором каталог явно передается в командной строке.
Я мог бы обойти это, не указав значение по умолчанию и сделав этот аргумент обязательным, или отсрочив проверку до более позднего времени в script, но является более элегантным решением, о котором все знают?
#!/usr/bin/python
import argparse
import os
def readable_dir(prospective_dir):
if not os.path.isdir(prospective_dir):
raise Exception("readable_dir:{0} is not a valid path".format(prospective_dir))
if os.access(prospective_dir, os.R_OK):
return prospective_dir
else:
raise Exception("readable_dir:{0} is not a readable dir".format(prospective_dir))
parser = argparse.ArgumentParser(description='test', fromfile_prefix_chars="@")
parser.add_argument('-l', '--launch_directory', type=readable_dir, default='/tmp/non_existent_dir')
args = parser.parse_args()
Ответы
Ответ 1
Вы можете создать настраиваемое действие вместо типа:
import argparse
import os
import tempfile
import shutil
import atexit
class readable_dir(argparse.Action):
def __call__(self, parser, namespace, values, option_string=None):
prospective_dir=values
if not os.path.isdir(prospective_dir):
raise argparse.ArgumentTypeError("readable_dir:{0} is not a valid path".format(prospective_dir))
if os.access(prospective_dir, os.R_OK):
setattr(namespace,self.dest,prospective_dir)
else:
raise argparse.ArgumentTypeError("readable_dir:{0} is not a readable dir".format(prospective_dir))
ldir = tempfile.mkdtemp()
atexit.register(lambda dir=ldir: shutil.rmtree(ldir))
parser = argparse.ArgumentParser(description='test', fromfile_prefix_chars="@")
parser.add_argument('-l', '--launch_directory', action=readable_dir, default=ldir)
args = parser.parse_args()
print (args)
Но это кажется мне немного подозрительным - если каталог не указан, он передает нечитаемый каталог, который, кажется, лишает цель проверить, доступен ли каталог в первую очередь.
Обратите внимание, что, как указано в комментариях, может быть лучше raise argparse.ArgumentError(self, ...)
вместо argparse.ArgumentTypeError
.
ИЗМЕНИТЬ
Насколько я знаю, нет способа проверить аргумент по умолчанию. Я полагаю, что разработчики argparse
предположили, что если вы предоставляете значение по умолчанию, оно должно быть действительным. Самый быстрый и простой способ сделать это - просто проверить аргументы сразу после их анализа. Похоже, вы просто пытаетесь получить временный каталог, чтобы выполнить какую-то работу. В этом случае вы можете использовать модуль tempfile
, чтобы получить новый каталог для работы. Я обновил свой ответ выше, чтобы отразить это. Я создаю временный каталог, использую его как аргумент по умолчанию (tempfile
уже гарантирует, что создаваемый каталог будет записываться), а затем я зарегистрирую его для удаления, когда ваша программа выйдет.
Ответ 2
Я отправил патч для "аргументов пути" в список рассылки стандартной библиотеки Python несколько месяцев назад.
С помощью этого класса PathType
вы можете просто указать следующий тип аргумента, чтобы он соответствовал только существующему каталогу - что-нибудь еще даст сообщение об ошибке:
type = PathType(exists=True, type='dir')
Здесь код, который может быть легко изменен, чтобы требовать определенных прав на файл/каталог:
from argparse import ArgumentTypeError as err
import os
class PathType(object):
def __init__(self, exists=True, type='file', dash_ok=True):
'''exists:
True: a path that does exist
False: a path that does not exist, in a valid parent directory
None: don't care
type: file, dir, symlink, None, or a function returning True for valid paths
None: don't care
dash_ok: whether to allow "-" as stdin/stdout'''
assert exists in (True, False, None)
assert type in ('file','dir','symlink',None) or hasattr(type,'__call__')
self._exists = exists
self._type = type
self._dash_ok = dash_ok
def __call__(self, string):
if string=='-':
# the special argument "-" means sys.std{in,out}
if self._type == 'dir':
raise err('standard input/output (-) not allowed as directory path')
elif self._type == 'symlink':
raise err('standard input/output (-) not allowed as symlink path')
elif not self._dash_ok:
raise err('standard input/output (-) not allowed')
else:
e = os.path.exists(string)
if self._exists==True:
if not e:
raise err("path does not exist: '%s'" % string)
if self._type is None:
pass
elif self._type=='file':
if not os.path.isfile(string):
raise err("path is not a file: '%s'" % string)
elif self._type=='symlink':
if not os.path.symlink(string):
raise err("path is not a symlink: '%s'" % string)
elif self._type=='dir':
if not os.path.isdir(string):
raise err("path is not a directory: '%s'" % string)
elif not self._type(string):
raise err("path not valid: '%s'" % string)
else:
if self._exists==False and e:
raise err("path exists: '%s'" % string)
p = os.path.dirname(os.path.normpath(string)) or '.'
if not os.path.isdir(p):
raise err("parent path is not a directory: '%s'" % p)
elif not os.path.exists(p):
raise err("parent directory does not exist: '%s'" % p)
return string
Ответ 3
Если ваш script не может работать без действительного launch_directory
, тогда он должен быть обязательным аргументом:
parser.add_argument('launch_directory', type=readable_dir)
btw, вы должны использовать argparse.ArgumentTypeError
вместо Exception
в readable_dir()
.