add toString and repr for qgsvector

lbartoletti · nyalldawson · commit c885cd7267af · 2019-01-16T01:10:33.000+11:00
diff --git a/python/core/auto_generated/qgsvector.sip.in b/python/core/auto_generated/qgsvector.sip.in
@@ -119,6 +119,19 @@ Will throw a QgsException if called on a vector with length of 0.
 
     bool operator!=( QgsVector other ) const;
 
+
+    QString toString( int precision = 17 ) const;
+%Docstring
+Returns a string representation of the vector.
+Members will be truncated to the specified ``precision``.
+%End
+
+    SIP_PYOBJECT __repr__();
+%MethodCode
+    QString str = QStringLiteral( "<QgsVector: %1>" ).arg( sipCpp->toString() );
+    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
+%End
+
 };
 
 
diff --git a/src/core/qgsvector.h b/src/core/qgsvector.h
@@ -16,6 +16,7 @@
 #ifndef QGSVECTOR_H
 #define QGSVECTOR_H
 
+#include "qgis.h"
 #include "qgis_core.h"
 #include <QtGlobal>
 
@@ -157,6 +158,29 @@ class CORE_EXPORT QgsVector
     //! Inequality operator
     bool operator!=( QgsVector other ) const;
 
+
+    /**
+    * Returns a string representation of the vector.
+    * Members will be truncated to the specified \a precision.
+    */
+    QString toString( int precision = 17 ) const
+    {
+      QString str = "Vector (";
+      str += qgsDoubleToString( mX, precision );
+      str += ", ";
+      str += qgsDoubleToString( mY, precision );
+      str += ')';
+      return str;
+    }
+
+#ifdef SIP_RUN
+    SIP_PYOBJECT __repr__();
+    % MethodCode
+    QString str = QStringLiteral( "<QgsVector: %1>" ).arg( sipCpp->toString() );
+    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
+    % End
+#endif
+
   private:
     double mX = 0.0, mY = 0.0;
 
diff --git a/src/core/qgsvector3d.h b/src/core/qgsvector3d.h
@@ -150,11 +150,11 @@ class CORE_EXPORT QgsVector3D
      */
     QString toString( int precision = 17 ) const
     {
-      QString str = "QgsVector3D (";
+      QString str = "Vector3D (";
       str += qgsDoubleToString( mX, precision );
-      str += ' ';
+      str += ", ";
       str += qgsDoubleToString( mY, precision );
-      str += ' ';
+      str += ", ";
       str += qgsDoubleToString( mZ, precision );
       str += ')';
       return str;
diff --git a/tests/src/core/testqgsvector.cpp b/tests/src/core/testqgsvector.cpp
@@ -48,9 +48,9 @@ void TestQgsVector::cleanupTestCase()
 void TestQgsVector::vector3d()
 {
   //string
-  QCOMPARE( QgsVector3D().toString(), QString( "QgsVector3D (0 0 0)" ) );
-  QCOMPARE( QgsVector3D( 0, 1, 2 ).toString(), QString( "QgsVector3D (0 1 2)" ) );
-  QCOMPARE( QgsVector3D( 0.12, 1.234, 2.3456789 ).toString( 1 ), QString( "QgsVector3D (0.1 1.2 2.3)" ) );
+  QCOMPARE( QgsVector3D().toString(), QString( "Vector3D (0, 0, 0)" ) );
+  QCOMPARE( QgsVector3D( 0, 1, 2 ).toString(), QString( "Vector3D (0, 1, 2)" ) );
+  QCOMPARE( QgsVector3D( 0.12, 1.234, 2.3456789 ).toString( 1 ), QString( "Vector3D (0.1, 1.2, 2.3)" ) );
 
   QgsVector3D p0( 0.0, 0.0, 0.0 );
   QgsVector3D p1( 1.0, 2.0, 3.0 );
diff --git a/tests/src/python/test_python_repr.py b/tests/src/python/test_python_repr.py
@@ -18,7 +18,7 @@
 from qgis.testing import unittest, start_app
 from qgis.core import QgsGeometry, QgsPoint, QgsPointXY, QgsCircle, QgsCircularString, QgsCompoundCurve,\
     QgsCurvePolygon, QgsEllipse, QgsLineString, QgsMultiCurve, QgsRectangle, QgsExpression, QgsField, QgsError,\
-    QgsMimeDataUtils
+    QgsMimeDataUtils, QgsVector, QgsVector3D
 
 start_app()
 
@@ -124,6 +124,13 @@ def testQgsRectangleRepr(self):
         r = QgsRectangle(1, 2, 3, 4)
         self.assertEqual(r.__repr__(), '<QgsRectangle: 1 2, 3 4>')
 
+    def testQgsVector(self):
+        v = QgsVector(1, 2)
+        self.assertEqual(v.__repr__(), '<QgsVector: Vector (1, 2)>')
+
+        v = QgsVector3D(1, 2, 3)
+        self.assertEqual(v.__repr__(), '<QgsVector3D: Vector3D (1, 2, 3)>')
+
     def testQgsExpressionRepr(self):
         e = QgsExpression('my expression')
         self.assertEqual(e.__repr__(), "<QgsExpression: 'my expression'>")
