using System;
namespace Python.Runtime
{
///
/// Represents a Python tuple object. See the documentation at
/// PY2: https://docs.python.org/2/c-api/tupleObjects.html
/// PY3: https://docs.python.org/3/c-api/tupleObjects.html
/// for details.
///
public class PyTuple : PySequence
{
///
/// PyTuple Constructor
///
///
/// Creates a new PyTuple from an existing object reference. Note
/// that the instance assumes ownership of the object reference.
/// The object reference is not checked for type-correctness.
///
public PyTuple(IntPtr ptr) : base(ptr)
{
}
///
/// PyTuple Constructor
///
///
/// Creates a new PyTuple from an existing object reference.
/// The object reference is not checked for type-correctness.
///
internal PyTuple(BorrowedReference reference) : base(reference) { }
private static IntPtr FromObject(PyObject o)
{
if (o == null || !IsTupleType(o))
{
throw new ArgumentException("object is not a tuple");
}
Runtime.XIncref(o.obj);
return o.obj;
}
///
/// PyTuple Constructor
///
///
/// Copy constructor - obtain a PyTuple from a generic PyObject. An
/// ArgumentException will be thrown if the given object is not a
/// Python tuple object.
///
public PyTuple(PyObject o) : base(FromObject(o))
{
}
///
/// PyTuple Constructor
///
///
/// Creates a new empty PyTuple.
///
public PyTuple() : base(Runtime.PyTuple_New(0))
{
PythonException.ThrowIfIsNull(obj);
}
private static IntPtr FromArray(PyObject[] items)
{
int count = items.Length;
IntPtr val = Runtime.PyTuple_New(count);
for (var i = 0; i < count; i++)
{
IntPtr ptr = items[i].obj;
Runtime.XIncref(ptr);
int res = Runtime.PyTuple_SetItem(val, i, ptr);
if (res != 0)
{
Runtime.Py_DecRef(val);
throw new PythonException();
}
}
return val;
}
///
/// PyTuple Constructor
///
///
/// Creates a new PyTuple from an array of PyObject instances.
///
/// See caveats about PyTuple_SetItem:
/// https://www.coursehero.com/file/p4j2ogg/important-exceptions-to-this-rule-PyTupleSetItem-and-PyListSetItem-These/
///
public PyTuple(PyObject[] items) : base(FromArray(items))
{
}
///
/// IsTupleType Method
///
///
/// Returns true if the given object is a Python tuple.
///
public static bool IsTupleType(PyObject value)
{
return Runtime.PyTuple_Check(value.obj);
}
///
/// AsTuple Method
///
///
/// Convert a Python object to a Python tuple if possible, raising
/// a PythonException if the conversion is not possible. This is
/// equivalent to the Python expression "tuple(object)".
///
public static PyTuple AsTuple(PyObject value)
{
IntPtr op = Runtime.PySequence_Tuple(value.obj);
PythonException.ThrowIfIsNull(op);
return new PyTuple(op);
}
}
}