build: upgrading exon

python/biobear/bcf_reader.py

@@ -19,11 +19,12 @@
 
 import pyarrow as pa
 
-
 from biobear.reader import Reader
 
 from .biobear import _ExonReader, _BCFIndexedReader
 
+from warnings import warn
+
 
 class BCFReader(Reader):
     """A BCF File Reader.
@@ -38,6 +39,13 @@ def __init__(self, path: os.PathLike):
             path (Path): Path to the BCF file.
 
         """
+
+        # show a warning that this is deprecated
+        warn(
+            "BCFReader is deprecated, use ExonSessionContext instead",
+            DeprecationWarning,
+        )
+
         self._bcf_reader = _ExonReader(str(path), "BCF", None)
 
     @property

python/tests/test_fastq_reader.py

@@ -31,15 +31,19 @@ def test_fastq_reader_to_pandas():
 
     assert len(df) == 2
 
+
 @pytest.mark.skipif(
     not importlib.util.find_spec("polars"), reason="polars not installed"
 )
 def test_fastq_bgzip_reader():
-    fastq_reader = FastqReader(DATA / "fake_fastq_file.fastq.gz", compression=Compression.GZIP)
+    fastq_reader = FastqReader(
+        DATA / "fake_fastq_file.fastq.gz", compression=Compression.GZIP
+    )
     df = fastq_reader.to_polars()
 
     assert len(df) == 20_000
 
+
 @pytest.mark.skipif(
     not importlib.util.find_spec("polars"), reason="polars not installed"
 )

python/tests/test_session.py

@@ -17,7 +17,13 @@
 
 import pytest
 
-from biobear import connect, FASTQReadOptions, FASTAReadOptions, FileCompressionType
+from biobear.biobear import (
+    connect,
+    FASTQReadOptions,
+    FASTAReadOptions,
+    FileCompressionType,
+    BCFReadOptions,
+)
 
 DATA = Path(__file__).parent / "data"
 
@@ -160,7 +166,7 @@ def test_read_fasta_gz():
     fasta_path = DATA / "test.fa.gz"
 
     options = FASTAReadOptions(
-        file_extension="fa.gz", file_compression_type=FileCompressionType.GZIP
+        file_extension="fa", file_compression_type=FileCompressionType.GZIP
     )
     df = session.read_fasta_file(str(fasta_path), options=options).to_polars()
 
@@ -287,3 +293,29 @@ def test_copy_to_s3():
 
     # Should not raise an exception
     session.execute(query)
+
+
+def test_read_bcf_file():
+    """Test reading a BCF file."""
+    session = connect()
+
+    bcf_path = DATA / "index.bcf"
+
+    arrow_table = session.read_bcf_file(bcf_path.as_posix()).to_arrow()
+
+    assert len(arrow_table) == 621
+
+
+@pytest.mark.skip("Not implemented yet")
+def test_bcf_indexed_reader_query():
+    """Test the BCFIndexedReader.query() method."""
+    session = connect()
+    options = BCFReadOptions(region="1")
+
+    bcf_path = DATA / "index.bcf"
+
+    rbr = session.read_bcf_file(
+        bcf_path.as_posix(), options=options
+    ).to_arrow_record_batch_reader()
+
+    assert 191 == sum(b.num_rows for b in rbr)

src/datasources/bcf.rs

@@ -0,0 +1,55 @@
+// Copyright 2024 WHERE TRUE Technologies.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use std::{str::FromStr, vec};
+
+use exon::datasources::bcf::table_provider::ListingBCFTableOptions;
+use noodles::core::Region;
+use pyo3::{pyclass, pymethods};
+
+use crate::error::{BioBearError, BioBearResult};
+
+#[pyclass]
+#[derive(Default, Debug, Clone)]
+pub struct BCFReadOptions {
+    region: Option<Region>,
+}
+
+#[pymethods]
+impl BCFReadOptions {
+    #[new]
+    #[pyo3(signature = (/, region))]
+    fn try_new(region: Option<String>) -> BioBearResult<Self> {
+        let region = region
+            .map(|r| Region::from_str(&r))
+            .transpose()
+            .map_err(|e| {
+                BioBearError::ParserError(format!("Couldn\'t parse region error {}", e))
+            })?;
+
+        Ok(Self { region })
+    }
+}
+
+impl From<BCFReadOptions> for ListingBCFTableOptions {
+    fn from(options: BCFReadOptions) -> Self {
+        let region = if let Some(r) = options.region {
+            vec![r]
+        } else {
+            vec![]
+        };
+
+        ListingBCFTableOptions::default().with_regions(region)
+    }
+}

src/datasources/mod.rs

@@ -12,5 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+pub mod bcf;
 pub mod fasta;
 pub mod fastq;

src/lib.rs

@@ -55,8 +55,10 @@ fn biobear(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_class::<file_compression_type::FileCompressionType>()?;
     m.add_class::<datasources::fastq::FASTQReadOptions>()?;
     m.add_class::<datasources::fasta::FASTAReadOptions>()?;
+    m.add_class::<datasources::bcf::BCFReadOptions>()?;
 
     m.add_function(wrap_pyfunction!(session_context::connect, m)?)?;
+    m.add_function(wrap_pyfunction!(session_context::new_context, m)?)?;
 
     Ok(())
 }

src/session_context.rs

@@ -17,6 +17,7 @@ use exon::{ExonRuntimeEnvExt, ExonSessionExt};
 
 use pyo3::prelude::*;
 
+use crate::datasources::bcf::BCFReadOptions;
 use crate::datasources::fasta::FASTAReadOptions;
 use crate::datasources::fastq::FASTQReadOptions;
 use crate::error;
@@ -59,6 +60,22 @@ impl ExonSessionContext {
         Ok(PyExecutionResult::new(df))
     }
 
+    /// Read a BCF file from the given path.
+    #[pyo3(signature = (file_path, *, options=None))]
+    fn read_bcf_file(
+        &mut self,
+        file_path: &str,
+        options: Option<BCFReadOptions>,
+        py: Python,
+    ) -> PyResult<PyExecutionResult> {
+        let options = options.unwrap_or_default();
+
+        let result = self.ctx.read_bcf(file_path, options.into());
+        let df = wait_for_future(py, result).map_err(error::BioBearError::from)?;
+
+        Ok(PyExecutionResult::new(df))
+    }
+
     /// Read a fasta file from the given path.
     #[pyo3(signature = (file_path, *, options=None))]
     fn read_fasta_file(
@@ -107,3 +124,8 @@ impl ExonSessionContext {
 pub fn connect() -> PyResult<ExonSessionContext> {
     Ok(ExonSessionContext::default())
 }
+
+#[pyfunction]
+pub fn new_context() -> PyResult<ExonSessionContext> {
+    Ok(ExonSessionContext::default())
+}