scratchattach 2.1.8__py3-none-any.whl → 2.1.10a0__py3-none-any.whl

scratchattach/utils/exceptions.py

@@ -1,206 +1,233 @@
-# Authentication / Authorization:
-
-class Unauthenticated(Exception):
-    """
-    Raised when a method that requires a login / session is called on an object that wasn't created with a session.
-
-    If you create Project, Studio, or User objects using :meth:`scratchattach.get_project`, :meth:`scratchattach.get_studio`, or :meth:`scratchattach.get_user`, they cannot be used for actions that require authentication. Instead, use the following methods to ensure the objects are connected to an authenticated session:
-    
-    - :meth:`scratchattach.Session.connect_project`
-    
-    - :meth:`scratchattach.Session.connect_user`
-    
-    - :meth:`scratchattach.Session.connect_studio`
-
-    This also applies to cloud variables, forum topics, and forum posts.
-    """
-
-    def __init__(self, message=""):
-        self.message = "No login / session connected.\n\nThe object on which the method was called was created using scratchattach.get_xyz()\nUse session.connect_xyz() instead (xyz is a placeholder for user / project / cloud / ...).\n\nMore information: https://scratchattach.readthedocs.io/en/latest/scratchattach.html#scratchattach.utils.exceptions.Unauthenticated"
-        super().__init__(self.message)
-
-
-class Unauthorized(Exception):
-    """
-    Raised when an action is performed that the user associated with the session that the object was created with is not allowed to do.
-
-    Example: Changing the "about me" of other users will raise this error.
-    """
-
-    def __init__(self, message=""):
-        self.message = "The user corresponding to the connected login / session is not allowed to perform this action."
-        super().__init__(self.message)
-
-
-class XTokenError(Exception):
-    """
-    Raised when an action can't be performed because there is no XToken available.
-
-    This error can occur if the xtoken couldn't be fetched when the session was created. Some actions (like loving projects) require providing this token.
-    """
-
-    pass
-
-
-# Not found errors:
-
-class UserNotFound(Exception):
-    """
-    Raised when a non-existent user is requested.
-    """
-
-    pass
-
-
-class ProjectNotFound(Exception):
-    """
-    Raised when a non-existent project is requested.
-    """
-
-    pass
-
-
-class ClassroomNotFound(Exception):
-    """
-    Raised when a non-existent Classroom is requested.
-    """
-
-    pass
-
-
-class StudioNotFound(Exception):
-    """
-    Raised when a non-existent studio is requested.
-    """
-
-    pass
-
-
-class ForumContentNotFound(Exception):
-    """
-    Raised when a non-existent forum topic / post is requested.
-    """
-    pass
-
-
-class CommentNotFound(Exception):
-    pass
-
-
-# Invalid inputs
-class InvalidLanguage(Exception):
-    """
-    Raised when an invalid language/language code/language object is provided, for TTS or Translate
-    """
-    pass
-
-
-class InvalidTTSGender(Exception):
-    """
-    Raised when an invalid TTS gender is provided.
-    """
-    pass
-
-# API errors:
-
-class LoginFailure(Exception):
-    """
-    Raised when the Scratch server doesn't respond with a session id.
-
-    This could be caused by an invalid username / password. Another cause could be that your IP address was banned from logging in to Scratch. If you're using an online IDE (like replit), try running the code on your computer.
-    """
-
-    pass
-
-
-class FetchError(Exception):
-    """
-    Raised when getting information from the Scratch API fails. This can have various reasons. Make sure all provided arguments are valid.
-    """
-
-    pass
-
-
-class BadRequest(Exception):
-    """
-    Raised when the Scratch API responds with a "Bad Request" error message. This can have various reasons. Make sure all provided arguments are valid.
-    """
-
-    pass
-
-
-class Response429(Exception):
-    """
-    Raised when the Scratch API responds with a 429 error. This means that your network was ratelimited or blocked by Scratch. If you're using an online IDE (like replit.com), try running the code on your computer.
-    """
-
-    pass
-
-
-class CommentPostFailure(Exception):
-    """
-    Raised when a comment fails to post. This can have various reasons.
-    """
-
-    pass
-
-
-class APIError(Exception):
-    """
-    For API errors that can't be classified into one of the above errors
-    """
-    pass
-
-
-class ScrapeError(Exception):
-    """
-    Raised when something goes wrong while web-scraping a page with bs4.
-    """
-
-    pass
-
-
-# Cloud / encoding errors:
-
-class CloudConnectionError(Exception):
-    """
-    Raised when connecting to Scratch's cloud server fails. This can have various reasons.
-    """
-
-    pass
-
-
-class InvalidCloudValue(Exception):
-    """
-    Raised when a cloud variable is set to an invalid value.
-    """
-
-    pass
-
-
-class InvalidDecodeInput(Exception):
-    """
-    Raised when the built-in decoder :meth:`scratchattach.encoder.Encoding.decode` receives an invalid input.
-    """
-
-    pass
-
-
-# Cloud Requests errors:
-
-class RequestNotFound(Exception):
-    """
-    Cloud Requests: Raised when a non-existent cloud request is edited using :meth:`scratchattach.cloud_requests.CloudRequests.edit_request`.
-    """
-
-    pass
-
-
-# Websocket server errors:
-
-class WebsocketServerError(Exception):
-    """
-    Raised when the self-hosted cloud websocket server fails to start.
-    """
-
-    pass
+# Authentication / Authorization:
+from __future__ import annotations
+
+class Unauthenticated(Exception):
+    """
+    Raised when a method that requires a login / session is called on an object that wasn't created with a session.
+
+    If you create Project, Studio, or User objects using :meth:`scratchattach.get_project`, :meth:`scratchattach.get_studio`, or :meth:`scratchattach.get_user`, they cannot be used for actions that require authentication. Instead, use the following methods to ensure the objects are connected to an authenticated session:
+    
+    - :meth:`scratchattach.Session.connect_project`
+    
+    - :meth:`scratchattach.Session.connect_user`
+    
+    - :meth:`scratchattach.Session.connect_studio`
+
+    This also applies to cloud variables, forum topics, and forum posts.
+    """
+
+    def __init__(self, message=""):
+        self.message = "No login / session connected.\n\nThe object on which the method was called was created using scratchattach.get_xyz()\nUse session.connect_xyz() instead (xyz is a placeholder for user / project / cloud / ...).\n\nMore information: https://scratchattach.readthedocs.io/en/latest/scratchattach.html#scratchattach.utils.exceptions.Unauthenticated"
+        super().__init__(self.message)
+
+
+class Unauthorized(Exception):
+    """
+    Raised when an action is performed that the user associated with the session that the object was created with is not allowed to do.
+
+    Example: Changing the "about me" of other users will raise this error.
+    """
+
+    def __init__(self, message=""):
+        self.message = (
+            f"The user corresponding to the connected login / session is not allowed to perform this action. "
+            f"{message}")
+        super().__init__(self.message)
+
+
+class XTokenError(Exception):
+    """
+    Raised when an action can't be performed because there is no XToken available.
+
+    This error can occur if the xtoken couldn't be fetched when the session was created. Some actions (like loving projects) require providing this token.
+    """
+
+
+# Not found errors:
+
+class UserNotFound(Exception):
+    """
+    Raised when a non-existent user is requested.
+    """
+
+
+class ProjectNotFound(Exception):
+    """
+    Raised when a non-existent project is requested.
+    """
+
+class ClassroomNotFound(Exception):
+    """
+    Raised when a non-existent Classroom is requested.
+    """
+
+
+class StudioNotFound(Exception):
+    """
+    Raised when a non-existent studio is requested.
+    """
+
+
+class ForumContentNotFound(Exception):
+    """
+    Raised when a non-existent forum topic / post is requested.
+    """
+
+
+class CommentNotFound(Exception):
+    pass
+
+
+# Invalid inputs
+class InvalidLanguage(Exception):
+    """
+    Raised when an invalid language/language code/language object is provided, for TTS or Translate
+    """
+
+
+class InvalidTTSGender(Exception):
+    """
+    Raised when an invalid TTS gender is provided.
+    """
+
+# API errors:
+
+class LoginFailure(Exception):
+    """
+    Raised when the Scratch server doesn't respond with a session id.
+
+    This could be caused by an invalid username / password. Another cause could be that your IP address was banned from logging in to Scratch. If you're using an online IDE (like replit), try running the code on your computer.
+    """
+
+
+class FetchError(Exception):
+    """
+    Raised when getting information from the Scratch API fails. This can have various reasons. Make sure all provided arguments are valid.
+    """
+
+
+class BadRequest(Exception):
+    """
+    Raised when the Scratch API responds with a "Bad Request" error message. This can have various reasons. Make sure all provided arguments are valid.
+    """
+
+class RateLimitedError(Exception):
+    """
+    Indicates a ratelimit enforced by scratchattach
+    """
+
+class Response429(Exception):
+    """
+    Raised when the Scratch API responds with a 429 error. This means that your network was ratelimited or blocked by Scratch. If you're using an online IDE (like replit.com), try running the code on your computer.
+    """
+
+
+class CommentPostFailure(Exception):
+    """
+    Raised when a comment fails to post. This can have various reasons.
+    """
+
+
+class APIError(Exception):
+    """
+    For API errors that can't be classified into one of the above errors
+    """
+
+
+class ScrapeError(Exception):
+    """
+    Raised when something goes wrong while web-scraping a page with bs4.
+    """
+
+
+
+# Cloud / encoding errors:
+
+class CloudConnectionError(Exception):
+    """
+    Raised when connecting to Scratch's cloud server fails. This can have various reasons.
+    """
+
+
+
+class InvalidCloudValue(Exception):
+    """
+    Raised when a cloud variable is set to an invalid value.
+    """
+
+
+
+class InvalidDecodeInput(Exception):
+    """
+    Raised when the built-in decoder :meth:`scratchattach.encoder.Encoding.decode` receives an invalid input.
+    """
+
+
+
+# Cloud Requests errors:
+
+class RequestNotFound(Exception):
+    """
+    Cloud Requests: Raised when a non-existent cloud request is edited using :meth:`scratchattach.cloud_requests.CloudRequests.edit_request`.
+    """
+
+
+
+# Websocket server errors:
+
+class WebsocketServerError(Exception):
+    """
+    Raised when the self-hosted cloud websocket server fails to start.
+    """
+
+
+
+# Editor errors:
+
+class UnclosedJSONError(Exception):
+    """
+    Raised when a JSON string is never closed.
+    """
+
+
+class BadVLBPrimitiveError(Exception):
+    """
+    Raised when a Primitive claiming to be a variable/list/broadcast actually isn't
+    """
+
+
+class UnlinkedVLB(Exception):
+    """
+    Raised when a Primitive cannot be linked to variable/list/broadcast because the provided ID does not have an associated variable/list/broadcast
+    """
+
+
+class InvalidStageCount(Exception):
+    """
+    Raised when a project has too many or too few Stage sprites
+    """
+
+
+class InvalidVLBName(Exception):
+    """
+    Raised when an invalid VLB name is provided (not variable, list or broadcast)
+    """
+
+
+class BadBlockShape(Exception):
+    """
+    Raised when the block shape cannot allow for the operation
+    """
+
+
+class BadScript(Exception):
+    """
+    Raised when the block script cannot allow for the operation
+    """
+
+# Warnings
+
+class LoginDataWarning(UserWarning):
+    """
+    Warns you not to accidentally share your login data.
+    """

scratchattach/utils/requests.py

@@ -1,59 +1,67 @@
-import requests
-from . import exceptions
-
-proxies = None
-
-class Requests:
-    """
-    Centralized HTTP request handler (for better error handling and proxies)
-    """
-
-    @staticmethod
-    def check_response(r : requests.Response):
-        if r.status_code == 403 or r.status_code == 401:
-            raise exceptions.Unauthorized
-        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.text == '{"code":"BadRequest","message":""}':
-            raise exceptions.BadRequest("Make sure all provided arguments are valid")
-        if r.text == '{"code":"BadRequest","message":""}':
-            raise exceptions.BadRequest("Make sure all provided arguments are valid")
-
-    @staticmethod
-    def get(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None):
-        try:
-            r = requests.get(url, data=data, json=json, headers=headers, cookies=cookies, params=params, timeout=timeout, proxies=proxies)
-        except Exception as e:
-            raise exceptions.FetchError(e)
-        Requests.check_response(r)
-        return r
-    
-    @staticmethod
-    def post(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None, errorhandling=True):
-        try:
-            r = requests.post(url, data=data, json=json, headers=headers, cookies=cookies, params=params, timeout=timeout, proxies=proxies)
-        except Exception as e:
-            raise exceptions.FetchError(e)
-        if errorhandling:
-            Requests.check_response(r)
-        return r
-
-    @staticmethod
-    def delete(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None):
-        try:
-            r = requests.delete(url, data=data, json=json, headers=headers, cookies=cookies, params=params, timeout=timeout, proxies=proxies)
-        except Exception as e:
-            raise exceptions.FetchError(e)
-        Requests.check_response(r)
-        return r
-
-    @staticmethod
-    def put(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None):
-        try:
-            r = requests.put(url, data=data, json=json, headers=headers, cookies=cookies, params=params, timeout=timeout, proxies=proxies)
-        except Exception as e:
-            raise exceptions.FetchError(e)
-        Requests.check_response(r)
-        return r
+from __future__ import annotations
+
+import requests
+from . import exceptions
+
+proxies = None
+
+
+class Requests:
+    """
+    Centralized HTTP request handler (for better error handling and proxies)
+    """
+
+    @staticmethod
+    def check_response(r: requests.Response):
+        if r.status_code == 403 or r.status_code == 401:
+            raise exceptions.Unauthorized(f"Request content: {r.content}")
+        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.text == '{"code":"BadRequest","message":""}':
+            raise exceptions.BadRequest("Make sure all provided arguments are valid")
+        if r.text == '{"code":"BadRequest","message":""}':
+            raise exceptions.BadRequest("Make sure all provided arguments are valid")
+
+    @staticmethod
+    def get(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None):
+        try:
+            r = requests.get(url, data=data, json=json, headers=headers, cookies=cookies, params=params,
+                             timeout=timeout, proxies=proxies)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        Requests.check_response(r)
+        return r
+
+    @staticmethod
+    def post(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None, files=None, errorhandling=True, ):
+        try:
+            r = requests.post(url, data=data, json=json, headers=headers, cookies=cookies, params=params,
+                              timeout=timeout, proxies=proxies, files=files)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        if errorhandling:
+            Requests.check_response(r)
+        return r
+
+    @staticmethod
+    def delete(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None):
+        try:
+            r = requests.delete(url, data=data, json=json, headers=headers, cookies=cookies, params=params,
+                                timeout=timeout, proxies=proxies)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        Requests.check_response(r)
+        return r
+
+    @staticmethod
+    def put(url, *, data=None, json=None, headers=None, cookies=None, timeout=None, params=None):
+        try:
+            r = requests.put(url, data=data, json=json, headers=headers, cookies=cookies, params=params,
+                             timeout=timeout, proxies=proxies)
+        except Exception as e:
+            raise exceptions.FetchError(e)
+        Requests.check_response(r)
+        return r
+

{scratchattach-2.1.8.dist-info → scratchattach-2.1.10a0.dist-info}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 TimMcCool (github user)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 TimMcCool (github user)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.