rgwfuncs 0.0.33__py3-none-any.whl → 0.0.34__py3-none-any.whl

rgwfuncs/__init__.py

@@ -4,4 +4,5 @@
 from .algebra_lib import compute_constant_expression, compute_constant_expression_involving_matrices, compute_constant_expression_involving_ordered_series, compute_prime_factors, python_polynomial_expression_to_latex, simplify_polynomial_expression, solve_homogeneous_polynomial_expression
 from .df_lib import append_columns, append_percentile_classification_column, append_ranged_classification_column, append_ranged_date_classification_column, append_rows, append_xgb_labels, append_xgb_logistic_regression_predictions, append_xgb_regression_predictions, bag_union_join, bottom_n_unique_values, cascade_sort, delete_rows, drop_duplicates, drop_duplicates_retain_first, drop_duplicates_retain_last, filter_dataframe, filter_indian_mobiles, first_n_rows, from_raw_data, insert_dataframe_in_sqlite_database, last_n_rows, left_join, limit_dataframe, load_data_from_path, load_data_from_query, load_data_from_sqlite_path, mask_against_dataframe, mask_against_dataframe_converse, numeric_clean, order_columns, print_correlation, print_dataframe, print_memory_usage, print_n_frequency_cascading, print_n_frequency_linear, rename_columns, retain_columns, right_join, send_data_to_email, send_data_to_slack, send_dataframe_via_telegram, sync_dataframe_to_sqlite_database, top_n_unique_values, union_join, update_rows
 from .docs_lib import docs
+from .interactive_shell_lib import interactive_shell
 from .str_lib import send_telegram_message

rgwfuncs/algebra_lib.py

@@ -76,7 +76,7 @@ def compute_constant_expression_involving_matrices(expression: str) -> str:
     Computes the result of a constant expression involving matrices and returns it as a LaTeX string.
 
     Parameters:
-    expression (str): The constant expression involving matrices. Example format includes operations such as "+", 
+    expression (str): The constant expression involving matrices. Example format includes operations such as "+",
     "-", "*", "/".
 
     Returns:
@@ -161,9 +161,9 @@ def compute_constant_expression_involving_matrices(expression: str) -> str:
 
 def compute_constant_expression_involving_ordered_series(expression: str) -> str:
     """
-    Computes the result of a constant expression involving ordered series, and returns it as a Latex string. 
+    Computes the result of a constant expression involving ordered series, and returns it as a Latex string.
     Supports operations lile "+", "-", "*", "/", as well as "dd()" (the discrete difference operator).
-  
+
     The function first applies the discrete difference operator to any series where applicable, then evaluates
     arithmetic operations between series.
 
@@ -261,8 +261,6 @@ def compute_constant_expression_involving_ordered_series(expression: str) -> str
         return f"Error computing ordered series operation: {e}"
 
 
-
-
 def python_polynomial_expression_to_latex(
     expression: str,
     subs: Optional[Dict[str, float]] = None
@@ -549,5 +547,3 @@ def solve_homogeneous_polynomial_expression(
 
     except Exception as e:
         raise ValueError(f"Error solving the expression: {e}")
-
-

rgwfuncs/interactive_shell_lib.py

@@ -0,0 +1,32 @@
+import code
+import readline
+import rlcompleter  # noqa: F401
+import sys  # noqa: F401
+from typing import Dict, Any
+from .df_lib import *  # noqa: F401, F403, E402
+from .algebra_lib import *  # noqa: F401, F403, E402
+from .str_lib import *  # noqa: F401, F403, E402
+from .docs_lib import *  # noqa: F401, F403, E402
+
+
+def interactive_shell(local_vars: Dict[str, Any]) -> None:
+    """
+    Launches an interactive prompt for inspecting and modifying local variables, making all methods
+    in the rgwfuncs library available by default.
+
+    Parameters:
+        local_vars (dict): Dictionary of local variables to be available in the interactive shell.
+    """
+    if not isinstance(local_vars, dict):
+        raise TypeError("local_vars must be a dictionary")
+
+    readline.parse_and_bind("tab: complete")
+
+    # Make imported functions available in the REPL
+    local_vars.update(globals())
+
+    # Create interactive console with local context
+    console = code.InteractiveConsole(locals=local_vars)
+
+    # Start interactive session
+    console.interact(banner="Welcome to the rgwfuncs interactive shell.")

{rgwfuncs-0.0.33.dist-info → rgwfuncs-0.0.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rgwfuncs
-Version: 0.0.33
+Version: 0.0.34
 Summary: A functional programming paradigm for mathematical modelling and data science
 Home-page: https://github.com/ryangerardwilson/rgwfunc
 Author: Ryan Gerard Wilson
@@ -150,6 +150,83 @@ Print a list of available function names in alphabetical order. If a filter is p
 
 --------------------------------------------------------------------------------
 
+## Interactive Shell Function
+
+This section includes functions that facilitate launching an interactive Python shell to inspect and modify local variables within the user's environment.
+
+### 1. `interactive_shell`
+
+#### Usage
+
+Launches an interactive prompt for inspecting and modifying local variables, making all methods in the rgwfuncs library available by default. This REPL (Read-Eval-Print Loop) environment supports command history and autocompletion, making it easier to interact with your Python code.
+
+• Parameters:
+  - `local_vars` (dict, optional): A dictionary of local variables to be accessible within the interactive shell. If not provided, defaults to an empty dictionary.
+
+• Usage:
+  - You can call this function to enter an interactive shell where you can view and modify the variables in the given local scope.
+
+• Example:
+
+    from rgwfuncs import interactive_shell
+    import pandas as pd
+    import numpy as np
+
+    # Example DataFrame
+    df = pd.DataFrame({
+        'id': [1, 2, 3, 4, 5],
+        'name': ['Alice', 'Bob', 'Charlie', 'David', 'Eva'],
+        'age': [30, 25, 35, 28, 22],
+        'city': ['New York', 'Los Angeles', 'Chicago', 'San Francisco', 'Boston']
+    })
+
+    # Function to retrieve the first n rows of a DataFrame
+    def first_n_rows(df, n):
+        return df.head(n).to_dict('records')
+
+    # Launch the interactive shell with local variables
+    interactive_shell(locals())
+
+- Once in the interactive shell, you are greeted with a welcome message. You can access the variables defined in the local scope where `interactive_shell(locals())` was called, including any imported modules such as `pandas` (accessed as `pd`) and `numpy` (accessed as `np`). This means you can directly use these modules in the interactive session. Type `exit()` to quit the shell.
+
+#### Interactive Shell Example Sessions
+
+1. DataFrame Inspection with Pandas:
+
+    Welcome to the rgwfuncs interactive shell.
+    >>> pirst_n_rows(df, 2)
+    Traceback (most recent call last):
+      File "<console>", line 1, in <module>
+    NameError: name 'pirst_n_rows' is not defined. Did you mean: 'first_n_rows'?
+    >>> first_n_rows(df, 2)
+    {'age': '30', 'city': 'New York', 'id': '1', 'name': 'Alice'}
+    {'age': '25', 'city': 'Los Angeles', 'id': '2', 'name': 'Bob'}
+    >>> print(df)
+      id     name age           city
+    0  1    Alice  30       New York
+    1  2      Bob  25    Los Angeles
+    2  3  Charlie  35        Chicago
+    3  4    David  28  San Francisco
+    4  5      Eva  22         Boston
+
+2. Array Operations with NumPy:
+
+    Welcome to the rgwfuncs interactive shell.
+    >>> arr = np.array([1, 2, 3, 4, 5])
+    >>> arr
+    array([1, 2, 3, 4, 5])
+
+These examples illustrate how you can use functions and variables within the interactive shell, handle errors with meaningful suggestions, and perform operations using external libraries like pandas and numpy.
+
+#### Key Features
+
+- Autocompletion: Uses the `rlcompleter` library to provide tab-completion of variables and functions names, enhancing ease of use.
+- History Support: Utilizes `readline` for command-line history, allowing you to navigate through previous commands using the arrow keys.
+
+This function is particularly useful for debugging purposes when you want real-time interaction with your program's execution environment.
+
+--------------------------------------------------------------------------------
+
 ## Algebra Based Functions
 
 This section provides comprehensive functions for handling algebraic expressions, performing tasks such as computation, simplification, solving equations, and prime factorization, all outputted in LaTeX format.

rgwfuncs-0.0.34.dist-info/RECORD

@@ -0,0 +1,12 @@
+rgwfuncs/__init__.py,sha256=CLPRpLtzXxyFHEjS-MrxnhXH0LdS6THjAC5sCHg0m3c,1520
+rgwfuncs/algebra_lib.py,sha256=g-sNkf9Hz4i17uRIgLUYLQlyUu8yROgsoJMujdj0U3Y,21577
+rgwfuncs/df_lib.py,sha256=G_H3PXNVeseX2YLjkkrmO9eXA_7r29swUZlbPBDZjXA,66612
+rgwfuncs/docs_lib.py,sha256=y3wSAOPO3qsA4HZ7xAtW8HimM8w-c8hjcEzMRLJ96ao,1960
+rgwfuncs/interactive_shell_lib.py,sha256=A7EWsYxAfDev_N0-2GjRvAtp0bAwBPHIczXb8Gu9fzI,1107
+rgwfuncs/str_lib.py,sha256=rtAdRlnSJIu3JhI-tA_A0wCiPK2m-zn5RoGpBxv_g-4,2228
+rgwfuncs-0.0.34.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
+rgwfuncs-0.0.34.dist-info/METADATA,sha256=JuG4wIxpjCaw7ST1u2lQHD9fBAUC9lC68X1E_4OztuM,48334
+rgwfuncs-0.0.34.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+rgwfuncs-0.0.34.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
+rgwfuncs-0.0.34.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
+rgwfuncs-0.0.34.dist-info/RECORD,,

rgwfuncs-0.0.33.dist-info/RECORD

@@ -1,11 +0,0 @@
-rgwfuncs/__init__.py,sha256=xs4RKtP6koffSxgfqG8b5E6qebsTmoQUMVj8-Hf2xj0,1467
-rgwfuncs/algebra_lib.py,sha256=HAG57M5ce5RsPBcKX1LFwK7hr-b55vSRPmxjYxDdRkE,21585
-rgwfuncs/df_lib.py,sha256=G_H3PXNVeseX2YLjkkrmO9eXA_7r29swUZlbPBDZjXA,66612
-rgwfuncs/docs_lib.py,sha256=y3wSAOPO3qsA4HZ7xAtW8HimM8w-c8hjcEzMRLJ96ao,1960
-rgwfuncs/str_lib.py,sha256=rtAdRlnSJIu3JhI-tA_A0wCiPK2m-zn5RoGpBxv_g-4,2228
-rgwfuncs-0.0.33.dist-info/LICENSE,sha256=7EI8xVBu6h_7_JlVw-yPhhOZlpY9hP8wal7kHtqKT_E,1074
-rgwfuncs-0.0.33.dist-info/METADATA,sha256=7rjtuE5Q1RAd44zz995DwJXPdoGHEAp05cKkDQ_UKew,44916
-rgwfuncs-0.0.33.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-rgwfuncs-0.0.33.dist-info/entry_points.txt,sha256=j-c5IOPIQ0252EaOV6j6STio56sbXl2C4ym_fQ0lXx0,43
-rgwfuncs-0.0.33.dist-info/top_level.txt,sha256=aGuVIzWsKiV1f2gCb6mynx0zx5ma0B1EwPGFKVEMTi4,9
-rgwfuncs-0.0.33.dist-info/RECORD,,