loại đường dẫn thư mục với argparse

Question

Tập lệnh python của tôi cần đọc các tệp từ thư mục được truyền trên dòng lệnh. Tôi đã định nghĩa một kiểu readable_dir như dưới đây để được sử dụng với argparse để xác nhận rằng thư mục được truyền trên dòng lệnh là tồn tại và có thể đọc được. Ngoài ra, giá trị mặc định (/ tmp/non_existent_dir trong ví dụ bên dưới) cũng đã được chỉ định cho đối số thư mục. Vấn đề ở đây là argparse gọi readable_dir() trên giá trị mặc định ngay cả trong trường hợp đối số thư mục được truyền vào dòng lệnh một cách rõ ràng. Điều này làm cho kịch bản trở nên khó hiểu vì đường dẫn mặc định/tmp/non_existent_dir không tồn tại trong một ngữ cảnh mà thư mục được truyền vào dòng lệnh một cách rõ ràng. Tôi có thể giải quyết vấn đề này bằng cách không chỉ định giá trị mặc định và làm cho đối số này bắt buộc hoặc trì hoãn xác thực cho đến sau này trong tập lệnh nhưng là giải pháp thanh lịch hơn mà mọi người đều biết?

#!/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() 

Answer 1

Bạn có thể tạo một hành động tùy chỉnh thay vì một loại:

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) 

Nhưng điều này có vẻ hơi tanh với tôi - nếu không có thư mục được đưa ra, nó đi một thư mục không thể đọc được mà có vẻ để đánh bại mục đích kiểm tra xem thư mục có thể truy cập được ở địa điểm đầu tiên không.

Lưu ý rằng như được nêu trong các nhận xét, nó có thể đẹp hơn đối với
raise argparse.ArgumentError(self, ...) thay vì argparse.ArgumentTypeError.

EDIT

Theo như tôi biết, không có cách nào để xác nhận đối số mặc định. Tôi cho rằng các nhà phát triển argparse chỉ giả định rằng nếu bạn đang cung cấp mặc định, thì nó sẽ hợp lệ. Điều nhanh nhất và dễ nhất để làm ở đây là chỉ cần xác thực các đối số ngay lập tức sau khi bạn phân tích cú pháp chúng. Có vẻ như, bạn chỉ đang cố gắng lấy một thư mục tạm thời để thực hiện một số công việc. Nếu đúng như vậy, bạn có thể sử dụng mô-đun tempfile để có được một thư mục mới để làm việc. Tôi đã cập nhật câu trả lời ở trên để phản ánh điều này. Tôi tạo một thư mục tạm thời, sử dụng nó làm đối số mặc định (tempfile đã đảm bảo thư mục mà nó tạo ra sẽ được ghi) và sau đó tôi đăng ký nó để xóa khi chương trình của bạn thoát.

Answer 2

Nếu kịch bản của bạn không thể làm việc mà không có một giá trị launch_directory sau đó nó phải được thực hiện một cuộc tranh luận bắt buộc:

parser.add_argument('launch_directory', type=readable_dir) 

btw, bạn nên sử dụng argparse.ArgumentTypeError thay vì Exception trong readable_dir().

Answer 3

Tôi đã gửi a patch for "path arguments" to the Python standard library mailing list cách đây vài tháng.

Với lớp PathType này, bạn chỉ có thể xác định loại tranh luận sau đây để phù hợp với chỉ một thư mục đang tồn tại - bất cứ điều gì khác sẽ đưa ra một thông báo lỗi:

type = PathType(exists=True, type='dir') 

Dưới đây là đoạn code, mà có thể là một cách dễ dàng được sửa đổi để yêu cầu quyền đối với tệp/thư mục cụ thể:

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