7

ファイルを最初の引数として取るいくつかの関数のデコレータを書きたいと思います。デコレータはコンテキストマネージャプロトコルを実装する必要があるため（つまり、ラップされた関数をコンテキストマネージャに変換する）、関数をクラスでラップする必要があると考えました。

私はデコレータパターンの経験があまりなく、これまでコンテキストマネージャを実装したことはありませんが、私が書いたものはPython 2.7で機能し、コメントアウトするとPython3.3でも機能しwrapsます。

from functools import wraps
def _file_reader(func):
    """A decorator implementing the context manager protocol for functions
    that read files."""
#   @wraps(func)
    class CManager:
        def __init__(self, source, *args, **kwargs):
            self.source = source
            self.args = args
            self.kwargs = kwargs
            self.close = kwargs.get('close', True)

        def __enter__(self):
            # _file_obj is a little helper that opens the file for reading
            self.fsource = _file_obj(self.source, 'r') 
            return func(self.fsource, *self.args, **self.kwargs)

        def __exit__(self, exc_type, exc_value, traceback):
            if self.close:
                self.fsource.close()
            return False
    return CManager

行のコメントを解除するときに発生するエラーは、次のwraps内部で発生しますupdate_wrapper。

/usr/lib/python3.3/functools.py in update_wrapper(wrapper, wrapped, assigned, updated)
     54             setattr(wrapper, attr, value)
     55     for attr in updated:
---> 56         getattr(wrapper, attr).update(getattr(wrapped, attr, {}))
     57     # Return the wrapper so this can be used as a decorator via partial()
     58     return wrapper

AttributeError: 'mappingproxy' object has no attribute 'update'

このようなクラスで関数をラップするために使用できるとドキュメントに記載されていないことは知っていますがfunctools.wraps、Python 2でも機能します。このトレースバックが正確に何を示しているのか、何をすべきかを誰かに説明してもらえますか？wrapsPythonの両方のバージョンでの効果を達成するには？

編集：私は間違っていた。上記のコードは、私が望んでいることを実行しません。ビルトインのように、の有無にかかわらず関数を使用できるようにしたいと思います。 withopen

上記のコードは、装飾された関数をコンテキストマネージャーに変換します。私ができるようになりたい：

reader = func('source.txt', arg)
for item in reader:
    pass

と同様

with func('source.txt', arg) as reader:
    for item in reader:
        pass

したがって、私のバージョンのコードは、おそらく次のようになります。

def _file_reader(func):
    """A decorator implementing the context manager protocol for functions
    that read files."""
    @wraps(func)
    class CManager:
        def __init__(self, source, *args, **kwargs):
            self.close = kwargs.get('close', True)
            self.fsource = _file_obj(source, 'r')
            self.reader = func(self.fsource, *args, **kwargs)

        def __enter__(self):
            return self.reader

        def __iter__(self):
            return self.reader

        def __next__(self):
            return next(self.reader)

        def __exit__(self, exc_type, exc_value, traceback):
            if self.close and not self.fsource.closed:
                self.fsource.close()
            return False
    return CManager

私が見落としたものについては、遠慮なくコメントしてください。

注：JFセバスティアンによるクラスバージョンは、次のように機能するようです。

基本的wrapsにクラスからを削除し、次のように変更return CManagerしました。

@wraps(func)
def helper(*args, **kwargs):
    return CManager(*args, **kwargs)
return helper
4

2 に答える 2

3

functools.wraps()ラッパー関数用です：

import contextlib
import functools

def file_reader(func):
    @functools.wraps(func)
    @contextlib.contextmanager
    def wrapper(file, *args, **kwargs):
        close = kwargs.pop('close', True) # remove `close` argument if present
        f = open(file)
        try:
            yield func(f, *args, **kwargs)
        finally:
            if close:
               f.close()
    return wrapper

例

@file_reader
def f(file):
    print(repr(file.read(10)))
    return file

with f('prog.py') as file:
    print(repr(file.read(10)))

クラスベースのコンテキスト マネージャーを使用する場合の回避策は次のとおりです。

def file_reader(func):
    @functools.wraps(func)
    def helper(*args, **kwds):
        return File(func, *args, **kwds)
    return helper

装飾された関数が直接使用されているか、コンテキスト マネージャーとして使用されているかに関係なく、同じように動作させるには、次のように返す必要がありselfます__enter__()。

import sys

class File(object):

    def __init__(self, file, func, *args, **kwargs):
        self.close_file = kwargs.pop('close', True)
        # accept either filename or file-like object
        self.file = file if hasattr(file, 'read') else open(file)

        try:
            # func is responsible for self.file if it doesn't return it
            self.file = func(self.file, *args, **kwargs)
        except:  # clean up on any error
            self.__exit__(*sys.exc_info())
            raise

    # context manager support
    def __enter__(self):
        return self

    def __exit__(self, *args, **kwargs):
        if not self.close_file:
            return  # do nothing
        # clean up
        exit = getattr(self.file, '__exit__', None)
        if exit is not None:
            return exit(*args, **kwargs)
        else:
            exit = getattr(self.file, 'close', None)
            if exit is not None:
                exit()

    # iterator support
    def __iter__(self):
        return self

    def __next__(self):
        return next(self.file)

    next = __next__  # Python 2 support

    # delegate everything else to file object
    def __getattr__(self, attr):
        return getattr(self.file, attr)

例

file = f('prog.py')  # use as ordinary function
print(repr(file.read(20)))
file.seek(0)
for line in file:
    print(repr(line))
    break
file.close()
于 2012-12-30T23:00:01.373 に答える
2

あなたが見ているエラーが何であるかはわかりませんが、とにかくあなたはおそらく運命にあるようです:

>>> import functools
>>> def foo():
...     pass
... 
>>> class bar:
...     pass
... 
>>> functools.wraps(foo)(bar)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/usr/lib64/python3.2/functools.py", line 48, in update_wrapper
    setattr(wrapper, attr, value)
AttributeError: attribute '__doc__' of 'type' objects is not writable
>>> bar.__doc__
>>> bar.__doc__ = 'Yay'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: attribute '__doc__' of 'type' objects is not writable

編集： JF Sebastianには解決策がありますが、クラスではなく関数でなければならない理由についての説明として、このビットを残しています

于 2012-12-30T22:43:19.240 に答える