FilesExpand file tree

 master

/

decorator.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

74 lines (51 loc) · 1.91 KB

 master

/

decorator.py

Copy path

Top

File metadata and controls

• Code
• Blame

74 lines (51 loc) · 1.91 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

"""

*What is this pattern about?

The Decorator pattern is used to dynamically add a new feature to an

object without changing its implementation. It differs from

inheritance because the new feature is added only to that particular

object, not to the entire subclass.

*What does this example do?

This example shows a way to add formatting options (boldface and

italic) to a text by appending the corresponding tags (<b> and

<i>). Also, we can see that decorators can be applied one after the other,

since the original text is passed to the bold wrapper, which in turn

is passed to the italic wrapper.

*Where is the pattern used practically?

The Grok framework uses decorators to add functionalities to methods,

like permissions or subscription to an event:

http://grok.zope.org/doc/current/reference/decorators.html

*References:

https://sourcemaking.com/design_patterns/decorator

*TL;DR

Adds behaviour to object without affecting its class.

"""

class TextTag:

"""Represents a base text tag"""

def __init__(self, text: str) -> None:

self._text = text

def render(self) -> str:

return self._text

class BoldWrapper(TextTag):

"""Wraps a tag in <b>"""

def __init__(self, wrapped: TextTag) -> None:

self._wrapped = wrapped

def render(self) -> str:

return f"<b>{self._wrapped.render()}</b>"

class ItalicWrapper(TextTag):

"""Wraps a tag in <i>"""

def __init__(self, wrapped: TextTag) -> None:

self._wrapped = wrapped

def render(self) -> str:

return f"<i>{self._wrapped.render()}</i>"

def main():

"""

>>> simple_hello = TextTag("hello, world!")

>>> special_hello = ItalicWrapper(BoldWrapper(simple_hello))

>>> print("before:", simple_hello.render())

before: hello, world!

>>> print("after:", special_hello.render())

after: <i><b>hello, world!</b></i>

"""

if __name__ == "__main__":

import doctest

doctest.testmod()