Tôi nên vượt qua tên tập tin để được mở, hoặc mở tập tin?

Giả sử tôi có một chức năng thực hiện mọi thứ với tệp văn bản - ví dụ đọc từ nó và xóa từ 'a'. Tôi có thể truyền cho nó một tên tệp và xử lý việc mở / đóng trong hàm, hoặc tôi có thể chuyển nó vào tệp đã mở và hy vọng rằng bất cứ ai gọi nó sẽ xử lý việc đóng nó.

Cách đầu tiên có vẻ như là một cách tốt hơn để đảm bảo không có tệp nào bị bỏ ngỏ, nhưng ngăn tôi sử dụng những thứ như các đối tượng StringIO

Cách thứ hai có thể hơi nguy hiểm - không có cách nào để biết liệu tệp có bị đóng hay không, nhưng tôi có thể sử dụng các đối tượng giống như tệp

def ver_1(filename):
    with open(filename, 'r') as f:
        return do_stuff(f)

def ver_2(open_file):
    return do_stuff(open_file)

print ver_1('my_file.txt')

with open('my_file.txt', 'r') as f:
    print ver_2(f)

Là một trong những thường được ưa thích? Có phải nói chung dự kiến ​​rằng một chức năng sẽ hành xử theo một trong hai cách này? Hoặc nó chỉ nên được ghi chép tốt để lập trình viên có thể sử dụng chức năng cho phù hợp?

Giao diện thuận tiện là tốt đẹp, và đôi khi cách để đi. Tuy nhiên, hầu hết thời gian khả năng kết hợp tốt quan trọng hơn sự tiện lợi , vì sự trừu tượng hóa có thể tổng hợp cho phép chúng tôi thực hiện các chức năng khác (bao gồm các trình bao bọc tiện lợi) trên đầu trang.

Cách chung nhất để chức năng của bạn sử dụng tệp là lấy một tệp xử lý mở làm tham số, vì điều này cho phép nó cũng sử dụng các thẻ điều khiển không phải là một phần của hệ thống tệp (ví dụ: ống, ổ cắm, Thẻ):

def your_function(open_file):
    return do_stuff(open_file)

Nếu đánh vần with open(filename, 'r') as f: result = your_function(f)quá nhiều để hỏi người dùng của bạn, bạn có thể chọn một trong các giải pháp sau:

• your_functionlấy một tệp đang mở hoặc một tên tệp làm tham số. Nếu đó là tên tệp, tệp sẽ được mở và đóng và ngoại lệ được truyền bá. Có một chút vấn đề với sự mơ hồ ở đây có thể được giải quyết bằng cách sử dụng các đối số được đặt tên.

• Cung cấp một trình bao bọc đơn giản chăm sóc mở tệp, ví dụ:

  def your_function_filename(file):
      with open(file, 'r') as f:
          return your_function(f)

  Tôi thường cảm nhận các chức năng như API bloat, nhưng nếu chúng cung cấp chức năng thường được sử dụng, thì sự thuận tiện thu được là một đối số đủ mạnh.

• Gói with openchức năng trong một chức năng tổng hợp khác:

  def with_file(filename, callback):
      with open(filename, 'r') as f:
          return callback(f)

  được sử dụng như with_file(name, your_function)hoặc trong các trường hợp phức tạp hơnwith_file(name, lambda f: some_function(1, 2, f, named=4))

Câu hỏi thực sự là một trong những đầy đủ. Là chức năng xử lý tệp của bạn là xử lý hoàn chỉnh tệp, hay chỉ là một phần trong chuỗi các bước xử lý? Nếu nó hoàn thành và tự nó, thì hãy đóng gói tất cả quyền truy cập tệp trong một hàm.

def ver(filepath):
    with open(filepath, "r") as f:
        # do processing steps on f
        return result

Điều này có thuộc tính rất hay là hoàn thiện tài nguyên (đóng tệp) vào cuối withcâu lệnh.

Tuy nhiên, nếu có thể cần xử lý một tệp đã mở, thì việc phân biệt của bạn ver_1và ver_2có ý nghĩa hơn. Ví dụ:

def _ver_file(f):
    # do processing steps on f
    return result

def ver(fileobj):
    if isinstance(fileobj, str):
        with open(fileobj, 'r') as f:
            return _ver_file(f)
    else:
        return _ver_file(fileobj)

Đây là loại thử nghiệm loại rõ ràng thường được tán thành , đặc biệt là trong các ngôn ngữ như Java, Julia, và Go nơi loại- hoặc điều phối giao diện dựa trên được hỗ trợ trực tiếp. Tuy nhiên, trong Python, không có hỗ trợ ngôn ngữ nào cho việc gửi dựa trên kiểu. Thỉnh thoảng bạn có thể thấy những lời chỉ trích về kiểm tra kiểu trực tiếp trong Python, nhưng trong thực tế, nó cực kỳ phổ biến và khá hiệu quả. Nó cho phép một hàm có mức độ tổng quát cao, xử lý bất kỳ kiểu dữ liệu nào có khả năng đi theo cách của nó, còn gọi là "gõ vịt". Lưu ý gạch dưới hàng đầu trên _ver_file; đó là một cách thông thường để chỉ định một chức năng (hoặc phương thức) riêng tư. Mặc dù về mặt kỹ thuật có thể được gọi trực tiếp, nó cho thấy chức năng này không dành cho tiêu dùng bên ngoài trực tiếp.

Cập nhật 2019: Đưa ra các bản cập nhật gần đây trong Python 3, ví dụ: các đường dẫn hiện có khả năng được lưu trữ dưới dạng pathlib.Pathcác đối tượng không chỉ strhoặc bytes(3.4+) và gợi ý kiểu đó đã chuyển từ bí truyền sang chính thống (khoảng 3.6+, mặc dù vẫn đang tích cực phát triển), đây mã cập nhật đưa những tiến bộ này vào tài khoản:

from pathlib import Path
from typing import IO, Any, AnyStr, Union

Pathish = Union[AnyStr, Path]  # in lieu of yet-unimplemented PEP 519
FileSpec = Union[IO, Pathish]

def _ver_file(f: IO) -> Any:
    "Process file f"
    ...
    return result

def ver(fileobj: FileSpec) -> Any:
    "Process file (or file path) f"
    if isinstance(fileobj, (str, bytes, Path)):
        with open(fileobj, 'r') as f:
            return _ver_file(f)
    else:
        return _ver_file(fileobj)

Nếu bạn chuyển tên tệp xung quanh thay vì xử lý tệp thì không có gì đảm bảo rằng tệp thứ hai là cùng tệp với tệp đầu tiên khi được mở; điều này có thể dẫn đến lỗi chính xác và lỗ hổng bảo mật.

Đây là về quyền sở hữu và trách nhiệm đóng tệp. Bạn có thể chuyển một luồng hoặc xử lý tệp hoặc bất cứ điều gì đáng lẽ phải đóng / xử lý tại một thời điểm nào đó cho phương thức khác, miễn là bạn chắc chắn ai là người sở hữu nó và chắc chắn nó sẽ bị chủ sở hữu đóng khi bạn hoàn thành . Điều này thường liên quan đến một cấu trúc thử cuối cùng hoặc mẫu dùng một lần.

Nếu bạn chọn chuyển các tệp đang mở, bạn có thể thực hiện một số thứ như NHƯNG sau đây, bạn không có quyền truy cập vào tên tệp trong hàm ghi vào tệp.

Tôi sẽ làm điều này nếu tôi muốn có một lớp chịu trách nhiệm 100% cho các hoạt động tệp / luồng và các lớp hoặc chức năng khác sẽ ngây thơ và không mong muốn mở hoặc đóng các tệp / luồng đã nói.

Hãy nhớ rằng các nhà quản lý bối cảnh làm việc như có một mệnh đề cuối cùng. Vì vậy, nếu một ngoại lệ được ném vào chức năng nhà văn, tập tin sẽ bị đóng bất kể điều gì.

import contextlib

class FileOpener:

    def __init__(self, path_to_file):
        self.path_to_file = path_to_file

    @contextlib.contextmanager
    def open_write(self):
        # ...
        # Here you can add code to create the directory that will accept the file.
        # ...
        # And you can add code that will check that the file does not exist 
        # already and maybe raise FileExistsError
        # ...
        try:            
            with open(self.path_to_file, "w") as file:
                print(f"open_write: has opened the file with id:{id(file)}")            
                yield file                
        except IOError:
            raise
        finally:
            # The try/catch/finally is not mandatory (except if you want to manage Exceptions in an other way, as file objects have predefined cleanup actions 
            # and when used with a 'with' ie. a context manager (not the decorator in this example) 
            # are closed even if an error occurs. Finally here is just used to demonstrate that the 
            # file was really closed.
            print(f"open_write: has closed the file with id:{id(file)} - {file.closed}")        


def writer(file_open, data, raise_exc):
    with file_open() as file:
        print("writer: started writing data.")
        file.write(data)
        if raise_exc:
            raise IOError("I am a broken data cable in your server!")
        print("writer: wrote data.")
    print("writer: finished.")

if __name__ == "__main__":
    fo = FileOpener('./my_test_file.txt')    
    data = "Hello!"  
    raise_exc = False  # change me to True and see that the file is closed even if an Exception is raised.
    writer(fo.open_write, data, raise_exc)