edsl 0.1.27.dev2__py3-none-any.whl → 0.1.29__py3-none-any.whl

edsl/utilities/interface.py

@@ -1,12 +1,45 @@
 """A module for displaying data in various formats."""
 
 from html import escape
-from IPython.display import HTML
-from IPython.display import display as ipython_diplay
 
-# from PIL import Image, ImageDraw, ImageFont
-from rich.console import Console
-from rich.table import Table
+
+def create_image(console, image_filename):
+    """Create an image from the console output."""
+    font_size = 15
+    from PIL import Image, ImageDraw, ImageFont
+
+    text = console.export_text()  # Get the console output as text.
+
+    # Create an image from the text
+    font_size = 15
+    font = ImageFont.load_default()  # Use the default font to avoid file path issues.
+    # text_width, text_height = ImageDraw.Draw(
+    #    Image.new("RGB", (100, 100))
+    # ).multiline_textsize(text, font=font)
+    text_width, text_height = get_multiline_textsize(text, font)
+    image = Image.new(
+        "RGB", (text_width + 20, text_height + 20), color=(255, 255, 255)
+    )  # Add some padding
+    d = ImageDraw.Draw(image)
+
+    # Draw text to image
+    d.multiline_text((10, 10), text, font=font, fill=(0, 0, 0))
+    # Save the image
+    image.save(image_filename)
+
+
+def display_table(console, table, filename):
+    # from rich.console import Console
+    # from rich.table import Table
+    """Display the table using the rich library and save it to a file if a filename is provided."""
+    if filename is not None:
+        with open(filename, "w") as f:
+            with console.capture() as capture:
+                console.print(table)
+            f.write(capture.get())
+        create_image(console, filename + ".png")
+    else:
+        console.print(table)
 
 
 def gen_html_sandwich(html_inner, interactive=False):
@@ -133,43 +166,10 @@ def get_multiline_textsize(text, font):
     return max_width, total_height
 
 
-# def create_image(console, image_filename):
-#     """Create an image from the console output."""
-#     font_size = 15
-
-#     text = console.export_text()  # Get the console output as text.
-
-#     # Create an image from the text
-#     font_size = 15
-#     font = ImageFont.load_default()  # Use the default font to avoid file path issues.
-#     # text_width, text_height = ImageDraw.Draw(
-#     #    Image.new("RGB", (100, 100))
-#     # ).multiline_textsize(text, font=font)
-#     text_width, text_height = get_multiline_textsize(text, font)
-#     image = Image.new(
-#         "RGB", (text_width + 20, text_height + 20), color=(255, 255, 255)
-#     )  # Add some padding
-#     d = ImageDraw.Draw(image)
-
-#     # Draw text to image
-#     d.multiline_text((10, 10), text, font=font, fill=(0, 0, 0))
-#     # Save the image
-#     image.save(image_filename)
-
-
-def display(console, table, filename):
-    """Display the table using the rich library and save it to a file if a filename is provided."""
-    if filename is not None:
-        with open(filename, "w") as f:
-            with console.capture() as capture:
-                console.print(table)
-            f.write(capture.get())
-        create_image(console, filename + ".png")
-    else:
-        console.print(table)
-
-
 def print_results_long(results, max_rows=None):
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console(record=True)
     table = Table(show_header=True, header_style="bold magenta")
     table.add_column("Result index", style="dim")
@@ -199,6 +199,9 @@ def print_dict_with_rich(d, key_name="Key", value_name="Value", filename=None):
     │ c   │ 3     │
     └─────┴───────┘
     """
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console(record=True)
     table = Table(show_header=True, header_style="bold magenta")
     table.add_column(key_name, style="dim")
@@ -206,7 +209,7 @@ def print_dict_with_rich(d, key_name="Key", value_name="Value", filename=None):
     for key, value in d.items():
         table.add_row(key, str(value))
     console.print(table)
-    # display(console, table, filename)
+    # display_table(console, table, filename)
 
 
 def print_dict_as_html_table(
@@ -251,6 +254,9 @@ def print_dict_as_html_table(
 
 
 def print_scenario_list(data):
+    from rich.console import Console
+    from rich.table import Table
+
     new_data = []
     for obs in data:
         try:
@@ -300,6 +306,9 @@ def print_dataset_with_rich(data, filename=None, split_at_dot=True):
     │ 3 │ 6 │
     └───┴───┘
     """
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console(record=True)
 
     # Create a table object
@@ -321,7 +330,7 @@ def print_dataset_with_rich(data, filename=None, split_at_dot=True):
         table.add_row(*row)
 
     console.print(table)
-    # display(console, table, filename)
+    # display_table(console, table, filename)
 
 
 def create_latex_table_from_data(data, filename=None, split_at_dot=True):
@@ -331,15 +340,15 @@ def create_latex_table_from_data(data, filename=None, split_at_dot=True):
 
     >>> data = [{"a": [1, 2, 3], "b": [4, 5, 6]}]
     >>> print(create_latex_table_from_data(data))
-    \begin{tabular}{|c|c|}
-    \hline
-    a & b \\
-    \hline
-    1 & 4 \\
-    2 & 5 \\
-    3 & 6 \\
-    \hline
-    \end{tabular}
+    \\begin{tabular}{|c|c|}
+    \\hline
+    a & b \\\\
+    \\hline
+    1 & 4 \\\\
+    2 & 5 \\\\
+    3 & 6 \\\\
+    \\hline
+    \\end{tabular}
     """
 
     def escape_latex(s):
@@ -379,7 +388,7 @@ def create_latex_table_from_data(data, filename=None, split_at_dot=True):
     num_rows = len(next(iter(data[0].values())))
 
     # Debugging: Print the keys of the dictionaries
-    print("Keys in data[0]:", list(data[0].keys()))
+    # print("Keys in data[0]:", list(data[0].keys()))
 
     # Add the data rows
     for i in range(num_rows):
@@ -410,9 +419,7 @@ def create_latex_table_from_data(data, filename=None, split_at_dot=True):
     return latex_table_str
 
 
-def print_list_of_dicts_as_html_table(
-    data, filename=None, interactive=True, notebook=False
-):
+def print_list_of_dicts_as_html_table(data, interactive=True):
     """Print a list of dictionaries as an HTML table.
 
     :param data: The list of dictionaries to print.
@@ -459,20 +466,7 @@ def print_list_of_dicts_as_html_table(
     # Close the table
     html_table += "</tbody>\n"
     html_table += "</table>"
-
-    html = gen_html_sandwich(html_table, interactive=interactive)
-
-    # Output or save to file
-    if filename:
-        with open(filename, "w") as f:
-            f.write(html)
-    else:
-        # view_html(html)
-        if notebook:
-            # ipython_diplay(HTML(html))
-            return html
-        else:
-            print(html)
+    return gen_html_sandwich(html_table, interactive=interactive)
 
 
 def print_list_of_dicts_as_markdown_table(data, filename=None):
@@ -486,7 +480,11 @@ def print_list_of_dicts_as_markdown_table(data, filename=None):
         return
 
     # Gather all unique headers
-    headers = list({key for d in data for key in d.keys()})
+    # headers = list({key for d in data for key in d.keys()})
+    headers = []
+    for column in data:
+        headers.append(list(column.keys())[0])
+
     markdown_table = "| " + " | ".join(headers) + " |\n"
     markdown_table += "|-" + "-|-".join(["" for _ in headers]) + "-|\n"
 
@@ -506,6 +504,9 @@ def print_list_of_dicts_as_markdown_table(data, filename=None):
 
 def print_public_methods_with_doc(obj):
     """Print the public methods of an object along with their docstrings."""
+    from rich.console import Console
+    from rich.table import Table
+
     console = Console()
     public_methods_with_docstrings = [
         (method, getattr(obj, method).__doc__)
@@ -527,8 +528,19 @@ def print_tally_with_rich(data, filename=None):
     Example:
     >>> data = {'a':12, 'b':14, 'c':9}
     >>> print_tally_with_rich(data)
+    ┏━━━━━━━┳━━━━━━━┓
+    ┃ Value ┃ Count ┃
+    ┡━━━━━━━╇━━━━━━━┩
+    │ a     │ 12    │
+    │ b     │ 14    │
+    │ c     │ 9     │
+    └───────┴───────┘
     """
     # Initialize a console object
+    from rich.console import Console
+    from rich.table import Table
+    from IPython.display import display
+
     console = Console(record=True)
 
     # Create a new table
@@ -542,7 +554,9 @@ def print_tally_with_rich(data, filename=None):
     for key, value in data.items():
         table.add_row(key, str(value))
 
-    display(console, table, filename)
+    from IPython.display import display
+
+    display_table(console, table, filename)
 
 
 def print_table_with_rich(data, filename=None):
@@ -565,6 +579,9 @@ def print_table_with_rich(data, filename=None):
     │ 2 │ 9 │ 8 │
     └───┴───┴───┘
     """
+    from rich.console import Console
+    from rich.table import Table
+
     # Initialize a console object - expects a list of dictionaries
     console = Console(record=True)
 
@@ -584,7 +601,7 @@ def print_table_with_rich(data, filename=None):
     for row in data:
         table.add_row(*[str(value) for value in row.values()])
 
-    display(console, table, filename)
+    display_table(console, table, filename)
 
 
 if __name__ == "__main__":

edsl/utilities/repair_functions.py

@@ -0,0 +1,28 @@
+import json
+from edsl.utilities.utilities import valid_json
+
+
+def extract_json_from_string(s):
+    """Extract a JSON string from a string."""
+    # Find the first occurrence of '{'
+    start_idx = s.find("{")
+    # Find the last occurrence of '}'
+    end_idx = s.rfind("}")
+    # If both '{' and '}' are found in the string
+    if start_idx != -1 and end_idx != -1 and start_idx < end_idx:
+        # Extract the substring from start_idx to end_idx (inclusive)
+        json_str = s[start_idx : end_idx + 1]
+        try:
+            return json.loads(json_str)
+        except json.JSONDecodeError:
+            raise ValueError("Invalid JSON string")
+    else:
+        raise ValueError("No JSON object found in string")
+
+
+if __name__ == "__main__":
+    text = (
+        'Sure - here is some JSON { "key": "value", "number": 123, "array": [1, 2, 3] }'
+    )
+    extracted_json = extract_json_from_string(text)
+    d = extracted_json

edsl/utilities/utilities.py

@@ -1,5 +1,9 @@
 """Utility functions for working with strings, dictionaries, and files."""
 
+from functools import wraps
+import types
+import time
+
 import hashlib
 import json
 import keyword
@@ -11,13 +15,50 @@ import tempfile
 import gzip
 import webbrowser
 import json
+
 from html import escape
 from typing import Callable, Union
 
-from pygments import highlight
-from pygments.lexers import JsonLexer
-from pygments.formatters import HtmlFormatter
-from IPython.display import HTML
+
+def time_it(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        start_time = time.time()
+        result = func(*args, **kwargs)
+        end_time = time.time()
+        execution_time = end_time - start_time
+        class_name = args[0].__class__.__name__ if args else func.__module__
+        print(
+            f"Function {class_name}.{func.__name__} took {execution_time:.4f} seconds to execute"
+        )
+        return result
+
+    return wrapper
+
+
+def time_all_functions(module_or_class):
+    for name, obj in vars(module_or_class).items():
+        if isinstance(obj, types.FunctionType):
+            setattr(module_or_class, name, time_it(obj))
+
+
+def dict_hash(data: dict):
+    return hash(
+        int(hashlib.md5(json.dumps(data, sort_keys=True).encode()).hexdigest(), 16)
+    )
+
+
+def extract_json_from_string(text):
+    pattern = re.compile(r"\{.*?\}")
+    match = pattern.search(text)
+    if match:
+        json_data = match.group(0)
+        try:
+            json_object = json.loads(json_data)
+            return json_object
+        except json.JSONDecodeError:
+            return None
+    return None
 
 
 def clean_json(bad_json_str):
@@ -32,6 +73,7 @@ def clean_json(bad_json_str):
         ("\t", "\\t"),
         ("\b", "\\b"),
         ("\f", "\\f"),
+        ("[/INST]", "removed_inst"),
     ]
 
     s = bad_json_str
@@ -46,6 +88,11 @@ def data_to_html(data, replace_new_lines=False):
     if "edsl_class_name" in data:
         _ = data.pop("edsl_class_name")
 
+    from pygments import highlight
+    from pygments.lexers import JsonLexer
+    from pygments.formatters import HtmlFormatter
+    from IPython.display import HTML
+
     json_str = json.dumps(data, indent=4)
     formatted_json = highlight(
         json_str,
@@ -54,6 +101,7 @@ def data_to_html(data, replace_new_lines=False):
     )
     if replace_new_lines:
         formatted_json = formatted_json.replace("\\n", "<br>")
+
     return HTML(formatted_json).data
 
 
@@ -233,9 +281,14 @@ def valid_json(json_string):
         return False
 
 
-def is_valid_variable_name(name):
+def is_valid_variable_name(name, allow_name=True):
     """Check if a string is a valid variable name."""
-    return name.isidentifier() and not keyword.iskeyword(name)
+    if allow_name:
+        return name.isidentifier() and not keyword.iskeyword(name)
+    else:
+        return (
+            name.isidentifier() and not keyword.iskeyword(name) and not name == "name"
+        )
 
 
 def create_valid_var_name(s, transform_func: Callable = lambda x: x.lower()) -> str:

{edsl-0.1.27.dev2.dist-info → edsl-0.1.29.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edsl
-Version: 0.1.27.dev2
+Version: 0.1.29
 Summary: Create and analyze LLM-based surveys
 Home-page: https://www.expectedparrot.com/
 License: MIT
@@ -30,6 +30,7 @@ Requires-Dist: pandas (>=2.1.4,<3.0.0)
 Requires-Dist: pydot (>=2.0.0,<3.0.0)
 Requires-Dist: pygments (>=2.17.2,<3.0.0)
 Requires-Dist: pymupdf (>=1.24.4,<2.0.0)
+Requires-Dist: pyreadstat (>=1.2.7,<2.0.0)
 Requires-Dist: python-docx (>=1.1.0,<2.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
 Requires-Dist: restrictedpython (>=7.1,<8.0)
@@ -45,28 +46,54 @@ Description-Content-Type: text/markdown
   <img src="https://github.com/expectedparrot/edsl/blob/main/static/logo.png?raw=true" alt="edsl.png" width="100"/>
 </p>
 
-The Expected Parrot Domain-Specific Language (EDSL) package lets you conduct computational social science and market research with AI. Use it to design surveys and experiments, simulate responses with large language models, and perform data labeling and other research tasks. EDSL comes with built-in methods for analyzing, visualizing and sharing your results. 
+The Expected Parrot Domain-Specific Language (EDSL) package lets you conduct computational social science and market research with AI. Use it to design surveys and experiments, simulate responses with large language models, and perform data labeling and other research tasks. Results are formatted as specified datasets and come with built-in methods for analyzing, visualizing, and sharing. 
 
 ## 🔗 Links
-- PyPI: https://pypi.org/project/edsl/
-- Documentation: https://docs.expectedparrot.com
-- Getting started: https://docs.expectedparrot.com/en/latest/starter_tutorial.html
-- Discord: https://discord.com/invite/mxAYkjfy9m
+- [PyPI](https://pypi.org/project/edsl/)
+- [Documentation](https://docs.expectedparrot.com)
+- [Getting started](https://docs.expectedparrot.com/en/latest/starter_tutorial.html) 
+- [Discord](https://discord.com/invite/mxAYkjfy9m)
+- [Twitter](https://x.com/ExpectedParrot)
+- [LinkedIn](https://www.linkedin.com/company/expectedparrot/)
+- [Blog](https://blog.expectedparrot.com)
 
+## 🌎 Hello, World!
+A quick example:
 
-## 💡 Contributions, Feature Requests & Bugs
-Interested in contributing? Want us to add a new feature? Found a nasty bug that you would like us to squash? Please send us an email at info@expectedparrot.com or message us at our Discord server.
+```python
+# Import a question type
+from edsl.questions import QuestionMultipleChoice
 
+# Construct a question using the question type template
+q = QuestionMultipleChoice(
+    question_name="example_question",
+    question_text="How do you feel today?",
+    question_options=["Bad", "OK", "Good"]
+)
 
-## 💻 Getting started
-EDSL is compatible with Python 3.9 - 3.12.
+# Run it with the default language model
+results = q.run()
+
+# Inspect the results in a dataset
+results.select("example_question").print()
 ```
-pip install edsl
+
+Output:
+```python
+┏━━━━━━━━━━━━━━━━━━━┓
+┃ answer            ┃
+┃ .example_question ┃
+┡━━━━━━━━━━━━━━━━━━━┩
+│ Good              │
+└───────────────────┘
 ```
 
-- Read the docs at http://docs.expectedparrot.com.
-- See https://docs.expectedparrot.com/en/latest/starter_tutorial.html for examples and tutorials.
+## 💻 Requirements
+* EDSL is compatible with Python 3.9 - 3.12.
+* API keys for large language models that you want to use, stored in a `.env` file.
+See instructions on [storing API keys](https://docs.expectedparrot.com/en/latest/api_keys.html).
 
-## 🔧 Dependencies
-API keys for LLMs that you want to use, stored in a `.env` file
+## 💡 Contributions, feature requests & bugs
+Interested in contributing? Want us to add a new feature? Found a bug for us to squash? 
+Please send us an email at [info@expectedparrot.com](mailto:info@expectedparrot.com) or message us at our [Discord channel](https://discord.com/invite/mxAYkjfy9m).