pythonwrap

Ⅰ python筆記：Python裝飾器

裝飾器是通過裝飾器函數修改原函數的一些功能而不需要修改原函數，在很多場景可以用到它，比如① 執行某個測試用例之前，判斷是否需要登錄或者執行某些特定操作；② 統計某個函數的執行時間；③ 判斷輸入合法性等。合理使用裝飾器可以極大地提高程序的可讀性以及運行效率。本文將介紹Python裝飾器的使用方法。

python裝飾器可以定義如下：

輸出：

python解釋器將test_decorator函數作為參數傳遞給my_decorator函數，並指向了內部函數 wrapper()，內部函數 wrapper() 又會調用原函數 test_decorator()，所以decorator()的執行會先列印'this is wrapper'，然後列印'hello world'， test_decorator()執行完成後，列印 'bye' ，*args和**kwargs，表示接受任意數量和類型的參數。

裝飾器 my_decorator() 把真正需要執行的函數 test_decorator() 包裹在其中，並且改變了它的行為，但是原函數 test_decorator() 不變。

一般使用如下形式使用裝飾器：

@my_decorator就相當於 decorator = my_decorator(test_decorator) 語句。

內置裝飾器@functools.wrap可用於保留原函數的元信息（將原函數的元信息，拷貝到對應的裝飾器函數里）。先來看看沒有使用functools的情況：

輸出：

從上面的輸出可以看出test_decorator() 函數被裝飾以後元信息被wrapper() 函數取代了，可以使用@functools.wrap裝飾器保留原函數的元信息：

輸出：

裝飾器可以接受自定義參數。比如定義一個參數來設置裝飾器內部函數的執行次數：

輸出：

Python 支持多個裝飾器嵌套：

裝飾的過程：

順序從里到外：

test_decorator('hello world') 執行順序和裝飾的過程相反。

輸出：

類也可以作為裝飾器，類裝飾器主要依賴__call__()方法，是python中所有能被調用的對象具有的內置方法（python魔術方法），每當調用一個類的實例時，__call__()就會被執行一次。

下面的類裝飾器實現統計函數執行次數：

輸出：

下面介紹兩種裝飾器使用場景

統計函數執行所花費的時間

輸出：

在使用某些web服務時，需要先判斷用戶是否登錄，如果沒有登錄就跳轉到登錄頁面或者提示用戶登錄：

--THE END--

Ⅱ 「低門檻 手把手」python 裝飾器(Decorators)原理說明

本文目的是由淺入深地介紹python裝飾器原理

裝飾器(Decorators)是 Python 的一個重要部分

其功能是， 在不修改原函數(類)定義代碼的情況下，增加新的功能

為了理解和實現裝飾器，我們先引入2個核心操作：

在這個例子中，函數hi的形參name，默認為'world'

在函數內部，又定義了另一個函數 howdoyoudo，定義這個函數時，將形參name作為新函數的形參name2的默認值。

因此，在函數內部調用howdoyoudo()時，將以調用hi時的實參為默認值，但也可以給howdoyoudo輸入其他參數。

上面的例子運行後輸出結果為：

這里新定義的howdoyoudo可以稱作一個「閉包」。不少關於裝飾器的blog都提到了這個概念，但其實沒必要給它取一個多專業的名字。我們知道閉包是 函數內的函數 就可以了

當我們進行 def 的時候，我們在做什麼？

這時，hi函數，列印一個字元串，同時返回一個字元串。

但hi函數本身也是一個對象，一個可以執行的對象。執行的方式是hi()。

這里hi和hi()有本質區別，

hi 代表了這個函數對象本身

hi() 則是運行了函數，得到函數的返回值。

作為對比，可以想像以下代碼

此時也是b存在，可以正常使用。

我們定義2個函數，分別實現自加1， 自乘2，

再定義一個函數double_exec，內容是將某個函數調用2次

在調用double_exec時，可以將函數作為輸入傳進來

輸出結果就是

7

27

同樣，也可以將函數作為輸出

輸出結果為

6

10

有了以上兩個核心操作，我們可以嘗試構造裝飾器了。

裝飾器的目的： 在不修改原函數(類)定義代碼的情況下，增加新的功能

試想一下，現在有一個原函數

在不修改原函數定義代碼的情況下，如果想進行函數內容的添加，可以將這個函數作為一個整體，添加到這樣的包裹中：

我們定義了一個my_decorator函數，這個函數進行了一種操作：

對傳入的f，添加操作(運行前後增加列印)，並把添加操作後的內容連同運行原函數的內容，一起傳出

這個my_decorator，定義了一種增加前後列印內容的行為

調用my_decorator時，對這個行為進行了操作。

因此，new_function是一個在original_function上增加了前後列印行為的新函數

這個過程被可以被稱作裝飾。

這里已經可以發現，裝飾器本身對於被裝飾的函數是什麼，是不需要考慮的。裝飾器本身只定義了一種裝飾行為，這個行為是通過裝飾器內部的閉包函數()進行定義的。

運行裝飾前後的函數，可以清晰看到裝飾的效果

我們復現一下實際要用裝飾器的情況，我們往往有一種裝飾器，想應用於很多個函數，比如

此時，如果我們想給3個print函數都加上裝飾器，需要這么做

實際調用的時候，就需要調用添加裝飾器的函數名了

當然，也可以賦值給原函數名

這樣至少不需要管理一系列裝飾前後的函數。

同時，在不需要進行裝飾的時候，需要把

全部刪掉。

事實上，這樣並不方便，尤其對於更復雜的裝飾器來說

為此，python提供了一種簡寫方式

這個定義print1函數前的@my_decorator，相當於在定義完print1後，自動直接運行了

不論採用@my_decorator放在新函數前，還是顯示地重寫print1 = my_decorator(print1)，都會存在一個問題：

裝飾後的函數，名字改變了(其實不止名字，一系列的索引都改變了)

輸出結果為:

這個現象的原因是，裝飾行為本身，是通過構造了一個新的函數（例子中是wrap_func函數）來實現裝飾這個行為的，然後把這個修改後的函數賦給了原函數名。

這樣，會導致我們預期的被裝飾函數的一些系統變數（比如__name__）發生了變化。

對此，python提供了解決方案：

經過這個行為後，被裝飾函數的系統變數問題被解決了

輸出結果為

剛才的例子都比較簡單，被裝飾的函數是沒有參數的。如果被裝飾的函數有參數，只需要在定義裝飾行為時（事實上，這個才更通用），增加(*args, **kwargs)描述即可

之前的描述中可以感受到，對於例子中的裝飾行為(前後加列印)，函數被裝飾後，本質上是調用了新的裝飾函數wrap_func。

因此，如果原函數需要有輸入參數傳遞，只需要在wrap_func（或其他任意名字的裝飾函數）定義時，也增加參數輸入(*args, **kwargs)，並將這些參數，原封不動地傳給待裝飾函數f。

這種定義裝飾行為的方式更具有普遍性，忘記之前的定義方式吧

我們試一下

輸出

這里需要注意的是，如果按照以下的方式定義裝飾器

那麼以下語句將不會執行

因為裝飾後實際的函數wrap_func(雖然名字被改成了原函數，系統參數也改成了原函數)，運行到return f(*args, **kwargs) 的時候已經結束了

因為裝飾器my_decorator本身也是可以輸入的，因此，只需要在定義裝飾器時，增加參數，並在後續函數中使用就可以了，比如

此時裝飾器已經可以有輸入參數了

輸出

你可能發現，為什麼不用簡寫版的方法了

因為以上代碼會報錯！！

究其原因，雖然

等價於

但是，

並不等價於

這本身和@語法有關，使用@my_decorator時，是系統在應用一個以單個函數作為參數的閉包函數。即，@是不能帶參數的。

但是你應該發現了，之前的@wraps(f)不是帶參數了嗎？請仔細觀察以下代碼

通過一層嵌套，my_decorator_with_parma本質上是返回了一個參數僅為一個函數的函數(my_decorator)，但因為my_decorator對my_decorator_with_parma來說是一個閉包，my_decorator_with_parma是可以帶參數的。（這句話真繞）

通過以上的定義，我們再來看

可以這么理解，my_decorator_with_parma(msg='yusheng')的結果是原來的my_decorator函數，同時，因為my_decorator_with_parma可以傳參，參數實際上是參與了my_decorator的（因為my_decorator對my_decorator_with_parma是閉包）， my_decorator_with_parma(msg='yusheng') 全等於 一個有參數參加的my_decorator

因此，以上代碼等價於有參數msg傳遞的

比較繞，需要理解一下，或者乾脆強記這種範式：

以上範式包含函數的輸入輸出、裝飾器的輸入，可以應對大部分情況了。

實驗一下：

輸出

以上是一個log裝飾器，利用datetime統計了函數的耗時，

並且，裝飾器可以進行輸出文件操作，如果給出了文件路徑，則輸出文件，否則就列印。

利用這個裝飾器，可以靈活地進行耗時統計

不設置輸出文件地址，則列印。運行結果為：

也可以輸出到文件

輸出結果為

同時在當前目錄生成了一個test.log 文件，內容為：

以上的裝飾器都是以函數形式出現的，但我們可以稍做改寫，將裝飾器以類的形式實現。

這個裝飾器類Log 上個例子里的裝飾器函數log功能是一樣的，同時，這個裝飾器類還可以作為基類被其他繼承，進一步增加功能。

原文 http://www.cnblogs.com/yushengchn/p/15636944.html

Ⅲ python裝飾器使用

裝飾器是從英文decorator翻譯過來的，從字面上來看就是對某個東西進行修飾，增強被修飾物的功能，下面我們對裝飾器做下簡單介紹。

一、怎麼編寫裝飾器

裝飾器的實現很簡單，本質是一個可調用對象，可以是函數、方法、對象等，它既可以裝飾函數也可以裝飾類和方法，為了簡單說明問題，我們實現一個函數裝飾器，如下代碼：

有了這個裝飾器，我們就可以列印出什麼時候開始和結束調用函數，對於排查函數的調用鏈非常方便。

二、帶參數的裝飾器

上面的例子無論什麼時候調用sum都會輸出信息，如果我們需要按需輸出信息怎麼實現呢，這時就要用到帶參數的裝飾器了，如下代碼：

對sum使用裝飾器時沒有參數，這時debug為0，所以調用sum時不會輸出函數調用相關信息。

對multi使用裝飾器時有參數，這時debug為1，所以調用multi時會輸出函數調用相關信息。

三、函數名字問題

當我們列印被裝飾後的函數名字時，不知道大家有沒發現輸出的不是函數本身的名字，如下代碼會輸出『wrap』而不是『sum』：

有時這種表現並不是我們想要的，我們希望被裝飾後的函數名字還是函數本身，那要怎麼實現呢？很簡單，只需要引入functools.wraps即可，如下代碼就會輸出『sum』了：

看完後是不是覺得python裝飾器很簡單，只要了解它的本質，怎麼寫都行，有好多種玩法呢。

Ⅳ textwrap -- 文本自動換行與填充

textwrap模塊在Python中主要用於文本的自動換行與填充，以下是關於這些功能的詳細解答：

1. 自動換行：

   • **textwrap.wrap：該函數將文本text按照每行width個字元自動換行，並返回一個列表。列表中的每個元素表示一行文本，行尾不帶換行符。所有轉義字元如n、a、b等被轉換為空格，而0保持不變。

2. 填充：

   • **textwrap.fill：該函數同樣用於自動換行，但返回的是一個新字元串。字元串中的每一行由換行符n分隔。與textwrap.wrap類似，部分專業字元被轉換為空格，而0保持不變。

3. 其他相關功能：

   • **textwrap.shorten：該函數用於折疊文本中的連續空格為一個，並按照指定的width截取字元串，同時添加後綴。確保截取後的字元串加上後綴後的長度不超過width。
   • textwrap.dedent：該函數移除所有行中相同前綴的空白符。它會找到所有行中前綴空白符最短的一個，然後所有行移除同等數量的前綴空白符。空格和t轉義字元都會被考慮，但t不會被當作8個空格處理。
   • textwrap.indent：該函數在指定行的開頭添加字元。prefix會被添加到文本text中每行子字元串的開頭，通過predicate參數傳入的匿名函數可以篩選符合條件的行添加prefix。默認情況下，prefix會添加到所有不是由空白符組成的行中。

4. TextWrapper類：

   • textwrap.TextWrapper**：這是TextWrapper類的構造器，接受多個可選的關鍵字參數，用於更靈活地對文本進行格式化。實例化後可以設置各種屬性來控制文本的換行、填充等行為。

以上功能使得textwrap模塊成為Python中處理文本格式化的強大工具。