polars-expr-transformer 0.1.0__tar.gz

polars_expr_transformer-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

polars_expr_transformer-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.1
+Name: polars_expr_transformer
+Version: 0.1.0
+Summary: Transform string-based expressions into Polars DataFrame operations
+Home-page: https://github.com/yourusername/polars_expr_transformer
+Author: Edward van Eehoud
+Author-email: evaneechoudl@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic~=1.10.6
+Requires-Dist: polars~=0.20.4
+Requires-Dist: pytest~=7.4.0
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+
+# polars_expr_transformer
+
+`polars_expr_transformer` is a Python package designed to simplify the transformation of string-based expressions into Polars DataFrame operations. It enables users to write expressive and readable string-based functions that are automatically converted into Polars expressions for data manipulation and analysis.
+
+## Features
+
+- **Preprocess Expressions:** Preprocess string-based functions to prepare them for transformation.
+- **Convert to Polars Expressions:** Transform preprocessed string expressions into Polars expressions.
+- **Integrate with Polars DataFrames:** Easily apply transformed expressions to Polars DataFrames.
+
+## Installation
+
+You can install the package using pip:
+```sh
+pip install polars_expr_transformer
+```
+
+Usage
+Here's a simplified example of how to use polars_expr_transformer:
+
+
+from polars_expr_transformer.process.polars_expr_transformer import preprocess, simple_function_to_expr
+import polars as pl
+
+# Define a string-based function
+test_func = """'abcd' in 'adbc'"""
+
+# Preprocess the function
+parsed_test_func = preprocess(test_func)
+
+# Create a Polars DataFrame
+df = pl.from_dicts([{'a': 'edward', 'b': 'courtney'}, {'a': 'courtney', 'b': 'edward'}])
+
+# Apply the transformed expressions to the DataFrame
+print(df.select(simple_function_to_expr("'hallo world'")))
+License
+This project is licensed under the MIT License. See the LICENSE file for more details.
+
+
+Contact
+For any questions or inquiries, please contact me.

polars_expr_transformer-0.1.0/README.md

@@ -0,0 +1,41 @@
+# polars_expr_transformer
+
+`polars_expr_transformer` is a Python package designed to simplify the transformation of string-based expressions into Polars DataFrame operations. It enables users to write expressive and readable string-based functions that are automatically converted into Polars expressions for data manipulation and analysis.
+
+## Features
+
+- **Preprocess Expressions:** Preprocess string-based functions to prepare them for transformation.
+- **Convert to Polars Expressions:** Transform preprocessed string expressions into Polars expressions.
+- **Integrate with Polars DataFrames:** Easily apply transformed expressions to Polars DataFrames.
+
+## Installation
+
+You can install the package using pip:
+```sh
+pip install polars_expr_transformer
+```
+
+Usage
+Here's a simplified example of how to use polars_expr_transformer:
+
+
+from polars_expr_transformer.process.polars_expr_transformer import preprocess, simple_function_to_expr
+import polars as pl
+
+# Define a string-based function
+test_func = """'abcd' in 'adbc'"""
+
+# Preprocess the function
+parsed_test_func = preprocess(test_func)
+
+# Create a Polars DataFrame
+df = pl.from_dicts([{'a': 'edward', 'b': 'courtney'}, {'a': 'courtney', 'b': 'edward'}])
+
+# Apply the transformed expressions to the DataFrame
+print(df.select(simple_function_to_expr("'hallo world'")))
+License
+This project is licensed under the MIT License. See the LICENSE file for more details.
+
+
+Contact
+For any questions or inquiries, please contact me.

polars_expr_transformer-0.1.0/polars_expr_transformer/__init__.py

@@ -0,0 +1 @@
+from polars_expr_transformer.main_module import build_func, simple_function_to_expr

polars_expr_transformer-0.1.0/polars_expr_transformer/configs/settings.py

@@ -0,0 +1,42 @@
+import polars as pl
+from polars_expr_transformer.funcs import all_functions
+from polars_expr_transformer.funcs.logic_functions import does_not_equal
+from polars_expr_transformer.funcs.logic_functions import _in
+operators = {  # get your data out of your code...
+    "+": "pl.Expr.add",
+    "-": "pl.Expr.sub",
+    "*": "pl.Expr.mul",
+    "%": "pl.Expr.mod",
+    "/": "pl.Expr.truediv",
+    "<": "pl.Expr.lt",
+    "<=": "pl.Expr.le",
+    ">": "pl.Expr.gt",
+    ">=": "pl.Expr.ge",
+    "==": "pl.Expr.eq",
+    "=": "pl.Expr.eq",
+    "&": "pl.Expr.and_",
+    '|': "pl.Expr.or_",
+    '!=': "does_not_equal",
+    'and': "pl.Expr.and_",
+    'or': "pl.Expr.or_",
+    'in': "_in",
+    'is_null': "pl.Expr.is_null",
+}
+
+aliases = {
+    'not': '_not',
+}
+
+
+operators_mappings = {v: eval(v) for v in operators.values()}
+all_split_vals = set(['(', ')', '$if$', '$endif$', '$else$', '$then$','$elseif$', ',', ''] + list(operators)+list(operators))
+all_split_vals_reversed = [v[::-1] for v in all_split_vals]
+funcs = {f'{k}': v for k,v in all_functions.items()}
+funcs['pl.col'] = pl.col
+funcs['pl.lit'] = pl.lit
+funcs.update(operators_mappings)
+for alias, ref in aliases.items():
+    funcs[alias] = funcs[ref]
+
+
+PRECEDENCE = {'+': 2, '-': 2, '*': 3, '/': 3, '|': -1, '&': -1, 'and': -1, 'or': -1, 'in': -1}

polars_expr_transformer-0.1.0/polars_expr_transformer/funcs/__init__.py

@@ -0,0 +1,10 @@
+import os
+
+from polars_expr_transformer.funcs import logic_functions, string_functions, math_functions, special_funcs, date_functions
+
+all_functions = {}
+all_functions.update(logic_functions.__dict__)
+all_functions.update(string_functions.__dict__)
+all_functions.update(math_functions.__dict__)
+all_functions.update(special_funcs.__dict__)
+all_functions.update(date_functions.__dict__)

polars_expr_transformer-0.1.0/polars_expr_transformer/funcs/date_functions.py

@@ -0,0 +1,244 @@
+import polars as pl
+from typing import Any
+from polars_expr_transformer.funcs.utils import is_polars_expr, create_fix_col, create_fix_date_col
+from datetime import datetime
+
+string_type = pl.Expr | str
+
+
+def now() -> pl.Expr:
+    """
+    Get the current timestamp.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the current timestamp.
+    """
+    return pl.lit(datetime.now())
+
+
+def today() -> pl.Expr:
+    """
+    Get the current date.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the current date.
+    """
+    return pl.lit(datetime.today())
+
+
+def year(s: Any) -> pl.Expr:
+    """
+    Extract the year from a date or timestamp.
+
+    Parameters:
+    - s (Any): The date or timestamp to extract the year from. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the year extracted from `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    return s.dt.year()
+
+
+def month(s: Any) -> pl.Expr:
+    """
+    Extract the month from a date or timestamp.
+
+    Parameters:
+    - s (Any): The date or timestamp to extract the month from. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the month extracted from `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_col(s).str.to_datetime()
+    return s.dt.month()
+
+
+def day(s: Any) -> pl.Expr:
+    """
+    Extract the day from a date or timestamp.
+
+    Parameters:
+    - s (Any): The date or timestamp to extract the day from. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the day extracted from `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    return s.dt.day()
+
+
+def hour(s: Any) -> pl.Expr:
+    """
+    Extract the hour from a timestamp.
+
+    Parameters:
+    - s (Any): The timestamp to extract the hour from. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the hour extracted from `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    return s.dt.hour()
+
+
+def minute(s: Any) -> pl.Expr:
+    """
+    Extract the minute from a timestamp.
+
+    Parameters:
+    - s (Any): The timestamp to extract the minute from. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the minute extracted from `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    return s.dt.minute()
+
+
+def second(s: Any) -> pl.Expr:
+    """
+    Extract the second from a timestamp.
+
+    Parameters:
+    - s (Any): The timestamp to extract the second from. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the second extracted from `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    return s.dt.second()
+
+
+def add_days(s: Any, days: Any) -> pl.Expr:
+    """
+    Add a specified number of days to a date or timestamp.
+
+    Parameters:
+    - s (Any): The date or timestamp to add days to. Can be a FlowFile expression or any other value.
+    - days (int): The number of days to add.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the result of adding `days` to `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    days = days if is_polars_expr(days) else create_fix_date_col(days)
+    return s + pl.duration(days=days)
+
+
+def add_hours(s: Any, hours: any) -> pl.Expr:
+    """
+    Add a specified number of hours to a timestamp.
+
+    Parameters:
+    - s (Any): The timestamp to add hours to. Can be a FlowFile expression or any other value.
+    - hours (int): The number of hours to add.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the result of adding `hours` to `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    hours = hours if is_polars_expr(hours) else create_fix_col(hours)
+    return s + pl.duration(hours=hours)
+
+
+def add_minutes(s: Any, minutes: Any) -> pl.Expr:
+    """
+    Add a specified number of minutes to a timestamp.
+
+    Parameters:
+    - s (Any): The timestamp to add minutes to. Can be a FlowFile expression or any other value.
+    - minutes (int): The number of minutes to add.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the result of adding `minutes` to `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    minutes = minutes if is_polars_expr(minutes) else create_fix_col(minutes)
+    return s + pl.duration(minutes=minutes)
+
+
+def add_seconds(s: Any, seconds: Any) -> pl.Expr:
+    """
+    Add a specified number of seconds to a timestamp.
+
+    Parameters:
+    - s (Any): The timestamp to add seconds to. Can be a FlowFile expression or any other value.
+    - seconds (int): The number of seconds to add.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the result of adding `seconds` to `s`.
+
+    Note: If `s` is not a FlowFile expression, it will be converted into one.
+    """
+    s = s if is_polars_expr(s) else create_fix_date_col(s)
+    seconds = seconds if is_polars_expr(seconds) else create_fix_col(seconds)
+    return s + pl.duration(seconds=seconds)
+
+
+def datetime_diff_seconds(s1: Any, s2: Any) -> pl.Expr:
+    """
+    Calculate the difference in seconds between two timestamps.
+
+    Parameters:
+    - s1 (Any): The first timestamp. Can be a FlowFile expression or any other value.
+    - s2 (Any): The second timestamp. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the difference in seconds between `s1` and `s2`.
+
+    Note: If `s1` and `s2` are not FlowFile expressions, they will be converted into one.
+    """
+    s1 = s1 if is_polars_expr(s1) else create_fix_date_col(s1)
+    s2 = s2 if is_polars_expr(s2) else create_fix_date_col(s2)
+    return (s1 - s2).dt.total_seconds()
+
+
+def datetime_diff_nanoseconds(s1: Any, s2: Any):
+    """ Calculate the difference in days between two dates.
+    Parameters:
+    - s1 (Any): The first date. Can be a FlowFile expression or any other value.
+    - s2 (Any): The second date. Can be a FlowFile expression or any other value.
+    Returns:
+    - pl.Expr: A FlowFile expression representing the difference in days between `s1` and `s2`.
+    Note: If `s1` and `s2` are not FlowFile expressions, they will be converted into one.
+    """
+    s1 = s1 if is_polars_expr(s1) else create_fix_date_col(s1)
+    s2 = s2 if is_polars_expr(s2) else create_fix_date_col(s2)
+    return (s1 - s2).dt.total_nanoseconds()
+
+
+def date_diff_days(s1: Any, s2: Any) -> pl.Expr:
+    """
+    Calculate the difference in days between two dates.
+
+    Parameters:
+    - s1 (Any): The first date. Can be a FlowFile expression or any other value.
+    - s2 (Any): The second date. Can be a FlowFile expression or any other value.
+
+    Returns:
+    - pl.Expr: A FlowFile expression representing the difference in days between `s1` and `s2`.
+
+    Note: If `s1` and `s2` are not FlowFile expressions, they will be converted into one.
+    """
+    s1 = s1 if is_polars_expr(s1) else create_fix_date_col(s1)
+    s2 = s2 if is_polars_expr(s2) else create_fix_date_col(s2)
+    return (s1 - s2).dt.total_days()