如何在Python函数中接受文件名和类文件对象？

Question

在我的代码中，我有一个 load_dataset 函数，它读取文本文件并进行一些处理。最近，我考虑添加对类文件对象的支持，并且我想知道对此的最佳方法。目前我想到了两种实现：

首先，类型检查：

if isinstance(inputelement, basestring):
   # open file, processing etc
# or
# elif hasattr(inputelement, "read"):
elif isinstance(inputelement, file):
   # Do something else

或者，两个不同的论点：

def load_dataset(filename=None, stream=None):
    if filename is not None and stream is None:
        # open file etc
    elif stream is not None and filename is None:
        # do something else

但这两种解决方案都没有让我太信服，尤其是第二个，因为我看到了太多的陷阱。

将类似文件的对象或字符串接受到执行文本读取的函数的最干净（也是最Pythonic）的方法是什么？

Answer 1

将文件名或类文件对象作为参数的一种方法是实现 此处找到实现，我引用是为了一个独立的答案：

class open_filename(object):
"""Context manager that opens a filename and closes it on exit, but does
nothing for file-like objects.
"""
def __init__(self, filename, *args, **kwargs):
    self.closing = kwargs.pop('closing', False)
    if isinstance(filename, basestring):
        self.fh = open(filename, *args, **kwargs)
        self.closing = True
    else:
        self.fh = filename

def __enter__(self):
    return self.fh

def __exit__(self, exc_type, exc_val, exc_tb):
    if self.closing:
        self.fh.close()

    return False

然后可能的用法：

def load_dataset(file_):
    with open_filename(file_, "r") as f:
        # process here, read only if the file_ is a string

Answer 2

不要同时接受文件和字符串。如果您要接受类似文件的对象，则意味着您不会检查类型，只需在实际参数上调用所需的方法（read、write ， ETC。）。如果您要接受字符串，那么您最终将open-ing 文件，这意味着您将无法模拟参数。所以我会说接受文件，让调用者向您传递一个类似文件的对象，并且不检查类型。

Answer 3

我正在使用上下文管理器包装器。当它是文件名 (str) 时，退出时关闭文件。

@contextmanager
def fopen(filein, *args, **kwargs):
    if isinstance(filein, str):  # filename
        with open(filein, *args, **kwargs) as f:
            yield f
    else:  # file-like object
        yield filein

然后你可以像这样使用它：

with fopen(filename_or_fileobj) as f:
    # do sth. with f

Answer 4

Python遵循鸭子类型，您可以通过对象中需要的函数检查这是否是文件对象。例如，hasattr(obj, 'read') 与 isinstance(inputelement, file) 相对。
为了将字符串转换为文件对象，您还可以使用这样的构造：

if not hasattr(obj, 'read'):
    obj = StringIO(str(obj))

在这段代码之后，您将能够安全地使用 obj 作为文件。