Skip to main content

PyTypeTableHandle

Struct PyTypeTableHandle 

Source
pub struct PyTypeTableHandle { /* private fields */ }
Expand description

Handle to a CCDB type table, exposing metadata and fetch APIs to Python.

§Attributes

name : str Table name without directory components. id : int Unique table identifier in CCDB. meta : TypeTableMeta Metadata describing row/column counts and comments.

Implementations§

Source§

impl PyTypeTableHandle

Source

pub fn name(&self) -> &str

str: Table name (without directory components).

Source

pub fn id(&self) -> i64

int: Numeric identifier of the table in CCDB.

Source

pub fn meta(&self) -> PyTypeTableMeta

TypeTableMeta: Metadata such as row counts and comments.

Source

pub fn full_path(&self) -> String

str: Absolute path to this table.

Source

pub fn columns(&self) -> PyResult<Vec<PyColumnMeta>>

columns(self)

§Returns

listColumnMeta Metadata for each column in order.

Source

pub fn fetch( &self, runs: Option<Vec<RunNumber>>, variation: Option<String>, timestamp: Option<Bound<'_, PyAny>>, ) -> PyResult<BTreeMap<RunNumber, PyData>>

fetch(self, *, runs=None, variation=None, timestamp=None)

§Parameters

runs : list[int] | None, optional Run numbers to query; defaults to run 0 when omitted. variation : str | None, optional Variation branch to resolve (default “default”). timestamp : datetime | str | None, optional Timestamp used to select historical assignments.

§Returns

dict[int, Data] Mapping of run number to fetched dataset.

Source

pub fn fetch_run_period( &self, run_period: &str, rest_version: Option<Bound<'_, PyAny>>, variation: Option<String>, timestamp: Option<Bound<'_, PyAny>>, ) -> PyResult<BTreeMap<RunNumber, PyData>>

fetch_run_period(self, *, run_period, rest_version=None, variation=None, timestamp=None)

§Parameters

run_period : str The short string of the corresponding GlueX run period (e.g. “S17”, “F18”) rest_version : int | datetime | None, optional The REST version or explicit timestamp to use when resolving a time stamp. variation : str | None, optional Variation branch to resolve (default “default”). timestamp : datetime | str | None, optional Timestamp used to select historical assignments. This will override timestamp from the REST version if provided

§Returns

dict[int, Data] Mapping of run number to fetched dataset.

Trait Implementations§

Source§

impl DerefToPyAny for PyTypeTableHandle

Source§

impl ExtractPyClassWithClone for PyTypeTableHandle

Source§

impl<'py> IntoPyObject<'py> for PyTypeTableHandle

Source§

type Target = PyTypeTableHandle

The Python output type
Source§

type Output = Bound<'py, <PyTypeTableHandle as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for PyTypeTableHandle

Source§

const NAME: &str = "TypeTableHandle"

Name of the class. Read more
Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for PyTypeTableHandle

Source§

const MODULE: Option<&str>

Module which the class will be associated with. Read more
Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// Handle to a CCDB type table, exposing metadata and fetch APIs to Python. /// /// Attributes /// ---------- /// name : str /// Table name without directory components. /// id : int /// Unique table identifier in CCDB. /// meta : TypeTableMeta /// Metadata describing row/column counts and comments.

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type Layout = <<PyTypeTableHandle as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyTypeTableHandle>

Description of how this class is laid out in memory
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = ThreadCheckerImpl

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

Source§

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)
Source§

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset
Source§

impl PyMethods<PyTypeTableHandle> for PyClassImplCollector<PyTypeTableHandle>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for PyTypeTableHandle

Source§

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.
Source§

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.
Source§

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.
Source§

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.
Source§

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.
Source§

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

Source§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
Source§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
Source§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

Source§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0:

Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.

Name of self. This is used in error messages, for example.
Source§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Ungil for T
where T: Send,