Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Drop V2 suffix on all geometry classes #5491

Merged
merged 17 commits into from
Oct 30, 2017
Merged

Drop V2 suffix on all geometry classes #5491

merged 17 commits into from
Oct 30, 2017

Conversation

m-kuhn
Copy link
Member

@m-kuhn m-kuhn commented Oct 29, 2017 •
edited
Loading

References qgis/qgis4.0_api#11

This finally brings back a consistent state in naming within the geometry API

Renames

QGIS 2 QGIS 3
QgsPolygon QgsPolygonXY
QgsMultiPoint QgsMultiPointXY
QgsMultiPolyline QgsMultiPolylineXY
QgsMultiPolygon QgsMultiPolygonXY
QgsPolygonV2 QgsPolygon
QgsMultiPointV2 QgsMultiPoint
QgsMultiPolylineV2 QgsMultiPolyline
QgsMultiPolygonV2 QgsMultiPolygon

@NathanW2
Copy link
Member

NathanW2 commented Oct 29, 2017 via email

@m-kuhn m-kuhn added the API Break! Breaks stable API. Proceed with extreme caution!! label Oct 29, 2017
@m-kuhn
Copy link
Member Author

m-kuhn commented Oct 29, 2017 •
edited
Loading

@nyalldawson

any idea what this is:

======================================================================
ERROR: testTaskFromFunctionFinishedWithVal (__main__.TestQgsTaskManager)
test that task from function can have callback finished function and is passed result values
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/root/QGIS/tests/src/python/test_qgstaskmanager.py", line 231, in testTaskFromFunctionFinishedWithVal
    self.assertEqual(finished_single_value_result.value, 5)
AttributeError: 'function' object has no attribute 'value'
----------------------------------------------------------------------

https://travis-ci.org/qgis/QGIS/jobs/294566074#L795-L804

Just seen this the first time (after restarting the job for a different failure). And to be honest, I've got no idea how that code works and how that ever succeeded. A method and a local variable with the same name and an assignment to it to pass back a value... Need to finally get a python book apparently :D

@nyalldawson
Copy link
Collaborator

Just seen this the first time (after restarting the job for a different failure). And to be honest, I've got no idea how that code works and how that ever succeeded. A method and a local variable with the same name and an assignment to it to pass back a value... Need to finally get a python book apparently

There's a duplicate line there. But basically it's storing the passed value as a property on the function so that we can later test if that function was called and what value was passed to it. Global variables would also work here, but this keeps the test self-contained.

@nyalldawson
Copy link
Collaborator

Lovely work here!

Can I suggest a related rename? c4f3832 renamed QgsGeometry::fromPolyline to QgsGeometry::fromPolylineXY. I think we should do this for all these methods if we're renaming the related classes. E.g. fromMultiPoint -> fromMultiPointXY, fromPolygon -> fromPolygonXY, etc. Then we've got scope to later in 3.x readd new fromMultiPoint/fromPolygon etc which operate on QgsPoint.

@m-kuhn
Copy link
Member Author

m-kuhn commented Oct 30, 2017

There's a duplicate line there. But basically it's storing the passed value as a property on the function so that we can later test if that function was called and what value was passed to it. Global variables would also work here, but this keeps the test self-contained.

Thanks. In the end, I figured it out which led me to propose #5495 which should make things even more self-contained.

@m-kuhn m-kuhn changed the title Drop V2 Prefix on all geometry classes Drop V2 suffix on all geometry classes Oct 30, 2017
@m-kuhn
Rename QgsPolygon to QgsPolygonXY
becf86c
@m-kuhn
Rename QgsMultiPoint to QgsMultiPointXY
29e65ed
@m-kuhn
Rename QgsMultiPolyline to QgsMultiPolylineXY
b790874
@m-kuhn
Rename QgsMultiPolygon to QgsMultiPolygonXY
9a57bae
@m-kuhn
Optimize loop
81586d2
@m-kuhn
Rename QgsPolygonV2 to QgsPolygon
b6f46ea
@m-kuhn
Rename QgsMultiPointV2 to QgsMultiPoint
3fcdcd8
@m-kuhn
Rename QgsMultiPolygonV2 to QgsMultiPolygon
7f3ad76
@m-kuhn
Document API breaks
b4e0ebe
@m-kuhn
Various fixes to dropping V2 suffix
e19f648
@m-kuhn
More V2 drop fixes
271ef7c
@m-kuhn
More drop V2 suffix fixes
750a54f
@m-kuhn
Rename QgsGeometry.addPoints with XY / V2-less versions
ca74e39
@m-kuhn
Adjust leftovers addPointsV2 to addPoints
bde014e
@m-kuhn
Rename from[GeometryType] to from[GeometryType]XY
82e6d12 
- QgsGeometry::fromPoint() was renamed to fromPointXY()
- QgsGeometry::fromMultiPoint() was renamed to fromMultiPointXY()
- QgsGeometry::fromMultiPolyline() was renamed to fromMultiPolylineXY()
- QgsGeometry::fromPolygon() was renamed to fromPolygonXY()
- QgsGeometry::fromMultiPolygon() was renamed to fromMultiPolygonXY()
@m-kuhn
Rename QgsGeometry::fromPoint to QgsGeometry::fromPointXY
e0025b6 
Also introduces the from[Geometry]XY for QgsGeometryFactory
@m-kuhn
Convert missing from[Geometry]XY calls
d2c1011
@m-kuhn m-kuhn merged commit 1d21072 into qgis:master Oct 30, 2017
@NathanW2
Copy link
Member

NathanW2 commented Oct 30, 2017 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
API Break! Breaks stable API. Proceed with extreme caution!!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@m-kuhn @NathanW2 @nyalldawson