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

folinimarc · 2024-09-12T15:40:49Z

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.

…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.

… examples.

folinimarc · 2024-09-13T12:46:31Z

@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 · 2024-09-13T14:05:57Z

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.

…nto fix_doctest_by_using_epsg4326_dataset_instead_of_epsg2964

folinimarc · 2024-09-13T15:49:51Z

@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 · 2024-09-18T14:14:42Z

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

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.

DelazJ · 2024-09-15T13:14:07Z

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:


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

DelazJ · 2024-09-15T13:14:57Z

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.


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.

DelazJ · 2024-09-24T02:30:55Z

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'


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

DelazJ · 2024-09-24T02:40:55Z

docs/pyqgis_developer_cookbook/loadlayer.rst


-  * for Shapefile:


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.

DelazJ · 2024-09-24T03:12:39Z

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")


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

DelazJ · 2024-09-24T03:14:20Z

docs/pyqgis_developer_cookbook/loadlayer.rst

@@ -79,12 +58,11 @@ For a geopackage vector layer:

 .. testcode:: loadlayer


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

folinimarc added 2 commits September 12, 2024 16:58

Revert capitalized parameters for wfs uri to be similar to subsequent…

65731db

… examples.

folinimarc added 5 commits September 13, 2024 16:33

Merge branch 'master' of https://github.com/qgis/QGIS-Documentation i…

cb6b0fa

…nto fix_doctest_by_using_epsg4326_dataset_instead_of_epsg2964

Empty test commit to trigger workflow

161c25a

Empty test commit to trigger workflow

4d5721e

Empty test commit to trigger workflow

c70620d

Empty test commit to trigger workflow

87d1d6c

DelazJ reviewed Sep 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

folinimarc commented Sep 12, 2024 •

edited

Loading

folinimarc commented Sep 13, 2024 •

edited

Loading

folinimarc commented Sep 13, 2024 •

edited

Loading

folinimarc commented Sep 13, 2024 •

edited

Loading

selmaVH1 commented Sep 18, 2024

DelazJ left a comment

DelazJ Sep 15, 2024

DelazJ Sep 15, 2024

DelazJ Sep 24, 2024

DelazJ Sep 24, 2024

DelazJ Sep 24, 2024

DelazJ Sep 24, 2024

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

		@@ -79,12 +58,11 @@ For a geopackage vector layer:

		.. testcode:: loadlayer

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

Are you sure you want to change the base?

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

Conversation

folinimarc commented Sep 12, 2024 • edited Loading

folinimarc commented Sep 13, 2024 • edited Loading

folinimarc commented Sep 13, 2024 • edited Loading

folinimarc commented Sep 13, 2024 • edited Loading

selmaVH1 commented Sep 18, 2024

DelazJ left a comment

Choose a reason for hiding this comment

DelazJ Sep 15, 2024

Choose a reason for hiding this comment

DelazJ Sep 15, 2024

Choose a reason for hiding this comment

DelazJ Sep 24, 2024

Choose a reason for hiding this comment

DelazJ Sep 24, 2024

Choose a reason for hiding this comment

DelazJ Sep 24, 2024

Choose a reason for hiding this comment

DelazJ Sep 24, 2024

Choose a reason for hiding this comment

folinimarc commented Sep 12, 2024 •

edited

Loading

folinimarc commented Sep 13, 2024 •

edited

Loading

folinimarc commented Sep 13, 2024 •

edited

Loading

folinimarc commented Sep 13, 2024 •

edited

Loading