fixing errors and adding type hints

Author: meg-1

Diff for: geometry/angles/angles/__init__.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class Angle:
+    """
+    representation of an Angle in degrees (unit of measurement)
+    """
+
+    degrees: float

Diff for: geometry/angles/angles/angle.py

@@ -33,23 +33,23 @@ class Circle(ClosedShape):
     TypeError: num_cuts must be a numeric value.
     """
 
-    def __init__(self, radius):
+    def __init__(self, radius: float) -> None:
         self.radius = radius
         self.origin = 0
 
-    def get_diameter(self):
+    def get_diameter(self) -> float:
         return self.radius * 2
 
-    def perimeter(self):
+    def perimeter(self) -> float:
         return 2 * math.pi * self.radius
 
-    def area(self):
+    def area(self) -> float:
         return math.pi * (self.radius**2)
 
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: ClosedShape) -> bool:
         raise NotImplementedError("Not Implemented")
 
-    def split(self):
+    def split(self) -> float:
         raise NotImplementedError("Not Implemented")
 
     def max_parts(self, num_cuts: float) -> float:

Diff for: geometry/angles/coordinate_plane/__init__.py

@@ -20,18 +20,18 @@ class Ellipse(ClosedShape):
     NotImplementedError: Not Implemented
     """
 
-    def __init__(self, major_radius, minor_radius):
+    def __init__(self, major_radius: float, minor_radius: float) -> None:
         self.major_radius: float = major_radius
         self.minor_radius: float = minor_radius
 
-    def perimeter(self):
+    def perimeter(self) -> float:
         return math.pi * (self.major_radius + self.minor_radius)
 
-    def area(self):
+    def area(self) -> float:
         return math.pi * self.major_radius * self.minor_radius
 
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: ClosedShape) -> bool:
         raise NotImplementedError("Not Implemented")
 
-    def split(self):
+    def split(self) -> float:
         raise NotImplementedError("Not Implemented")

Diff for: geometry/angles/lines/__init__.py

@@ -1,6 +1,9 @@
 from geometry.shapes.shape_types.closed_shapes import ClosedShape
 from geometry.shapes.shape_types.intersecting_self_shapes import IntersectSelfShape
 from geometry.shapes.side import Side
+from typing import TypeVar
+
+PolygonType = TypeVar("PolygonType", bound="Polygon")
 
 
 class Polygon(ClosedShape, IntersectSelfShape):
@@ -43,26 +46,26 @@ class Polygon(ClosedShape, IntersectSelfShape):
 
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.sides: list[Side] = []
 
-    def get_side(self, index):
+    def get_side(self, index: int) -> Side:
         return self.sides[index]
 
-    def set_side(self, index, side):
+    def set_side(self, index: int, side: Side) -> None:
         self.sides[index] = side
 
-    def add_side(self, side):
+    def add_side(self, side: Side) -> None:
         self.sides.append(side)
 
-    def area(self):
+    def area(self) -> float:
         pass
 
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: PolygonType) -> bool:
         pass
 
-    def perimeter(self):
+    def perimeter(self) -> float:
         pass
 
-    def split(self):
+    def split(self) -> float:
         pass

Diff for: geometry/shapes/ellipses/circle.py

@@ -22,21 +22,21 @@ class Rectangle(Polygon):
     NotImplementedError: Not Implemented
     """
 
-    def __init__(self, short_side_length, long_side_length):
+    def __init__(self, short_side_length: float, long_side_length: float) -> None:
         super().__init__()
         self.short_side = Side([], Angle(90), short_side_length)
         self.long_side = Side([], Angle(90), long_side_length)
         super().add_side(self.short_side)
         super().add_side(self.long_side)
 
-    def perimeter(self):
+    def perimeter(self) -> float:
         return (self.short_side.length + self.long_side.length) * 2
 
-    def area(self):
+    def area(self) -> float:
         return self.short_side.length * self.long_side.length
 
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: Polygon) -> bool:
         raise NotImplementedError("Not Implemented")
 
-    def split(self):
+    def split(self) -> float:
         raise NotImplementedError("Not Implemented")

Diff for: geometry/shapes/ellipses/ellipse.py

@@ -19,17 +19,17 @@ class Square(Rectangle):
     NotImplementedError: Not Implemented
     """
 
-    def __init__(self, side_length):
+    def __init__(self, side_length: float) -> None:
         super().__init__(side_length, side_length)
 
-    def perimeter(self):
+    def perimeter(self) -> float:
         return super().perimeter()
 
-    def area(self):
+    def area(self) -> float:
         return super().area()
 
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: Rectangle) -> bool:
         raise NotImplementedError("Not Implemented")
 
-    def split(self):
+    def split(self) -> float:
         raise NotImplementedError("Not Implemented")

Diff for: geometry/shapes/polygon/polygon.py

@@ -1,4 +1,7 @@
 from abc import ABC, abstractmethod
+from typing import TypeVar
+
+ShapeType = TypeVar("ShapeType", bound="Shape")
 
 
 class Shape(ABC):
@@ -9,18 +12,23 @@ class Shape(ABC):
     """
 
     @abstractmethod
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: ShapeType) -> bool:
         """
         a method for comparing with another shape,
         which also implements this interface
         """
 
     @abstractmethod
-    def split(self):
+    def split(self) -> float:
         """
         a method for splitting a shape
         into a certain quantity of pieces,
-        following a specific algorithm
+        following a specific algorithm which returns
+        the amount of pieces after splitting the shape
+
+        note: in the future, a separate class might be created,
+        which will represent a certain part of a shape, because of that
+        the return type of this method might change
         """
 
     """

Diff for: geometry/shapes/polygon/rectangle.py

@@ -11,17 +11,17 @@ class ClosedShape(Shape, ABC):
     """
 
     @abstractmethod
-    def perimeter(self):
+    def perimeter(self) -> float:
         pass
 
     @abstractmethod
-    def area(self):
+    def area(self) -> float:
         pass
 
     @abstractmethod
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: Shape) -> bool:
         pass
 
     @abstractmethod
-    def split(self):
+    def split(self) -> float:
         pass

Diff for: geometry/shapes/polygon/square.py

@@ -11,17 +11,17 @@ class IntersectSelfShape(Shape, ABC):
     """
 
     @abstractmethod
-    def perimeter(self):
+    def perimeter(self) -> float:
         pass
 
     @abstractmethod
-    def area(self):
+    def area(self) -> float:
         pass
 
     @abstractmethod
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: Shape) -> bool:
         pass
 
     @abstractmethod
-    def split(self):
+    def split(self) -> float:
         pass

Diff for: geometry/shapes/shape.py

@@ -11,9 +11,9 @@ class OpenShape(Shape, ABC):
     """
 
     @abstractmethod
-    def is_similar(self, compared_shape):
+    def is_similar(self, compared_shape: Shape) -> bool:
         pass
 
     @abstractmethod
-    def split(self):
+    def split(self) -> float:
         pass