darn-dmap 0.2.1__tar.gz → 0.3.0__tar.gz

{darn_dmap-0.2.1 → darn_dmap-0.3.0}/Cargo.lock

@@ -80,9 +80,9 @@ checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5"
 
 [[package]]
 name = "cc"
-version = "1.2.29"
+version = "1.2.33"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5c1599538de2394445747c8cf7935946e3cc27e9625f889d979bfb2aaf569362"
+checksum = "3ee0f8803222ba5a7e2777dd72ca451868909b1ac410621b676adf07280e9b5f"
 dependencies = [
  "shlex",
 ]
@@ -210,7 +210,7 @@ checksum = "460fbee9c2c2f33933d720630a6a0bac33ba7053db5344fac858d4b8952d77d5"
 
 [[package]]
 name = "dmap"
-version = "0.2.1"
+version = "0.3.0"
 dependencies = [
  "bzip2",
  "criterion",
@@ -255,9 +255,9 @@ checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888"
 
 [[package]]
 name = "hashbrown"
-version = "0.15.4"
+version = "0.15.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5971ac85611da7067dbfcabef3c70ebb5606018acd9e2a3903a0da507521e0d5"
+checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1"
 
 [[package]]
 name = "heck"
@@ -291,7 +291,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "fe4cd85333e22411419a0bcae1297d25e58c9443848b11dc6a86fefe8c78a661"
 dependencies = [
  "equivalent",
- "hashbrown 0.15.4",
+ "hashbrown 0.15.5",
 ]
 
 [[package]]
@@ -342,9 +342,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
 [[package]]
 name = "libc"
-version = "0.2.174"
+version = "0.2.175"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1171693293099992e19cddea4e8b849964e9846f4acee11b3948bcc337be8776"
+checksum = "6a82ae493e598baaea5209805c49bbf2ea7de956d50d7da0da1164f9c6d28543"
 
 [[package]]
 name = "log"
@@ -509,9 +509,9 @@ dependencies = [
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.95"
+version = "1.0.101"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "02b3e5e68a3a1a02aad3ec490a98007cbc13c37cbe84a3cd7b8e406d76e7f778"
+checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de"
 dependencies = [
  "unicode-ident",
 ]
@@ -597,9 +597,9 @@ checksum = "60a357793950651c4ed0f3f52338f53b2f809f32d83a07f72909fa13e4c6c1e3"
 
 [[package]]
 name = "rayon"
-version = "1.10.0"
+version = "1.11.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b418a60154510ca1a002a752ca9714984e21e4241e804d32555251faf8b78ffa"
+checksum = "368f01d005bf8fd9b1206fb6fa653e6c4a81ceb1466406b81792d87c5677a58f"
 dependencies = [
  "either",
  "rayon-core",
@@ -607,9 +607,9 @@ dependencies = [
 
 [[package]]
 name = "rayon-core"
-version = "1.12.1"
+version = "1.13.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1465873a3dfdaa8ae7cb14b4383657caab0b3e8a0aa9ae8e04b044854c8dfce2"
+checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91"
 dependencies = [
  "crossbeam-deque",
  "crossbeam-utils",
@@ -652,9 +652,9 @@ checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
 
 [[package]]
 name = "rustversion"
-version = "1.0.21"
+version = "1.0.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8a0d197bd2c9dc6e53b84da9556a69ba4cdfab8619eb41a8bd1cc2027a0f6b1d"
+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
 
 [[package]]
 name = "ryu"
@@ -693,9 +693,9 @@ dependencies = [
 
 [[package]]
 name = "serde_json"
-version = "1.0.140"
+version = "1.0.143"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "20068b6e96dc6c9bd23e01df8827e6c7e1f2fddd43c21810382803c136b99373"
+checksum = "d401abef1d108fbd9cbaebc3e46611f4b1021f714a0597a71f41ee463f5f4a5a"
 dependencies = [
  "itoa",
  "memchr",
@@ -711,9 +711,9 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "syn"
-version = "2.0.104"
+version = "2.0.106"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "17b6f705963418cdb9927482fa304bc562ece2fdd4f616084c50b7023b435a40"
+checksum = "ede7c438028d4436d71104916910f5bb611972c5cfd7f89b8300a8186e6fada6"
 dependencies = [
  "proc-macro2",
  "quote",

{darn_dmap-0.2.1 → darn_dmap-0.3.0}/Cargo.toml

@@ -1,8 +1,9 @@
 [package]
 name = "dmap"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 rust-version = "1.63.0"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

darn_dmap-0.3.0/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: darn-dmap
+Version: 0.3.0
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Rust
+Requires-Dist: numpy<3
+Author: Remington Rohel
+Requires-Python: >=3.8

{darn_dmap-0.2.1 → darn_dmap-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "darn-dmap"
-version = "0.2.1"
+version = "0.3.0"
 requires-python = ">=3.8"
 authors = [
     { name = "Remington Rohel" }

{darn_dmap-0.2.1 → darn_dmap-0.3.0}/src/lib.rs

@@ -163,7 +163,7 @@ read_rust!(dmap);
 /// Generates two functions: `read_[type]` and `read_[type]_lax`, for strict and lax
 /// reading, respectively.
 macro_rules! read_py {
-    ($name:ident, $py_name:literal, $lax_name:literal, $bytes_name:literal, $lax_bytes_name:literal) => {
+    ($name:ident, $py_name:literal, $lax_name:literal, $bytes_name:literal, $lax_bytes_name:literal, $sniff_name:literal) => {
         paste! {
             #[doc = "Reads a `" $name:upper "` file, returning a list of dictionaries containing the fields." ]
             #[pyfunction]
@@ -219,29 +219,42 @@ macro_rules! read_py {
                     result.1,
                 ))
             }
+
+            #[doc = "Reads a `" $name:upper "` file, returning the first record." ]
+            #[pyfunction]
+            #[pyo3(name = $sniff_name)]
+            #[pyo3(text_signature = "(infile: str, /)")]
+            fn [< sniff_ $name _py >](infile: PathBuf) -> PyResult<IndexMap<String, DmapField>> {
+                Ok([< $name:camel Record >]::sniff_file(&infile)
+                    .map_err(PyErr::from)?
+                    .inner()
+                )
+            }
         }
     }
 }
 
-read_py!(iqdat, "read_iqdat", "read_iqdat_lax", "read_iqdat_bytes", "read_iqdat_bytes_lax");
+read_py!(iqdat, "read_iqdat", "read_iqdat_lax", "read_iqdat_bytes", "read_iqdat_bytes_lax", "sniff_iqdat");
 read_py!(
     rawacf,
     "read_rawacf",
     "read_rawacf_lax",
     "read_rawacf_bytes",
-    "read_rawacf_bytes_lax"
+    "read_rawacf_bytes_lax",
+    "sniff_rawacf"
 );
 read_py!(
     fitacf,
     "read_fitacf",
     "read_fitacf_lax",
     "read_fitacf_bytes",
-    "read_fitacf_bytes_lax"
+    "read_fitacf_bytes_lax",
+    "sniff_fitacf"
 );
-read_py!(grid, "read_grid", "read_grid_lax", "read_grid_bytes", "read_grid_bytes_lax");
-read_py!(map, "read_map", "read_map_lax", "read_map_bytes", "read_map_bytes_lax");
-read_py!(snd, "read_snd", "read_snd_lax", "read_snd_bytes", "read_snd_bytes_lax");
-read_py!(dmap, "read_dmap", "read_dmap_lax", "read_dmap_bytes", "read_dmap_bytes_lax");
+read_py!(grid, "read_grid", "read_grid_lax", "read_grid_bytes", "read_grid_bytes_lax", "sniff_grid");
+read_py!(map, "read_map", "read_map_lax", "read_map_bytes", "read_map_bytes_lax", "sniff_map");
+read_py!(snd, "read_snd", "read_snd_lax", "read_snd_bytes", "read_snd_bytes_lax", "sniff_snd");
+read_py!(dmap, "read_dmap", "read_dmap_lax", "read_dmap_bytes", "read_dmap_bytes_lax", "sniff_dmap");
 
 /// Checks that a list of dictionaries contains DMAP records, then appends to outfile.
 ///
@@ -359,5 +372,14 @@ fn dmap(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(write_grid_bytes_py, m)?)?;
     m.add_function(wrap_pyfunction!(write_map_bytes_py, m)?)?;
 
+    // Sniff the first record
+    m.add_function(wrap_pyfunction!(sniff_dmap_py, m)?)?;
+    m.add_function(wrap_pyfunction!(sniff_iqdat_py, m)?)?;
+    m.add_function(wrap_pyfunction!(sniff_rawacf_py, m)?)?;
+    m.add_function(wrap_pyfunction!(sniff_fitacf_py, m)?)?;
+    m.add_function(wrap_pyfunction!(sniff_snd_py, m)?)?;
+    m.add_function(wrap_pyfunction!(sniff_grid_py, m)?)?;
+    m.add_function(wrap_pyfunction!(sniff_map_py, m)?)?;
+
     Ok(())
 }

{darn_dmap-0.2.1 → darn_dmap-0.3.0}/src/record.rs

@@ -18,6 +18,36 @@ pub trait Record<'a>:
     /// Gets the underlying data of `self`.
     fn inner(self) -> IndexMap<String, DmapField>;
 
+    /// Reads from `dmap_data` and parses into `Vec<Self>`.
+    ///
+    /// Returns `DmapError` if `dmap_data` cannot be read or contains invalid data.
+    fn read_first_record(mut dmap_data: impl Read) -> Result<Self, DmapError>
+    where
+        Self: Sized,
+        Self: Send,
+    {
+        let mut buffer = [0; 8];  // record size should be an i32 of the data
+        let read_result = dmap_data.read(&mut buffer[..])?;
+        if read_result < buffer.len() {
+            return Err(DmapError::CorruptStream("Unable to read size of first record"))
+        }
+
+        let rec_size = i32::from_le_bytes(buffer[4..8].try_into().unwrap()) as usize; // advance 4 bytes, skipping the "code" field
+        if rec_size <= 0 {
+            return Err(DmapError::InvalidRecord(format!(
+                "Record 0 starting at byte 0 has non-positive size {} <= 0",
+                rec_size
+            )));
+        }
+
+        let mut rec = vec![0; rec_size];
+        rec[0..8].clone_from_slice(&buffer[..]);
+        dmap_data.read_exact(&mut rec[8..])?;
+        let first_rec = Self::parse_record(&mut Cursor::new(rec))?;
+
+        Ok(first_rec)
+    }
+
     /// Reads from `dmap_data` and parses into `Vec<Self>`.
     ///
     /// Returns `DmapError` if `dmap_data` cannot be read or contains invalid data.
@@ -171,6 +201,22 @@ pub trait Record<'a>:
         }
     }
 
+    /// Reads the first record of a DMAP file of type `Self`.
+    fn sniff_file(infile: &PathBuf) -> Result<Self, DmapError>
+    where
+        Self: Sized,
+        Self: Send,
+    {
+        let file = File::open(infile)?;
+        match infile.extension() {
+            Some(ext) if ext == OsStr::new("bz2") => {
+                let compressor = BzDecoder::new(file);
+                Self::read_first_record(compressor)
+            }
+            _ => Self::read_first_record(file),
+        }
+    }
+
     /// Reads a record from `cursor`.
     fn parse_record(cursor: &mut Cursor<Vec<u8>>) -> Result<Self, DmapError>
     where

{darn_dmap-0.2.1 → darn_dmap-0.3.0}/tests/tests.rs

@@ -92,6 +92,14 @@ macro_rules! make_test {
                 // Clean up tempfile
                 remove_file(&tempfile).expect("Unable to delete tempfile");
             }
+
+            #[test]
+            fn [< test_ $record_type _sniff >] () {
+                let filename: PathBuf = PathBuf::from(format!("tests/test_files/test.{}", stringify!($record_type)));
+                let data = [< $record_type:camel Record >]::sniff_file(&filename).expect("Unable to sniff file");
+                let all_recs = [< $record_type:camel Record >]::read_file(&filename).expect("Unable to read file");
+                assert_eq!(data, all_recs[0])
+            }
         }
     };
 }

darn_dmap-0.2.1/PKG-INFO

@@ -1,60 +0,0 @@
-Metadata-Version: 2.4
-Name: darn-dmap
-Version: 0.2.1
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Rust
-Requires-Dist: numpy<3
-Author: Remington Rohel
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-
-# Dmap
-
-Rust tools for SuperDARN DMAP file format operations.
-
-This project exposes both Rust and Python APIs for handling DMAP I/O.
-I/O can be conducted either on byte buffers, or directly to/from files.
-
-The SuperDARN DMAP file formats are all supported (IQDAT, RAWACF, FITACF, GRID, MAP, and SND)
-as well as a generic DMAP format that is unaware of any required fields or types 
-(e.g. char, int32) for any fields.
-
-## Developer Guidelines
-
-### `src/record.rs`
-This file contains the `Record` trait, which defines a set of functions that specific DMAP formats must implement.
-For example, `read_file(infile: &PathBuf) -> Result<Vec<Self>, DmapError>` is defined in the `Record` trait, and handles
-reading in records from a file at the specified path. This function is generic, in that it doesn't know what type of records
-(RAWACF, FITACF, etc.) are expected. Also, since it is a trait function, you can only use it through a struct which implements
-the trait. For example, the `FitacfRecord` struct defined in `src/formats/fitacf.rs` implements the `Record` trait, and so
-you can call `FitacfRecord::read_file(...)` to read a FITACF file, but you couldn't invoke `Record::read_file(...)`.
-
-### `src/types.rs`
-This file defines necessary structs and enums for encapsulating basic types (`i8`, `u32`, `String`, etc.) into
-objects like `DmapField`, `DmapScalar`, `DmapVec`, etc. that abstract over the supported underlying types.
-For instance, when reading scalar from a DMAP file, the underlying data type is inferred from the `type` field in the 
-scalar's metadata, so it can't be known beforehand. This requires some encapsulating type, `DmapScalar` in this case,
-which contains the metadata of the field and has a known size for the stack memory. 
-
-This file defines the `Fields` struct, which is used to hold the names and types of the required and optional
-scalar and vector fields for a type of DMAP record (RAWACF, FITACF, etc.).
-
-This file defines the `DmapType` trait and implements it for supported data types that can be in DMAP records, namely
-`u8`, `u16`, `u32`, `u64`, `i8`, `i16`, `i32`, `i64`, `f32`, `f64`, and `String`. The implementation of the trait for
-these types only means that other types, e.g. `i128`, cannot be stored in DMAP records.
-
-Lastly, functions for parsing scalars and vectors from a byte buffer are defined in this file.
-
-### `src/formats`
-This directory holds the files that define the DMAP record formats: IQDAT, RAWACF, FITACF, GRID, MAP, SND, and the generic DMAP.
-If you are defining a new DMAP format, you will need to make a new file in this directory following the structure of the
-existing files. Essentially, you define the scalar and vector fields, both required and optional, and the groups of vector
-fields which must have identical dimensions, then call a macro to autogenerate the struct code for you. 
-
-### `tests`
-In `tests.rs`, integration tests for reading and writing all file types are present. Small example files
-are contained in `tests/test_files`.
-
-### `benches/io_benchmarking.rs`
-This file contains benchmarking functions for checking the performance of the basic read functions.
-