Skip to content

Commit

Permalink
fix: make PyType::name consistent with __name__ and add PyType::module
Browse files Browse the repository at this point in the history
  • Loading branch information
@wyfo
wyfo committed Apr 7, 2024
1 parent a4aea23 commit 7370b02
Showing 1 changed file with 131 additions and 7 deletions.
138 changes: 131 additions & 7 deletions src/types/typeobject.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,21 @@ impl PyType {
self.as_borrowed().qualname()
}

/// Gets the full name, which includes the module, of the `PyType`.
/// Gets the module of the `PyType`.
pub fn module(&self) -> PyResult<Cow<'_, str>> {
self.as_borrowed().module()
}

/// Gets the name of the `PyType`.
pub fn name(&self) -> PyResult<Cow<'_, str>> {
self.as_borrowed().name()
}

/// Gets the full name, which includes the module, of the `PyType`.
pub fn full_name(&self) -> PyResult<Cow<'_, str>> {
self.as_borrowed().full_name()
}

/// Checks whether `self` is a subclass of `other`.
///
/// Equivalent to the Python expression `issubclass(self, other)`.
Expand Down Expand Up @@ -111,9 +121,15 @@ pub trait PyTypeMethods<'py>: crate::sealed::Sealed {
/// Retrieves the underlying FFI pointer associated with this Python object.
fn as_type_ptr(&self) -> *mut ffi::PyTypeObject;

/// Gets the full name, which includes the module, of the `PyType`.
/// Gets the module of the `PyType`.
fn module(&self) -> PyResult<Cow<'_, str>>;

/// Gets the name of the `PyType`.
fn name(&self) -> PyResult<Cow<'_, str>>;

/// Gets the full name, which includes the module, of the `PyType`.
fn full_name(&self) -> PyResult<Cow<'_, str>>;

/// Gets the [qualified name](https://docs.python.org/3/glossary.html#term-qualified-name) of the `PyType`.
fn qualname(&self) -> PyResult<String>;

Expand All @@ -138,11 +154,21 @@ impl<'py> PyTypeMethods<'py> for Bound<'py, PyType> {
self.as_ptr() as *mut ffi::PyTypeObject
}

/// Gets the module of the `PyType`.
fn module(&self) -> PyResult<Cow<'_, str>> {
Borrowed::from(self).module()
}

/// Gets the name of the `PyType`.
fn name(&self) -> PyResult<Cow<'_, str>> {
Borrowed::from(self).name()
}

/// Gets the full name, which includes the module, of the `PyType`.
fn full_name(&self) -> PyResult<Cow<'_, str>> {
Borrowed::from(self).full_name()
}

fn qualname(&self) -> PyResult<String> {
#[cfg(any(Py_LIMITED_API, PyPy, not(Py_3_11)))]
let name = self.getattr(intern!(self.py(), "__qualname__"))?.extract();
Expand Down Expand Up @@ -182,12 +208,43 @@ impl<'py> PyTypeMethods<'py> for Bound<'py, PyType> {
}

impl<'a> Borrowed<'a, '_, PyType> {
fn module(self) -> PyResult<Cow<'a, str>> {
#[cfg(not(any(Py_LIMITED_API, PyPy)))]
{
let ptr = self.as_type_ptr();

if let Some((module, _)) = unsafe { CStr::from_ptr((*ptr).tp_name) }
.to_str()?
.rsplit_once('.')
{
#[cfg(Py_3_10)]
if unsafe { ffi::PyType_HasFeature(ptr, ffi::Py_TPFLAGS_IMMUTABLETYPE) } != 0 {
return Ok(Cow::Borrowed(module));
}

Ok(Cow::Owned(module.to_owned()))
} else {
let module = self.getattr(intern!(self.py(), "__module__"))?;

Ok(Cow::Owned(module.str()?.to_string()))
}
}

#[cfg(any(Py_LIMITED_API, PyPy))]
{
let module = self.getattr(intern!(self.py(), "__module__"))?;

Ok(Cow::Owned(module.str()?.to_string()))
}
}

fn name(self) -> PyResult<Cow<'a, str>> {
#[cfg(not(any(Py_LIMITED_API, PyPy)))]
{
let ptr = self.as_type_ptr();

let name = unsafe { CStr::from_ptr((*ptr).tp_name) }.to_str()?;
let tp_name = unsafe { CStr::from_ptr((*ptr).tp_name) }.to_str()?;
let name = tp_name.rsplit_once('.').map_or(tp_name, |(_, s)| s);

#[cfg(Py_3_10)]
if unsafe { ffi::PyType_HasFeature(ptr, ffi::Py_TPFLAGS_IMMUTABLETYPE) } != 0 {
Expand All @@ -199,8 +256,41 @@ impl<'a> Borrowed<'a, '_, PyType> {

#[cfg(any(Py_LIMITED_API, PyPy))]
{
let module = self.getattr(intern!(self.py(), "__module__"))?;
#[cfg(not(Py_3_11))]
let name = self.getattr(intern!(self.py(), "__name__"))?;

#[cfg(Py_3_11)]
let name = {
use crate::ffi_ptr_ext::FfiPtrExt;
unsafe { ffi::PyType_GetName(self.as_type_ptr()).assume_owned_or_err(self.py())? }
};

Ok(Cow::Owned(name.str()?.to_string()))
}
}

fn full_name(self) -> PyResult<Cow<'a, str>> {
#[cfg(not(any(Py_LIMITED_API, PyPy)))]
{
let ptr = self.as_type_ptr();

let name = unsafe { CStr::from_ptr((*ptr).tp_name) }.to_str()?;
if name.contains('.') {
#[cfg(Py_3_10)]
if unsafe { ffi::PyType_HasFeature(ptr, ffi::Py_TPFLAGS_IMMUTABLETYPE) } != 0 {
return Ok(Cow::Borrowed(name));
}

Ok(Cow::Owned(name.to_owned()))
} else {
let module = self.getattr(intern!(self.py(), "__module__"))?;

Ok(Cow::Owned(format!("{}.{}", module, name)))
}
}

#[cfg(any(Py_LIMITED_API, PyPy))]
{
#[cfg(not(Py_3_11))]
let name = self.getattr(intern!(self.py(), "__name__"))?;

Expand All @@ -210,16 +300,20 @@ impl<'a> Borrowed<'a, '_, PyType> {
unsafe { ffi::PyType_GetName(self.as_type_ptr()).assume_owned_or_err(self.py())? }
};

let module = self.getattr(intern!(self.py(), "__module__"))?;

Ok(Cow::Owned(format!("{}.{}", module, name)))
}
}
}

#[cfg(test)]
mod tests {
use crate::types::typeobject::PyTypeMethods;
use crate::types::{PyBool, PyLong};
use crate::Python;
use crate::types::PyType;
use crate::{
types::{any::PyAnyMethods, typeobject::PyTypeMethods, PyBool, PyLong},
Python,
};

#[test]
fn test_type_is_subclass() {
Expand All @@ -239,4 +333,34 @@ mod tests {
.unwrap());
});
}

#[test]
fn test_type_full_name() {
Python::with_gil(|py| {
// C type
let datetime = py.import_bound("datetime").unwrap();
let date = datetime
.getattr("date")
.unwrap()
.downcast_into::<PyType>()
.unwrap();
assert_eq!(date.module().unwrap(), "datetime");
assert_eq!(date.name().unwrap(), "date");
assert_eq!(date.full_name().unwrap(), "datetime.date");

// Python type
let asyncio = py.import_bound("asyncio").unwrap();
let date = asyncio
.getattr("CancelledError")
.unwrap()
.downcast_into::<PyType>()
.unwrap();
assert_eq!(date.module().unwrap(), "asyncio.exceptions");
assert_eq!(date.name().unwrap(), "CancelledError");
assert_eq!(
date.full_name().unwrap(),
"asyncio.exceptions.CancelledError"
);
})
}
}

0 comments on commit 7370b02

Please sign in to comment.