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
impl PyTypeTableHandle
Sourcepub fn meta(&self) -> PyTypeTableMeta
pub fn meta(&self) -> PyTypeTableMeta
TypeTableMeta: Metadata such as row counts and comments.
Sourcepub fn columns(&self) -> PyResult<Vec<PyColumnMeta>>
pub fn columns(&self) -> PyResult<Vec<PyColumnMeta>>
Sourcepub fn fetch(
&self,
runs: Option<Vec<RunNumber>>,
variation: Option<String>,
timestamp: Option<Bound<'_, PyAny>>,
) -> PyResult<BTreeMap<RunNumber, PyData>>
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.
Sourcepub fn fetch_run_period(
&self,
run_period: &str,
rest_version: Option<Bound<'_, PyAny>>,
variation: Option<String>,
timestamp: Option<Bound<'_, PyAny>>,
) -> PyResult<BTreeMap<RunNumber, PyData>>
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§
impl DerefToPyAny for PyTypeTableHandle
impl ExtractPyClassWithClone for PyTypeTableHandle
Source§impl<'py> IntoPyObject<'py> for PyTypeTableHandle
impl<'py> IntoPyObject<'py> for PyTypeTableHandle
Source§type Target = PyTypeTableHandle
type Target = PyTypeTableHandle
Source§type Output = Bound<'py, <PyTypeTableHandle as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyTypeTableHandle as IntoPyObject<'py>>::Target>
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Source§impl PyClass for PyTypeTableHandle
impl PyClass for PyTypeTableHandle
Source§impl PyClassImpl for PyTypeTableHandle
impl PyClassImpl for PyTypeTableHandle
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
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.
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.
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type Layout = <<PyTypeTableHandle as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyTypeTableHandle>
type Layout = <<PyTypeTableHandle as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyTypeTableHandle>
Source§type ThreadChecker = ThreadCheckerImpl
type ThreadChecker = ThreadCheckerImpl
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
PyAny by default, and when you declare
#[pyclass(extends=PyDict)], it’s PyDict.fn items_iter() -> PyClassItemsIter
fn lazy_type_object() -> &'static LazyTypeObject<Self>
Source§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
Source§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Source§impl PyMethods<PyTypeTableHandle> for PyClassImplCollector<PyTypeTableHandle>
impl PyMethods<PyTypeTableHandle> for PyClassImplCollector<PyTypeTableHandle>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyTypeTableHandle
impl PyTypeInfo for PyTypeTableHandle
Source§const NAME: &str = <Self as ::pyo3::PyClass>::NAME
const NAME: &str = <Self as ::pyo3::PyClass>::NAME
prefer using ::type_object(py).name() to get the correct runtime value
Source§const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE
prefer using ::type_object(py).module() to get the correct runtime value
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Auto Trait Implementations§
impl !RefUnwindSafe for PyTypeTableHandle
impl !UnwindSafe for PyTypeTableHandle
impl Freeze for PyTypeTableHandle
impl Send for PyTypeTableHandle
impl Sync for PyTypeTableHandle
impl Unpin for PyTypeTableHandle
impl UnsafeUnpin for PyTypeTableHandle
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<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
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.