Possiblysemver2

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -20,18 +20,12 @@ body:
       label: What happened?
     validations:
       required: true
-  - type: dropdown
-    id: cloudvariables-location
+  - type: textarea
+    id: code
     attributes:
-      label: Cloud variables
-      description: If your bug is based in some form on cloud variables, which cloud variable server did you use? If your bug doesn't have anything to do with cloud variables, submit "No cloud vars"
-      options:
-        - Scratch
-        - TurboWarp
-        - Custom Cloud Server
-        - Other
-        - No cloud vars
-      default: 0
+      label: Your code.
+      description: Put your code here. Be careful not to reveal your login data.
+      render: python
     validations:
       required: true
   - type: textarea

.gitignore

@@ -9,4 +9,5 @@ scratchattach.code-workspace
 **/.DS_Store
 setup.py
 setup.py
-.env
+.env
+tests/manual_tests/**

requirements.txt

@@ -2,3 +2,5 @@ websocket-client
 requests
 bs4
 SimpleWebSocketServer
+typing-extensions
+browser_cookie3

scratchattach/cloud/_base.py

@@ -24,13 +24,13 @@ def close(self) -> None:
 
 import websocket
 
-from ..site import session
-from ..eventhandlers import cloud_recorder
-from ..utils import exceptions
-from ..eventhandlers.cloud_requests import CloudRequests
-from ..eventhandlers.cloud_events import CloudEvents
-from ..eventhandlers.cloud_storage import CloudStorage
-from ..site import cloud_activity
+from scratchattach.site import session
+from scratchattach.eventhandlers import cloud_recorder
+from scratchattach.utils import exceptions
+from scratchattach.eventhandlers.cloud_requests import CloudRequests
+from scratchattach.eventhandlers.cloud_events import CloudEvents
+from scratchattach.eventhandlers.cloud_storage import CloudStorage
+from scratchattach.site import cloud_activity
 
 T = TypeVar("T")
 

scratchattach/cloud/cloud.py

@@ -4,9 +4,9 @@
 
 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
+from scratchattach.utils.requests import requests
+from scratchattach.utils import exceptions, commons
+from scratchattach.site import cloud_activity
 
 
 class ScratchCloud(BaseCloud):
@@ -88,7 +88,7 @@ def get_all_vars(self, *, use_logs=False):
 
     def events(self, *, use_logs=False):
         if self._session is None or use_logs:
-            from ..eventhandlers.cloud_events import CloudLogEvents
+            from scratchattach.eventhandlers.cloud_events import CloudLogEvents
             return CloudLogEvents(self)
         else:
             return super().events()

scratchattach/editor/asset.py

@@ -10,12 +10,19 @@
 
 @dataclass(init=True, repr=True)
 class AssetFile:
+    """
+    Represents the file information for an asset
+    - stores the filename, data, and md5 hash
+    """
     filename: str
-    _data: bytes = field(repr=False, default=None)
-    _md5: str = field(repr=False, default=None)
+    _data: bytes = field(repr=False, default_factory=bytes)
+    _md5: str = field(repr=False, default_factory=str)
 
     @property
     def data(self):
+        """
+        Return the contents of the asset file, as bytes
+        """
         if self._data is None:
             # Download and cache
             rq = requests.get(f"https://assets.scratch.mit.edu/internalapi/asset/{self.filename}/get/")
@@ -28,6 +35,9 @@ def data(self):
 
     @property
     def md5(self):
+        """
+        Compute/retrieve the md5 hash value of the asset file data
+        """
         if self._md5 is None:
             self._md5 = md5(self.data).hexdigest()
 
@@ -38,7 +48,7 @@ class Asset(base.SpriteSubComponent):
     def __init__(self,
                  name: str = "costume1",
                  file_name: str = "b7853f557e4426412e64bb3da6531a99.svg",
-                 _sprite: sprite.Sprite = build_defaulting.SPRITE_DEFAULT):
+                 _sprite: commons.SpriteInput = 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
@@ -60,29 +70,50 @@ def __repr__(self):
 
     @property
     def folder(self):
+        """
+        Get the folder name of this asset, based on the asset name. Uses the turbowarp syntax
+        """
         return commons.get_folder_name(self.name)
 
     @property
     def name_nfldr(self):
+        """
+        Get the asset name after removing the folder name
+        """
         return commons.get_name_nofldr(self.name)
 
     @property
     def file_name(self):
+        """
+        Get the exact file name, as it would be within an sb3 file
+        equivalent to the md5ext value using in scratch project JSON
+        """
         return f"{self.id}.{self.data_format}"
 
     @property
     def md5ext(self):
+        """
+        Get the exact file name, as it would be within an sb3 file
+        equivalent to the md5ext value using in scratch project JSON
+        """
         return self.file_name
 
     @property
     def parent(self):
+        """
+        Return the project that this asset is attached to. If there is no attached project,
+        try returning the attached sprite
+        """
         if self.project is None:
             return self.sprite
         else:
             return self.project
 
     @property
     def asset_file(self) -> AssetFile:
+        """
+        Get the associated asset file object for this asset object
+        """
         for asset_file in self.parent.asset_data:
             if asset_file.filename == self.file_name:
                 return asset_file
@@ -94,17 +125,27 @@ def asset_file(self) -> AssetFile:
 
     @staticmethod
     def from_json(data: dict):
+        """
+        Load asset data from project.json
+        """
         _name = data.get("name")
+        assert isinstance(_name, str)
         _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}"
+            else:
+                _file_name = ""
+        assert isinstance(_file_name, str)
 
         return Asset(_name, _file_name)
 
     def to_json(self) -> dict:
+        """
+        Convert asset data to project.json format
+        """
         return {
             "name": self.name,
 
@@ -113,6 +154,7 @@ def to_json(self) -> dict:
             "dataFormat": self.data_format,
         }
 
+    # todo: implement below:
     """
     @staticmethod
     def from_file(fp: str, name: str = None):
@@ -132,9 +174,9 @@ def __init__(self,
                  bitmap_resolution=None,
                  rotation_center_x: int | float = 48,
                  rotation_center_y: int | float = 50,
-                 _sprite: sprite.Sprite = build_defaulting.SPRITE_DEFAULT):
+                 _sprite: commons.SpriteInput = build_defaulting.SPRITE_DEFAULT):
         """
-        A costume. An asset with additional properties
+        A costume (image). An asset with additional properties
         https://en.scratch-wiki.info/wiki/Scratch_File_Format#Costumes
         """
         super().__init__(name, file_name, _sprite)
@@ -145,6 +187,9 @@ def __init__(self,
 
     @staticmethod
     def from_json(data):
+        """
+        Load costume data from project.json
+        """
         _asset_load = Asset.from_json(data)
 
         bitmap_resolution = data.get("bitmapResolution")
@@ -156,6 +201,9 @@ def from_json(data):
                        bitmap_resolution, rotation_center_x, rotation_center_y)
 
     def to_json(self) -> dict:
+        """
+        Convert costume to project.json format
+        """
         _json = super().to_json()
         _json.update({
             "bitmapResolution": self.bitmap_resolution,
@@ -184,13 +232,19 @@ def __init__(self,
 
     @staticmethod
     def from_json(data):
+        """
+        Load sound from project.json
+        """
         _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:
+        """
+        Convert Sound to project.json format
+        """
         _json = super().to_json()
         commons.noneless_update(_json, {
             "rate": self.rate,