Struct PyCCDB 

pub struct PyCCDB { /* private fields */ }

Entry point for interacting with CCDB from Python.

Parameters

path : str, optional Filesystem path to an existing CCDB SQLite database file. Defaults to the CCDB_CONNECTION environment variable.

Implementations

impl PyCCDB

pub fn new(path: Option<String>) -> PyResult<Self>

init(self, path)

Parameters

path : str, optional Filesystem path to an existing CCDB SQLite database file. Defaults to CCDB_CONNECTION.

pub fn dir(&self, path: &str) -> PyResult<PyDirectoryHandle>

dir(self, path)

Parameters

path : str Absolute or relative directory path.

Returns

DirectoryHandle Handle to the requested directory.

pub fn table(&self, path: &str) -> PyResult<PyTypeTableHandle>

table(self, path)

Parameters

path : str Absolute or relative table path.

Returns

TypeTableHandle Handle to the requested table.

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

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

Parameters

path : str Absolute or relative table path. 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.

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

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

Parameters

path : str Absolute or relative table path. 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.

pub fn root(&self) -> PyResult<PyDirectoryHandle>

root(self)

Returns

DirectoryHandle Handle to the root directory.

pub fn connection_path(&self) -> &str

str: Filesystem path that was used to open the database.

Trait Implementations

impl DerefToPyAny for PyCCDB

impl ExtractPyClassWithClone for PyCCDB

impl<'py> IntoPyObject<'py> for PyCCDB

type Target = PyCCDB

The Python output type

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

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

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

Performs the conversion.

impl PyClass for PyCCDB

const NAME: &str = "CCDB"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyCCDB

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Entry point for interacting with CCDB from Python. /// /// Parameters /// ---------- /// path : str, optional /// Filesystem path to an existing CCDB SQLite database file. Defaults to /// the ``CCDB_CONNECTION`` environment variable.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

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

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerImpl

This handles following two situations:

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

Immutable or mutable

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

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

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyCCDB

const TEXT_SIGNATURE: &'static str = "(path=None)"

impl PyMethods<PyCCDB> for PyClassImplCollector<PyCCDB>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyCCDB

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.

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.

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

Returns the PyTypeObject instance for this type.

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

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.