Skip to content

Commit

Permalink
Improve Python __repr__ handling for null geometries
Browse files Browse the repository at this point in the history 
Also avoid massive long __repr__ strings for complex geometries,
as these can flood the Python console (and first aid plugin),
and aren't useful for debugging anyway.

Refs #14640
  • Loading branch information
@nyalldawson
nyalldawson committed Dec 18, 2018
1 parent d072a13 commit 7d648e5
Show file tree
Hide file tree
Showing 21 changed files with 102 additions and 20 deletions.
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgscircularstring.sip.in
View file
Expand Up @@ -168,7 +168,10 @@ Sets the circular string's points

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsCircularString: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsCircularString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgscompoundcurve.sip.in
View file
Expand Up @@ -172,7 +172,10 @@ Appends first point if not already closed.

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsCompoundCurve: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsCompoundCurve: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgscurvepolygon.sip.in
View file
Expand Up @@ -274,7 +274,10 @@ Returns approximate rotation angle for a vertex. Usually average angle between a

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
11 changes: 10 additions & 1 deletion python/core/auto_generated/geometry/qgsgeometry.sip.in
View file
Expand Up @@ -1391,7 +1391,16 @@ Exports the geometry to WKT

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsGeometry: %1>" ).arg( sipCpp->asWkt() );
QString str;
if ( sipCpp->isNull() )
str = QStringLiteral( "<QgsGeometry: null>" );
else
{
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
str = QStringLiteral( "<QgsGeometry: %1>" ).arg( wkt );
}
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgslinestring.sip.in
View file
Expand Up @@ -501,7 +501,10 @@ of the curve.

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsLineString: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsLineString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgsmulticurve.sip.in
View file
Expand Up @@ -58,7 +58,10 @@ Returns a copy of the multi curve, where each component curve has had its line d

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsMultiCurve: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiCurve: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgsmultilinestring.sip.in
View file
Expand Up @@ -55,7 +55,10 @@ Returns the geometry converted to the more generic curve type :py:class:`QgsMult

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsMultiLineString: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiLineString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgsmultipoint.sip.in
View file
Expand Up @@ -57,7 +57,10 @@ Multi point geometry collection.

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsMultiPoint: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiPoint: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgsmultipolygon.sip.in
View file
Expand Up @@ -56,7 +56,10 @@ Returns the geometry converted to the more generic curve type :py:class:`QgsMult

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsMultiPolygon: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiPolygon: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion python/core/auto_generated/geometry/qgspolygon.sip.in
View file
Expand Up @@ -67,7 +67,10 @@ negative if the point lies outside the polygon.

SIP_PYOBJECT __repr__();
%MethodCode
QString str = QStringLiteral( "<QgsPolygon: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsPolygon: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgscircularstring.h
View file
Expand Up @@ -152,7 +152,10 @@ class CORE_EXPORT QgsCircularString: public QgsCurve
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsCircularString: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsCircularString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgscompoundcurve.h
View file
Expand Up @@ -152,7 +152,10 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsCompoundCurve: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsCompoundCurve: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgscurvepolygon.h
View file
Expand Up @@ -286,7 +286,10 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsCurvePolygon: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
11 changes: 10 additions & 1 deletion src/core/geometry/qgsgeometry.h
View file
Expand Up @@ -1392,7 +1392,16 @@ class CORE_EXPORT QgsGeometry
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsGeometry: %1>" ).arg( sipCpp->asWkt() );
QString str;
if ( sipCpp->isNull() )
str = QStringLiteral( "<QgsGeometry: null>" );
else
{
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
str = QStringLiteral( "<QgsGeometry: %1>" ).arg( wkt );
}
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgslinestring.h
View file
Expand Up @@ -635,7 +635,10 @@ class CORE_EXPORT QgsLineString: public QgsCurve
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsLineString: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsLineString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End

Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgsmulticurve.h
View file
Expand Up @@ -76,7 +76,10 @@ class CORE_EXPORT QgsMultiCurve: public QgsGeometryCollection
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsMultiCurve: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiCurve: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgsmultilinestring.h
View file
Expand Up @@ -68,7 +68,10 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsMultiLineString: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiLineString: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgsmultipoint.h
View file
Expand Up @@ -69,7 +69,10 @@ class CORE_EXPORT QgsMultiPoint: public QgsGeometryCollection
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsMultiPoint: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiPoint: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgsmultipolygon.h
View file
Expand Up @@ -68,7 +68,10 @@ class CORE_EXPORT QgsMultiPolygon: public QgsMultiSurface
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsMultiPolygon: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsMultiPolygon: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
5 changes: 4 additions & 1 deletion src/core/geometry/qgspolygon.h
View file
Expand Up @@ -87,7 +87,10 @@ class CORE_EXPORT QgsPolygon: public QgsCurvePolygon
#ifdef SIP_RUN
SIP_PYOBJECT __repr__();
% MethodCode
QString str = QStringLiteral( "<QgsPolygon: %1>" ).arg( sipCpp->asWkt() );
QString wkt = sipCpp->asWkt();
if ( wkt.length() > 1000 )
wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
QString str = QStringLiteral( "<QgsPolygon: %1>" ).arg( wkt );
sipRes = PyUnicode_FromString( str.toUtf8().constData() );
% End
#endif
Expand Down
10 changes: 10 additions & 0 deletions tests/src/python/test_python_repr.py
View file
Expand Up @@ -26,9 +26,19 @@
class TestPython__repr__(unittest.TestCase):

def testQgsGeometryRepr(self):

g = QgsGeometry()
self.assertEqual(g.__repr__(), '<QgsGeometry: null>')
p = QgsPointXY(123.456, 987.654)
g = QgsGeometry.fromPointXY(p)
self.assertTrue(g.__repr__().startswith('<QgsGeometry: Point (123.456'))
g = QgsGeometry(QgsLineString([QgsPoint(0, 2), QgsPoint(1010, 2)]))
g = g.densifyByCount(1000)
# long strings must be truncated for performance -- otherwise they flood the console/first aid output
self.assertTrue(g.__repr__().startswith('<QgsGeometry: LineString (0 2,'))
self.assertTrue(
g.__repr__().endswith('...>'))
self.assertEqual(len(g.__repr__()), 1018)

def testQgsPointRepr(self):
p = QgsPoint(123.456, 987.654, 100)
Expand Down

0 comments on commit 7d648e5

Please sign in to comment.