scratchattach 2.1.9__py3-none-any.whl → 2.1.10a1__py3-none-any.whl

scratchattach/cloud/cloud.py

@@ -1,168 +1,171 @@
-"""v2 ready: ScratchCloud, TwCloud and CustomCloud classes"""
-
-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):
-
-    def __init__(self, *, project_id, _session=None):
-        super().__init__()
-        
-        self.project_id = project_id
-
-        # Configure this object's attributes specifically for being used with Scratch's cloud:
-        self.cloud_host = "wss://clouddata.scratch.mit.edu"
-        self.length_limit = 256
-        self._session = _session
-        if self._session is not None:
-            self.username = self._session.username
-            self.cookie = "scratchsessionsid=" + self._session.id + ";"
-            self.origin = "https://scratch.mit.edu"
-
-    def connect(self):
-        self._assert_auth() # Connecting to Scratch's cloud websocket requires a login to the Scratch website
-        super().connect()
-
-    def set_var(self, variable, value):
-        self._assert_auth() # Setting a cloud var requires a login to the Scratch website
-        super().set_var(variable, value)
-    
-    def set_vars(self, var_value_dict, *, intelligent_waits=True):
-        self._assert_auth() 
-        super().set_vars(var_value_dict, intelligent_waits=intelligent_waits)
-
-    def logs(self, *, filter_by_var_named=None, limit=100, offset=0):
-        """
-        Gets the data from Scratch's clouddata logs.
-        
-        Keyword Arguments:
-            filter_by_var_named (str or None): If you only want to get data for one cloud variable, set this argument to its name.
-            limit (int): Max. amount of returned activity.
-            offset (int): Offset of the first activity in the returned list.
-            log_url (str): If you want to get the clouddata from a cloud log API different to Scratch's normal cloud log API, set this argument to the URL of the API. Only set this argument if you know what you are doing. If you want to get the clouddata from the normal API, don't put this argument.
-        """
-        try:
-            data = requests.get(f"https://clouddata.scratch.mit.edu/logs?projectid={self.project_id}&limit={limit}&offset={offset}", timeout=10).json()
-            if filter_by_var_named is not None:
-                data = list(filter(lambda k: k["name"] == "☁ "+filter_by_var_named, data))
-            for x in data:
-                x["cloud"] = self
-                x["name"] = x["name"][2:]
-            return commons.parse_object_list(data, cloud_activity.CloudActivity, self._session, "name")
-        except Exception as e:
-            return exceptions.FetchError(str(e))
-
-    def get_var(self, var, *, use_logs=False):
-        if self._session is None or use_logs:
-            logs = self.logs(limit=100)
-            filtered = list(filter(lambda k: k.name == "☁ "+var, logs))
-            if len(filtered) == 0:
-                return None
-            return filtered[0].value
-        else:
-            if self.recorder is None:
-                initial_values = self.get_all_vars(use_logs=True)
-                return super().get_var(var, recorder_initial_values=initial_values)
-            else:
-                return super().get_var(var)
-
-    def get_all_vars(self, *, use_logs=False):
-        if self._session is None or use_logs:
-            logs = self.logs(limit=100)
-            logs.reverse()
-            clouddata = {}
-            for activity in logs:
-                clouddata[activity.name.replace("☁ ", "")] = activity.value
-            return clouddata
-        else:
-            if self.recorder is None:
-                initial_values = self.get_all_vars(use_logs=True)
-                return super().get_all_vars(recorder_initial_values=initial_values)
-            else:
-                return super().get_all_vars()
-
-    def events(self, *, use_logs=False):
-        if self._session is None or use_logs:
-            from ..eventhandlers.cloud_events import CloudLogEvents
-            return CloudLogEvents(self)
-        else:
-            return super().events()
-
-class TwCloud(BaseCloud):
-
-    def __init__(self, *, project_id, cloud_host="wss://clouddata.turbowarp.org", purpose="", contact=""):
-        super().__init__()
-        
-        self.project_id = project_id
-        
-        # Configure this object's attributes specifically for being used with TurboWarp's cloud:
-        self.cloud_host = cloud_host
-        self.ws_shortterm_ratelimit = 0 # TurboWarp doesn't enforce a wait time between cloud variable sets
-        self.ws_longterm_ratelimit = 0
-        self.length_limit = 100000 # TurboWarp doesn't enforce a cloud variable length
-        purpose_string = ""
-        if purpose != "" or contact != "":
-            purpose_string = f" (Purpose:{purpose}; Contact:{contact})"
-        self.header = {"User-Agent":f"scratchattach/2.0.0{purpose_string}"}
-
-class CustomCloud(BaseCloud):
-
-    def __init__(self, *, project_id, cloud_host, **kwargs):
-        super().__init__()
-        
-        self.project_id = project_id
-        self.cloud_host = cloud_host
-
-        # Configure this object's attributes specifically for the cloud that the developer wants to connect to:
-        # -> For this purpose, all additional keyword arguments (kwargs) will be set as attributes of the CustomCloud object
-        # This allows the maximum amount of attribute customization
-        # See the docstring for the cloud._base.BaseCloud class to find out what attributes can be set / specified as keyword args
-        self.__dict__.update(kwargs)
-
-        # If even more customization is needed, the developer can create a class inheriting from cloud._base.BaseCloud to override functions like .set_var etc.
-
-
-def get_cloud(project_id, *, CloudClass:Type[BaseCloud]=ScratchCloud) -> Type[BaseCloud]:
-    """
-    Connects to a cloud (by default Scratch's cloud) as logged out user.
-
-    Warning:
-        Since this method doesn't connect a login / session to the returned object, setting Scratch cloud variables won't be possible with it.
-
-        To set Scratch cloud variables, use `scratchattach.Session.connect_scratch_cloud` instead.
-
-    Args:
-        project_id:
-    
-    Keyword arguments:
-        CloudClass: The class that the returned object should be of. By default this class is scratchattach.cloud.ScratchCloud.
-
-    Returns:
-        Type[scratchattach._base.BaseCloud]: An object representing the cloud of a project. Can be of any class inheriting from BaseCloud.
-    """
-    print("Warning: To set Scratch cloud variables, use session.connect_cloud instead of get_cloud")
-    return CloudClass(project_id=project_id)
-
-def get_scratch_cloud(project_id):
-    """
-    Warning:
-        Since this method doesn't connect a login / session to the returned object, setting Scratch cloud variables won't be possible with it.
-
-        To set Scratch cloud variables, use `scratchattach.Session.connect_scratch_cloud` instead.
-
-        
-    Returns:
-        scratchattach.cloud.ScratchCloud: An object representing the Scratch cloud of a project.
-    """
-    print("Warning: To set Scratch cloud variables, use session.connect_scratch_cloud instead of get_scratch_cloud")
-    return ScratchCloud(project_id=project_id)
-
-def get_tw_cloud(project_id, *, purpose="", contact="", cloud_host="wss://clouddata.turbowarp.org"):
-    """
-    Returns:
-        scratchattach.cloud.TwCloud: An object representing the TurboWarp cloud of a project.
-    """
-    return TwCloud(project_id=project_id, purpose=purpose, contact=contact, cloud_host=cloud_host)
+"""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):
+    def __init__(self, *, project_id, _session=None):
+        super().__init__()
+        
+        self.project_id = project_id
+
+        # Configure this object's attributes specifically for being used with Scratch's cloud:
+        self.cloud_host = "wss://clouddata.scratch.mit.edu"
+        self.length_limit = 256
+        self._session = _session
+        if self._session is not None:
+            self.username = self._session.username
+            self.cookie = "scratchsessionsid=" + self._session.id + ";"
+            self.origin = "https://scratch.mit.edu"
+
+    def connect(self):
+        self._assert_auth() # Connecting to Scratch's cloud websocket requires a login to the Scratch website
+        super().connect()
+
+    def set_var(self, variable, value):
+        self._assert_auth() # Setting a cloud var requires a login to the Scratch website
+        super().set_var(variable, value)
+    
+    def set_vars(self, var_value_dict, *, intelligent_waits=True):
+        self._assert_auth() 
+        super().set_vars(var_value_dict, intelligent_waits=intelligent_waits)
+
+    def logs(self, *, filter_by_var_named=None, limit=100, offset=0) -> list[cloud_activity.CloudActivity]:
+        """
+        Gets the data from Scratch's clouddata logs.
+        
+        Keyword Arguments:
+            filter_by_var_named (str or None): If you only want to get data for one cloud variable, set this argument to its name.
+            limit (int): Max. amount of returned activity.
+            offset (int): Offset of the first activity in the returned list.
+            log_url (str): If you want to get the clouddata from a cloud log API different to Scratch's normal cloud log API, set this argument to the URL of the API. Only set this argument if you know what you are doing. If you want to get the clouddata from the normal API, don't put this argument.
+        """
+        try:
+            data = requests.get(f"https://clouddata.scratch.mit.edu/logs?projectid={self.project_id}&limit={limit}&offset={offset}", timeout=10).json()
+            if filter_by_var_named is not None:
+                filter_by_var_named = filter_by_var_named.removeprefix("☁ ")
+                data = list(filter(lambda k: k["name"] == "☁ "+filter_by_var_named, data))
+            for x in data:
+                x["cloud"] = self
+            return commons.parse_object_list(data, cloud_activity.CloudActivity, self._session, "name")
+        except Exception as e:
+            raise exceptions.FetchError(str(e))
+
+    def get_var(self, var, *, use_logs=False):
+        var = var.removeprefix("☁ ")
+        if self._session is None or use_logs:
+            filtered = self.logs(limit=100, filter_by_var_named="☁ "+var)
+            if len(filtered) == 0:
+                return None
+            return filtered[0].value
+        else:
+            if self.recorder is None:
+                initial_values = self.get_all_vars(use_logs=True)
+                return super().get_var("☁ "+var, recorder_initial_values=initial_values)
+            else:
+                return super().get_var("☁ "+var)
+
+    def get_all_vars(self, *, use_logs=False):
+        if self._session is None or use_logs:
+            logs = self.logs(limit=100)
+            logs.reverse()
+            clouddata = {}
+            for activity in logs:
+                clouddata[activity.name] = activity.value
+            return clouddata
+        else:
+            if self.recorder is None:
+                initial_values = self.get_all_vars(use_logs=True)
+                return super().get_all_vars(recorder_initial_values=initial_values)
+            else:
+                return super().get_all_vars()
+
+    def events(self, *, use_logs=False):
+        if self._session is None or use_logs:
+            from ..eventhandlers.cloud_events import CloudLogEvents
+            return CloudLogEvents(self)
+        else:
+            return super().events()
+
+
+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
+        
+        # Configure this object's attributes specifically for being used with TurboWarp's cloud:
+        self.cloud_host = cloud_host
+        self.ws_shortterm_ratelimit = 0 # TurboWarp doesn't enforce a wait time between cloud variable sets
+        self.ws_longterm_ratelimit = 0
+        self.length_limit = 100000 # TurboWarp doesn't enforce a cloud variable length
+        purpose_string = ""
+        if purpose != "" or contact != "":
+            purpose_string = f" (Purpose:{purpose}; Contact:{contact})"
+        self.header = {"User-Agent":f"scratchattach/2.0.0{purpose_string}"}
+
+class CustomCloud(BaseCloud):
+
+    def __init__(self, *, project_id, cloud_host, **kwargs):
+        super().__init__()
+        
+        self.project_id = project_id
+        self.cloud_host = cloud_host
+
+        # Configure this object's attributes specifically for the cloud that the developer wants to connect to:
+        # -> For this purpose, all additional keyword arguments (kwargs) will be set as attributes of the CustomCloud object
+        # This allows the maximum amount of attribute customization
+        # See the docstring for the cloud._base.BaseCloud class to find out what attributes can be set / specified as keyword args
+        self.__dict__.update(kwargs)
+
+        # If even more customization is needed, the developer can create a class inheriting from cloud._base.BaseCloud to override functions like .set_var etc.
+
+
+def get_cloud(project_id, *, CloudClass:Type[BaseCloud]=ScratchCloud) -> BaseCloud:
+    """
+    Connects to a cloud (by default Scratch's cloud) as logged out user.
+
+    Warning:
+        Since this method doesn't connect a login / session to the returned object, setting Scratch cloud variables won't be possible with it.
+
+        To set Scratch cloud variables, use `scratchattach.site.session.Session.connect_scratch_cloud` instead.
+
+    Args:
+        project_id:
+    
+    Keyword arguments:
+        CloudClass: The class that the returned object should be of. By default this class is scratchattach.cloud.ScratchCloud.
+
+    Returns:
+        Type[scratchattach.cloud._base.BaseCloud]: An object representing the cloud of a project. Can be of any class inheriting from BaseCloud.
+    """
+    print("Warning: To set Scratch cloud variables, use session.connect_cloud instead of get_cloud")
+    return CloudClass(project_id=project_id)
+
+def get_scratch_cloud(project_id):
+    """
+    Warning:
+        Since this method doesn't connect a login / session to the returned object, setting Scratch cloud variables won't be possible with it.
+
+        To set Scratch cloud variables, use `scratchattach.Session.connect_scratch_cloud` instead.
+
+        
+    Returns:
+        scratchattach.cloud.ScratchCloud: An object representing the Scratch cloud of a project.
+    """
+    print("Warning: To set Scratch cloud variables, use session.connect_scratch_cloud instead of get_scratch_cloud")
+    return ScratchCloud(project_id=project_id)
+
+def get_tw_cloud(project_id, *, purpose="", contact="", cloud_host="wss://clouddata.turbowarp.org"):
+    """
+    Returns:
+        scratchattach.cloud.TwCloud: An object representing the TurboWarp cloud of a project.
+    """
+    return TwCloud(project_id=project_id, purpose=purpose, contact=contact, cloud_host=cloud_host)

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

scratchattach/editor/asset.py

@@ -0,0 +1,199 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from hashlib import md5
+import requests
+
+from . import base, commons, sprite, build_defaulting
+from typing import Optional
+
+
+@dataclass(init=True, repr=True)
+class AssetFile:
+    filename: str
+    _data: bytes = field(repr=False, default=None)
+    _md5: str = field(repr=False, default=None)
+
+    @property
+    def data(self):
+        if self._data is None:
+            # Download and cache
+            rq = requests.get(f"https://assets.scratch.mit.edu/internalapi/asset/{self.filename}/get/")
+            if rq.status_code != 200:
+                raise ValueError(f"Can't download asset {self.filename}\nIs not uploaded to scratch! Response: {rq.text}")
+
+            self._data = rq.content
+
+        return self._data
+
+    @property
+    def md5(self):
+        if self._md5 is None:
+            self._md5 = md5(self.data).hexdigest()
+
+        return self._md5
+
+
+class Asset(base.SpriteSubComponent):
+    def __init__(self,
+                 name: str = "costume1",
+                 file_name: str = "b7853f557e4426412e64bb3da6531a99.svg",
+                 _sprite: sprite.Sprite = build_defaulting.SPRITE_DEFAULT):
+        """
+        Represents a generic asset. Can be a sound or an image.
+        https://en.scratch-wiki.info/wiki/Scratch_File_Format#Assets
+        """
+        try:
+            asset_id, data_format = file_name.split('.')
+        except ValueError:
+            raise ValueError(f"Invalid file name: {file_name}, # of '.' in {file_name} ({file_name.count('.')}) != 2; "
+                             f"(too many/few values to unpack)")
+        self.name = name
+
+        self.id = asset_id
+        self.data_format = data_format
+
+        super().__init__(_sprite)
+
+    def __repr__(self):
+        return f"Asset<{self.name!r}>"
+
+    @property
+    def folder(self):
+        return commons.get_folder_name(self.name)
+
+    @property
+    def name_nfldr(self):
+        return commons.get_name_nofldr(self.name)
+
+    @property
+    def file_name(self):
+        return f"{self.id}.{self.data_format}"
+
+    @property
+    def md5ext(self):
+        return self.file_name
+
+    @property
+    def parent(self):
+        if self.project is None:
+            return self.sprite
+        else:
+            return self.project
+
+    @property
+    def asset_file(self) -> AssetFile:
+        for asset_file in self.parent.asset_data:
+            if asset_file.filename == self.file_name:
+                return asset_file
+
+        # No pre-existing asset file object; create one and add it to the project
+        asset_file = AssetFile(self.file_name)
+        self.project.asset_data.append(asset_file)
+        return asset_file
+
+    @staticmethod
+    def from_json(data: dict):
+        _name = data.get("name")
+        _file_name = data.get("md5ext")
+        if _file_name is None:
+            if "dataFormat" in data and "assetId" in data:
+                _id = data["assetId"]
+                _data_format = data["dataFormat"]
+                _file_name = f"{_id}.{_data_format}"
+
+        return Asset(_name, _file_name)
+
+    def to_json(self) -> dict:
+        return {
+            "name": self.name,
+
+            "assetId": self.id,
+            "md5ext": self.file_name,
+            "dataFormat": self.data_format,
+        }
+
+    """
+    @staticmethod
+    def from_file(fp: str, name: str = None):
+        image_types = ("png", "jpg", "jpeg", "svg")
+        sound_types = ("wav", "mp3")
+        
+        # Should save data as well so it can be uploaded to scratch if required (add to project asset data)
+        ...
+    """
+
+
+class Costume(Asset):
+    def __init__(self,
+                 name: str = "Cat",
+                 file_name: str = "b7853f557e4426412e64bb3da6531a99.svg",
+
+                 bitmap_resolution=None,
+                 rotation_center_x: int | float = 48,
+                 rotation_center_y: int | float = 50,
+                 _sprite: sprite.Sprite = build_defaulting.SPRITE_DEFAULT):
+        """
+        A costume. An asset with additional properties
+        https://en.scratch-wiki.info/wiki/Scratch_File_Format#Costumes
+        """
+        super().__init__(name, file_name, _sprite)
+
+        self.bitmap_resolution = bitmap_resolution
+        self.rotation_center_x = rotation_center_x
+        self.rotation_center_y = rotation_center_y
+
+    @staticmethod
+    def from_json(data):
+        _asset_load = Asset.from_json(data)
+
+        bitmap_resolution = data.get("bitmapResolution")
+
+        rotation_center_x = data["rotationCenterX"]
+        rotation_center_y = data["rotationCenterY"]
+        return Costume(_asset_load.name, _asset_load.file_name,
+
+                       bitmap_resolution, rotation_center_x, rotation_center_y)
+
+    def to_json(self) -> dict:
+        _json = super().to_json()
+        _json.update({
+            "bitmapResolution": self.bitmap_resolution,
+            "rotationCenterX": self.rotation_center_x,
+            "rotationCenterY": self.rotation_center_y
+        })
+        return _json
+
+
+class Sound(Asset):
+    def __init__(self,
+                 name: str = "pop",
+                 file_name: str = "83a9787d4cb6f3b7632b4ddfebf74367.wav",
+
+                 rate: Optional[int] = None,
+                 sample_count: Optional[int] = None,
+                 _sprite: sprite.Sprite = build_defaulting.SPRITE_DEFAULT):
+        """
+        A sound. An asset with additional properties
+        https://en.scratch-wiki.info/wiki/Scratch_File_Format#Sounds
+        """
+        super().__init__(name, file_name, _sprite)
+
+        self.rate = rate
+        self.sample_count = sample_count
+
+    @staticmethod
+    def from_json(data):
+        _asset_load = Asset.from_json(data)
+
+        rate = data.get("rate")
+        sample_count = data.get("sampleCount")
+        return Sound(_asset_load.name, _asset_load.file_name, rate, sample_count)
+
+    def to_json(self) -> dict:
+        _json = super().to_json()
+        commons.noneless_update(_json, {
+            "rate": self.rate,
+            "sampleCount": self.sample_count
+        })
+        return _json