Struct perspective_python::PySyncClient

pub struct PySyncClient(/* private fields */);

Implementations

impl PySyncClient

pub fn new(callback: Py<PyAny>) -> PyResult<Self>

pub fn handle_response( &self, py: Python<'_>, response: Py<PyBytes>, ) -> PyResult<bool>

pub fn table( &self, py: Python<'_>, input: Py<PyAny>, limit: Option<u32>, index: Option<Py<PyString>>, name: Option<Py<PyString>>, ) -> PyResult<PySyncTable>

[Table] is Perspective’s columnar data frame, analogous to a Pandas DataFrame or Apache Arrow, supporting append & in-place updates, removal by index, and update notifications.

A [Table] contains columns, each of which have a unique name, are strongly and consistently typed, and contains rows of data conforming to the column’s type. Each column in a [Table] must have the same number of rows, though not every row must contain data; null-values are used to indicate missing values in the dataset.

The schema of a [Table] is immutable after creation, which means the column names and data types cannot be changed after the [Table] has been created. Columns cannot be added or deleted after creation either, but a [View] can be used to select an arbitrary set of columns from the [Table].

pub fn open_table(&self, name: String) -> PyResult<PySyncTable>

Opens a [Table] that is hosted on the perspective_server::Server that is connected to this [Client].

The name property of [TableInitOptions] is used to identify each [Table]. [Table] names can be looked up for each [Client] via [Client::get_hosted_table_names].

JavaScript Examples

Get a virtual [Table] named “table_one” from this [Client]

const tables = await client.open_table("table_one");

Python Examples

tables = client.open_table("table_one");

Examples

let tables = client.open_table("table_one").await;

pub fn get_hosted_table_names(&self) -> PyResult<Vec<String>>

Retrieves the names of all tables that this client has access to.

name is a string identifier unique to the [Table] (per [Client]), which can be used in conjunction with [Client::open_table] to get a [Table] instance without the use of [Client::table] constructor directly (e.g., one created by another [Client]).

JavaScript Examples

const tables = await client.get_hosted_table_names();

Python Examples

tables = client.get_hosted_table_names();

Examples

let tables = client.get_hosted_table_names().await;

pub fn set_loop_callback(&self, loop_cb: Py<PyAny>) -> PyResult<()>

Methods such as [View::on_update] take a callback function as an argument, which may be invoked by the Perspective runtime when updates occur. If provided a loop callback function via [Client::set_loop_callback], such callback function invocations be passed to the loop callback instead.

[Client::set_loop_callback] can be used to control scheduling/conflation (e.g. by adding a delay), as well as executor integration.

Trait Implementations

impl HasPyGilRef for PySyncClient

type AsRefTarget = PyCell<PySyncClient>

Utility type to make Py::as_ref work.

impl IntoPy<Py<PyAny>> for PySyncClient

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PyClass for PySyncClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PySyncClient

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PySyncClient>

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<PySyncClient> for PyClassImplCollector<PySyncClient>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a PySyncClient

type Holder = Option<PyRef<'py, PySyncClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a mut PySyncClient

type Holder = Option<PyRefMut<'py, PySyncClient>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<PySyncClient> for PyClassImplCollector<PySyncClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PySyncClient

const NAME: &'static str = "PySyncClient"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

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

Returns the PyTypeObject instance for this type.

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

👎Deprecated since 0.21.0: PyTypeInfo::type_object will be replaced by PyTypeInfo::type_object_bound in a future PyO3 version

Returns the safe abstraction over the type object.

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

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_type_of will be replaced by PyTypeInfo::is_type_of_bound in a future PyO3 version

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

fn is_type_of_bound(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: &PyAny) -> bool

👎Deprecated since 0.21.0: PyTypeInfo::is_exact_type_of will be replaced by PyTypeInfo::is_exact_type_of_bound in a future PyO3 version

Checks if object is an instance of this type.

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

Checks if object is an instance of this type.

impl DerefToPyAny for PySyncClient