scratchattach 3.0.0b0__py3-none-any.whl → 3.0.0b2__py3-none-any.whl

scratchattach/utils/requests.py

@@ -0,0 +1,306 @@
+from __future__ import annotations
+
+from collections.abc import MutableMapping, Iterator
+from abc import ABC, abstractmethod
+from types import TracebackType
+from typing import Optional, Any, Self, Union
+from contextlib import contextmanager
+from enum import Enum, auto
+from dataclasses import dataclass, field
+import json
+
+from aiohttp.cookiejar import DummyCookieJar
+from typing_extensions import override
+from requests import Session as HTTPSession
+from requests import Response
+import aiohttp
+
+from . import exceptions
+from . import optional_async
+
+proxies: Optional[MutableMapping[str, str]] = None
+
+class HTTPMethod(Enum):
+    GET = auto()
+    POST = auto()
+    PUT = auto()
+    DELETE = auto()
+    HEAD = auto()
+    OPTIONS = auto()
+    PATCH = auto()
+    TRACE = auto()
+    @classmethod
+    def of(cls, name: str) -> HTTPMethod:
+        member_map = {
+            "GET": cls.GET,
+            "POST": cls.POST,
+            "PUT": cls.PUT,
+            "DELETE": cls.DELETE,
+            "HEAD": cls.HEAD,
+            "OPTIONS": cls.OPTIONS,
+            "PATCH": cls.PATCH,
+            "TRACE": cls.TRACE
+        }
+        return member_map[name]
+
+class AnyHTTPResponse(ABC):
+    request_method: HTTPMethod
+    status_code: int
+    content: bytes
+    text: str
+    headers: dict[str, str]
+    
+    def json(self) -> Any:
+        return json.loads(self.text)
+
+@dataclass
+class HTTPResponse(AnyHTTPResponse):
+    request_method: HTTPMethod = field(kw_only=True)
+    status_code: int = field(kw_only=True)
+    content: bytes = field(kw_only=True)
+    text: str = field(kw_only=True)
+    headers: dict[str, str] = field(kw_only=True)
+
+class OAHTTPSession(ABC):
+    error_handling: bool = True
+    @abstractmethod
+    def sync_request(
+        self,
+        method: HTTPMethod,
+        url: str,
+        *,
+        cookies: Optional[dict[str, str]] = None,
+        headers: Optional[dict[str, str]] = None,
+        params: Optional[dict[str, str]] = None,
+        data: Optional[Union[dict[str, str], str]] = None,
+        json: Optional[Any] = None
+    ) -> AnyHTTPResponse:
+        pass
+    
+    @abstractmethod
+    async def async_request(
+        self,
+        method: HTTPMethod,
+        url: str,
+        *,
+        cookies: Optional[dict[str, str]] = None,
+        headers: Optional[dict[str, str]] = None,
+        params: Optional[dict[str, str]] = None,
+        data: Optional[Union[dict[str, str], str]] = None,
+        json: Optional[Any] = None
+    ) -> AnyHTTPResponse:
+        pass
+
+    def check_response(self, r: AnyHTTPResponse):
+        if r.status_code == 403 or r.status_code == 401:
+            raise exceptions.Unauthorized(f"Request content: {r.content!r}")
+        if r.status_code == 500:
+            raise exceptions.APIError("Internal Scratch server error")
+        if r.status_code == 429:
+            raise exceptions.Response429("You are being rate-limited (or blocked) by Scratch")
+        if r.json() == {"code":"BadRequest","message":""}:
+            raise exceptions.BadRequest("Make sure all provided arguments are valid")
+    
+    
+    def request(
+        self,
+        method: Union[HTTPMethod, str],
+        url: str,
+        *,
+        cookies: Optional[dict[str, str]] = None,
+        headers: Optional[dict[str, str]] = None,
+        params: Optional[dict[str, str]] = None,
+        data: Optional[Union[dict[str, str], str]] = None,
+        json: Optional[Any] = None
+    ) -> optional_async.CARequest:
+        if isinstance(method, str):
+            method = HTTPMethod.of(method.upper())
+        return optional_async.CARequest(
+            self,
+            method,
+            url,
+            cookies = cookies,
+            headers = headers,
+            params = params,
+            data = data,
+            json = json
+        )
+    
+    @contextmanager
+    def no_error_handling(self) -> Iterator[None]:
+        val_before = self.error_handling
+        self.error_handling = False
+        try:
+            yield
+        finally:
+            self.error_handling = val_before
+    
+    @contextmanager
+    def yes_error_handling(self) -> Iterator[None]:
+        val_before = self.error_handling
+        self.error_handling = True
+        try:
+            yield
+        finally:
+            self.error_handling = val_before
+
+class SyncRequests(OAHTTPSession):
+    @override
+    def sync_request(self, method, url, *, cookies = None, headers = None, params = None, data = None, json = None):
+        try:
+            r = requests.request(
+                method.name,
+                url,
+                cookies = cookies,
+                headers = headers,
+                params = params,
+                data = data,
+                json = json,
+                proxies = proxies
+            )
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        response = HTTPResponse(
+            request_method=method,
+            status_code=r.status_code,
+            content=r.content,
+            text=r.text,
+            headers=r.headers
+        )
+        if self.error_handling:
+            self.check_response(response)
+        return response
+    
+    async def async_request(self, method, url, *, cookies = None, headers = None, params = None, data = None, json = None):
+        raise NotImplementedError()
+
+class AsyncRequests(OAHTTPSession):
+    client_session: aiohttp.ClientSession
+    async def __aenter__(self) -> Self:
+        self.client_session = await aiohttp.ClientSession(cookie_jar=DummyCookieJar()).__aenter__()
+        return self
+    
+    async def __aexit__(
+        self,
+        exc_type: Optional[type[BaseException]] = None,
+        exc_val: Optional[BaseException] = None,
+        exc_tb: Optional[TracebackType] = None
+    ) -> None:
+        await self.client_session.__aexit__(exc_type, exc_val, exc_tb)
+    
+    @override
+    def sync_request(self, method, url, *, cookies = None, headers = None, params = None, data = None, json = None):
+        raise NotImplementedError()
+    
+    async def async_request(self, method, url, *, cookies = None, headers = None, params = None, data = None, json = None):
+        proxy = None
+        if url.startswith("http"):
+            proxy = proxies.get("http")
+        if url.startswith("https"):
+            proxy = proxies.get("https")
+        async with self.client_session.request(
+            method.name,
+            url,
+            cookies = cookies,
+            headers = headers,
+            params = params,
+            data = data,
+            json = json,
+            proxy = proxy
+        ) as resp:
+            assert isinstance(resp, aiohttp.ClientResponse)
+            content = await resp.read()
+            try:
+                text = content.decode(resp.get_encoding())
+            except Exception:
+                text = ""
+            response = HTTPResponse(
+                request_method=method,
+                status_code=resp.status,
+                content=content,
+                text=text,
+                headers=resp.headers
+            )
+            if self.error_handling:
+                self.check_response(response)
+            return response
+
+class Requests(HTTPSession):
+    """
+    Centralized HTTP request handler (for better error handling and proxies)
+    """
+    error_handling: bool = True
+
+    def check_response(self, r: Response):
+        if r.status_code == 403 or r.status_code == 401:
+            raise exceptions.Unauthorized(f"Request content: {r.content!r}")
+        if r.status_code == 500:
+            raise exceptions.APIError("Internal Scratch server error")
+        if r.status_code == 429:
+            raise exceptions.Response429("You are being rate-limited (or blocked) by Scratch")
+        if r.json() == {"code":"BadRequest","message":""}:
+            raise exceptions.BadRequest("Make sure all provided arguments are valid")
+
+    @override
+    def get(self, *args, **kwargs):
+        kwargs.setdefault("proxies", proxies)
+        try:
+            r = super().get(*args, **kwargs)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        if self.error_handling:
+            self.check_response(r)
+        return r
+
+    @override
+    def post(self, *args, **kwargs):
+        kwargs.setdefault("proxies", proxies)
+        try:
+            r = super().post(*args, **kwargs)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        if self.error_handling:
+            self.check_response(r)
+        return r
+
+    @override
+    def delete(self, *args, **kwargs):
+        kwargs.setdefault("proxies", proxies)
+        try:
+            r = super().delete(*args, **kwargs)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        if self.error_handling:
+            self.check_response(r)
+        return r
+
+    @override
+    def put(self, *args, **kwargs):
+        kwargs.setdefault("proxies", proxies)
+        try:
+            r = super().put(*args, **kwargs)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        if self.error_handling:
+            self.check_response(r)
+        return r
+    
+    @contextmanager
+    def no_error_handling(self) -> Iterator[None]:
+        val_before = self.error_handling
+        self.error_handling = False
+        try:
+            yield
+        finally:
+            self.error_handling = val_before
+    
+    @contextmanager
+    def yes_error_handling(self) -> Iterator[None]:
+        val_before = self.error_handling
+        self.error_handling = True
+        try:
+            yield
+        finally:
+            self.error_handling = val_before
+
+requests = Requests()

{scratchattach-3.0.0b0.dist-info → scratchattach-3.0.0b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scratchattach
-Version: 3.0.0b0
+Version: 3.0.0b2
 Summary: A Scratch API Wrapper
 Author: TimMcCool
 License-Expression: MIT

scratchattach-3.0.0b2.dist-info/RECORD

@@ -0,0 +1,81 @@
+scratchattach/__init__.py,sha256=K26DsJHYlj7atN0WVQOmtN7d1rNAnmLcO3ljA1UD1lc,1849
+scratchattach/__main__.py,sha256=K520LnmXe5WAlr8UZQE1Owrm8BDncy19QQ5GJ75V9FM,4054
+scratchattach/cli/__about__.py,sha256=rWWgBXhOQakEGEip4jZgZsmGHkIU08m01PRgPUfmHdg,17
+scratchattach/cli/__init__.py,sha256=WAJmqnZi5RoJGlx3fngQAi9APNf84QlicncbsPRwhkg,700
+scratchattach/cli/context.py,sha256=7m9i-J2j36MN8uPJm8ydjMFKWZjJQAyu5NBluL8eQUE,4950
+scratchattach/cli/db.py,sha256=sV-AwyYc8WeHalpadAV1vD0HXkEmZrcvhLGJA0q0TD0,1920
+scratchattach/cli/namespace.py,sha256=qWH1QI9ot-5Y1ahpY9JHw8HTGnlFwHRKLoKxvxFqk5A,445
+scratchattach/cli/cmd/__init__.py,sha256=KiNP3GVwCf-NE_yzYgDvza3hR3Sr1B0-wqu5Xaxi_g4,110
+scratchattach/cli/cmd/group.py,sha256=j8jqy2N4KEChe6cUus5MczoqGKDzjOIgG2mBmxVmb-A,4144
+scratchattach/cli/cmd/login.py,sha256=BnPUCUDG58gNly76OZdBT22oxaZY50b_VHnQWx2p40I,1914
+scratchattach/cli/cmd/profile.py,sha256=jT-JoJhFCtzbyskdQpi8_ckVzrVqDghlh-zEEEchFDI,172
+scratchattach/cli/cmd/sessions.py,sha256=JzBx6BTjddqU-UGZz4CtYpBKb9CC7lbpXLk19Pz7Zoo,116
+scratchattach/cloud/__init__.py,sha256=MN7s4grQcciqUO7TiFjTbU2sC69m6XXlwOHNRbN3FKo,41
+scratchattach/cloud/_base.py,sha256=tXVWPsL9Ybvu2H0zQ5R9GexgeHAarEv4GS16foD3_qw,19251
+scratchattach/cloud/cloud.py,sha256=zq0Z-N2EF2uUxpJ0uZlITY2DeKkjb3TxwK_etci-xCM,8470
+scratchattach/editor/__init__.py,sha256=pdq-dg7fa4cj6eksu5yzUe27DGY6CLKVUtCSrbYCsM8,807
+scratchattach/editor/asset.py,sha256=Ut_Em2rzlzswi2aDTvyRZWvF5JKLY8IAmoLMOQLBpjQ,8148
+scratchattach/editor/backpack_json.py,sha256=zhNRKDmlA9Oz-IixjLRnSwVG6JfKURs31KhQPjJu_bs,3880
+scratchattach/editor/base.py,sha256=MUQ4zqw-IaFZDH9o_F9k7F3mptymR67E8ITkaMfnD5M,5311
+scratchattach/editor/block.py,sha256=2UKKQbrDdsI6dbswo2swvIr7jXiXA114TCtXDO9DSFw,19085
+scratchattach/editor/blockshape.py,sha256=Q8CAWsBc2O5VqcGhUxbJoW1RRfy7kBxz1AporkExBi8,25318
+scratchattach/editor/build_defaulting.py,sha256=rRDSXpIugWENYs6X50A_a3BJfWJuzEtwW1bv9IAyo-M,1421
+scratchattach/editor/comment.py,sha256=G_eFxeaC_vKbCFpDfw4oZxIReUBoBUaCA5q35O-AW6Y,2403
+scratchattach/editor/commons.py,sha256=0mm30KjAenl_V2BXbkdirFN62SraYfGUariXB-TXNlU,3583
+scratchattach/editor/extension.py,sha256=PFVl5SrS66M4Md98I_dsfeL9BLeWwvyWezmhnTRseIQ,1541
+scratchattach/editor/field.py,sha256=_AmBwrb5TeG_CRm312I69T2xXlzuKYeudpygPyA4698,2994
+scratchattach/editor/inputs.py,sha256=bmCLsxgGimkESbKEnhsnw_ZSRpBDsWRIcEoYPFMx9Zs,4505
+scratchattach/editor/meta.py,sha256=QCHk5DKvYAw7F5Gg4OIJNcB7PhK8u5YgfDmGQPWobTs,3330
+scratchattach/editor/monitor.py,sha256=A30XadTjw_G0KsTnwo3YEI31nkplc1DnO8AirjmB3zc,5921
+scratchattach/editor/mutation.py,sha256=o2msH-s6UxFZ-LuYF1BlR4CBm-ulKTVpStux54cxnDk,12246
+scratchattach/editor/pallete.py,sha256=OY76grzJLUWsAKi2x-mipEXv5f-9I-s9UjoLZ3FmtBM,2299
+scratchattach/editor/prim.py,sha256=v74mkdLwsXAKPy_KPesugv-xCxA6YcGU6_v7Zvc2YEY,5919
+scratchattach/editor/project.py,sha256=tWf9kULlJjMCV1t5AofIDFqGylBYQ31vpjDMJ3jM3_Q,12884
+scratchattach/editor/sprite.py,sha256=M_rrkErJswH9stKvrywrkaoNEwgRBbF7-Si17W-0vTs,21205
+scratchattach/editor/twconfig.py,sha256=iE6ylAsZzniAfhL09GkZSFn1XacYtCQPzRCUSPIBzDA,3324
+scratchattach/editor/vlb.py,sha256=Fl2gGwZyYh54uOhQ7XITfCgCpJTQB2P8wy47PKY3Qyk,4151
+scratchattach/editor/code_translation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scratchattach/editor/code_translation/parse.py,sha256=FjuHVg_tNzkGcGSNwgH6MzAHcf5YCvaEUSYukyJkwbk,4932
+scratchattach/eventhandlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scratchattach/eventhandlers/_base.py,sha256=97vFbuhSoJeYb-jrEWDdbZWQ7e_54CY3ktrq8d_-w8g,3142
+scratchattach/eventhandlers/cloud_events.py,sha256=LDENLVopVwKDVrcfkR1spKzT45ET-EKqBdtCzXoaS5g,5228
+scratchattach/eventhandlers/cloud_recorder.py,sha256=dvob4-aKLxE9WFqvCNv28M_r3r3OEkET6rwmu5yl4jk,795
+scratchattach/eventhandlers/cloud_requests.py,sha256=CQsA6wzW6C0xJYtw6g0X8x5DY5EHkDE1tAOMVigzhzA,25113
+scratchattach/eventhandlers/cloud_server.py,sha256=j2Iiuxsp9xOLeZ6S7iT7Yto8u599O57kRUZLMMIxjQ0,12431
+scratchattach/eventhandlers/cloud_storage.py,sha256=YYcvRjhIuOboWVemMKFEtUhrd6UeUFO_BlbAIH7oaeQ,4609
+scratchattach/eventhandlers/combine.py,sha256=YiWI6WI1BySioXpfYaMv8noBM14EjZa7dtsJsMTshEU,894
+scratchattach/eventhandlers/filterbot.py,sha256=V5dQErz_yFpSioh5VxUDaBW8L9ny1uMviTt7x-KFC1k,7612
+scratchattach/eventhandlers/message_events.py,sha256=KvznXAeNGk1WWCxd7PI95yovX-58TyCBNDdXbrYgb8Q,1776
+scratchattach/other/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scratchattach/other/other_apis.py,sha256=yZ06rCZmJLSZZdfv1V_VgRBq5dUxS31YHkpsdOxAezw,17509
+scratchattach/other/project_json_capabilities.py,sha256=07t1iMgWm4Qd06jHyQ3vK7tROguvc2RQCo78enrdSlA,22646
+scratchattach/site/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scratchattach/site/_base.py,sha256=D2SOp2aFiDP0hG7-xP8kK1pmoAz5TOi7_iWt6Ulpsbg,3283
+scratchattach/site/activity.py,sha256=g5fg97xHUAKOkaZ4VzKl3hVpICZhv1mpDCO6LlmkoTU,17871
+scratchattach/site/alert.py,sha256=V6asmcWy4tcQgWhG95rpqXP0KeUy7VQU9wD9AMhCqds,9324
+scratchattach/site/backpack_asset.py,sha256=__VZomGDJkbgWj2ridQQArMMLWoSMv8dpO7PPpvPgBU,3322
+scratchattach/site/browser_cookie3_stub.py,sha256=codk0knOP5C0YThaRazvqsqX7X7WnrD2UwFd1nFG7mg,1422
+scratchattach/site/browser_cookies.py,sha256=uQyjJJ4HCu46R4tPWCcTUqDMXSXhQ4KQUobqCSxScSA,1864
+scratchattach/site/classroom.py,sha256=lpHh2OkHeFzGUaFbf9PWIrosYOBo2cRrfc6fsex2w44,18139
+scratchattach/site/cloud_activity.py,sha256=vMQy2k3jzPbOa3_TiH23B9dTk4BQA_z0q_Ab6TFkeV8,5397
+scratchattach/site/comment.py,sha256=kUZxbjChs8K66vShz-Q1y1s72yJ44hFXJUYLsSb9rUs,9449
+scratchattach/site/forum.py,sha256=-XLi3UJOwDt0Ye8CqP4c-sSxOkPSe5fPVa9b7MOm64k,16553
+scratchattach/site/placeholder.py,sha256=BTOroGKA3lpgKPJXFeveEuMdcNkOIddpbNTrV-48s-o,5446
+scratchattach/site/project.py,sha256=Zc5TN4PEGC1fTze_rkU7_-Y1YDuSXrkHaJGD3eeLgqU,34750
+scratchattach/site/session.py,sha256=kd4IKaMXmtWGJJnFV3wOoLAF2S_012zHkdGcMZgUFxs,54451
+scratchattach/site/studio.py,sha256=sAqFJDjhxf-9NynLB7mrCgzxq8td1oqa1zTW9MP1yTM,26195
+scratchattach/site/typed_dicts.py,sha256=Hq65u56OSLdcoQ0F0A_CxZ8WBY5d_0VuJmUEMd8KmpU,3611
+scratchattach/site/user.py,sha256=P2nsSGo-Z1QlXzAQxstOOq-E4QGN9HVA4dIQaJd1YFY,47404
+scratchattach/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scratchattach/utils/commons.py,sha256=DpBTxRC2XeKURW5YJwAT6teAfYG7221GxClTaZ0-yQE,8465
+scratchattach/utils/encoder.py,sha256=1lOXBbqo2JGMdns6Q5WGhAB9p7Q8trduBk-SZgmcEKw,2559
+scratchattach/utils/enums.py,sha256=5HhXidczUYYVwHf6jfJcMA80jK4V0imaltLEu5epIF8,11127
+scratchattach/utils/exceptions.py,sha256=T1nBbbkTZVkZU7uNaqBqSbNTGtOaOnTVLRRqUTatTis,7556
+scratchattach/utils/optional_async.py,sha256=zTCFt6tpSvlcwns1RgAACKplA1SSFyVWAcDRS8kLLjE,4721
+scratchattach/utils/requests.py,sha256=Brl94PCyblaQopanXyyQZ8ZoaWuFrK3NqUTZWW22gpY,9608
+scratchattach-3.0.0b2.dist-info/licenses/LICENSE,sha256=1PRKLhZU4wYt5M-C9f7q0W3go3u_ojnZMNOdR3g3J-E,1080
+scratchattach-3.0.0b2.dist-info/METADATA,sha256=NanxaLAiqzD7fyD2O9oMWxqkLsfdg-439oGR5Qhd3xo,5633
+scratchattach-3.0.0b2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+scratchattach-3.0.0b2.dist-info/entry_points.txt,sha256=vNXuP05TQKEoIzmzmUzS7zbtSZx0p3JmeUW3QhNdYfg,56
+scratchattach-3.0.0b2.dist-info/top_level.txt,sha256=gIwCwW39ohXn0JlnvSzAjV7VtL3qPlRnHiRqBbxsEUE,14
+scratchattach-3.0.0b2.dist-info/RECORD,,

scratchattach-3.0.0b0.dist-info/RECORD

@@ -1,8 +0,0 @@
-scratchattach/__init__.py,sha256=K26DsJHYlj7atN0WVQOmtN7d1rNAnmLcO3ljA1UD1lc,1849
-scratchattach/__main__.py,sha256=K520LnmXe5WAlr8UZQE1Owrm8BDncy19QQ5GJ75V9FM,4054
-scratchattach-3.0.0b0.dist-info/licenses/LICENSE,sha256=1PRKLhZU4wYt5M-C9f7q0W3go3u_ojnZMNOdR3g3J-E,1080
-scratchattach-3.0.0b0.dist-info/METADATA,sha256=qapruF1xW-anLx5HiFgZ8B1k6oH_a1YcV2WHGRsU5PI,5633
-scratchattach-3.0.0b0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-scratchattach-3.0.0b0.dist-info/entry_points.txt,sha256=vNXuP05TQKEoIzmzmUzS7zbtSZx0p3JmeUW3QhNdYfg,56
-scratchattach-3.0.0b0.dist-info/top_level.txt,sha256=gIwCwW39ohXn0JlnvSzAjV7VtL3qPlRnHiRqBbxsEUE,14
-scratchattach-3.0.0b0.dist-info/RECORD,,