add docs and tests for PyTuple

Author: Christopher Doris

docs/src/pythoncall-reference.md

@@ -181,6 +181,7 @@ Apart from a few fundamental immutable types, conversion from Python to Julia `A
 
 ```@docs
 PyList
+PyTuple
 PySet
 PyDict
 PyIterable

docs/src/releasenotes.md

@@ -11,6 +11,7 @@
 * Adds methods `Py(::AbstractString)`, `Py(::AbstractChar)` (previously only builtin string and char types were allowed).
 * Adds methods `Py(::Integer)`, `Py(::Rational{<:Integer})`, `Py(::AbstractRange{<:Integer})` (previously only builtin integer types were allowed).
 * Adds method `pydict(::Pair...)` to construct a python `dict` from `Pair`s, similar to `Dict`.
+* Added `PyTuple` wrapper for Python tuples with typed indexing.
 * Bug fixes.
 * Internal: switch from Requires.jl to package extensions.
 

src/Wrap/PyTuple.jl

@@ -80,8 +80,8 @@ function Base.Tuple(x::PyTuple{T}) where {T<:Tuple}
     end
 end
 
-# Conversion rule for builtins:tuple -> PyTuple
-function pyconvert_rule_tuple(
+# Conversion rule for Sequence -> PyTuple
+function pyconvert_rule_sequence(
     ::Type{T},
     x::Py,
     ::Type{T1} = Utils._type_ub(T),

src/Wrap/Wrap.jl

@@ -70,7 +70,12 @@ function __init__()
     )
 
     priority = PYCONVERT_PRIORITY_NORMAL
-    pyconvert_add_rule("builtins:tuple", PyTuple, pyconvert_rule_tuple, priority)
+    pyconvert_add_rule(
+        "collections.abc:Sequence",
+        PyTuple,
+        pyconvert_rule_sequence,
+        priority,
+    )
     pyconvert_add_rule("<arraystruct>", Array, pyconvert_rule_array, priority)
     pyconvert_add_rule("<arrayinterface>", Array, pyconvert_rule_array, priority)
     pyconvert_add_rule("<array>", Array, pyconvert_rule_array, priority)

test/Convert.jl

@@ -196,6 +196,15 @@ end
     @test x2 == [1, 2, 3]
 end
 
+@testitem "sequence → PyTuple" begin
+    x1 = pyconvert(PyTuple, pylist([1, "foo", "B"]))
+    @test x1 isa PyTuple{Tuple}
+    @test isequal(Tuple(x1), (1, "foo", "B"))
+    x2 = pyconvert(PyTuple{Tuple{Int,Symbol,Char}}, pylist([1, "foo", "B"]))
+    @test x2 isa PyTuple{Tuple{Int,Symbol,Char}}
+    @test isequal(Tuple(x2), (1, :foo, 'B'))
+end
+
 @testitem "set → PySet" begin
     x1 = pyconvert(PySet, pyset([1, 2, 3]))
     @test x1 isa PySet{Any}

test/Wrap.jl

@@ -570,3 +570,35 @@ end
     @test PyTable isa Type
     @test_throws Exception PyTable(0)
 end
+
+@testitem "PyTuple" begin
+    x = pytuple((1, "a"))
+    y = PyTuple(x)
+    z = PyTuple{Tuple{Int,String}}(x)
+    @testset "construct" begin
+        @test y isa PyTuple{Tuple}
+        @test z isa PyTuple{Tuple{Int,String}}
+        @test PythonCall.ispy(y)
+        @test PythonCall.ispy(z)
+        @test Py(y) === x
+        @test Py(z) === x
+    end
+    @testset "length" begin
+        @test length(y) == 2
+        @test length(z) == 2
+        v = PyTuple{Tuple{Int,Vararg{String}}}(pytuple((1, "a", "b")))
+        @test length(v) == 3
+    end
+    @testset "getindex" begin
+        @test_throws BoundsError y[0]
+        @test y[1] === 1
+        @test y[2] == "a"
+        @test z[1] === 1
+        @test z[2] == "a"
+        @test_throws BoundsError y[3]
+    end
+    @testset "Tuple" begin
+        @test Tuple(y) == (1, "a")
+        @test Tuple(z) == (1, "a")
+    end
+end