跳到主要內容

Rust - 以 JSON 為資料來源建立 Polars DataFrame

緣起

在科技的蓬勃發展中,資料處理和分析變得愈發重要。Rust 語言的 Polars 框架為我們提供了一個強大的工具,讓資料操作變得更加容易且高效。這個框架支援以 JSON 格式匯入資料並建立 Dataframe,為我們提供了一個直觀且方便的方式來操作資料。

本文開始

本文的目的,為使用 JSON 為資料來源,在 Rust 中建立 Polars 的 Dataframe。在以下的文章裡,我們將在 Cargo.toml 中,使用如下的設定:

[dependencies] polars = { version = "0.36.2", features = ["json"] }

撰文的當下,Polars 的最新版本為 0.36.2。參考 Polars 的官方文件,它提供了以下的程式碼段落,以匯入 JSON 檔案內容:

use polars::prelude::*;

let mut file = std::fs::File::open("docs/data/path.json").unwrap();
let df = JsonReader::new(&mut file).finish().unwrap();

到這裡,就能輕鬆的利用一個 JSON 檔案的內容,建立出 Dataframe 物件。

好了,故事結束,收工。
.
.
.
.
.
如果故事真的就這麼簡單,我想也就沒有撰寫這篇文章的必要了。

想想上面程式段落的例子,過程裡需要透過一個存在於檔案系統中的 JSON 檔案為媒介,儲存我們要處理的資料,再透過「JsonReader」讀入的 Dataframe 中處理。如果這些資料是從網路上取得(例如呼叫RESTful API),以字串變數的形式存在於系統之中,例如下面的內容:

let msg = r#"[
    {"id": 1, "name": "A", "age": 10},
    {"id": 2, "name": "B", "age": 20}
]"#;

面對這樣的情境,若將資料先落地後再重新讀入,實在是有些不切實際,還可能因為受到磁碟 I/O 的效能影響,而拖慢了程式執行的效率。

那為了避免上述的問題,我們應該怎麼處理呢?

使用「Serde」框架,手動建立 Dataframe

在 Rust 語言的生態系中,有一個「Serde」框架可以協助我們處理 JSON 格式的訊息或檔案。為了使用「Serde」,我們需要調整「Cargo.toml」的內容如下:

[dependencies] polars = { version = "0.36.2", features = ["json"] }
serde = { version = "1", features = ["serde_derive", "derive"] }
serde_json = "1"

但在開始程式碼內容前,我們先說說整個方法的處理邏輯如下:

  1. 定義訊息格式;
  2. 把訊息的內容,透過「Serde」框架轉換為物件或清單(這個視訊息的內容,是否有陣列存在);
  3. 建立 Polars Dataframe。

定義訊息格式

這個動作裡,需要先定義好一個結構(struct);參考了 JSON 訊息的內容,我們將「User」這個結構定義如下:

use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct User {
    id: i32,
    name: String,
    age: i32,
}

這樣做的好處是,在匯入前就明確定義要處理的資料欄位、名稱,以及資料型態。我們會利用這個結構,來匯入 JSON 訊息。

匯入 JSON 訊息

這個步驟裡,我們會使用到「serde_json::from_str()」來匯入 JSON 訊息,具體的方式如下:

// Parse JSON string into a vector of Item structs
let users: Vec<User> = serde_json::from_str(msg).unwrap();

由於 JSON 訊息裡記載的是一個具有陣列型態的資料內容,因此在處理上,就應以「Vec<User>」來宣告,以同時儲存多個不同的「User」。

建立 Polars Dataframe

最後的重頭戲來了!!我們的目標是建立出 Polars Dataframe 物件,以進行後續資料的處理與操作。參考以下的程式片段,以完成這個作業:

use polars::prelude::*;

// Create a DataFrame from the vector of structs
let df = DataFrame::new(vec![
    Series::new("id", users.iter().map(|i| i.id).collect::<Vec<_>>()),
    Series::new("name", users.iter().map(|i| i.name.clone()).collect::<Vec<_>>()),
    Series::new("age", users.iter().map(|i| i.age).collect::<Vec<_>>())
    ]).unwrap();

// Display the DataFrame
println!("{:?}", df);

這裡使用的方式,是將「users」裡的各個欄位透過「iterator」的方式「抽出」,產生對應的資料序列(Series)後,再逐一填寫到 Dataframe 中,最終產生我們的 Dataframe - 「df」。

除了手動建立 Dataframe 的方式外,有沒有什麼比較好的方式,可以用來建立 Dataframe 呢?

透過「Cursor」建立字元串流

其實在 Rust 語言的「std::io」標準庫裡,有一個「Cursor」的 Wrapper 結構,它可以把一個字串轉換為資料串流,以進行 I/O 讀取操作;這個用法有點像我們在 Java 語言裡,會把「String」物件轉換為「StringReader」,再逐字或逐行的讀入這個字串內容。

相關的做法如下:

use polars::prelude::*;

// Create a Cursor from the input string
let cur = Cursor::new(msg);
let df = JsonReader::new(cur).finish().unwrap();

這個方法只用了短短的兩行,就完成了上述的 Dataframe 生成作業,是不是很方便?

結論

在本文中,我們探討了使用 Rust 語言的 Polars 框架處理 JSON 訊息的方法。從檔案匯入的方式進一步擴展,介紹了在處理來自網路的 JSON 字串時,如何避免因資料落地後再讀入的效能問題。透過 Serde 框架,我們定義了資料結構,並展示了如何手動建立 Dataframe,以及透過 std::io::Cursor 結構建立字元串流的方式,使產生 Dataframe 的作業更為簡單方便。這樣的處理方式不僅提高了效能,也讓資料處理更具彈性。

我尚在浩瀚的 Rust 世界中探索各種發展的可能。文章的內容皆為我實際操作後所撰寫下的過程及心得,雖已儘可能追求正確與嚴謹,但內容仍難免因觀念或理解而有所差誤,還望看到此文的同好先進,不忘指點改正,謝謝您。

最後附上本篇文章所用到的完整程式碼供大家參考:

use std::io::Cursor;

use polars::prelude::*;
use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct User {
    id: i32,
    name: String,
    age: i32,
}

fn main() {
    // Define your JSON message as a string
    let msg = r#"[
        {"id": 1, "name": "A", "age": 10},
        {"id": 2, "name": "B", "age": 20}
    ]"#;

    // Parse JSON string into a vector of Item structs
    let users: Vec<User> = serde_json::from_str(msg).unwrap();

    // Create a DataFrame from the vector of structs
    let df = DataFrame::new(vec![
        Series::new("id", users.iter().map(|i| i.id).collect::<Vec<_>>()),
        Series::new("name", users.iter().map(|i| i.name.clone()).collect::<Vec<_>>()),
        Series::new("age", users.iter().map(|i| i.age).collect::<Vec<_>>())
        ]).unwrap();

    // Display the DataFrame
    println!("{:?}", df);

   
    // Create a Cursor from the input string
    let cur = Cursor::new(msg);
    let df = JsonReader::new(cur).finish().unwrap();

    // Display the DataFrame
    println!("{:?}", df);

}


留言

這個網誌中的熱門文章

衝到四道好浪,爽!

距離上次作品發表的時間,已剛好整整一個月。這一個月裡,都在忙些雜事,也就沒了新作品的發表。 星期天趁著萬宜颱風的外圍環流還在,趕緊跑到金山試試身手。雖然整體的浪況很不理想,不過在下午三點半的時候,浪突然變的穩定下來,讓我迫不急待的下水一試。沒想到好浪連連,一連搭了四道回來;不過也因為起浪點都在 Outside,距離遠,相當耗體力,衝完了這四道也就差不多了。 想著時間慢慢的變晚,浪況也逐漸轉壞,甘脆收拾板子回家,也好早點吃飯。沒想到就在回家的路上,看到了永福橋旁的晚霞,決定了大致的構圖,二話不說的馬上衝回家拿相機,留下了這幾張作品。 #1. 以河岸旁的大樓做剪影;雲層、晚霞、大樓成三等分分配。 #2. #3. 拿樹當剪影;不過樹延伸的方向有點怪。

哇...外星人!!

清晨四點就下水,趁著大家都還在睡覺的時候,偷偷的溜到海裡。雖然水下的能見度不是很好,但是生物超多的(很多都是晚上才會出現),而且有一些魚,根本就是睡死了,要不是浪太大,在水裡頭搖搖晃晃,我應該可以拍到不少的照片。 #1. 清晨四點半,在海裡遇到大章魚… #2. 牠嚇了一跳,我也嚇了一跳!(後悔沒有帶魚叉…) 根據查證,這隻大章魚學名叫「 Octopus Luteus 」,中文俗名叫「 紅章 」,英文俗名叫「 Starry Night Octopus 」。 台灣官方的物種資料庫真是爛到沒話說。沒有圖就算了,連基本資料也不完整!還什麼數位國家典藏計畫咧!看起來就像一群人,做了一個沒內容的爛網站搞錢。 #3. 花園裡有好多的獅子魚,聽說至少有三個品種。 #4. 這個是什麼魚啊?!剃刀魚嗎?一直都是立著游,很特別喔! 經過查證,這種魚正式名稱叫「 條紋蝦魚 (Aeoliscus strigatus) 」,英文俗名「Razorfish, Shrimpfish」,中文俗名叫「玻璃魚、甲香魚、刀片魚」。 資料來源:台灣魚類資料庫

20120917

20120917 , a photo by Paladin R. Liu on Flickr.