Struct pyo3::types::PySequence
source · #[repr(transparent)]pub struct PySequence(_);
Expand description
Represents a reference to a Python object supporting the sequence protocol.
Implementations§
source§impl PySequence
impl PySequence
sourcepub fn len(&self) -> PyResult<usize>
pub fn len(&self) -> PyResult<usize>
Returns the number of objects in sequence.
This is equivalent to the Python expression len(self)
.
sourcepub fn concat(&self, other: &PySequence) -> PyResult<&PySequence>
pub fn concat(&self, other: &PySequence) -> PyResult<&PySequence>
Returns the concatenation of self
and other
.
This is equivalent to the Python expression self + other
.
sourcepub fn repeat(&self, count: usize) -> PyResult<&PySequence>
pub fn repeat(&self, count: usize) -> PyResult<&PySequence>
Returns the result of repeating a sequence object count
times.
This is equivalent to the Python expression self * count
.
sourcepub fn in_place_concat(&self, other: &PySequence) -> PyResult<&PySequence>
pub fn in_place_concat(&self, other: &PySequence) -> PyResult<&PySequence>
Concatenates self
and other
, in place if possible.
This is equivalent to the Python expression self.__iadd__(other)
.
The Python statement self += other
is syntactic sugar for self = self.__iadd__(other)
. __iadd__
should modify and return self
if
possible, but create and return a new object if not.
sourcepub fn in_place_repeat(&self, count: usize) -> PyResult<&PySequence>
pub fn in_place_repeat(&self, count: usize) -> PyResult<&PySequence>
Repeats the sequence object count
times and updates self
, if possible.
This is equivalent to the Python expression self.__imul__(other)
.
The Python statement self *= other
is syntactic sugar for self = self.__imul__(other)
. __imul__
should modify and return self
if
possible, but create and return a new object if not.
sourcepub fn get_item(&self, index: usize) -> PyResult<&PyAny>
pub fn get_item(&self, index: usize) -> PyResult<&PyAny>
Returns the index
th element of the Sequence.
This is equivalent to the Python expression self[index]
without support of negative indices.
sourcepub fn get_slice(&self, begin: usize, end: usize) -> PyResult<&PySequence>
pub fn get_slice(&self, begin: usize, end: usize) -> PyResult<&PySequence>
Returns the slice of sequence object between begin
and end
.
This is equivalent to the Python expression self[begin:end]
.
sourcepub fn set_item<I>(&self, i: usize, item: I) -> PyResult<()>where
I: ToPyObject,
pub fn set_item<I>(&self, i: usize, item: I) -> PyResult<()>where I: ToPyObject,
Assigns object item
to the i
th element of self.
This is equivalent to the Python statement self[i] = v
.
sourcepub fn del_item(&self, i: usize) -> PyResult<()>
pub fn del_item(&self, i: usize) -> PyResult<()>
Deletes the i
th element of self.
This is equivalent to the Python statement del self[i]
.
sourcepub fn set_slice(&self, i1: usize, i2: usize, v: &PyAny) -> PyResult<()>
pub fn set_slice(&self, i1: usize, i2: usize, v: &PyAny) -> PyResult<()>
Assigns the sequence v
to the slice of self
from i1
to i2
.
This is equivalent to the Python statement self[i1:i2] = v
.
sourcepub fn del_slice(&self, i1: usize, i2: usize) -> PyResult<()>
pub fn del_slice(&self, i1: usize, i2: usize) -> PyResult<()>
Deletes the slice from i1
to i2
from self
.
This is equivalent to the Python statement del self[i1:i2]
.
sourcepub fn count<V>(&self, value: V) -> PyResult<usize>where
V: ToPyObject,
pub fn count<V>(&self, value: V) -> PyResult<usize>where V: ToPyObject,
Returns the number of occurrences of value
in self, that is, return the
number of keys for which self[key] == value
.
sourcepub fn contains<V>(&self, value: V) -> PyResult<bool>where
V: ToPyObject,
pub fn contains<V>(&self, value: V) -> PyResult<bool>where V: ToPyObject,
Determines if self contains value
.
This is equivalent to the Python expression value in self
.
sourcepub fn index<V>(&self, value: V) -> PyResult<usize>where
V: ToPyObject,
pub fn index<V>(&self, value: V) -> PyResult<usize>where V: ToPyObject,
Returns the first index i
for which self[i] == value
.
This is equivalent to the Python expression self.index(value)
.
sourcepub fn list(&self) -> PyResult<&PyList>
👎Deprecated since 0.19.0: renamed to .to_list()
pub fn list(&self) -> PyResult<&PyList>
Returns a fresh list based on the Sequence.
sourcepub fn tuple(&self) -> PyResult<&PyTuple>
👎Deprecated since 0.19.0: renamed to .to_tuple()
pub fn tuple(&self) -> PyResult<&PyTuple>
Returns a fresh tuple based on the Sequence.
sourcepub fn register<T: PyTypeInfo>(py: Python<'_>) -> PyResult<()>
pub fn register<T: PyTypeInfo>(py: Python<'_>) -> PyResult<()>
Register a pyclass as a subclass of collections.abc.Sequence
(from the Python standard
library). This is equvalent to collections.abc.Sequence.register(T)
in Python.
This registration is required for a pyclass to be downcastable from PyAny
to PySequence
.
Methods from Deref<Target = PyAny>§
sourcepub fn is<T: AsPyPointer>(&self, other: &T) -> bool
pub fn is<T: AsPyPointer>(&self, other: &T) -> bool
Returns whether self
and other
point to the same object. To compare
the equality of two objects (the ==
operator), use eq
.
This is equivalent to the Python expression self is other
.
sourcepub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool>where
N: IntoPy<Py<PyString>>,
pub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool>where N: IntoPy<Py<PyString>>,
Determines whether this object has the given attribute.
This is equivalent to the Python expression hasattr(self, attr_name)
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern attr_name
.
Example: intern!
ing the attribute name
#[pyfunction]
fn has_version(sys: &PyModule) -> PyResult<bool> {
sys.hasattr(intern!(sys.py(), "version"))
}
sourcepub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny>where
N: IntoPy<Py<PyString>>,
pub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny>where N: IntoPy<Py<PyString>>,
Retrieves an attribute value.
This is equivalent to the Python expression self.attr_name
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern attr_name
.
Example: intern!
ing the attribute name
#[pyfunction]
fn version(sys: &PyModule) -> PyResult<&PyAny> {
sys.getattr(intern!(sys.py(), "version"))
}
sourcepub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()>where
N: IntoPy<Py<PyString>>,
V: ToPyObject,
pub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()>where N: IntoPy<Py<PyString>>, V: ToPyObject,
Sets an attribute value.
This is equivalent to the Python expression self.attr_name = value
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern name
.
Example: intern!
ing the attribute name
#[pyfunction]
fn set_answer(ob: &PyAny) -> PyResult<()> {
ob.setattr(intern!(ob.py(), "answer"), 42)
}
sourcepub fn delattr<N>(&self, attr_name: N) -> PyResult<()>where
N: IntoPy<Py<PyString>>,
pub fn delattr<N>(&self, attr_name: N) -> PyResult<()>where N: IntoPy<Py<PyString>>,
Deletes an attribute.
This is equivalent to the Python statement del self.attr_name
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern attr_name
.
sourcepub fn compare<O>(&self, other: O) -> PyResult<Ordering>where
O: ToPyObject,
pub fn compare<O>(&self, other: O) -> PyResult<Ordering>where O: ToPyObject,
Returns an Ordering
between self
and other
.
This is equivalent to the following Python code:
if self == other:
return Equal
elif a < b:
return Less
elif a > b:
return Greater
else:
raise TypeError("PyAny::compare(): All comparisons returned false")
Examples
use pyo3::prelude::*;
use pyo3::types::PyFloat;
use std::cmp::Ordering;
Python::with_gil(|py| -> PyResult<()> {
let a = PyFloat::new(py, 0_f64);
let b = PyFloat::new(py, 42_f64);
assert_eq!(a.compare(b)?, Ordering::Less);
Ok(())
})?;
It will return PyErr
for values that cannot be compared:
use pyo3::prelude::*;
use pyo3::types::{PyFloat, PyString};
Python::with_gil(|py| -> PyResult<()> {
let a = PyFloat::new(py, 0_f64);
let b = PyString::new(py, "zero");
assert!(a.compare(b).is_err());
Ok(())
})?;
sourcepub fn rich_compare<O>(
&self,
other: O,
compare_op: CompareOp
) -> PyResult<&PyAny>where
O: ToPyObject,
pub fn rich_compare<O>( &self, other: O, compare_op: CompareOp ) -> PyResult<&PyAny>where O: ToPyObject,
Tests whether two Python objects obey a given CompareOp
.
lt
, le
, eq
, ne
,
gt
and ge
are the specialized versions
of this function.
Depending on the value of compare_op
, this is equivalent to one of the
following Python expressions:
compare_op | Python expression |
---|---|
CompareOp::Eq | self == other |
CompareOp::Ne | self != other |
CompareOp::Lt | self < other |
CompareOp::Le | self <= other |
CompareOp::Gt | self > other |
CompareOp::Ge | self >= other |
Examples
use pyo3::class::basic::CompareOp;
use pyo3::prelude::*;
use pyo3::types::PyInt;
Python::with_gil(|py| -> PyResult<()> {
let a: &PyInt = 0_u8.into_py(py).into_ref(py).downcast()?;
let b: &PyInt = 42_u8.into_py(py).into_ref(py).downcast()?;
assert!(a.rich_compare(b, CompareOp::Le)?.is_true()?);
Ok(())
})?;
sourcepub fn lt<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
pub fn lt<O>(&self, other: O) -> PyResult<bool>where O: ToPyObject,
Tests whether this object is less than another.
This is equivalent to the Python expression self < other
.
sourcepub fn le<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
pub fn le<O>(&self, other: O) -> PyResult<bool>where O: ToPyObject,
Tests whether this object is less than or equal to another.
This is equivalent to the Python expression self <= other
.
sourcepub fn eq<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
pub fn eq<O>(&self, other: O) -> PyResult<bool>where O: ToPyObject,
Tests whether this object is equal to another.
This is equivalent to the Python expression self == other
.
sourcepub fn ne<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
pub fn ne<O>(&self, other: O) -> PyResult<bool>where O: ToPyObject,
Tests whether this object is not equal to another.
This is equivalent to the Python expression self != other
.
sourcepub fn gt<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
pub fn gt<O>(&self, other: O) -> PyResult<bool>where O: ToPyObject,
Tests whether this object is greater than another.
This is equivalent to the Python expression self > other
.
sourcepub fn ge<O>(&self, other: O) -> PyResult<bool>where
O: ToPyObject,
pub fn ge<O>(&self, other: O) -> PyResult<bool>where O: ToPyObject,
Tests whether this object is greater than or equal to another.
This is equivalent to the Python expression self >= other
.
sourcepub fn is_callable(&self) -> bool
pub fn is_callable(&self) -> bool
Determines whether this object appears callable.
This is equivalent to Python’s callable()
function.
Examples
use pyo3::prelude::*;
Python::with_gil(|py| -> PyResult<()> {
let builtins = PyModule::import(py, "builtins")?;
let print = builtins.getattr("print")?;
assert!(print.is_callable());
Ok(())
})?;
This is equivalent to the Python statement assert callable(print)
.
Note that unless an API needs to distinguish between callable and non-callable objects, there is no point in checking for callability. Instead, it is better to just do the call and handle potential exceptions.
sourcepub fn call(
&self,
args: impl IntoPy<Py<PyTuple>>,
kwargs: Option<&PyDict>
) -> PyResult<&PyAny>
pub fn call( &self, args: impl IntoPy<Py<PyTuple>>, kwargs: Option<&PyDict> ) -> PyResult<&PyAny>
Calls the object.
This is equivalent to the Python expression self(*args, **kwargs)
.
Examples
use pyo3::prelude::*;
use pyo3::types::PyDict;
const CODE: &str = r#"
def function(*args, **kwargs):
assert args == ("hello",)
assert kwargs == {"cruel": "world"}
return "called with args and kwargs"
"#;
Python::with_gil(|py| {
let module = PyModule::from_code(py, CODE, "", "")?;
let fun = module.getattr("function")?;
let args = ("hello",);
let kwargs = PyDict::new(py);
kwargs.set_item("cruel", "world")?;
let result = fun.call(args, Some(kwargs))?;
assert_eq!(result.extract::<&str>()?, "called with args and kwargs");
Ok(())
})
sourcepub fn call0(&self) -> PyResult<&PyAny>
pub fn call0(&self) -> PyResult<&PyAny>
Calls the object without arguments.
This is equivalent to the Python expression self()
.
Examples
use pyo3::prelude::*;
Python::with_gil(|py| -> PyResult<()> {
let module = PyModule::import(py, "builtins")?;
let help = module.getattr("help")?;
help.call0()?;
Ok(())
})?;
This is equivalent to the Python expression help()
.
sourcepub fn call1(&self, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny>
pub fn call1(&self, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny>
Calls the object with only positional arguments.
This is equivalent to the Python expression self(*args)
.
Examples
use pyo3::prelude::*;
const CODE: &str = r#"
def function(*args, **kwargs):
assert args == ("hello",)
assert kwargs == {}
return "called with args"
"#;
Python::with_gil(|py| {
let module = PyModule::from_code(py, CODE, "", "")?;
let fun = module.getattr("function")?;
let args = ("hello",);
let result = fun.call1(args)?;
assert_eq!(result.extract::<&str>()?, "called with args");
Ok(())
})
sourcepub fn call_method<N, A>(
&self,
name: N,
args: A,
kwargs: Option<&PyDict>
) -> PyResult<&PyAny>where
N: IntoPy<Py<PyString>>,
A: IntoPy<Py<PyTuple>>,
pub fn call_method<N, A>( &self, name: N, args: A, kwargs: Option<&PyDict> ) -> PyResult<&PyAny>where N: IntoPy<Py<PyString>>, A: IntoPy<Py<PyTuple>>,
Calls a method on the object.
This is equivalent to the Python expression self.name(*args, **kwargs)
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern name
.
Examples
use pyo3::prelude::*;
use pyo3::types::PyDict;
const CODE: &str = r#"
class A:
def method(self, *args, **kwargs):
assert args == ("hello",)
assert kwargs == {"cruel": "world"}
return "called with args and kwargs"
a = A()
"#;
Python::with_gil(|py| {
let module = PyModule::from_code(py, CODE, "", "")?;
let instance = module.getattr("a")?;
let args = ("hello",);
let kwargs = PyDict::new(py);
kwargs.set_item("cruel", "world")?;
let result = instance.call_method("method", args, Some(kwargs))?;
assert_eq!(result.extract::<&str>()?, "called with args and kwargs");
Ok(())
})
sourcepub fn call_method0<N>(&self, name: N) -> PyResult<&PyAny>where
N: IntoPy<Py<PyString>>,
pub fn call_method0<N>(&self, name: N) -> PyResult<&PyAny>where N: IntoPy<Py<PyString>>,
Calls a method on the object without arguments.
This is equivalent to the Python expression self.name()
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern name
.
Examples
use pyo3::prelude::*;
const CODE: &str = r#"
class A:
def method(self, *args, **kwargs):
assert args == ()
assert kwargs == {}
return "called with no arguments"
a = A()
"#;
Python::with_gil(|py| {
let module = PyModule::from_code(py, CODE, "", "")?;
let instance = module.getattr("a")?;
let result = instance.call_method0("method")?;
assert_eq!(result.extract::<&str>()?, "called with no arguments");
Ok(())
})
sourcepub fn call_method1<N, A>(&self, name: N, args: A) -> PyResult<&PyAny>where
N: IntoPy<Py<PyString>>,
A: IntoPy<Py<PyTuple>>,
pub fn call_method1<N, A>(&self, name: N, args: A) -> PyResult<&PyAny>where N: IntoPy<Py<PyString>>, A: IntoPy<Py<PyTuple>>,
Calls a method on the object with only positional arguments.
This is equivalent to the Python expression self.name(*args)
.
To avoid repeated temporary allocations of Python strings, the intern!
macro can be used
to intern name
.
Examples
use pyo3::prelude::*;
const CODE: &str = r#"
class A:
def method(self, *args, **kwargs):
assert args == ("hello",)
assert kwargs == {}
return "called with args"
a = A()
"#;
Python::with_gil(|py| {
let module = PyModule::from_code(py, CODE, "", "")?;
let instance = module.getattr("a")?;
let args = ("hello",);
let result = instance.call_method1("method", args)?;
assert_eq!(result.extract::<&str>()?, "called with args");
Ok(())
})
sourcepub fn is_true(&self) -> PyResult<bool>
pub fn is_true(&self) -> PyResult<bool>
Returns whether the object is considered to be true.
This is equivalent to the Python expression bool(self)
.
sourcepub fn is_none(&self) -> bool
pub fn is_none(&self) -> bool
Returns whether the object is considered to be None.
This is equivalent to the Python expression self is None
.
sourcepub fn is_ellipsis(&self) -> bool
pub fn is_ellipsis(&self) -> bool
Returns whether the object is Ellipsis, e.g. ...
.
This is equivalent to the Python expression self is ...
.
sourcepub fn is_empty(&self) -> PyResult<bool>
pub fn is_empty(&self) -> PyResult<bool>
Returns true if the sequence or mapping has a length of 0.
This is equivalent to the Python expression len(self) == 0
.
sourcepub fn get_item<K>(&self, key: K) -> PyResult<&PyAny>where
K: ToPyObject,
pub fn get_item<K>(&self, key: K) -> PyResult<&PyAny>where K: ToPyObject,
Gets an item from the collection.
This is equivalent to the Python expression self[key]
.
sourcepub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()>where
K: ToPyObject,
V: ToPyObject,
pub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()>where K: ToPyObject, V: ToPyObject,
Sets a collection item value.
This is equivalent to the Python expression self[key] = value
.
sourcepub fn del_item<K>(&self, key: K) -> PyResult<()>where
K: ToPyObject,
pub fn del_item<K>(&self, key: K) -> PyResult<()>where K: ToPyObject,
Deletes an item from the collection.
This is equivalent to the Python expression del self[key]
.
sourcepub fn iter(&self) -> PyResult<&PyIterator>
pub fn iter(&self) -> PyResult<&PyIterator>
Takes an object and returns an iterator for it.
This is typically a new iterator but if the argument is an iterator, this returns itself.
sourcepub fn get_type_ptr(&self) -> *mut PyTypeObject
pub fn get_type_ptr(&self) -> *mut PyTypeObject
Returns the Python type pointer for this object.
sourcepub fn downcast<'p, T>(&'p self) -> Result<&'p T, PyDowncastError<'_>>where
T: PyTryFrom<'p>,
pub fn downcast<'p, T>(&'p self) -> Result<&'p T, PyDowncastError<'_>>where T: PyTryFrom<'p>,
Downcast this PyAny
to a concrete Python type or pyclass.
Note that you can often avoid downcasting yourself by just specifying the desired type in function or method signatures. However, manual downcasting is sometimes necessary.
For extracting a Rust-only type, see PyAny::extract
.
Example: Downcasting to a specific Python object
use pyo3::prelude::*;
use pyo3::types::{PyDict, PyList};
Python::with_gil(|py| {
let dict = PyDict::new(py);
assert!(dict.is_instance_of::<PyAny>());
let any: &PyAny = dict.as_ref();
assert!(any.downcast::<PyDict>().is_ok());
assert!(any.downcast::<PyList>().is_err());
});
Example: Getting a reference to a pyclass
This is useful if you want to mutate a PyObject
that
might actually be a pyclass.
use pyo3::prelude::*;
#[pyclass]
struct Class {
i: i32,
}
Python::with_gil(|py| {
let class: &PyAny = Py::new(py, Class { i: 0 }).unwrap().into_ref(py);
let class_cell: &PyCell<Class> = class.downcast()?;
class_cell.borrow_mut().i += 1;
// Alternatively you can get a `PyRefMut` directly
let class_ref: PyRefMut<'_, Class> = class.extract()?;
assert_eq!(class_ref.i, 1);
Ok(())
})
sourcepub fn downcast_exact<'p, T>(&'p self) -> Result<&'p T, PyDowncastError<'_>>where
T: PyTryFrom<'p>,
pub fn downcast_exact<'p, T>(&'p self) -> Result<&'p T, PyDowncastError<'_>>where T: PyTryFrom<'p>,
Downcast this PyAny
to a concrete Python type or pyclass (but not a subclass of it).
It is almost always better to use PyAny::downcast
because it accounts for Python
subtyping. Use this method only when you do not want to allow subtypes.
The advantage of this method over PyAny::downcast
is that it is faster. The implementation
of downcast_exact
uses the equivalent of the Python expression type(self) is T
, whereas
downcast
uses isinstance(self, T)
.
For extracting a Rust-only type, see PyAny::extract
.
Example: Downcasting to a specific Python object but not a subtype
use pyo3::prelude::*;
use pyo3::types::{PyBool, PyLong};
Python::with_gil(|py| {
let b = PyBool::new(py, true);
assert!(b.is_instance_of::<PyBool>());
let any: &PyAny = b.as_ref();
// `bool` is a subtype of `int`, so `downcast` will accept a `bool` as an `int`
// but `downcast_exact` will not.
assert!(any.downcast::<PyLong>().is_ok());
assert!(any.downcast_exact::<PyLong>().is_err());
assert!(any.downcast_exact::<PyBool>().is_ok());
});
sourcepub unsafe fn downcast_unchecked<'p, T>(&'p self) -> &'p Twhere
T: PyTryFrom<'p>,
pub unsafe fn downcast_unchecked<'p, T>(&'p self) -> &'p Twhere T: PyTryFrom<'p>,
Converts this PyAny
to a concrete Python type without checking validity.
Safety
Callers must ensure that the type is valid or risk type confusion.
sourcepub fn extract<'a, D>(&'a self) -> PyResult<D>where
D: FromPyObject<'a>,
pub fn extract<'a, D>(&'a self) -> PyResult<D>where D: FromPyObject<'a>,
Extracts some type from the Python object.
This is a wrapper function around FromPyObject::extract()
.
sourcepub fn get_refcnt(&self) -> isize
pub fn get_refcnt(&self) -> isize
Returns the reference count for the Python object.
sourcepub fn repr(&self) -> PyResult<&PyString>
pub fn repr(&self) -> PyResult<&PyString>
Computes the “repr” representation of self.
This is equivalent to the Python expression repr(self)
.
sourcepub fn str(&self) -> PyResult<&PyString>
pub fn str(&self) -> PyResult<&PyString>
Computes the “str” representation of self.
This is equivalent to the Python expression str(self)
.
sourcepub fn hash(&self) -> PyResult<isize>
pub fn hash(&self) -> PyResult<isize>
Retrieves the hash code of self.
This is equivalent to the Python expression hash(self)
.
sourcepub fn len(&self) -> PyResult<usize>
pub fn len(&self) -> PyResult<usize>
Returns the length of the sequence or mapping.
This is equivalent to the Python expression len(self)
.
sourcepub fn dir(&self) -> &PyList
pub fn dir(&self) -> &PyList
Returns the list of attributes of this object.
This is equivalent to the Python expression dir(self)
.
sourcepub fn is_instance(&self, ty: &PyAny) -> PyResult<bool>
pub fn is_instance(&self, ty: &PyAny) -> PyResult<bool>
Checks whether this object is an instance of type ty
.
This is equivalent to the Python expression isinstance(self, ty)
.
sourcepub fn is_exact_instance(&self, ty: &PyAny) -> bool
pub fn is_exact_instance(&self, ty: &PyAny) -> bool
Checks whether this object is an instance of exactly type ty
(not a subclass).
This is equivalent to the Python expression type(self) is ty
.
sourcepub fn is_instance_of<T: PyTypeInfo>(&self) -> bool
pub fn is_instance_of<T: PyTypeInfo>(&self) -> bool
Checks whether this object is an instance of type T
.
This is equivalent to the Python expression isinstance(self, T)
,
if the type T
is known at compile time.
sourcepub fn is_exact_instance_of<T: PyTypeInfo>(&self) -> bool
pub fn is_exact_instance_of<T: PyTypeInfo>(&self) -> bool
Checks whether this object is an instance of exactly type T
.
This is equivalent to the Python expression type(self) is T
,
if the type T
is known at compile time.
sourcepub fn contains<V>(&self, value: V) -> PyResult<bool>where
V: ToPyObject,
pub fn contains<V>(&self, value: V) -> PyResult<bool>where V: ToPyObject,
Determines if self contains value
.
This is equivalent to the Python expression value in self
.
sourcepub fn as_ptr(&self) -> *mut PyObject
pub fn as_ptr(&self) -> *mut PyObject
Returns the raw FFI pointer represented by self.
Safety
Callers are responsible for ensuring that the pointer does not outlive self.
The reference is borrowed; callers should not decrease the reference count when they are finished with the pointer.
Trait Implementations§
source§impl AsPyPointer for PySequence
impl AsPyPointer for PySequence
source§impl AsRef<PyAny> for PySequence
impl AsRef<PyAny> for PySequence
source§impl Debug for PySequence
impl Debug for PySequence
source§impl Deref for PySequence
impl Deref for PySequence
source§impl Display for PySequence
impl Display for PySequence
source§impl<'a> From<&'a PySequence> for &'a PyAny
impl<'a> From<&'a PySequence> for &'a PyAny
source§fn from(ob: &'a PySequence) -> Self
fn from(ob: &'a PySequence) -> Self
source§impl From<&PySequence> for Py<PySequence>
impl From<&PySequence> for Py<PySequence>
source§fn from(other: &PySequence) -> Self
fn from(other: &PySequence) -> Self
source§impl<'py> FromPyObject<'py> for &'py PySequence
impl<'py> FromPyObject<'py> for &'py PySequence
source§impl Index<RangeFull> for PySequence
impl Index<RangeFull> for PySequence
source§impl Index<RangeInclusive<usize>> for PySequence
impl Index<RangeInclusive<usize>> for PySequence
§type Output = PySequence
type Output = PySequence
source§impl Index<RangeToInclusive<usize>> for PySequence
impl Index<RangeToInclusive<usize>> for PySequence
§type Output = PySequence
type Output = PySequence
source§impl Index<usize> for PySequence
impl Index<usize> for PySequence
source§impl IntoPy<Py<PySequence>> for &PySequence
impl IntoPy<Py<PySequence>> for &PySequence
source§impl PyNativeType for PySequence
impl PyNativeType for PySequence
source§impl<'v> PyTryFrom<'v> for PySequence
impl<'v> PyTryFrom<'v> for PySequence
source§fn try_from<V: Into<&'v PyAny>>(
value: V
) -> Result<&'v PySequence, PyDowncastError<'v>>
fn try_from<V: Into<&'v PyAny>>( value: V ) -> Result<&'v PySequence, PyDowncastError<'v>>
Downcasting to PySequence
requires the concrete class to be a subclass (or registered
subclass) of collections.abc.Sequence
(from the Python standard library) - i.e.
isinstance(<class>, collections.abc.Sequence) == True
.
source§fn try_from_exact<V: Into<&'v PyAny>>(
value: V
) -> Result<&'v PySequence, PyDowncastError<'v>>
fn try_from_exact<V: Into<&'v PyAny>>( value: V ) -> Result<&'v PySequence, PyDowncastError<'v>>
source§unsafe fn try_from_unchecked<V: Into<&'v PyAny>>(value: V) -> &'v PySequence
unsafe fn try_from_unchecked<V: Into<&'v PyAny>>(value: V) -> &'v PySequence
source§impl ToPyObject for PySequence
impl ToPyObject for PySequence
Auto Trait Implementations§
impl !RefUnwindSafe for PySequence
impl !Send for PySequence
impl !Sync for PySequence
impl Unpin for PySequence
impl UnwindSafe for PySequence
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<'p, T> FromPyPointer<'p> for Twhere
T: 'p + PyNativeType,
impl<'p, T> FromPyPointer<'p> for Twhere T: 'p + PyNativeType,
source§unsafe fn from_owned_ptr_or_opt(
py: Python<'p>,
ptr: *mut PyObject
) -> Option<&'p T>
unsafe fn from_owned_ptr_or_opt( py: Python<'p>, ptr: *mut PyObject ) -> Option<&'p T>
PyObject
. Read moresource§unsafe fn from_borrowed_ptr_or_opt(
_py: Python<'p>,
ptr: *mut PyObject
) -> Option<&'p T>
unsafe fn from_borrowed_ptr_or_opt( _py: Python<'p>, ptr: *mut PyObject ) -> Option<&'p T>
PyObject
. Read moresource§unsafe fn from_owned_ptr_or_panic(
py: Python<'p>,
ptr: *mut PyObject
) -> &'p Self
unsafe fn from_owned_ptr_or_panic( py: Python<'p>, ptr: *mut PyObject ) -> &'p Self
PyObject
or panic. Read moresource§unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
PyObject
or panic. Read moresource§unsafe fn from_owned_ptr_or_err(
py: Python<'p>,
ptr: *mut PyObject
) -> PyResult<&'p Self>
unsafe fn from_owned_ptr_or_err( py: Python<'p>, ptr: *mut PyObject ) -> PyResult<&'p Self>
PyObject
. Read moresource§unsafe fn from_borrowed_ptr_or_panic(
py: Python<'p>,
ptr: *mut PyObject
) -> &'p Self
unsafe fn from_borrowed_ptr_or_panic( py: Python<'p>, ptr: *mut PyObject ) -> &'p Self
PyObject
. Read more