Added type hints to proxy pattern

rednafi · rednafi · commit af3be6587653 · 2020-06-19T03:22:18.000+06:00
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ __pycache__
 .idea
 *.egg-info/
 .tox/
+venv
diff --git a/patterns/structural/proxy.py b/patterns/structural/proxy.py
@@ -15,6 +15,8 @@
 without changing its interface.
 """
 
+from typing import Union
+
 
 class Subject:
     """
@@ -26,7 +28,7 @@ class Subject:
     able to use RealSubject or Proxy interchangeably with no change in code.
     """
 
-    def do_the_job(self, user):
+    def do_the_job(self, user: str) -> None:
         raise NotImplementedError()
 
 
@@ -36,30 +38,31 @@ class RealSubject(Subject):
     good example.
     """
 
-    def do_the_job(self, user):
-        print(f'I am doing the job for {user}')
+    def do_the_job(self, user: str) -> None:
+        print(f"I am doing the job for {user}")
 
 
 class Proxy(Subject):
-    def __init__(self):
+    def __init__(self) -> None:
         self._real_subject = RealSubject()
 
-    def do_the_job(self, user):
+    def do_the_job(self, user: str) -> None:
         """
         logging and controlling access are some examples of proxy usages.
         """
 
-        print(f'[log] Doing the job for {user} is requested.')
+        print(f"[log] Doing the job for {user} is requested.")
 
-        if user == 'admin':
+        if user == "admin":
             self._real_subject.do_the_job(user)
         else:
-            print(f'[log] I can do the job just for `admins`.')
+            print(f"[log] I can do the job just for `admins`.")
 
 
-def client(job_doer, user):
+def client(job_doer: Union[RealSubject, Proxy], user: str) -> None:
     job_doer.do_the_job(user)
 
+
 def main():
     """
     >>> proxy = Proxy()
@@ -82,6 +85,7 @@ def main():
     """
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     import doctest
-    doctest.testmod()
+
+    doctest.testmod()

-Original file line number
+Diff line change
 .idea
 *.egg-info/
 .tox/
 +venv