Provider a newer cairo in Windows wheels

[lazka]

Some work already done in #243

Ideally we'd pin down all transitive dependencies, like gst-build.

[naveen521kk]

Some work already done in #243

I did so that we don't need to depend on the other one. That PR did work and built wheels locally but didn't pass the test suite. I remember all the tests with exception handling failed, dunno why, could be because of static build of Cairo. I'll post the test suite run output later today.

[naveen521kk]

Ideally we'd pin down all transitive dependencies, like gst-build.

I thought meson subprojects should do the work for us right? Or am I wrong?

[lazka]

I thought meson subprojects should do the work for us right? Or am I wrong?

cairo has various git subprojects: https://gitlab.freedesktop.org/cairo/cairo/-/blob/master/subprojects/pixman.wrap As far as I understand this means it's not reproducible.

[naveen521kk]

As far as I understand this means it's not reproducible.

Hmm, okay I see master branch being used there, which isn't reproducible. I'll add support for that in that PR. Or maybe rather than building ourselves manually we can create those subprojects files ourselves with version we need, right?

The tests failing on static build did demotivate me from working on it and made that PR stale. Probably, need to investigate why it happens.

[lazka]

From what I understood we can create a dummy meson project and provide our own subproject with hardcoded versions. But that's all a stretch goal, so don't worry too much about it.

Another question is, if we build cairo in this repo, or create a separate repo which just provides the cairo build artifacts, similar to https://github.com/preshing/cairo-windows

[naveen521kk]

Another question is, if we build cairo in this repo, or create a separate repo which just provides the cairo build artifacts, similar to https://github.com/preshing/cairo-windows

Hmm, I think having a seperate repo would be better, but in the PR I made it so that it's included in the build process of pycairo itself. Which means, if Cairo or pkg-config isn't available while building pycairo, the build process will automatically build one(the aim was to make it buildable on all platforms, but I never tested it). I was inspired by how matplotlib builds freetype and other deps when not available.

Maybe, if we gonna have a seperate repo then we don't need to include the build scripts for Cairo inside of pycairo itself as done in that PR and just download those binaries in CI as it is done currently.

[stuaxo]

I guess having cairo build artifacts upstream would be ideal, but I'm not sure where we would even start.

Having our own repo, seems the easiest way for now as it builds on knowledge we already have.

[naveen521kk]

The error from the test suite was:

running test
copying build\lib.win-amd64-3.9\cairo\_cairo.cp39-win_amd64.pyd -> cairo
copying build\pycairo_tests\lib.win-amd64-3.9\tests\cmod.cp39-win_amd64.pyd -> tests
============================= test session starts =============================
platform win32 -- Python 3.9.7, pytest-6.0.0, py-1.10.0, pluggy-0.13.1
rootdir: C:\Users\naveen\Desktop\projects\pycairo
plugins: hypothesis-6.0.0
collected 273 items / 2 skipped / 271 selected

tests\test_api.py ....F...........s                                      [  6%]
tests\test_cmod.py .                                                     [  6%]
tests\test_context.py .............................F.................... [ 24%]
.................                                                        [ 31%]
tests\test_device.py ...........                                         [ 35%]
tests\test_enums.py .......                                              [ 37%]
tests\test_error.py .F..                                                 [ 39%]
tests\test_font.py ..............................                        [ 50%]
tests\test_glyph.py ..                                                   [ 50%]
tests\test_hypothesis.py ...........                                     [ 54%]
tests\test_matrix.py ...........                                         [ 58%]
tests\test_path.py ....                                                  [ 60%]
tests\test_pattern.py .......................F......                     [ 71%]
tests\test_rectangle.py ...                                              [ 72%]
tests\test_region.py ...........                                         [ 76%]
tests\test_surface.py F..F.........FF.Fs.FFsF..F...s...............F.... [ 94%]
..........                                                               [ 98%]
tests\test_textcluster.py .                                              [ 98%]
tests\test_textextents.py ..                                             [ 99%]
tests\test_typing.py .                                                   [100%]

================================== FAILURES ===================================
______________________ test_surface_has_show_text_glyphs ______________________

    def test_surface_has_show_text_glyphs():
        surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, 100, 100)
        assert not surface.has_show_text_glyphs()
        surface.finish()
        with pytest.raises(cairo.Error):
>           surface.has_show_text_glyphs()
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_api.py:76: Failed
_____________________________ test_push_pop_group _____________________________

context = <cairo.Context object at 0x000002EA0F4A1A90>

    def test_push_pop_group(context):
        context.push_group()
        context.pop_group()
    
        context.push_group()
        context.pop_group_to_source()
    
        with pytest.raises(TypeError):
            context.push_group_with_content(object())
    
        context.push_group_with_content(cairo.Content.COLOR)
        context.pop_group()
    
        with pytest.raises(cairo.Error):
>           context.pop_group()
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_context.py:267: Failed
_____________________________ test_error_context ______________________________

    def test_error_context():
        surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, 100, 100)
        ctx = cairo.Context(surface)
        with pytest.raises(cairo.Error) as excinfo:
>           ctx.restore()
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_error.py:50: Failed
_______________________ test_mesh_pattern_error_states ________________________

    def test_mesh_pattern_error_states():
        pattern = cairo.MeshPattern()
        pattern.begin_patch()
        with pytest.raises(cairo.Error):
>           pattern.begin_patch()
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_pattern.py:242: Failed
____________________________ test_context_manager _____________________________

    def test_context_manager():
        with cairo.ImageSurface(cairo.FORMAT_ARGB32, 10, 10) as surface:
            surface.show_page()
        with pytest.raises(cairo.Error) as excinfo:
>           surface.show_page()
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:20: Failed
__________________ test_surface_map_to_image_context_manager __________________

    def test_surface_map_to_image_context_manager():
        main = cairo.ImageSurface(cairo.FORMAT_ARGB32, 10, 10)
        with main.map_to_image(None) as image:
            pass
    
        with pytest.raises(RuntimeError):
            main.unmap_image(image)
    
        with pytest.raises(cairo.Error) as excinfo:
>           image.show_page()
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:86: Failed
___________________________ test_pdf_set_page_label ___________________________

    @pytest.mark.skipif(not hasattr(cairo.PDFSurface, "set_page_label"),
                        reason="too old cairo")
    def test_pdf_set_page_label():
        fileobj = io.BytesIO()
        with cairo.PDFSurface(fileobj, 128, 128) as surface:
            surface.set_page_label("foo")
            surface.set_page_label("bar")
        with pytest.raises(cairo.Error):
>           surface.set_page_label("bar")
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:199: Failed
____________________________ test_pdf_set_metadata ____________________________

    @pytest.mark.skipif(not hasattr(cairo.PDFSurface, "set_metadata"),
                        reason="too old cairo")
    def test_pdf_set_metadata():
        fileobj = io.BytesIO()
        with cairo.PDFSurface(fileobj, 128, 128) as surface:
            surface.set_metadata(cairo.PDFMetadata.TITLE, "title")
            surface.set_metadata(cairo.PDFMetadata.TITLE, "title")
            surface.set_metadata(cairo.PDFMetadata.AUTHOR, "author")
        with pytest.raises(cairo.Error):
>           surface.set_metadata(cairo.PDFMetadata.AUTHOR, "author")
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:211: Failed
_________________________ test_pdf_set_thumbnail_size _________________________

    @pytest.mark.skipif(not hasattr(cairo.PDFSurface, "set_thumbnail_size"),
                        reason="too old cairo")
    def test_pdf_set_thumbnail_size():
        fileobj = io.BytesIO()
        with cairo.PDFSurface(fileobj, 128, 128) as surface:
            surface.set_thumbnail_size(10, 10)
            surface.set_thumbnail_size(0, 0)
            surface.set_thumbnail_size(1, 1)
        with pytest.raises(cairo.Error):
>           surface.set_thumbnail_size(0, 0)
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:234: Failed
_____________________ test_svg_surface_get_document_unit ______________________

    @pytest.mark.skipif(not hasattr(cairo.SVGSurface, "get_document_unit"),
                        reason="too old cairo")
    def test_svg_surface_get_document_unit():
        with cairo.SVGSurface(None, 10, 10) as surface:
            assert surface.get_document_unit() == cairo.SVGUnit.PT
            surface.set_document_unit(cairo.SVGUnit.PX)
            assert surface.get_document_unit() == cairo.SVGUnit.PX
        with pytest.raises(cairo.Error):
>           surface.set_document_unit(cairo.SVGUnit.PX)
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:274: Failed
____________________ test_svg_surface_restrict_to_version _____________________

    def test_svg_surface_restrict_to_version():
        surface = cairo.SVGSurface(None, 10, 10)
        surface.restrict_to_version(cairo.SVG_VERSION_1_1)
        surface.finish()
        with pytest.raises(cairo.Error):
>           surface.restrict_to_version(cairo.SVG_VERSION_1_2)
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:282: Failed
_________________________ test_pdf_version_to_string __________________________

    def test_pdf_version_to_string():
        ver = cairo.PDFSurface.version_to_string(cairo.PDF_VERSION_1_4)
        assert ver and isinstance(ver, str)
        with pytest.raises(ValueError):
>           cairo.PDFSurface.version_to_string(-1)
E           Failed: DID NOT RAISE <class 'ValueError'>

tests\test_surface.py:303: Failed
_________________________ test_ps_surface_dsc_comment _________________________

    def test_ps_surface_dsc_comment():
        surface = cairo.PSSurface(None, 10, 10)
        surface.dsc_comment("%%Title: My excellent document")
        with pytest.raises(cairo.Error):
>           surface.dsc_comment("")
E           Failed: DID NOT RAISE <class 'cairo.Error'>

tests\test_surface.py:326: Failed
_______________ test_surface_from_stream_closed_before_finished _______________

    def test_surface_from_stream_closed_before_finished():
        for Kind in [cairo.PDFSurface, cairo.PSSurface, cairo.SVGSurface]:
            fileobj = io.BytesIO()
            surface = cairo.PDFSurface(fileobj, 128, 128)
            fileobj.close()
            with pytest.raises(IOError):
>               surface.finish()
E               Failed: DID NOT RAISE <class 'OSError'>

tests\test_surface.py:575: Failed
=========================== short test summary info ===========================
FAILED tests/test_api.py::test_surface_has_show_text_glyphs - Failed: DID NOT...
FAILED tests/test_context.py::test_push_pop_group - Failed: DID NOT RAISE <cl...
FAILED tests/test_error.py::test_error_context - Failed: DID NOT RAISE <class...
FAILED tests/test_pattern.py::test_mesh_pattern_error_states - Failed: DID NO...
FAILED tests/test_surface.py::test_context_manager - Failed: DID NOT RAISE <c...
FAILED tests/test_surface.py::test_surface_map_to_image_context_manager - Fai...
FAILED tests/test_surface.py::test_pdf_set_page_label - Failed: DID NOT RAISE...
FAILED tests/test_surface.py::test_pdf_set_metadata - Failed: DID NOT RAISE <...
FAILED tests/test_surface.py::test_pdf_set_thumbnail_size - Failed: DID NOT R...
FAILED tests/test_surface.py::test_svg_surface_get_document_unit - Failed: DI...
FAILED tests/test_surface.py::test_svg_surface_restrict_to_version - Failed: ...
FAILED tests/test_surface.py::test_pdf_version_to_string - Failed: DID NOT RA...
FAILED tests/test_surface.py::test_ps_surface_dsc_comment - Failed: DID NOT R...
FAILED tests/test_surface.py::test_surface_from_stream_closed_before_finished
================== 14 failed, 255 passed, 6 skipped in 3.76s ==================

[danyeaw]

Great idea to provide wheels for Windows! Gvsbuild is now pip installable, and it can generate wheels with the --py-wheel option. It already avoids meson subprojects. It would be really straightforward to create a CI pipeline to upload the wheels. If you like the approach, I would be glad to help out.

[lazka]

@danyeaw thanks for the offer, but we have everything set up already in this repo and https://github.com/pygobject/cairo-win-build

[lazka]

This is fixed now with the 1.23.0 release