Merge remote-tracking branch 'origin/dev' into feat/offline

Author: Tanguylo

CHANGELOG.md

@@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Allow to log scale axes
 - Offline mode
 
+### Fix
+- Add reference_path to all Primitive / Elementary drawing Objects
+- Remove data attr from class Arc in Python
+- Light improvement of class Arc in Python
+- Html stream method
+
 ## [0.21.0]
 ### Add
 - Tests of typescript app

code_pylint.py

@@ -35,7 +35,7 @@
                      'trailing-whitespace': 11,
                      'empty-docstring': 7,
                      'missing-module-docstring': 4,
-                     'too-many-arguments': 19,
+                     'too-many-arguments': 20,
                      'too-few-public-methods': 5,
                      'unnecessary-comprehension': 5,
                      'no-value-for-parameter': 2,

plot_data/core.py

@@ -134,14 +134,14 @@ def _to_html(self, local: bool = False, canvas_id: str = 'canvas', version: str
 
     def to_html_stream(self, stream, local: bool = False, canvas_id: str = 'canvas', version: str = None):
         """ Export current Figure to its equivalent html stream file. """
-        html = self._to_html(local=local, canvas_id=canvas_id, version=version)
-        stream.write(html.encode('utf-8'))
+        html = self._to_html(debug_mode=debug_mode, canvas_id=canvas_id, version=version)
+        stream.write(html)
 
     def to_html(self, filepath: str = None, local: bool = False, canvas_id: str = 'canvas', version: str = None):
         """ Export current Figure to an HTML file given by the filepath. """
         filepath = make_filepath(filepath=filepath)
-        with open(filepath, 'wb') as file:
-            self.to_html_stream(file, local=local, canvas_id=canvas_id, version=version)
+        with open(filepath, 'w', encoding="utf-8") as file:
+            self.to_html_stream(file, debug_mode=debug_mode, canvas_id=canvas_id, version=version)
         return filepath
 
     def plot_data(self, **kwargs):
@@ -152,13 +152,21 @@ def plot(self, filepath: str = None, **kwargs):
         webbrowser.open('file://' + os.path.realpath(filepath))
 
 
-class Sample(PlotDataObject):
+class ReferencedObject(PlotDataObject):
+    """ PlotData object with reference_path. """
+
+    def __init__(self, type_: str, reference_path: str = "#", name: str = ""):
+        self.reference_path = reference_path
+        super().__init__(type_=type_, name=name)
+
+
+class Sample(ReferencedObject):
     """ Graph Point. """
 
     def __init__(self, values, reference_path: str = "#", name: str = ""):
         self.values = values
         self.reference_path = reference_path
-        super().__init__(type_="sample", name=name)
+        super().__init__(type_="sample", reference_path=reference_path, name=name)
 
     def to_dict(self, use_pointers: bool = True, memo=None, path: str = '#', id_method=True,
                 id_memo=None) -> JsonSerializable:
@@ -419,7 +427,7 @@ def __init__(self, point_color: str, point_index: List[int], name: str = ''):
         PlotDataObject.__init__(self, type_=None, name=name)
 
 
-class Text(PlotDataObject):
+class Text(ReferencedObject):
     """
     A class for displaying texts on canvas. Text is a primitive and can be instantiated by PrimitiveGroup.
 
@@ -443,7 +451,7 @@ class Text(PlotDataObject):
 
     def __init__(self, comment: str, position_x: float, position_y: float, text_style: TextStyle = None,
                  text_scaling: bool = None, max_width: float = None, height: float = None, multi_lines: bool = True,
-                 name: str = ''):
+                 reference_path: str = "#", name: str = ''):
         self.comment = comment
         self.text_style = text_style
         self.position_x = position_x
@@ -452,7 +460,7 @@ def __init__(self, comment: str, position_x: float, position_y: float, text_styl
         self.max_width = max_width
         self.height = height
         self.multi_lines = multi_lines
-        PlotDataObject.__init__(self, type_='text', name=name)
+        super().__init__(type_='text', reference_path=reference_path, name=name)
 
     def mpl_plot(self, ax=None, color='k', alpha=1., **kwargs):
         """ Plots using Matplotlib. """
@@ -462,7 +470,7 @@ def mpl_plot(self, ax=None, color='k', alpha=1., **kwargs):
         return ax
 
 
-class Line2D(PlotDataObject):
+class Line2D(ReferencedObject):
     """
     An infinite line. Line2D is a primitive and can be instantiated by PrimitiveGroups.
 
@@ -474,12 +482,13 @@ class Line2D(PlotDataObject):
     :type edge_style: EdgeStyle
     """
 
-    def __init__(self, point1: List[float], point2: List[float], edge_style: EdgeStyle = None, name: str = ''):
+    def __init__(self, point1: List[float], point2: List[float], edge_style: EdgeStyle = None,
+                 reference_path: str = "#", name: str = ''):
         self.data = point1 + point2  # Retrocompatibility
         self.point1 = point1
         self.point2 = point2
         self.edge_style = edge_style
-        PlotDataObject.__init__(self, type_='line2d', name=name)
+        super().__init__(type_='line2d', reference_path=reference_path, name=name)
 
     def mpl_plot(self, ax=None, edge_style=None, **kwargs):
         """ Plots using matplotlib. """
@@ -497,7 +506,7 @@ def mpl_plot(self, ax=None, edge_style=None, **kwargs):
         return ax
 
 
-class LineSegment2D(PlotDataObject):
+class LineSegment2D(ReferencedObject):
     """
     A line segment. This is a primitive that can be called by PrimitiveGroup.
 
@@ -509,7 +518,8 @@ class LineSegment2D(PlotDataObject):
     :type edge_style: EdgeStyle
     """
 
-    def __init__(self, point1: List[float], point2: List[float], edge_style: EdgeStyle = None, name: str = ''):
+    def __init__(self, point1: List[float], point2: List[float], edge_style: EdgeStyle = None,
+                 reference_path: str = "#", name: str = ''):
         # Data is used in typescript
         self.data = point1 + point2
         self.point1 = point1
@@ -519,7 +529,7 @@ def __init__(self, point1: List[float], point2: List[float], edge_style: EdgeSty
             self.edge_style = EdgeStyle()
         else:
             self.edge_style = edge_style
-        PlotDataObject.__init__(self, type_='linesegment2d', name=name)
+        super().__init__(type_='linesegment2d', reference_path=reference_path, name=name)
 
     def bounding_box(self):
         """ Get 2D bounding box of current LineSegment2D. """
@@ -547,7 +557,7 @@ def mpl_plot(self, ax=None, edge_style=None, **kwargs):
         return ax
 
 
-class Wire(PlotDataObject):
+class Wire(ReferencedObject):
     """
     A set of connected lines. It also provides highlighting feature.
 
@@ -560,11 +570,11 @@ class Wire(PlotDataObject):
     """
 
     def __init__(self, lines: List[Tuple[float, float]], edge_style: EdgeStyle = None, tooltip: str = None,
-                 name: str = ""):
+                 reference_path: str = "#", name: str = ""):
         self.lines = lines
         self.edge_style = edge_style
         self.tooltip = tooltip
-        PlotDataObject.__init__(self, type_="wire", name=name)
+        super().__init__(type_="wire", reference_path=reference_path, name=name)
 
     def mpl_plot(self, ax=None, **kwargs):
         """ Plots using matplotlib. """
@@ -579,7 +589,7 @@ def mpl_plot(self, ax=None, **kwargs):
         return ax
 
 
-class Circle2D(PlotDataObject):
+class Circle2D(ReferencedObject):
     """
     A circle. It is a primitive and can be instantiated by PrimitiveGroup.
 
@@ -598,14 +608,14 @@ class Circle2D(PlotDataObject):
     """
 
     def __init__(self, cx: float, cy: float, r: float, edge_style: EdgeStyle = None,
-                 surface_style: SurfaceStyle = None, tooltip: str = None, name: str = ''):
+                 surface_style: SurfaceStyle = None, tooltip: str = None, reference_path: str = "#", name: str = ''):
         self.edge_style = edge_style
         self.surface_style = surface_style
         self.r = r
         self.cx = cx
         self.cy = cy
         self.tooltip = tooltip
-        PlotDataObject.__init__(self, type_='circle', name=name)
+        super().__init__(type_='circle', reference_path=reference_path, name=name)
 
     def bounding_box(self):
         """ Get 2D bounding box of current Circle2D. """
@@ -635,19 +645,19 @@ def mpl_plot(self, ax=None, **kwargs):
         return ax
 
 
-class Rectangle(PlotDataObject):
+class Rectangle(ReferencedObject):
     """ Class to draw a rectangle. """
 
     def __init__(self, x_coord: float, y_coord: float, width: float, height: float, edge_style: EdgeStyle = None,
-                 surface_style: SurfaceStyle = None, tooltip: str = None, name: str = ''):
+                 surface_style: SurfaceStyle = None, tooltip: str = None, reference_path: str = "#", name: str = ''):
         self.x_coord = x_coord
         self.y_coord = y_coord
         self.width = width
         self.height = height
         self.surface_style = surface_style
         self.edge_style = edge_style
         self.tooltip = tooltip
-        PlotDataObject.__init__(self, type_='rectangle', name=name)
+        super().__init__(type_='rectangle', reference_path=reference_path, name=name)
 
     def bounding_box(self):
         """ Get 2D bounding box of current Circle2D. """
@@ -681,13 +691,15 @@ class RoundRectangle(Rectangle):
     """ Class to draw a round rectangle. """
 
     def __init__(self, x_coord: float, y_coord: float, width: float, height: float, radius: float = 2,
-                 edge_style: EdgeStyle = None, surface_style: SurfaceStyle = None, tooltip: str = None, name: str = ''):
-        super().__init__(x_coord, y_coord, width, height, edge_style, surface_style, tooltip, name=name)
+                 edge_style: EdgeStyle = None, surface_style: SurfaceStyle = None, tooltip: str = None,
+                 reference_path: str = "#", name: str = ''):
+        super().__init__(x_coord, y_coord, width, height, edge_style, surface_style, tooltip,
+                         reference_path=reference_path, name=name)
         self.type_ = "roundrectangle"
         self.radius = radius
 
 
-class Point2D(PlotDataObject):
+class Point2D(ReferencedObject):
     """
     A class for instantiating a point.
 
@@ -699,11 +711,11 @@ class Point2D(PlotDataObject):
     :type point_style: PointStyle
     """
 
-    def __init__(self, cx: float, cy: float, point_style: PointStyle = None, name: str = ''):
+    def __init__(self, cx: float, cy: float, point_style: PointStyle = None, reference_path: str = "#", name: str = ''):
         self.cx = cx
         self.cy = cy
         self.point_style = point_style
-        PlotDataObject.__init__(self, type_='point', name=name)
+        super().__init__(type_='point', reference_path=reference_path, name=name)
 
     def bounding_box(self):
         """ Get 2D bounding box of current Circle2D. """
@@ -1103,7 +1115,7 @@ def _build_multiplot(self):
                 for row in sample_attributes for col in sample_attributes]
 
 
-class Arc2D(PlotDataObject):
+class Arc2D(ReferencedObject):
     """
     A class for drawing arcs. Arc2D is a primitive and can be instantiated by PrimitiveGroup. By default,
     the arc is drawn anticlockwise.
@@ -1122,25 +1134,22 @@ class Arc2D(PlotDataObject):
     BSPline method. This argument is useless unless the arc2D is part of\
      a Contour2D. In such case, the arc must be instantiated by volmdlr.
     :type data: List[dict]
-    :param anticlockwise: True if you want the arc the be drawn \
-    anticlockwise, False otherwise
-    :type anticlockwise: bool
+    :param clockwise: True if you want the arc the be drawn clockwise, False otherwise
+    :type clockwise: bool
     :param edge_style: for customization
     :type edge_style: EdgeStyle
     """
 
-    def __init__(self, cx: float, cy: float, r: float, start_angle: float, end_angle: float, data=None,
-                 clockwise: bool = None, edge_style: EdgeStyle = None, name: str = ''):
+    def __init__(self, cx: float, cy: float, r: float, start_angle: float, end_angle: float, clockwise: bool = None,
+                 edge_style: EdgeStyle = None, reference_path: str = "#", name: str = ''):
         self.cx = cx
         self.cy = cy
         self.r = r
         self.start_angle = start_angle
         self.end_angle = end_angle
-        self.data = data
-        self.anticlockwise = not clockwise
         self.clockwise = clockwise
         self.edge_style = edge_style
-        PlotDataObject.__init__(self, type_='arc', name=name)
+        super().__init__(type_='arc', reference_path=reference_path, name=name)
 
     def bounding_box(self):
         """ Get 2D bounding box of current Circle2D. """
@@ -1174,7 +1183,7 @@ def mpl_plot(self, ax=None, **kwargs):
         return ax
 
 
-class Contour2D(PlotDataObject):
+class Contour2D(ReferencedObject):
     """
     A Contour2D is a closed polygon that is formed by multiple primitives.
 
@@ -1190,13 +1199,13 @@ class Contour2D(PlotDataObject):
     """
 
     def __init__(self, plot_data_primitives: List[Union[Arc2D, LineSegment2D]], edge_style: EdgeStyle = None,
-                 surface_style: SurfaceStyle = None, tooltip: str = None, name: str = ''):
+                 surface_style: SurfaceStyle = None, tooltip: str = None, reference_path: str = "#", name: str = ''):
         self.plot_data_primitives = plot_data_primitives
         self.edge_style = edge_style
         self.surface_style = surface_style
         self.tooltip = tooltip
         self.is_filled = surface_style is not None
-        PlotDataObject.__init__(self, type_='contour', name=name)
+        super().__init__(type_='contour', reference_path=reference_path, name=name)
 
     def bounding_box(self):
         """ Get 2D bounding box of current Contour2D. """

script/histogram.py

@@ -18,7 +18,7 @@
                      'color': random_color
                      })
 
-plot_data_object = plot_data.Histogram(x_variable='mass', elements=elements, graduation_nb = 20,
+plot_data_object = plot_data.Histogram(x_variable='mass', elements=elements, graduation_nb=20,
                                        surface_style=plot_data.SurfaceStyle("rgb(50, 50, 220)"),
                                        edge_style=plot_data.EdgeStyle(1, "rgb(0, 255, 0)", [5, 3]))
 

script/minimal_dataviz.py

@@ -17,13 +17,13 @@
 
 for i in range(100):
 
-    elements.append({'mass': 52+ 47*random.random(),
-                     'cost': 231 + 89*random.random(),
-                     'wiring_length': 8.9 + 3.1*random.random()})
+    elements.append({'mass': 52 + 47 * random.random(),
+                     'cost': 231 + 89 * random.random(),
+                     'wiring_length': 8.9 + 3.1 * random.random()})
 
 
 parallel_plot = plot_data.ParallelPlot(disposition='vertical',
-                                           axes=axes)
+                                       axes=axes)
 
 # Scatter
 

script/plot_scatter.py

@@ -18,10 +18,10 @@
                      'shape': random_shape,
                      'color': random_color})
 
-points_sets = [plot_data.PointFamily(plot_data.colors.RED, [0,1,2,3,4,5,6,7,8,9]),
-               plot_data.PointFamily(plot_data.colors.YELLOW, [10,11,12,13,14,15,16,17,18,19]),
-               plot_data.PointFamily(plot_data.colors.GREEN, [20,21,22,23,24,25,26,27,28,29]),
-               plot_data.PointFamily(plot_data.colors.PINK, [30,31,32,33,34,35,36,37,38,39])]
+points_sets = [plot_data.PointFamily(plot_data.colors.RED, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]),
+               plot_data.PointFamily(plot_data.colors.YELLOW, [10, 11, 12, 13, 14, 15, 16, 17, 18, 19]),
+               plot_data.PointFamily(plot_data.colors.GREEN, [20, 21, 22, 23, 24, 25, 26, 27, 28, 29]),
+               plot_data.PointFamily(plot_data.colors.PINK, [30, 31, 32, 33, 34, 35, 36, 37, 38, 39])]
 
 plot_data_object = plot_data.Scatter(elements=elements, points_sets=points_sets,
                                      x_variable='mass', y_variable='length')
@@ -66,12 +66,12 @@
 
 # Now, here is the new scatterplot
 plot_data_object = plot_data.Scatter(x_variable='mass', y_variable='length',
-                                           point_style=point_style,
-                                           elements=elements,
-                                           points_sets=points_sets,
-                                           axis=axis,
-                                           tooltip=tooltip,
-                                           heatmap=heatmap)
+                                     point_style=point_style,
+                                     elements=elements,
+                                     points_sets=points_sets,
+                                     axis=axis,
+                                     tooltip=tooltip,
+                                     heatmap=heatmap)
 
 # if local is True, set it to False
 plot_data.plot_canvas(plot_data_object=plot_data_object, local=True)