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

Attempt to fix doctests by using airports layer in epsg4326 instead of epsg2964. #9256

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Attempt to fix doctests by using airports layer in epsg4326 instead of epsg2964. #9256

wants to merge 7 commits into from

Conversation

folinimarc
Copy link
Contributor

@folinimarc folinimarc commented Sep 12, 2024 •
edited
Loading

Fixes #9255

This is an attempt to fix the flaky doctests behavior, only actual workflow runs on the Github agent will provide certainty.

Primary changes

  • Use the airports dataset from data/data.gpkg (EPSG:4326) instead of the Alaska scoped airports.shp (EPSG:2964) and remove the warning string as expected test output. We do not simply reproject the layer, because the Alaska airports crs is mentioned multiple times in the cookbook and streamlining the whole cookbook is out of scope for this PR.

Secondary changes

  • Prefer usage of geopackage instead of shapefile in the spirit of slowly fading out .shp hopefully.
  • Minor refactoring of documentation along the way.

@folinimarc
Attempt to fix doctests by using airports layer in epsg4326 instead o…
00f8746 
…f epsg2964.

Use geopackage airports layer (epsg4326) to avoid ambiguous reprojection warning of previously used Alaska scoped airports layer (epsg2964) when adding it programmatically to a vanilla qgis project during doctest. We do not simply reproject the layer, because the alaska airports crs is mentioned mutliple times in the codebase and streamlining the whole cookbook is out of scope for this PR.
@folinimarc
Revert capitalized parameters for wfs uri to be similar to subsequent…
65731db 
… examples.
@folinimarc
Copy link
Contributor Author

folinimarc commented Sep 13, 2024 •
edited
Loading

@selmaVH1 could you please trigger the doctest workflow to see if it passes? If not, the whole PR is pointless. If it passes a few times in a row, a priority review/merge could benefit all other PRs. Cheers!

@folinimarc
Copy link
Contributor Author

folinimarc commented Sep 13, 2024 •
edited
Loading

Cool thanks! The workflow failed, but not due to failing tests (which is good) but due to a segfault after running the tests (which is bad). Link.

I am not sure what this is about and how it is connected to my changes. If anybody has an idea, ping me.

From failed workflow run logs:

Doctest summary
===============
  330 tests
    0 failures in tests
    0 failures in setup code
    0 failures in cleanup code
rediraffe: Redirect generation skipped for unsupported builders. Supported builders: html, dirhtml, readthedocs, readthedocsdirhtml.
build succeeded.

Testing of doctests in the sources finished, look at the results in build/doctest/output.txt.
Segmentation fault (core dumped)
make: *** [Makefile:131: doctest-gh] Error 139
make: *** [docker.mk:5: doctest] Error 2
Error: Process completed with exit code 2.

@folinimarc
Copy link
Contributor Author

folinimarc commented Sep 13, 2024 •
edited
Loading

@selmaVH1 Good news, it might be that the segfault was just one time bad luck. I triggered the workflow multiple times now and it consistently passes (pass, pass, pass, pass).

I merged master into the branch and I think it would be worth to review this PR and give it a shot?

@selmaVH1
Copy link
Collaborator

Hi @folinimarc, thank you for your work on this!

I know that airport.shp has been part of the sample data for a long time, and while I'm not entirely sure, I don't think it has previously caused issues or doctest failures. But I do support preferring geopackage over shapefile.

@timlinux, if you have time to review this PR, your input would be very helpful. Thanks!

DelazJ
DelazJ reviewed Sep 24, 2024
View reviewed changes
Copy link
Collaborator

@DelazJ DelazJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @folinimarc for addressing this annoying issue.
We could have used an airports_4326.shp layer but I'm fine with using gpkg. However I miss an example with shp and think it could be possible to add one, as untested code.

docs/pyqgis_developer_cookbook/loadlayer.rst
@@ -49,28 +49,7 @@ Vector Layers
=============

To create and add a vector layer instance to the project, specify the layer's data source
identifier, name for the layer and provider's name:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is unclear to me why layer name and provider are removed here. and "layer name" is mentioned two sentences after.

docs/pyqgis_developer_cookbook/loadlayer.rst
path to the file:
* The ogr provider from the GDAL library supports a `wide variety of formats <https://gdal.org/en/latest/drivers/vector/index.html>`_,
also called drivers in GDAL speak.
Examples are Geopackage, Flatgeobuf, Geojson and also The-One-We-Shall-Not-Name.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Examples are Geopackage, Flatgeobuf, Geojson and also The-One-We-Shall-Not-Name.
Examples are Geopackage, Flatgeobuf, Geojson and also ESRI Shapefile.

Not everyone knows what it is about so let's name it, please.

docs/pyqgis_developer_cookbook/vector.rst
@@ -1230,7 +1237,7 @@ arrangement)

from qgis.PyQt import QtGui

myVectorLayer = QgsVectorLayer("testdata/airports.shp", "airports", "ogr")
myVectorLayer = QgsVectorLayer("testdata/data/data.gpkg|layername=airports", "Airports layer", "ogr")
myTargetField = 'ELEV'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This field doesn't exist in the gpkg, does it?

docs/pyqgis_developer_cookbook/loadlayer.rst

* for Shapefile:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Imo It is a pity to no longer provide an example with flat files. We can keep the gpkg for tests and it should be possible to add a .. code:: sample for shp without putting it in the testing workflow. And it could appear at the beginning, new line 75.
Not ideal but would address the simplest and most occurring situation.

docs/pyqgis_developer_cookbook/loadlayer.rst
@@ -96,7 +74,7 @@ method of the :class:`QgisInterface <qgis.gui.QgisInterface>`:

.. testcode:: loadlayer

vlayer = iface.addVectorLayer(path_to_airports_layer, "Airports layer", "ogr")
vlayer = iface.addVectorLayer(gpkg_airports_layer, "Airports layer", "ogr")
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In reference to my comment about missing shp, we could keep shp code here...

docs/pyqgis_developer_cookbook/loadlayer.rst
@@ -79,12 +58,11 @@ For a geopackage vector layer:

.. testcode:: loadlayer
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to keep this example here? Before we ever mention the addVectorLayer method? and knowing that it is a more verbose version of new line 101?
I know you are simply following the existing docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DelazJ DelazJ DelazJ left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Flaky doctests due to "Using non-preferred coordinate operation between EPSG:2964 and EPSG:4326."
3 participants
@folinimarc @selmaVH1 @DelazJ