TR updates, first round

Author: lpozo

solid-principles-python/app_dip.py

@@ -2,8 +2,6 @@
 
 # Bad example
 # class Frontend:
-#     """Frontend, concrete implementation."""
-
 #     def __init__(self, backend):
 #         self.backend = backend
 
@@ -13,17 +11,13 @@
 
 
 # class Backend:
-#     """Backend, concrete implementation."""
-
 #     def get_data_from_database(self):
 #         """Return data from the database."""
 #         return "Data from the database"
 
 
 # Good example
 class Frontend:
-    """Frontend, concrete implementation."""
-
     def __init__(self, data_source):
         self.data_source = data_source
 
@@ -33,24 +27,16 @@ def display_data(self):
 
 
 class DataSource(ABC):
-    """DataSource interface (Abstraction)."""
-
     @abstractmethod
     def get_data(self):
         pass
 
 
 class Database(DataSource):
-    """Database, concrete implementation."""
-
     def get_data(self):
-        """Return data from the database."""
         return "Data from the database"
 
 
 class API(DataSource):
-    """API, concrete implementation."""
-
     def get_data(self):
-        """Return data from the API."""
         return "Data from the API"

solid-principles-python/printers_isp.py

@@ -2,8 +2,6 @@
 
 # Bad example
 # class Printer(ABC):
-#     """Printer interface."""
-
 #     @abstractmethod
 #     def print(self, document):
 #         pass
@@ -18,10 +16,8 @@
 
 
 # class OldPrinter(Printer):
-#     """Old printer, concrete implementation."""
-
 #     def print(self, document):
-#         print(f"Print {document} in black and white")
+#         print(f"Printing {document} in black and white...")
 
 #     def fax(self, document):
 #         raise NotImplementedError("Fax functionality not supported")
@@ -31,59 +27,46 @@
 
 
 # class ModernPrinter(Printer):
-#     """Modern printer, concrete implementation."""
-
 #     def print(self, document):
-#         print(f"Printing {document} in color")
+#         print(f"Printing {document} in color...")
 
 #     def fax(self, document):
-#         print(f"Faxing {document}")
+#         print(f"Faxing {document}...")
 
 #     def scan(self, document):
-#         print(f"Scanning {document}")
+#         print(f"Scanning {document}...")
 
 
 # Good example
 class Printer(ABC):
-    """Printer interface."""
-
     @abstractmethod
     def print(self, document):
         pass
 
 
 class Fax(ABC):
-    """Fax interface."""
-
     @abstractmethod
     def fax(self, document):
         pass
 
 
-class Scan(ABC):
-    """Scan interface."""
-
+class Scanner(ABC):
     @abstractmethod
     def scan(self, document):
         pass
 
 
 class OldPrinter(Printer):
-    """Old printer, concrete implementation."""
-
     def print(self, document):
-        print(f"Print {document} in black and white")
-
+        print(f"Printing {document} in black and white...")
 
-class NewPrinter(Printer, Fax, Scan):
-    """New printer, concrete implementation."""
 
+class NewPrinter(Printer, Fax, Scanner):
     def print(self, document):
-        print(f"Printing {document} in color")
+        print(f"Printing {document} in color...")
 
     def fax(self, document):
-        print(f"Faxing {document}")
+        print(f"Faxing {document}...")
 
     def scan(self, document):
-        print(f"Scanning {document}")
-        print(f"Scanning {document}")
+        print(f"Scanning {document}...")

solid-principles-python/shapes_ocp.py

@@ -1,6 +1,7 @@
 from abc import ABC, abstractmethod
 from math import pi
 
+# Bad example
 # class Shape:
 #     def __init__(self, shape_type, **kwargs):
 #         self.shape_type = shape_type
@@ -10,19 +11,20 @@
 #         elif self.shape_type == "circle":
 #             self.radius = kwargs["radius"]
 
-#     def area(self):
+#     def calculate_area(self):
 #         if self.shape_type == "rectangle":
 #             return self.width * self.height
 #         elif self.shape_type == "circle":
 #             return pi * self.radius**2
 
 
+# Good example
 class Shape(ABC):
     def __init__(self, shape_type):
         self.shape_type = shape_type
 
     @abstractmethod
-    def area(self):
+    def calculate_area(self):
         pass
 
 
@@ -31,7 +33,7 @@ def __init__(self, radius):
         super().__init__("circle")
         self.radius = radius
 
-    def area(self):
+    def calculate_area(self):
         return pi * self.radius**2
 
 
@@ -41,7 +43,7 @@ def __init__(self, width, height):
         self.width = width
         self.height = height
 
-    def area(self):
+    def calculate_area(self):
         return self.width * self.height
 
 
@@ -50,5 +52,5 @@ def __init__(self, side):
         super().__init__("square")
         self.side = side
 
-    def area(self):
+    def calculate_area(self):
         return self.side**2