Skip to main content

PyParquetDataCatalog

nautilus_persistence::python::catalog

Struct PyParquetDataCatalog 

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

A catalog for writing data to Parquet files.

Implementations§

Source§

impl PyParquetDataCatalog

Source

pub fn new( base_path: &str, storage_options: Option<HashMap<String, String>>, batch_size: Option<usize>, compression: Option<u8>, max_row_group_size: Option<usize>, ) -> Self

Create a new ParquetCatalog with the given base path and optional parameters.

§Parameters
  • base_path: The base path for the catalog
  • storage_options: Optional storage configuration for cloud backends
  • batch_size: Optional batch size for processing (default: 5000)
  • compression: Optional compression type (0=UNCOMPRESSED, 1=SNAPPY, 2=GZIP, 3=LZO, 4=BROTLI, 5=LZ4, 6=ZSTD)
  • max_row_group_size: Optional maximum row group size (default: 5000)
Source

pub fn write_quote_ticks( &self, data: Vec<QuoteTick>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write quote tick data to Parquet files.

§Parameters
  • data: Vector of quote ticks to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_trade_ticks( &self, data: Vec<TradeTick>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write trade tick data to Parquet files.

§Parameters
  • data: Vector of trade ticks to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_order_book_deltas( &self, data: Vec<OrderBookDelta>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write order book delta data to Parquet files.

§Parameters
  • data: Vector of order book deltas to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_bars( &self, data: Vec<Bar>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write bar data to Parquet files.

§Parameters
  • data: Vector of bars to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_order_book_depths( &self, data: Vec<OrderBookDepth10>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write order book depth data to Parquet files.

§Parameters
  • data: Vector of order book depths to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_mark_price_updates( &self, data: Vec<MarkPriceUpdate>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write mark price update data to Parquet files.

§Parameters
  • data: Vector of mark price updates to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_index_price_updates( &self, data: Vec<IndexPriceUpdate>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write index price update data to Parquet files.

§Parameters
  • data: Vector of index price updates to write
  • start: Optional start timestamp override (nanoseconds since Unix epoch)
  • end: Optional end timestamp override (nanoseconds since Unix epoch)
§Returns

Returns the path of the created file as a string.

Source

pub fn write_instruments( &self, data: &Bound<'_, PyAny>, ) -> PyResult<Vec<String>>

Write instruments to Parquet files in the catalog.

Instruments are stored under data/instruments/{instrument_id}/ using timestamp-ranged parquet file names, allowing multiple historical versions of the same instrument to be written across separate calls.

§Parameters
  • data: A Python list of instrument objects (e.g. CurrencyPair, Equity).
§Returns

Returns a list of written file paths.

Source

pub fn instruments( &self, instrument_ids: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, ) -> PyResult<Vec<Py<PyAny>>>

Query instruments from the catalog.

§Parameters
  • instrument_ids: Optional list of instrument IDs to filter by. If None, returns all instruments.
  • start: Optional inclusive lower bound for ts_init filtering.
  • end: Optional inclusive upper bound for ts_init filtering.
§Returns

Returns a list of instrument objects (e.g. CurrencyPair, Equity).

Source

pub fn extend_file_name( &self, data_cls: &str, instrument_id: Option<String>, start: u64, end: u64, ) -> PyResult<()>

Extend file names in the catalog with additional timestamp information.

§Parameters
  • data_cls: The data class name
  • instrument_id: Optional instrument ID filter
  • start: Start timestamp (nanoseconds since Unix epoch)
  • end: End timestamp (nanoseconds since Unix epoch)
Source

pub fn consolidate_catalog( &self, start: Option<u64>, end: Option<u64>, ensure_contiguous_files: Option<bool>, deduplicate: Option<bool>, ) -> PyResult<()>

Consolidate all data files in the catalog within the specified time range.

§Parameters
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • ensure_contiguous_files: Optional flag to ensure files are contiguous
  • deduplicate: Optional flag to deduplicate rows when combining files
Source

pub fn consolidate_data( &self, type_name: &str, instrument_id: Option<String>, start: Option<u64>, end: Option<u64>, ensure_contiguous_files: Option<bool>, deduplicate: Option<bool>, ) -> PyResult<()>

Consolidate data files for a specific data type within the specified time range.

§Parameters
  • type_name: The data type name to consolidate
  • instrument_id: Optional instrument ID filter
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • ensure_contiguous_files: Optional flag to ensure files are contiguous
  • deduplicate: Optional flag to deduplicate rows when combining files
Source

pub fn consolidate_catalog_by_period( &mut self, period_nanos: Option<u64>, start: Option<u64>, end: Option<u64>, ensure_contiguous_files: Option<bool>, ) -> PyResult<()>

Consolidate all data files in the catalog by splitting them into fixed time periods.

This method identifies all leaf directories in the catalog that contain parquet files and consolidates them by period. A leaf directory is one that contains files but no subdirectories. This is a convenience method that effectively calls consolidate_data_by_period for all data types and instrument IDs in the catalog.

§Parameters
  • period_nanos: Optional period duration for consolidation in nanoseconds. Default is 1 day (86400000000000). Examples: 3600000000000 (1 hour), 604800000000000 (7 days), 1800000000000 (30 minutes)
  • start: Optional start timestamp for the consolidation range (nanoseconds since Unix epoch)
  • end: Optional end timestamp for the consolidation range (nanoseconds since Unix epoch)
  • ensure_contiguous_files: Optional flag to control file naming strategy
Source

pub fn consolidate_data_by_period( &mut self, type_name: &str, identifier: Option<String>, period_nanos: Option<u64>, start: Option<u64>, end: Option<u64>, ensure_contiguous_files: Option<bool>, ) -> PyResult<()>

Consolidate data files by splitting them into fixed time periods.

This method queries data by period and writes consolidated files immediately, using efficient period-based consolidation logic. When start/end boundaries intersect existing files, the function automatically splits those files to preserve all data.

§Parameters
  • type_name: The data type directory name (e.g., “quotes”, “trades”, “bars”)
  • identifier: Optional instrument ID to consolidate. If None, consolidates all instruments
  • period_nanos: Optional period duration for consolidation in nanoseconds. Default is 1 day (86400000000000). Examples: 3600000000000 (1 hour), 604800000000000 (7 days), 1800000000000 (30 minutes)
  • start: Optional start timestamp for consolidation range (nanoseconds since Unix epoch)
  • end: Optional end timestamp for consolidation range (nanoseconds since Unix epoch)
  • ensure_contiguous_files: Optional flag to control file naming strategy
Source

pub fn reset_all_file_names(&self) -> PyResult<()>

Reset all catalog file names to their canonical form.

Source

pub fn reset_data_file_names( &self, data_cls: &str, instrument_id: Option<String>, ) -> PyResult<()>

Reset data file names for a specific data class to their canonical form.

§Parameters
  • data_cls: The data class name
  • instrument_id: Optional instrument ID filter
Source

pub fn delete_catalog_range( &mut self, start: Option<u64>, end: Option<u64>, ) -> PyResult<()>

Delete data within a specified time range across the entire catalog.

This method identifies all leaf directories in the catalog that contain parquet files and deletes data within the specified time range from each directory. A leaf directory is one that contains files but no subdirectories. This is a convenience method that effectively calls delete_data_range for all data types and instrument IDs in the catalog.

§Parameters
  • start: Optional start timestamp for the deletion range (nanoseconds since Unix epoch)
  • end: Optional end timestamp for the deletion range (nanoseconds since Unix epoch)
§Notes
  • This operation permanently removes data and cannot be undone
  • The deletion process handles file intersections intelligently by splitting files when they partially overlap with the deletion range
  • Files completely within the deletion range are removed entirely
  • Files partially overlapping the deletion range are split to preserve data outside the range
  • This method is useful for bulk data cleanup operations across the entire catalog
  • Empty directories are not automatically removed after deletion
Source

pub fn delete_data_range( &mut self, type_name: &str, instrument_id: Option<String>, start: Option<u64>, end: Option<u64>, ) -> PyResult<()>

Delete data within a specified time range for a specific data type and instrument.

This method identifies all parquet files that intersect with the specified time range and handles them appropriately:

  • Files completely within the range are deleted
  • Files partially overlapping the range are split to preserve data outside the range
  • The original intersecting files are removed after processing
§Parameters
  • type_name: The data type directory name (e.g., “quotes”, “trades”, “bars”)
  • instrument_id: Optional instrument ID to delete data for. If None, deletes data across all instruments
  • start: Optional start timestamp for the deletion range (nanoseconds since Unix epoch)
  • end: Optional end timestamp for the deletion range (nanoseconds since Unix epoch)
§Notes
  • This operation permanently removes data and cannot be undone
  • Files that partially overlap the deletion range are split to preserve data outside the range
  • The method ensures data integrity by using atomic operations where possible
  • Empty directories are not automatically removed after deletion
Source

pub fn write_custom_data( &self, _py: Python<'_>, data: Vec<Bound<'_, PyAny>>, start: Option<u64>, end: Option<u64>, skip_disjoint_check: bool, ) -> PyResult<String>

Write custom data to Parquet files.

Requires CustomData wrappers. Callers must wrap raw custom objects in CustomData(data_type=DataType(cls, metadata=...), data=...) before writing.

Source

pub fn list_instruments(&self, data_type: &str) -> PyResult<Vec<String>>

List all instrument IDs available in the catalog for a given data type.

Source

pub fn list_parquet_files( &self, data_type: &str, instrument_id: &str, ) -> PyResult<Vec<String>>

List all Parquet files in the catalog for a given data type and instrument.

Source

pub fn query_files( &self, data_cls: &str, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, ) -> PyResult<Vec<String>>

Query files in the catalog matching the specified criteria.

§Parameters
  • data_cls: The data class name to query
  • identifiers: Optional list of identifiers to filter by. Can be instrument_id strings (e.g., “EUR/USD.SIM”) or bar_type strings (e.g., “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”). For bars, partial matching is supported.
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
§Returns

Returns a list of file paths matching the criteria.

Source

pub fn get_missing_intervals_for_request( &self, start: u64, end: u64, data_cls: &str, instrument_id: Option<String>, ) -> PyResult<Vec<(u64, u64)>>

Get missing time intervals for a data request.

§Parameters
  • start: Start timestamp (nanoseconds since Unix epoch)
  • end: End timestamp (nanoseconds since Unix epoch)
  • data_cls: The data class name
  • instrument_id: Optional instrument ID filter
§Returns

Returns a list of (start, end) timestamp tuples representing missing intervals.

Source

pub fn query_first_timestamp( &self, data_cls: &str, instrument_id: Option<String>, ) -> PyResult<Option<u64>>

Query the first timestamp for a specific data class and instrument.

§Parameters
  • data_cls: The data class name
  • instrument_id: Optional instrument ID filter
§Returns

Returns the first timestamp as nanoseconds since Unix epoch, or None if no data exists.

Source

pub fn query_last_timestamp( &self, data_cls: &str, instrument_id: Option<String>, ) -> PyResult<Option<u64>>

Query the last timestamp for a specific data class and instrument.

§Parameters
  • data_cls: The data class name
  • instrument_id: Optional instrument ID filter
§Returns

Returns the last timestamp as nanoseconds since Unix epoch, or None if no data exists.

Source

pub fn get_intervals( &self, data_cls: &str, instrument_id: Option<String>, ) -> PyResult<Vec<(u64, u64)>>

Get time intervals covered by data for a specific data class and instrument.

§Parameters
  • data_cls: The data class name
  • instrument_id: Optional instrument ID filter
§Returns

Returns a list of (start, end) timestamp tuples representing covered intervals.

Source

pub fn query( &mut self, py: Python<'_>, data_type: &str, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, files: Option<Vec<String>>, optimize_file_loading: bool, ) -> PyResult<Vec<Py<PyAny>>>

Query Parquet files for data matching the given criteria.

Source

pub fn query_quote_ticks( &mut self, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<QuoteTick>>

Query quote tick data from Parquet files.

§Parameters
  • identifiers: Optional list of identifiers to filter by. Can be instrument_id strings (e.g., “EUR/USD.SIM”) or bar_type strings (e.g., “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”). For bars, partial matching is supported.
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of QuoteTick objects matching the query criteria.

Source

pub fn query_trade_ticks( &mut self, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<TradeTick>>

Query trade tick data from Parquet files.

§Parameters
  • identifiers: Optional list of identifiers to filter by. Can be instrument_id strings (e.g., “EUR/USD.SIM”) or bar_type strings (e.g., “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”). For bars, partial matching is supported.
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of TradeTick objects matching the query criteria.

Source

pub fn query_order_book_deltas( &mut self, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<OrderBookDelta>>

Query order book delta data from Parquet files.

§Parameters
  • identifiers: Optional list of identifiers to filter by. Can be instrument_id strings (e.g., “EUR/USD.SIM”) or bar_type strings (e.g., “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”). For bars, partial matching is supported.
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of OrderBookDelta objects matching the query criteria.

Source

pub fn query_bars( &mut self, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<Bar>>

Query bar data from Parquet files.

§Parameters
  • identifiers: Optional list of identifiers to filter by. Can be instrument_id strings (e.g., “EUR/USD.SIM”) or bar_type strings (e.g., “EUR/USD.SIM-1-MINUTE-LAST-EXTERNAL”). For bars, partial matching is supported (e.g., “EUR/USD.SIM” will match all bar types for that instrument).
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of Bar objects matching the query criteria.

Source

pub fn query_order_book_depths( &mut self, instrument_ids: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<OrderBookDepth10>>

Query order book depth data from Parquet files.

§Parameters
  • instrument_ids: Optional list of instrument IDs to filter by
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of OrderBookDepth10 objects matching the query criteria.

Source

pub fn query_mark_price_updates( &mut self, instrument_ids: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<MarkPriceUpdate>>

Query mark price update data from Parquet files.

§Parameters
  • instrument_ids: Optional list of instrument IDs to filter by
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of MarkPriceUpdate objects matching the query criteria.

Source

pub fn query_index_price_updates( &mut self, instrument_ids: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<IndexPriceUpdate>>

Query index price update data from Parquet files.

§Parameters
  • instrument_ids: Optional list of instrument IDs to filter by
  • start: Optional start timestamp (nanoseconds since Unix epoch)
  • end: Optional end timestamp (nanoseconds since Unix epoch)
  • where_clause: Optional SQL WHERE clause for additional filtering
§Returns

Returns a vector of IndexPriceUpdate objects matching the query criteria.

Source

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

List all data types available in the catalog.

§Returns

Returns a list of data type names (as directory stems) in the catalog.

Source

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

List all live run IDs available in the catalog.

§Returns

Returns a list of live run IDs (as directory stems) in the catalog.

Source

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

List all backtest run IDs available in the catalog.

§Returns

Returns a list of backtest run IDs (as directory stems) in the catalog.

Source

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

List all backtest run instances available in the catalog.

Source

pub fn read_live_run( &self, py: Python<'_>, instance_id: &str, ) -> PyResult<Vec<Py<PyAny>>>

Read data from a live run instance.

§Parameters
  • instance_id: The ID of the live run instance
§Returns

Returns a list of data objects from the live run, sorted by timestamp.

Source

pub fn read_backtest( &self, py: Python<'_>, instance_id: &str, ) -> PyResult<Vec<Py<PyAny>>>

Read data from a backtest run instance.

§Parameters
  • instance_id: The ID of the backtest run instance
§Returns

Returns a list of data objects from the backtest run, sorted by timestamp.

Source

pub fn convert_stream_to_data( &mut self, instance_id: &str, data_cls: &str, subdirectory: Option<&str>, identifiers: Option<Vec<String>>, use_ts_event_for_ts_init: bool, ) -> PyResult<()>

Convert stream data from feather files to parquet files.

This method reads data from feather files generated during a backtest or live run and writes it to the catalog in parquet format. It’s useful for converting temporary stream data into a more permanent and queryable format.

§Parameters
  • instance_id: The ID of the backtest or live run instance
  • data_cls: The data class name (e.g., “quotes”, “trades”, “bars”)
  • subdirectory: Optional subdirectory containing the feather files. Either “backtest” or “live” (default: “backtest”)
  • identifiers: Optional list of identifiers to filter by (instrument IDs or bar types)
  • use_ts_event_for_ts_init: If true, replaces the ts_init column with ts_event column values before deserializing
§Returns

Returns nothing on success.

§Examples
# Convert backtest stream data to parquet
catalog.convert_stream_to_data(
    "instance-123",
    "quotes",
    subdirectory="backtest"
)

# Convert live run data with identifier filtering
catalog.convert_stream_to_data(
    "instance-456",
    "trades",
    subdirectory="live",
    identifiers=["EUR/USD.SIM"]
)
Source

pub fn query_custom_data( &mut self, py: Python<'_>, type_name: &str, identifiers: Option<Vec<String>>, start: Option<u64>, end: Option<u64>, where_clause: Option<&str>, ) -> PyResult<Vec<Py<PyAny>>>

Query custom data from Parquet files.

Trait Implementations§

Source§

impl<'py> IntoPyObject<'py> for PyParquetDataCatalog

Source§

type Target = PyParquetDataCatalog

The Python output type
Source§

type Output = Bound<'py, <PyParquetDataCatalog 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 PyParquetDataCatalog

Source§

const NAME: &str = "ParquetDataCatalog"

Name of the class. Read more
Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for PyParquetDataCatalog

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 = /// A catalog for writing data to Parquet files.

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 = <<PyParquetDataCatalog as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyParquetDataCatalog>

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

type BaseType = PyAny

Base class
Source§

type ThreadChecker = NoopThreadChecker

This handles following two situations: Read more
Source§

type Inventory = Pyo3MethodsInventoryForPyParquetDataCatalog

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>

§

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
Source§

impl PyClassNewTextSignature for PyParquetDataCatalog

Source§

const TEXT_SIGNATURE: &'static str = "(base_path, storage_options=None, batch_size=None, compression=None, max_row_group_size=None)"

Source§

impl PyStubType for PyParquetDataCatalog

Source§

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.
§

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods. Read more
Source§

impl PyTypeInfo for PyParquetDataCatalog

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.
§

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.
Source§

impl DerefToPyAny for PyParquetDataCatalog

Source§

impl ExtractPyClassWithClone for PyParquetDataCatalog

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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
§

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

§

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

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

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.
§

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

Converts self into a Python object. Read more
§

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

§

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

Convert self into a [Py<PyAny>] while panicking if the conversion fails. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

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

§

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

Arguments for exception
§

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

§

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.
§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

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