Merge pull request #321 from h4ppysmile/patch-1

enhance top description

Author: faif

append_output.sh

@@ -10,7 +10,7 @@ output_marker='OUTPUT = """'
 # get everything (excluding part between `output_marker` and the end of the file)
 # into `src` var
 src=$(sed -n -e "/$output_marker/,\$!p" "$1")
-output=$(python "$1")
+output=$(python3 "$1")
 
 echo "$src" > $1
 echo -e "\n" >> $1

patterns/structural/proxy.py

@@ -1,55 +1,87 @@
 """
+*What is this pattern about?
+Proxy is used in places where you want to add functionality to a class without
+changing its interface. The main class is called `Real Subject`. A client should
+use the proxy or the real subject without any code change, so both must have the
+same interface. Logging and controlling access to the real subject are some of
+the proxy pattern usages.
+
+*References:
+https://refactoring.guru/design-patterns/proxy/python/example
+https://python-3-patterns-idioms-test.readthedocs.io/en/latest/Fronting.html
+
 *TL;DR
-Provides an interface to resource that is expensive to duplicate.
+Add functionality or logic (e.g. logging, caching, authorization) to a resource
+without changing its interface.
 """
 
-import time
 
+class Subject:
+    """
+    As mentioned in the document, interfaces of both RealSubject and Proxy should
+    be the same, because the client should be able to use RealSubject or Proxy with
+    no code change.
+
+    Not all times this interface is necessary. The point is the client should be
+    able to use RealSubject or Proxy interchangeably with no change in code.
+    """
+
+    def do_the_job(self, user):
+        raise NotImplementedError()
 
-class SalesManager:
-    def talk(self):
-        print("Sales Manager ready to talk")
 
+class RealSubject(Subject):
+    """
+    This is the main job doer. External services like payment gateways can be a
+    good example.
+    """
 
-class Proxy:
+    def do_the_job(self, user):
+        print(f'I am doing the job for {user}')
+
+
+class Proxy(Subject):
     def __init__(self):
-        self.busy = 'No'
-        self.sales = None
-
-    def talk(self):
-        print("Proxy checking for Sales Manager availability")
-        if self.busy == 'No':
-            self.sales = SalesManager()
-            time.sleep(0.1)
-            self.sales.talk()
+        self._real_subject = RealSubject()
+
+    def do_the_job(self, user):
+        """
+        logging and controlling access are some examples of proxy usages.
+        """
+
+        print(f'[log] Doing the job for {user} is requested.')
+
+        if user == 'admin':
+            self._real_subject.do_the_job(user)
         else:
-            time.sleep(0.1)
-            print("Sales Manager is busy")
+            print(f'[log] I can do the job just for `admins`.')
+
+
+def client(job_doer, user):
+    job_doer.do_the_job(user)
+
+def main():
+    """
+    >>> proxy = Proxy()
+
+    >>> real_subject = RealSubject()
+
+    >>> client(proxy, 'admin')
+    [log] Doing the job for admin is requested.
+    I am doing the job for admin
+
+    >>> client(proxy, 'anonymous')
+    [log] Doing the job for anonymous is requested.
+    [log] I can do the job just for `admins`.
 
+    >>> client(real_subject, 'admin')
+    I am doing the job for admin
 
-class NoTalkProxy(Proxy):
-    def talk(self):
-        print("Proxy checking for Sales Manager availability")
-        time.sleep(0.1)
-        print("This Sales Manager will not talk to you", "whether he/she is busy or not")
+    >>> client(real_subject, 'anonymous')
+    I am doing the job for anonymous
+    """
 
 
 if __name__ == '__main__':
-    p = Proxy()
-    p.talk()
-    p.busy = 'Yes'
-    p.talk()
-    p = NoTalkProxy()
-    p.talk()
-    p.busy = 'Yes'
-    p.talk()
-
-### OUTPUT ###
-# Proxy checking for Sales Manager availability
-# Sales Manager ready to talk
-# Proxy checking for Sales Manager availability
-# Sales Manager is busy
-# Proxy checking for Sales Manager availability
-# This Sales Manager will not talk to you whether he/she is busy or not
-# Proxy checking for Sales Manager availability
-# This Sales Manager will not talk to you whether he/she is busy or not
+    import doctest
+    doctest.testmod()