From d58ae945230584f6b184ef3e83e956481413988a Mon Sep 17 00:00:00 2001 From: Matt Green Date: Tue, 10 Sep 2024 13:04:23 -0700 Subject: [PATCH] Add docstring comments to SortExpr python class --- python/datafusion/expr.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/python/datafusion/expr.py b/python/datafusion/expr.py index 60f87cf0..78acee31 100644 --- a/python/datafusion/expr.py +++ b/python/datafusion/expr.py @@ -84,7 +84,7 @@ ScalarVariable = expr_internal.ScalarVariable SimilarTo = expr_internal.SimilarTo Sort = expr_internal.Sort -SortExpr = expr_internal.SortExpr +# SortExpr = expr_internal.SortExpr Subquery = expr_internal.Subquery SubqueryAlias = expr_internal.SubqueryAlias TableScan = expr_internal.TableScan @@ -669,19 +669,24 @@ def end(self) -> Expr: class SortExpr: - """Used to specify sorting on either a DataFrame or function""" + """Used to specify sorting on either a DataFrame or function.""" def __init__(self, expr: Expr, ascending: bool, nulls_first: bool) -> None: + """This constructor should not be called by the end user.""" self.raw_sort = expr_internal.SortExpr(expr, ascending, nulls_first) def expr(self) -> Expr: + """Return the raw expr backing teh SortExpr.""" return Expr(self.raw_sort.expr()) def ascending(self) -> bool: + """Return ascending property.""" return self.raw_sort.ascending() def nulls_first(self) -> bool: + """Return nulls_first property.""" return self.raw_sort.nulls_first() def __repr__(self) -> str: + """Generate a string representation of this expression.""" return self.raw_sort.__repr__()