Merge pull request #58 from pola-rs/toplevel-funcs

Rewrite all as toplevel funcs
pola-rs · Jan 22, 2024 · f527b05 · f527b05
2 parents 8a4c1c1 + e076b16
commit f527b05
Show file tree

Hide file tree

Showing 28 changed files with 1,046 additions and 1,118 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,5 @@ rust-toolchain.toml
 *.bat
 *.js
 docs/_build
-*.so
+docs/api/*
+*.so
diff --git a/Makefile b/Makefile
@@ -16,7 +16,7 @@ install-release: venv
 pre-commit: venv
 	cargo fmt --all && cargo clippy --all-features
 	venv/bin/python -m ruff check . --fix --exit-non-zero-on-fix
-	venv/bin/python -m ruff format
+	venv/bin/python -m ruff format polars_xdt tests
 	venv/bin/python -m mypy polars_xdt tests
 
 test: venv

diff --git a/README.md b/README.md
@@ -30,16 +30,6 @@ Then, you'll need to install `polars-xdt`:
 pip install polars-xdt
 ```
 
-Then, if you can run
-```python
-import polars as pl
-import polars_xdt  # noqa: F401
-
-print(pl.col('a').xdt)
-```
-and see something like `<polars_xdt.ExprXDTNamespace at 0x7f5bc943fc10>`,
-it means installation all worked correctly!
-
 Read the [documentation](https://marcogorelli.github.io/polars-xdt-docs/) for a little tutorial and API reference.
 
 Basic Example
@@ -49,7 +39,7 @@ Say we start with
 from datetime import date
 
 import polars as pl
-import polars_xdt  # noqa: F401
+import polars_xdt as xdt
 
 
 df = pl.DataFrame(
@@ -61,7 +51,8 @@ Let's shift `Date` forwards by 5 days, excluding Saturday and Sunday:
 
 ```python
 result = df.with_columns(
-    date_shifted=pl.col("date").xdt.offset_by(
+    date_shifted=xdt.offset_by(
+      'date',
       '5bd',
       weekend=('Sat', 'Sun'),
     )
@@ -80,6 +71,9 @@ shape: (3, 2)
 │ 2024-01-04 ┆ 2024-01-11   │
 └────────────┴──────────────┘
 ```
+Note that `polars-xdt` also registers a `xdt` namespace in the `Expression` class, so you
+could equivalently write the above using `pl.col('date').xdt.offset_by('5bd')` (but note
+that then type-checking would not recognise the `xdt` attribute).
 
 Read the [documentation](https://marcogorelli.github.io/polars-xdt-docs/) for more examples!
 

diff --git a/docs/API.rst b/docs/API.rst
@@ -6,14 +6,12 @@ API
 
     polars_xdt.date_range
     polars_xdt.workday_count
-    polars_xdt.ExprXDTNamespace.base_utc_offset
-    polars_xdt.ExprXDTNamespace.ceil
-    polars_xdt.ExprXDTNamespace.day_name
-    polars_xdt.ExprXDTNamespace.dst_offset
-    polars_xdt.ExprXDTNamespace.format_localized
-    polars_xdt.ExprXDTNamespace.from_local_datetime
-    polars_xdt.ExprXDTNamespace.is_workday
-    polars_xdt.ExprXDTNamespace.month_name
-    polars_xdt.ExprXDTNamespace.offset_by
-    polars_xdt.ExprXDTNamespace.to_local_datetime
-    polars_xdt.ExprXDTNamespace.to_julian_date
+    polars_xdt.ceil
+    polars_xdt.day_name
+    polars_xdt.format_localized
+    polars_xdt.from_local_datetime
+    polars_xdt.is_workday
+    polars_xdt.month_name
+    polars_xdt.offset_by
+    polars_xdt.to_local_datetime
+    polars_xdt.to_julian_date
diff --git a/docs/api/polars_xdt.ExprXDTNamespace.ceil.rst b/docs/api/polars_xdt.ExprXDTNamespace.ceil.rst
diff --git a/docs/api/polars_xdt.ExprXDTNamespace.format_localized.rst b/docs/api/polars_xdt.ExprXDTNamespace.format_localized.rst
diff --git a/docs/api/polars_xdt.ExprXDTNamespace.from_local_datetime.rst b/docs/api/polars_xdt.ExprXDTNamespace.from_local_datetime.rst
diff --git a/docs/api/polars_xdt.ExprXDTNamespace.is_workday.rst b/docs/api/polars_xdt.ExprXDTNamespace.is_workday.rst
diff --git a/docs/api/polars_xdt.ExprXDTNamespace.offset_by.rst b/docs/api/polars_xdt.ExprXDTNamespace.offset_by.rst
diff --git a/docs/api/polars_xdt.ExprXDTNamespace.to_local_datetime.rst b/docs/api/polars_xdt.ExprXDTNamespace.to_local_datetime.rst
diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -8,7 +8,7 @@ Say we start with
     from datetime import date
 
     import polars as pl
-    import polars_xdt  # noqa: F401
+    import polars_xdt as xdt
 
 
     df = pl.DataFrame(
@@ -21,10 +21,7 @@ Let's shift `Date` forwards by 5 days, excluding Saturday and Sunday:
 .. code-block:: python
 
     result = df.with_columns(
-        date_shifted=pl.col("date").xdt.offset_by(
-        '5bd',
-        weekend=('Sat', 'Sun'),
-        )
+        date_shifted=xdt.offset_by('date', '5bd', weekend=('Sat', 'Sun'))
     )
     print(result)
 
@@ -52,10 +49,11 @@ for 2023 and 2024 (note: you'll need to install the
     england_holidays = holidays.country_holidays("UK", subdiv='ENG', years=[2023, 2024])
 
     result = df.with_columns(
-        date_shifted=pl.col("date").xdt.offset_by(
-        by='5bd',
-        weekend=('Sat', 'Sun'),
-        holidays=england_holidays,
+        date_shifted=xdt.offset_by(
+            'date',
+            by='5bd',
+            weekend=('Sat', 'Sun'),
+            holidays=england_holidays,
         )
     )
     print(result)
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,4 +10,5 @@ rust-toolchain.toml @@
     *.bat
     *.js
     docs/_build
-    *.so
+    docs/api/*
+    *.so