Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

depr(python): Deprecate arctan2d in favor of arctan2(...).degrees() #16786

Merged
merged 1 commit into from
Jun 6, 2024
Merged

depr(python): Deprecate arctan2d in favor of arctan2(...).degrees() #16786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 24 additions & 30 deletions py-polars/polars/functions/lazy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import polars._reexport as pl
import polars.functions as F
from polars._utils.async_ import _AioDataFrameResult, _GeventDataFrameResult
from polars._utils.deprecation import issue_deprecation_warning
from polars._utils.deprecation import deprecate_function, issue_deprecation_warning
from polars._utils.parse_expr_input import (
parse_as_expression,
parse_as_list_of_expressions,
Expand Down Expand Up @@ -1341,28 +1341,25 @@ def arctan2(y: str | Expr, x: str | Expr) -> Expr:

Examples
--------
>>> import math
>>> twoRootTwo = math.sqrt(2) / 2
>>> c = (2**0.5) / 2
>>> df = pl.DataFrame(
... {
... "y": [twoRootTwo, -twoRootTwo, twoRootTwo, -twoRootTwo],
... "x": [twoRootTwo, twoRootTwo, -twoRootTwo, -twoRootTwo],
... "y": [c, -c, c, -c],
... "x": [c, c, -c, -c],
... }
... )
>>> df.select(
... pl.arctan2d("y", "x").alias("atan2d"), pl.arctan2("y", "x").alias("atan2")
... )
shape: (4, 2)
┌────────┬───────────┐
│ atan2d ┆ atan2 │
│ --- ┆ --- │
│ f64 ┆ f64 │
╞════════╪═══════════╡
│ 45.0 ┆ 0.785398 │
│ -45.0 ┆ -0.785398 │
│ 135.0 ┆ 2.356194 │
│ -135.0 ┆ -2.356194 │
└────────┴───────────┘
>>> df.with_columns(pl.arctan2("y", "x").alias("atan2"))
shape: (4, 3)
┌───────────┬───────────┬───────────┐
│ y ┆ x ┆ atan2 │
│ --- ┆ --- ┆ --- │
│ f64 ┆ f64 ┆ f64 │
╞═══════════╪═══════════╪═══════════╡
│ 0.707107 ┆ 0.707107 ┆ 0.785398 │
│ -0.707107 ┆ 0.707107 ┆ -0.785398 │
│ 0.707107 ┆ -0.707107 ┆ 2.356194 │
│ -0.707107 ┆ -0.707107 ┆ -2.356194 │
└───────────┴───────────┴───────────┘
"""
if isinstance(y, str):
y = F.col(y)
Expand All @@ -1371,6 +1368,7 @@ def arctan2(y: str | Expr, x: str | Expr) -> Expr:
return wrap_expr(plr.arctan2(y._pyexpr, x._pyexpr))


@deprecate_function("Use `arctan2` followed by `.degrees()` instead.", version="1.0.0")
def arctan2d(y: str | Expr, x: str | Expr) -> Expr:
"""
Compute two argument arctan in degrees.
Expand All @@ -1387,16 +1385,16 @@ def arctan2d(y: str | Expr, x: str | Expr) -> Expr:

Examples
--------
>>> import math
>>> twoRootTwo = math.sqrt(2) / 2
>>> c = (2**0.5) / 2
>>> df = pl.DataFrame(
... {
... "y": [twoRootTwo, -twoRootTwo, twoRootTwo, -twoRootTwo],
... "x": [twoRootTwo, twoRootTwo, -twoRootTwo, -twoRootTwo],
... "y": [c, -c, c, -c],
... "x": [c, c, -c, -c],
... }
... )
>>> df.select(
... pl.arctan2d("y", "x").alias("atan2d"), pl.arctan2("y", "x").alias("atan2")
>>> df.select( # doctest: +SKIP
... pl.arctan2d("y", "x").alias("atan2d"),
... pl.arctan2("y", "x").alias("atan2"),
... )
shape: (4, 2)
┌────────┬───────────┐
Expand All @@ -1410,11 +1408,7 @@ def arctan2d(y: str | Expr, x: str | Expr) -> Expr:
│ -135.0 ┆ -2.356194 │
└────────┴───────────┘
"""
if isinstance(y, str):
y = F.col(y)
if isinstance(x, str):
x = F.col(x)
return wrap_expr(plr.arctan2d(y._pyexpr, x._pyexpr))
return arctan2(y, x).degrees()


def exclude(
Expand Down
6 changes: 0 additions & 6 deletions py-polars/src/functions/lazy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,12 +220,6 @@ pub fn arctan2(y: PyExpr, x: PyExpr) -> PyExpr {
y.inner.arctan2(x.inner).into()
}

#[pyfunction]
#[cfg(feature = "trigonometry")]
pub fn arctan2d(y: PyExpr, x: PyExpr) -> PyExpr {
y.inner.arctan2(x.inner).degrees().into()
}

#[pyfunction]
pub fn cum_fold(acc: PyExpr, lambda: PyObject, exprs: Vec<PyExpr>, include_init: bool) -> PyExpr {
let exprs = exprs.to_exprs();
Expand Down
3 changes: 0 additions & 3 deletions py-polars/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,9 +214,6 @@ fn polars(py: Python, m: &Bound<PyModule>) -> PyResult<()> {
.unwrap();
#[cfg(feature = "trigonometry")]
m.add_wrapped(wrap_pyfunction!(functions::arctan2)).unwrap();
#[cfg(feature = "trigonometry")]
m.add_wrapped(wrap_pyfunction!(functions::arctan2d))
.unwrap();
m.add_wrapped(wrap_pyfunction!(functions::datetime))
.unwrap();
m.add_wrapped(wrap_pyfunction!(functions::concat_expr))
Expand Down
Loading