edsl 0.1.14__py3-none-any.whl → 0.1.40__py3-none-any.whl

edsl/utilities/SystemInfo.py

@@ -1,3 +1,5 @@
+"""Module to store system information."""
+
 from dataclasses import dataclass
 import getpass
 import platform
@@ -6,6 +8,8 @@ import pkg_resources
 
 @dataclass
 class SystemInfo:
+    """Dataclass to store system information."""
+
     username: str
     system_info: str
     release_info: str
@@ -13,6 +17,7 @@ class SystemInfo:
     package_version: str
 
     def __init__(self, package_name: str):
+        """Initialize the dataclass with system."""
         self.username = getpass.getuser()
         self.system_info = platform.system()
         self.release_info = platform.release()

edsl/utilities/__init__.py

@@ -1,21 +1,22 @@
-from edsl.utilities.interface import (
-    print_dict_as_html_table,
-    print_dict_with_rich,
-    print_list_of_dicts_as_html_table,
-    print_list_of_dicts_with_rich,
-    print_table_with_rich,
-    print_public_methods_with_doc,
-)
+# from edsl.utilities.interface import (
+#     print_dict_as_html_table,
+#     print_dict_with_rich,
+#     print_list_of_dicts_as_html_table,
+#     print_table_with_rich,
+#     print_public_methods_with_doc,
+#     print_list_of_dicts_as_markdown_table,
+# )
 
-from edsl.utilities.utilities import (
-    create_valid_var_name,
-    dict_to_html,
-    hash_value,
-    HTMLSnippet,
-    is_notebook,
-    is_gzipped,
-    is_valid_variable_name,
-    random_string,
-    repair_json,
-    shorten_string,
-)
+# from edsl.utilities.utilities import (
+#     create_valid_var_name,
+#     dict_to_html,
+#     hash_value,
+#     HTMLSnippet,
+#     is_notebook,
+#     is_gzipped,
+#     is_valid_variable_name,
+#     random_string,
+#     repair_json,
+#     shorten_string,
+#     time_all_functions,
+# )

edsl/utilities/ast_utilities.py

@@ -1,7 +1,10 @@
+"""Utilities for working with abstract syntax trees (ASTs)."""
+
 import ast
 
 
 def extract_variable_names(node):
+    """Extract variable names from an abstract syntax tree (AST) node."""
     if isinstance(node, ast.Name):
         return [node.id]  # Extract variable name
     elif isinstance(node, ast.BinOp):

edsl/utilities/data/Registry.py

@@ -1,3 +1,5 @@
+"""This file contains the path to a results file."""
+
 import os
 from edsl import BASE_DIR
 

edsl/utilities/decorators.py

@@ -4,6 +4,47 @@ import nest_asyncio
 
 nest_asyncio.apply()
 
+from edsl import __version__ as edsl_version
+
+
+def add_edsl_version(func):
+    """
+    Decorator for EDSL objects' `to_dict` method.
+    - Adds the EDSL version and class name to the dictionary.
+    """
+
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        d = func(*args, **kwargs)
+        d["edsl_version"] = edsl_version
+        d["edsl_class_name"] = func.__qualname__.split(".")[0]
+        return d
+
+    return wrapper
+
+
+def remove_edsl_version(func):
+    """
+    Decorator for the EDSL objects' `from_dict` method.
+    - Removes the EDSL version and class name from the dictionary.
+    - Ensures backwards compatibility with older versions of EDSL.
+    """
+
+    @functools.wraps(func)
+    def wrapper(cls, data, *args, **kwargs):
+        data_copy = dict(data)
+        edsl_version = data_copy.pop("edsl_version", None)
+        edsl_classname = data_copy.pop("edsl_class_name", None)
+
+        # Version- and class-specific logic here
+        if edsl_classname == "Survey":
+            if edsl_version is None or edsl_version <= "0.1.20":
+                data_copy["question_groups"] = {}
+
+        return func(cls, data_copy, *args, **kwargs)
+
+    return wrapper
+
 
 def jupyter_nb_handler(func):
     """Decorator to run an async function in the event loop if it's running, or synchronously otherwise."""

edsl/utilities/gcp_bucket/cloud_storage.py

@@ -0,0 +1,96 @@
+import requests
+
+
+class CloudStorageManager:
+    def __init__(self, secret_token=None):
+        self.api_url = "https://bucket-server-tte53lsfxq-uc.a.run.app"
+        self.secret_token = secret_token
+
+    def get_signed_url(self, file_name, operation="upload"):
+        """Get a signed URL for uploading or downloading a file."""
+
+        if operation == "upload":
+            if self.secret_token == None:
+                raise "Set secret_token for upload permissions"
+            headers = {
+                "Authorization": self.secret_token,
+                "Content-Type": "application/json",
+            }
+        else:
+            headers = {
+                "Content-Type": "application/json",
+            }
+        data = {"file_name": file_name}
+        endpoint = f"{self.api_url}/generate-{operation}-signed-url"
+        response = requests.post(endpoint, json=data, headers=headers)
+
+        if response.status_code == 200:
+            return response.json().get("signed_url")
+        else:
+            raise Exception(
+                f"Failed to get signed URL: {response.status_code} {response.text}"
+            )
+
+    def upload_file(self, file_path, upload_file_name):
+        """Upload a file to the signed URL."""
+        signed_url = self.get_signed_url(upload_file_name, operation="upload")
+
+        with open(file_path, "rb") as file:
+            upload_response = requests.put(
+                signed_url,
+                data=file,
+                headers={"Content-Type": "application/octet-stream"},
+            )
+
+            if upload_response.status_code == 200:
+                print("File uploaded successfully")
+            else:
+                raise Exception(
+                    f"Failed to upload file: {upload_response.status_code} {upload_response.text}"
+                )
+
+    def download_file(self, file_name, save_name):
+        """Download a file from the signed URL."""
+
+        signed_url = self.get_signed_url(file_name, operation="download")
+        download_response = requests.get(signed_url, stream=True)
+
+        if download_response.status_code == 200:
+            with open(save_name, "wb") as file:
+                for chunk in download_response.iter_content(chunk_size=8192):
+                    file.write(chunk)
+            print("File downloaded successfully")
+        else:
+            raise Exception(
+                f"Failed to download file: {download_response.status_code} {download_response.text}"
+            )
+
+    def delete_file(self, file_name):
+        """Delete a file from the cloud storage."""
+        headers = {
+            "Authorization": self.secret_token,
+            "Content-Type": "application/json",
+        }
+        data = {"file_name": file_name}
+        endpoint = f"{self.api_url}/delete-file"
+        response = requests.delete(endpoint, params=data, headers=headers)
+
+        if response.status_code == 200:
+            print("File deleted successfully")
+        else:
+            raise Exception(
+                f"Failed to delete file: {response.status_code} {response.text}"
+            )
+
+    def list_files(self):
+        url = self.api_url + "/list_files"
+        headers = {
+            "Authorization": self.secret_token,
+            "Content-Type": "application/json",
+        }
+        res = requests.get(url, headers=headers)
+        data = res.json()
+        for x in data["data"]:
+            x["url"] = self.api_url + "/file/" + x["shaKey"]
+
+        return data