merge main into sa-selenium

.gitignore

@@ -8,3 +8,4 @@ scratchattach/test.py
 scratchattach.code-workspace
 **/.DS_Store
 setup.py
+setup.py

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.1.7
+
+- Fixed self-hosting TW cloud ws servers feature
+- Added sa.translate and sa.text2speech functions
+
 # 2.0.6
 
 Cloud variables: Stability improvement

README.md

@@ -4,7 +4,7 @@ The library allows setting cloud variables, following users, updating your profi
 so much more! Additionally, it provides frameworks that simplify sending data through cloud variables.
 
 <p align="left" style="margin:10px">
-  <img width="160" src="https://github.com/TimMcCool/scratchattach/blob/main/logos/logo.svg">
+  <img width="160" src="https://raw.githubusercontent.com/TimMcCool/scratchattach/refs/heads/main/logos/logo.svg">
 
 [![PyPI status](https://img.shields.io/pypi/status/scratchattach.svg)](https://pypi.python.org/pypi/scratchattach/)
 [![PyPI download month](https://img.shields.io/pypi/dm/scratchattach.svg)](https://pypi.python.org/pypi/scratchattach/)

scratchattach/__init__.py

@@ -10,6 +10,7 @@
 from .other.other_apis import *
 from .other.project_json_capabilities import ProjectBody, get_empty_project_pb, get_pb_from_dict, read_sb3_file, download_asset
 from .utils.encoder import Encoding
+from .utils.enums import Languages, TTSVoices
 
 from .site.activity import Activity
 from .site.backpack_asset import BackpackAsset
@@ -22,3 +23,5 @@
 from .site.classroom import Classroom, get_classroom
 from .site.user import User, get_user
 from .site._base import BaseSiteComponent
+
+from . import editor

scratchattach/cloud/_base.py

@@ -1,60 +1,62 @@
-from abc import ABC, abstractmethod
+from __future__ import annotations
 
-import websocket
 import json
+import ssl
 import time
-from ..utils import exceptions
-import warnings
+from abc import ABC
+
+import websocket
+
 from ..eventhandlers import cloud_recorder
-import ssl
+from ..utils import exceptions
 
-class BaseCloud(ABC):
 
+class BaseCloud(ABC):
     """
     Base class for a project's cloud variables. Represents a cloud.
 
-    When inheriting from this class, the __init__ function of the inherited class ...
-
+    When inheriting from this class, the __init__ function of the inherited class:
     - must first call the constructor of the super class: super().__init__()
-
     - must then set some attributes
 
     Attributes that must be specified in the __init__ function a class inheriting from this one:
+        project_id: Project id of the cloud variables
 
-    :self.project_id: Project id of the cloud variables
-
-    :self.cloud_host: URL of the websocket server ("wss://..." or "ws://...")
+        cloud_host: URL of the websocket server ("wss://..." or "ws://...")
 
     Attributes that can, but don't have to be specified in the __init__ function:
 
-    :self._session: Either None or a site.session.Session object. Defaults to None.
+        _session: Either None or a site.session.Session object. Defaults to None.
 
-    :self.ws_shortterm_ratelimit: The wait time between cloud variable sets. Defaults to 0.1
+        ws_shortterm_ratelimit: The wait time between cloud variable sets. Defaults to 0.1
 
-    :self.ws_longterm_ratelimit: The amount of cloud variable set that can be performed long-term without ever getting ratelimited
+        ws_longterm_ratelimit: The amount of cloud variable set that can be performed long-term without ever getting ratelimited
 
-    :self.allow_non_numeric: Whether non-numeric cloud variable values are allowed. Defaults to False
+        allow_non_numeric: Whether non-numeric cloud variable values are allowed. Defaults to False
 
-    :self.length_limit: Length limit for cloud variable values. Defaults to 100000
+        length_limit: Length limit for cloud variable values. Defaults to 100000
 
-    :self.username: The username to send during handshake. Defaults to "scratchattach"
+        username: The username to send during handshake. Defaults to "scratchattach"
 
-    :self.header: The header to send. Defaults to None
+        header: The header to send. Defaults to None
 
-    :self.cookie: The cookie to send. Defaults to None
+        cookie: The cookie to send. Defaults to None
 
-    :self.origin: The origin to send. Defaults to None
+        origin: The origin to send. Defaults to None
 
-    :self.print_connect_messages: Whether to print a message on every connect to the cloud server. Defaults to False.
+        print_connect_messages: Whether to print a message on every connect to the cloud server. Defaults to False.
     """
 
-    def __init__(self):
+
+    def __init__(self, *, _session=None):
 
         # Required internal attributes that every object representing a cloud needs to have (no matter what cloud is represented):
-        self._session = None
+        self._session = _session
         self.active_connection = False #whether a connection to a cloud variable server is currently established
+
         self.websocket = websocket.WebSocket(sslopt={"cert_reqs": ssl.CERT_NONE})
-        self.recorder = None # A CloudRecorder object that records cloud activity for the values to be retrieved later will be saved in this attribute as soon as .get_var is called
+        self.recorder = None  # A CloudRecorder object that records cloud activity for the values to be retrieved later,
+        # which will be saved in this attribute as soon as .get_var is called
         self.first_var_set = 0
         self.last_var_set = 0
         self.var_stets_since_first = 0
@@ -63,7 +65,8 @@ def __init__(self):
         # (These attributes can be specifically in the constructors of classes inheriting from this base class)
         self.ws_shortterm_ratelimit = 0.06667
         self.ws_longterm_ratelimit = 0.1
-        self.ws_timeout = 3 # Timeout for send operations (after the timeout, the connection will be renewed and the operation will be retried 3 times)
+        self.ws_timeout = 3  # Timeout for send operations (after the timeout,
+        # the connection will be renewed and the operation will be retried 3 times)
         self.allow_non_numeric = False
         self.length_limit = 100000
         self.username = "scratchattach"
@@ -100,7 +103,7 @@ def _send_packet(self, packet):
                         self.websocket.send(json.dumps(packet) + "\n")
                     except Exception:
                         self.active_connection = False
-                        raise exceptions.ConnectionError(f"Sending packet failed three times in a row: {packet}")
+                        raise exceptions.CloudConnectionError(f"Sending packet failed three times in a row: {packet}")
 
     def _send_packet_list(self, packet_list):
         packet_string = "".join([json.dumps(packet) + "\n" for packet in packet_list])
@@ -126,7 +129,8 @@ def _send_packet_list(self, packet_list):
                         self.websocket.send(packet_string)
                     except Exception:
                         self.active_connection = False
-                        raise exceptions.ConnectionError(f"Sending packet list failed four times in a row: {packet_list}")
+                        raise exceptions.CloudConnectionError(
+                            f"Sending packet list failed four times in a row: {packet_list}")
 
     def _handshake(self):
         packet = {"method": "handshake", "user": self.username, "project_id": self.project_id}
@@ -139,8 +143,8 @@ def connect(self):
             cookie=self.cookie,
             origin=self.origin,
             enable_multithread=True,
-            timeout = self.ws_timeout,
-            header = self.header
+            timeout=self.ws_timeout,
+            header=self.header
         )
         self._handshake()
         self.active_connection = True
@@ -166,29 +170,29 @@ def _assert_valid_value(self, value):
         if not (value in [True, False, float('inf'), -float('inf')]):
             value = str(value)
             if len(value) > self.length_limit:
-                raise(exceptions.InvalidCloudValue(
+                raise (exceptions.InvalidCloudValue(
                     f"Value exceeds length limit: {str(value)}"
                 ))
             if not self.allow_non_numeric:
                 x = value.replace(".", "")
                 x = x.replace("-", "")
                 if not (x.isnumeric() or x == ""):
-                    raise(exceptions.InvalidCloudValue(
+                    raise (exceptions.InvalidCloudValue(
                         "Value not numeric"
                     ))
 
     def _enforce_ratelimit(self, *, n):
         # n is the amount of variables being set
-        if (time.time() - self.first_var_set) / (self.var_stets_since_first+1) > self.ws_longterm_ratelimit: # if the average delay between cloud variable sets has been bigger than the long-term rate-limit, cloud variables can be set fast (wait time smaller than long-term rate limit) again
+        if (time.time() - self.first_var_set) / (
+                self.var_stets_since_first + 1) > self.ws_longterm_ratelimit:  # if the average delay between cloud variable sets has been bigger than the long-term rate-limit, cloud variables can be set fast (wait time smaller than long-term rate limit) again
             self.var_stets_since_first = 0
             self.first_var_set = time.time()
 
         wait_time = self.ws_shortterm_ratelimit * n
-        if time.time() - self.first_var_set > 25: # if cloud variables have been continously set fast (wait time smaller than long-term rate limit) for 25 seconds, they should be set slow now (wait time = long-term rate limit) to avoid getting rate-limited
+        if time.time() - self.first_var_set > 25:  # if cloud variables have been continously set fast (wait time smaller than long-term rate limit) for 25 seconds, they should be set slow now (wait time = long-term rate limit) to avoid getting rate-limited
             wait_time = self.ws_longterm_ratelimit * n
         while self.last_var_set + wait_time >= time.time():
             time.sleep(0.001)
-
 
     def set_var(self, variable, value):
         """
@@ -231,7 +235,7 @@ def set_vars(self, var_value_dict, *, intelligent_waits=True):
             self.connect()
         if intelligent_waits:
             self._enforce_ratelimit(n=len(list(var_value_dict.keys())))
-            
+
         self.var_stets_since_first += len(list(var_value_dict.keys()))
 
         packet_list = []
@@ -256,7 +260,7 @@ def get_var(self, var, *, recorder_initial_values={}):
             self.recorder = cloud_recorder.CloudRecorder(self, initial_values=recorder_initial_values)
             self.recorder.start()
             start_time = time.time()
-            while not (self.recorder.cloud_values != {} or start_time < time.time() -5):
+            while not (self.recorder.cloud_values != {} or start_time < time.time() - 5):
                 time.sleep(0.01)
         return self.recorder.get_var(var)
 
@@ -265,17 +269,19 @@ def get_all_vars(self, *, recorder_initial_values={}):
             self.recorder = cloud_recorder.CloudRecorder(self, initial_values=recorder_initial_values)
             self.recorder.start()
             start_time = time.time()
-            while not (self.recorder.cloud_values != {} or start_time < time.time() -5):
+            while not (self.recorder.cloud_values != {} or start_time < time.time() - 5):
                 time.sleep(0.01)
         return self.recorder.get_all_vars()
 
     def events(self):
         from ..eventhandlers.cloud_events import CloudEvents
         return CloudEvents(self)
 
-    def requests(self, *, no_packet_loss=False, used_cloud_vars=["1", "2", "3", "4", "5", "6", "7", "8", "9"], respond_order="receive"):
+    def requests(self, *, no_packet_loss=False, used_cloud_vars=["1", "2", "3", "4", "5", "6", "7", "8", "9"],
+                 respond_order="receive"):
         from ..eventhandlers.cloud_requests import CloudRequests
-        return CloudRequests(self, used_cloud_vars=used_cloud_vars, no_packet_loss=no_packet_loss, respond_order=respond_order)
+        return CloudRequests(self, used_cloud_vars=used_cloud_vars, no_packet_loss=no_packet_loss,
+                             respond_order=respond_order)
 
     def storage(self, *, no_packet_loss=False, used_cloud_vars=["1", "2", "3", "4", "5", "6", "7", "8", "9"]):
         from ..eventhandlers.cloud_storage import CloudStorage

scratchattach/cloud/cloud.py

@@ -1,13 +1,15 @@
 """v2 ready: ScratchCloud, TwCloud and CustomCloud classes"""
 
+from __future__ import annotations
+
 from ._base import BaseCloud
 from typing import Type
 from ..utils.requests import Requests as requests
 from ..utils import exceptions, commons
 from ..site import cloud_activity
 
-class ScratchCloud(BaseCloud):
 
+class ScratchCloud(BaseCloud):
     def __init__(self, *, project_id, _session=None):
         super().__init__()
 
@@ -91,9 +93,10 @@ def events(self, *, use_logs=False):
         else:
             return super().events()
 
-class TwCloud(BaseCloud):
 
-    def __init__(self, *, project_id, cloud_host="wss://clouddata.turbowarp.org", purpose="", contact=""):
+class TwCloud(BaseCloud):
+    def __init__(self, *, project_id, cloud_host="wss://clouddata.turbowarp.org", purpose="", contact="",
+                 _session=None):
         super().__init__()
 
         self.project_id = project_id

scratchattach/editor/__init__.py

@@ -0,0 +1,21 @@
+"""
+scratchattach.editor (sbeditor v2) - a library for all things sb3
+"""
+
+from .asset import Asset, Costume, Sound
+from .project import Project
+from .extension import Extensions, Extension
+from .mutation import Mutation, Argument, parse_proc_code
+from .meta import Meta, set_meta_platform
+from .sprite import Sprite
+from .block import Block
+from .prim import Prim, PrimTypes
+from .backpack_json import load_script as load_script_from_backpack
+from .twconfig import TWConfig, is_valid_twconfig
+from .inputs import Input, ShadowStatuses
+from .field import Field
+from .vlb import Variable, List, Broadcast
+from .comment import Comment
+from .monitor import Monitor
+
+from .build_defaulting import add_chain, add_comment, add_block