@ohos-ports/nodejs-polars 0.23.4-beta.0

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 Ritchie Vink
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,217 @@
+# Polars
+
+Polars: Blazingly fast DataFrames in Rust, Python, Node.js, R and SQL
+
+[![rust docs](https://github.com/pola-rs/nodejs-polars/actions/workflows/docs.yaml/badge.svg)](https://github.com/pola-rs/nodejs-polars/actions/workflows/docs.yaml/)
+[![Build and test](https://github.com/pola-rs/nodejs-polars/actions/workflows/test-js.yaml/badge.svg)](https://github.com/pola-rs/nodejs-polars/actions/workflows/test-js.yaml)
+[![](https://img.shields.io/crates/v/polars.svg)](https://crates.io/crates/polars)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/polars.svg)](https://pypi.org/project/polars/)
+[![NPM Latest Release](https://img.shields.io/npm/v/nodejs-polars.svg)](https://www.npmjs.com/package/nodejs-polars)
+
+Documentation: [Node.js](https://pola-rs.github.io/nodejs-polars/index.html)
+-[ Rust](https://docs.rs/polars/latest/polars/)
+-[ Python](https://pola-rs.github.io/polars/py-polars/html/reference/index.html)
+-[ R](https://rpolars.github.io/index.html)
+|StackOverflow: [ Node.js](https://stackoverflow.com/questions/tagged/nodejs-polars)
+-[ Rust](https://stackoverflow.com/questions/tagged/rust-polars)
+-[ Python](https://stackoverflow.com/questions/tagged/python-polars)
+| [User Guide](https://pola-rs.github.io/polars/)
+| [Discord](https://discord.gg/4UfP5cfBE7)
+
+#### Note: This library is intended to work only with server side JS/TS (Node, Bun, Deno). For browser please see [js-polars](https://github.com/pola-rs/js-polars)
+
+## Usage
+
+### Importing
+
+```js
+// esm
+import pl from 'nodejs-polars';
+
+// require
+const pl = require('nodejs-polars'); 
+```
+
+### Series
+
+```js
+> const fooSeries = pl.Series("foo", [1, 2, 3])
+> fooSeries.sum()
+6
+
+// a lot operations support both positional and named arguments
+// you can see the full specs in the docs or the type definitions
+> fooSeries.sort(true)
+> fooSeries.sort({descending: true})
+shape: (3,)
+Series: 'foo' [f64]
+[
+        3
+        2
+        1
+]
+> fooSeries.toArray()
+[1, 2, 3]
+
+// Series are 'Iterables' so you can use javascript iterable syntax on them
+> [...fooSeries]
+[1, 2, 3]
+
+> fooSeries[0]
+1
+
+```
+
+### DataFrame
+
+```js
+>const df = pl.DataFrame(
+...   {
+...     A: [1, 2, 3, 4, 5],
+...     fruits: ["banana", "banana", "apple", "apple", "banana"],
+...     B: [5, 4, 3, 2, 1],
+...     cars: ["beetle", "audi", "beetle", "beetle", "beetle"],
+...   }
+... )
+> df.sort("fruits").select(
+...     "fruits",
+...     "cars",
+...     pl.lit("fruits").alias("literal_string_fruits"),
+...     pl.col("B").filter(pl.col("cars").eq(pl.lit("beetle"))).sum(),
+...     pl.col("A").filter(pl.col("B").gt(2)).sum().over("cars").alias("sum_A_by_cars"),
+...     pl.col("A").sum().over("fruits").alias("sum_A_by_fruits"),
+...     pl.col("A").reverse().over("fruits").flatten().alias("rev_A_by_fruits")
+...   )
+shape: (5, 8)
+┌──────────┬──────────┬──────────────┬─────┬─────────────┬─────────────┬─────────────┐
+│ fruits   ┆ cars     ┆ literal_stri ┆ B   ┆ sum_A_by_ca ┆ sum_A_by_fr ┆ rev_A_by_fr │
+│ ---      ┆ ---      ┆ ng_fruits    ┆ --- ┆ rs          ┆ uits        ┆ uits        │
+│ str      ┆ str      ┆ ---          ┆ i64 ┆ ---         ┆ ---         ┆ ---         │
+│          ┆          ┆ str          ┆     ┆ i64         ┆ i64         ┆ i64         │
+╞══════════╪══════════╪══════════════╪═════╪═════════════╪═════════════╪═════════════╡
+│ "apple"  ┆ "beetle" ┆ "fruits"     ┆ 11  ┆ 4           ┆ 7           ┆ 4           │
+├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ "apple"  ┆ "beetle" ┆ "fruits"     ┆ 11  ┆ 4           ┆ 7           ┆ 3           │
+├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ "banana" ┆ "beetle" ┆ "fruits"     ┆ 11  ┆ 4           ┆ 8           ┆ 5           │
+├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ "banana" ┆ "audi"   ┆ "fruits"     ┆ 11  ┆ 2           ┆ 8           ┆ 2           │
+├╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌┤
+│ "banana" ┆ "beetle" ┆ "fruits"     ┆ 11  ┆ 4           ┆ 8           ┆ 1           │
+└──────────┴──────────┴──────────────┴─────┴─────────────┴─────────────┴─────────────┘
+```
+
+```js
+> df["cars"] // or df.getColumn("cars")
+shape: (5,)
+Series: 'cars' [str]
+[
+        "beetle"
+        "beetle"
+        "beetle"
+        "audi"
+        "beetle"
+]
+```
+
+## Node setup
+
+Install the latest polars version with:
+
+```sh
+$ yarn add nodejs-polars # yarn
+$ npm i -s nodejs-polars # npm
+$ bun i -D nodejs-polars # Bun
+```
+
+Releases happen quite often (weekly / every few days) at the moment, so updating polars regularly to get the latest bugfixes / features might not be a bad idea.
+
+### Minimum Requirements
+- Node version `>=18`
+- Rust version `>=1.86` - *Only needed for development*
+
+
+## Deno
+
+In Deno modules you can import polars straight from `npm`:
+
+```typescript
+import pl from "npm:nodejs-polars";
+```
+
+With Deno 1.37, you can use the `display` function to display a `DataFrame` in the notebook:
+
+```typescript
+import pl from "npm:nodejs-polars";
+import { display } from "https://deno.land/x/display@v1.1.2/mod.ts";
+
+let response = await fetch(
+  "https://cdn.jsdelivr.net/npm/world-atlas@1/world/110m.tsv",
+);
+let data = await response.text();
+let df = pl.readCSV(data, { sep: "\t" });
+await display(df)
+```
+
+With Deno 1.38, you only have to make the dataframe be the last expression in the cell:
+
+```typescript
+import pl from "npm:nodejs-polars";
+let response = await fetch(
+  "https://cdn.jsdelivr.net/npm/world-atlas@1/world/110m.tsv",
+);
+let data = await response.text();
+let df = pl.readCSV(data, { sep: "\t" });
+df
+```
+
+<img width="510" alt="image" src="https://github.com/pola-rs/nodejs-polars/assets/836375/90cf7bf4-7478-4919-b297-f8eb6a16196f">
+
+
+___
+
+## Documentation
+
+Want to know about all the features Polars supports? Read the [docs](https://docs.pola.rs)!
+
+#### Python
+
+- Installation guide: `$ pip3 install polars`
+- [Python documentation](https://pola-rs.github.io/polars/py-polars/html/reference/index.html)
+- [User guide](https://docs.pola.rs)
+
+#### Rust
+
+- [Rust documentation](https://docs.rs/polars/latest/polars/)
+
+#### Node
+
+  * Installation guide: `$ yarn add nodejs-polars` or `$ bun install nodejs-polars`
+  * [Node documentation](https://pola-rs.github.io/nodejs-polars/)
+
+## Contribution
+
+Want to contribute? Read our [contribution guideline](https://github.com/pola-rs/polars/blob/master/CONTRIBUTING.md).
+
+## \[Node\]: compile polars from source
+
+If you want a bleeding edge release or maximal performance you should compile **polars** from source.
+
+1. Install the latest [Rust compiler](https://www.rust-lang.org/tools/install)
+2. Run `npm|yarn install`
+3. Choose any of:
+   - Fastest binary, very long compile times:
+     ```bash
+     $ cd nodejs-polars && yarn build && yarn build:ts # this will generate a /bin directory with the compiles TS code, as well as the rust binary
+     ```
+   - Debugging, fastest compile times but slow & large binary:
+     ```bash
+     $ cd nodejs-polars && yarn build:debug && yarn build:ts # this will generate a /bin directory with the compiles TS code, as well as the rust binary
+     ```
+
+## Webpack configuration
+To use `nodejs-polars` with [Webpack](https://webpack.js.org) please use [node-loader](https://github.com/webpack-contrib/node-loader) and `webpack.config.js`
+
+## Sponsors
+
+[<img src="https://www.jetbrains.com/company/brand/img/jetbrains_logo.png" height="50" alt="JetBrains logo" />](https://www.jetbrains.com)

package/bin/cfg.d.ts

@@ -0,0 +1,156 @@
+/**
+ * Configure polars; offers options for table formatting and more.
+ */
+export interface Config {
+    /** Use ASCII characters to display table outlines.
+     * @param active - Set False to revert to the standard UTF8_FULL_CONDENSED formatting style. Default: true
+     *
+     * @example
+     * const df = pl.DataFrame({abc: [1.0, 2.5, 5.0], xyz: [true, false, true]})
+       pl.Config.setAsciiTables(true)
+       
+      # shape: (3, 2)        shape: (3, 2)
+      # ┌─────┬───────┐      +-----+-------+
+      # │ abc ┆ xyz   │      | abc | xyz   |
+      # │ --- ┆ ---   │      | --- | ---   |
+      # │ f64 ┆ bool  │      | f64 | bool  |
+      # ╞═════╪═══════╡      +=============+
+      # │ 1.0 ┆ true  │  >>  | 1.0 | true  |
+      # │ 2.5 ┆ false │      | 2.5 | false |
+      # │ 5.0 ┆ true  │      | 5.0 | true  |
+      # └─────┴───────┘      +-----+-------+
+     */
+    setAsciiTables(active: boolean): Config;
+    setAsciiTables(): Config;
+    /** Set the maximum width of a table in characters.
+     * @param width - Maximum table width in characters; if n < 0 (eg: -1), display full width.
+     *
+     * @example
+     * const df = pl.DataFrame({ id: ["SEQ1", "SEQ2"], seq: ["ATGATAAAGGAG", "GCAACGCATATA"] });
+        >>> df
+        shape: (2, 2)
+        ┌──────┬──────────────┐
+        │ id   ┆ seq          │
+        │ ---  ┆ ---          │
+        │ str  ┆ str          │
+        ╞══════╪══════════════╡
+        │ SEQ1 ┆ ATGATAAAGGAG │
+        │ SEQ2 ┆ GCAACGCATATA │
+        └──────┴──────────────┘
+        >>> pl.Config.setTblWidthChars(12);
+        >>> df
+        shape: (2, 2)
+        ┌─────┬─────┐
+        │ id  ┆ seq │
+        │ --- ┆ --- │
+        │ str ┆ str │
+        ╞═════╪═════╡
+        │ SEQ ┆ ATG │
+        │ 1   ┆ ATA │
+        │     ┆ AAG │
+        │     ┆ GAG │
+        │ SEQ ┆ GCA │
+        │ 2   ┆ ACG │
+        │     ┆ CAT │
+        │     ┆ ATA │
+        └─────┴─────┘
+    */
+    setTblWidthChars(width: number): Config;
+    setTblWidthChars(): Config;
+    /** Set the max number of rows used to draw the table (both Dataframe and Series).
+     * @param n - Number of rows to display; if `n < 0` (eg: -1), display all rows (DataFrame) and all elements (Series).
+     *
+     * @example
+      const df = pl.DataFrame({abc: [1.0, 2.5, 5.0], xyz: [true, false, true]})
+      pl.Config.setTblRows(2);
+      
+      shape: (4, 2)
+      ┌─────┬───────┐
+      │ abc ┆ xyz   │
+      │ --- ┆ ---   │
+      │ f64 ┆ bool  │
+      ╞═════╪═══════╡
+      │ 1.0 ┆ true  │
+      │ …   ┆ …     │
+      │ 5.0 ┆ false │
+      └─────┴───────┘
+    */
+    setTblRows(n: number): Config;
+    setTblRows(): Config;
+    /** Set the number of columns that are visible when displaying tables.
+     * @param n -  Number of columns to display; if `n < 0` (eg: -1), display all columns.
+     *
+     * @example
+  
+      const df = pl.DataFrame( {abc: [1.0, 2.5, 3.5, 5.0], def: ["d", "e", "f", "g"], xyz: [true, false, true, false] } );
+      // Set number of displayed columns to a low value
+      pl.Config.setTblCols(2);
+      
+      shape: (4, 3)
+      ┌─────┬───┬───────┐
+      │ abc ┆ … ┆ xyz   │
+      │ --- ┆   ┆ ---   │
+      │ f64 ┆   ┆ bool  │
+      ╞═════╪═══╪═══════╡
+      │ 1.0 ┆ … ┆ true  │
+      │ 2.5 ┆ … ┆ false │
+      │ 3.5 ┆ … ┆ true  │
+      │ 5.0 ┆ … ┆ false │
+      └─────┴───┴───────┘
+    */
+    setTblCols(n?: number): Config;
+    /**
+     * Display the data type next to the column name (to the right, in parentheses).
+     * @param active - true / false Default - true
+     *
+     * @example
+      --------
+      const df = pl.DataFrame({abc: [1.0, 2.5, 5.0], xyz: [true, false, true]})
+      pl.Config.setTblColumnDataTypeInline(true)
+  
+      # shape: (3, 2)        shape: (3, 2)
+      # ┌─────┬───────┐      ┌───────────┬────────────┐
+      # │ abc ┆ xyz   │      │ abc (f64) ┆ xyz (bool) │
+      # │ --- ┆ ---   │      ╞═══════════╪════════════╡
+      # │ f64 ┆ bool  │      │ 1.0       ┆ true       │
+      # ╞═════╪═══════╡  >>  │ 2.5       ┆ false      │
+      # │ 1.0 ┆ true  │      │ 5.0       ┆ true       │
+      # │ 2.5 ┆ false │      └───────────┴────────────┘
+      # │ 5.0 ┆ true  │
+      # └─────┴───────┘
+     */
+    setTblColumnDataTypeInline(active?: boolean): Config;
+    /**
+     * Hide table column data types (i64, f64, str etc.).
+     * @param active - true / false Default - true
+  
+     * @example
+      const df = pl.DataFrame({abc: [1.0, 2.5, 5.0], xyz: [true, false, true]})
+      pl.Config.setTblHideColumnDataTypes(true)
+          
+      # shape: (3, 2)        shape: (3, 2)
+      # ┌─────┬───────┐      ┌─────┬───────┐
+      # │ abc ┆ xyz   │      │ abc ┆ xyz   │
+      # │ --- ┆ ---   │      ╞═════╪═══════╡
+      # │ f64 ┆ bool  │      │ 1.0 ┆ true  │
+      # ╞═════╪═══════╡  >>  │ 2.5 ┆ false │
+      # │ 1.0 ┆ true  │      │ 5.0 ┆ true  │
+      # │ 2.5 ┆ false │      └─────┴───────┘
+      # │ 5.0 ┆ true  │
+      # └─────┴───────┘
+     */
+    setTblHideColumnDataTypes(active?: boolean): Config;
+    /**
+     * Enable additional verbose/debug logging.
+     * @param active - true / false Default - true
+     */
+    setVerbose(active?: boolean): Config;
+    /**
+     * Set the thousands grouping separator character.
+     * @param separator : string | bool
+          Set True to use the default "," (thousands) and "." (decimal) separators.
+          Can also set a custom char, or set ``None`` to omit the separator.
+     */
+    setThousandsSeparator(separator?: string | boolean): Config;
+}
+export declare const Config: Config;

package/bin/cfg.js

@@ -0,0 +1,52 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const polars_internal_1 = __importDefault(require("./internals/polars_internal"));
+exports.Config = {
+    setAsciiTables(active) {
+        polars_internal_1.default.setAsciiTables(active);
+        return this;
+    },
+    setTblWidthChars(width) {
+        polars_internal_1.default.setTblWidthChars(width);
+        return this;
+    },
+    setTblRows(n) {
+        polars_internal_1.default.setTblRows(n);
+        return this;
+    },
+    setTblCols(n) {
+        polars_internal_1.default.setTblCols(n);
+        return this;
+    },
+    setTblColumnDataTypeInline(active) {
+        polars_internal_1.default.setTblColumnDataTypeInline(active ? 1 : 0);
+        return this;
+    },
+    setTblHideColumnDataTypes(active) {
+        polars_internal_1.default.setTblHideColumnDataTypes(active ? 1 : 0);
+        return this;
+    },
+    setVerbose(active) {
+        polars_internal_1.default.setVerbose(active ? 1 : 0);
+        return this;
+    },
+    setThousandsSeparator(separator) {
+        if (typeof separator === "boolean" && separator) {
+            polars_internal_1.default.setDecimalSeparator(".");
+            polars_internal_1.default.setThousandsSeparator(",");
+        }
+        else if (typeof separator === "string") {
+            if (separator.length > 1)
+                throw new TypeError("separator must be a single character;");
+            polars_internal_1.default.setThousandsSeparator(separator);
+        }
+        else {
+            polars_internal_1.default.setThousandsSeparator();
+        }
+        return this;
+    },
+};