[Bug]: sa.CustomCloud(...) not working

[JloAu]

scratchattach version

2.1.19 (also tried on 3.0.0b3)

What happened?

When I try to create a CustomCloud object as described here in method 1, I get the following error:
AttributeError: module 'scratchattach' has no attribute 'CustomCloud'

My goal is to catch events on my self-hosted Turbowarp cloud server. Is that possible?

Your code.

cloud = sa.CustomCloud(project_id = project_id, cloud_host = f"ws://{server_ip}:{server_port}", username = "JloAu", length_limit = None, allow_non_numeric = True, _session = None, header = None, cookie = None, origin = None, print_connect_messages = False)

Traceback

Traceback (most recent call last):
  File "/mnt/82746CA0746C98A5/Users/JloAu/Documents/Python/Scratchattach.py", line 21, in <module>
    cloud = sa.CustomCloud(project_id = project_id, cloud_host = f"ws://{server_ip}:{server_port}", username = "JloAu", length_limit = None, allow_non_numeric = True, _session = None, header = None, cookie = None, origin = None, print_connect_messages = False)
            ^^^^^^^^^^^^^^
AttributeError: module 'scratchattach' has no attribute 'CustomCloud'

[faretek1]

If you try from scratchattach.cloud.cloud import CustomCloud and replace sa.CustomCloud with just CustomCloud, does it work?

It appears that it is not being exported in __init__.py. If this works, then I will just add it.

[JloAu]

Yes it works with this way...
But when I do (after creating the cloud object):
events = cloud.events()
I get 2 errors (including 1 ignored):

txt
Exception ignored in: <function BaseCloud.__del__ at 0x79fb73f59c60>
Traceback (most recent call last):
  File "/home/jloau/.venv/lib/python3.12/site-packages/scratchattach/cloud/_base.py", line 477, in __del__
    self.disconnect()
  File "/home/jloau/.venv/lib/python3.12/site-packages/scratchattach/cloud/_base.py", line 348, in disconnect
    if self.recorder is not None:
       ^^^^^^^^^^^^^
AttributeError: 'CustomCloud' object has no attribute 'recorder'
Traceback (most recent call last):
  File "/mnt/82746CA0746C98A5/Users/JloAu/Documents/Python/Scratchattach.py", line 24, in <module>
    events = cloud.events()
             ^^^^^^^^^^^^^^
  File "/home/jloau/.venv/lib/python3.12/site-packages/scratchattach/cloud/_base.py", line 99, in events
    return CloudEvents(self)
           ^^^^^^^^^^^^^^^^^
  File "/home/jloau/.venv/lib/python3.12/site-packages/scratchattach/eventhandlers/cloud_events.py", line 19, in __init__
    self.source_stream = cloud.create_event_stream()
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jloau/.venv/lib/python3.12/site-packages/scratchattach/cloud/_base.py", line 473, in create_event_stream
    self.event_stream = WebSocketEventStream(self)
                        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/jloau/.venv/lib/python3.12/site-packages/scratchattach/cloud/_base.py", line 119, in __init__
    self.source_cloud = type(cloud)(project_id=cloud.project_id)
                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: CustomCloud.__init__() missing 1 required keyword-only argument: 'cloud_host'```

[faretek1]

It appears that this is going to take some debugging.

Details

I ran this in my REPL and the same error occurs.

>>> from scratchattach.cloud.cloud import CustomCloud
>>> cloud = CustomCloud(project_id = 123, cloud_host = f"ws://clouddata.turbowarp.org", username = "JloAu", length_limit = None, allow_non_numeric = True, _session = None, header = None, cookie = None, origin = None, print_connect_messages = False)
>>> cloud.events()
Exception ignored in: <function BaseCloud.__del__ at 0x0000027AB823E480>
Traceback (most recent call last):
  File "C:\Users\rtk\code\scratchattach\scratchattach\cloud\_base.py", line 511, in __del__
    self.disconnect()
  File "C:\Users\rtk\code\scratchattach\scratchattach\cloud\_base.py", line 372, in disconnect
    if self.recorder is not None:
       ^^^^^^^^^^^^^
AttributeError: 'CustomCloud' object has no attribute 'recorder'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:\Users\rtk\code\scratchattach\scratchattach\cloud\_base.py", line 112, in events
    return CloudEvents(self)
           ^^^^^^^^^^^^^^^^^
  File "C:\Users\rtk\code\scratchattach\scratchattach\eventhandlers\cloud_events.py", line 28, in __init__
    self.source_stream = cloud.create_event_stream()
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rtk\code\scratchattach\scratchattach\cloud\_base.py", line 507, in create_event_stream
    self.event_stream = WebSocketEventStream(self)
                        ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Users\rtk\code\scratchattach\scratchattach\cloud\_base.py", line 176, in __init__
    self.source_cloud = type(cloud)(project_id=cloud.project_id)
                        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: CustomCloud.__init__() missing 1 required keyword-only argument: 'cloud_host'

[faretek1]

I have fixed the instantiation issue, however it appears as though CustomCloud is constantly making new websocket connections. I am investigating

[faretek1]

I have found the issue which caused the new websocket connections. It is because internally, the event handler extensively uses try: ... except Exception: ... (blanket exception handler), and ends up catching a JSON decoder error when "This server uses @TimMcCool's scratchattach 2.0.0" is sent. The blanket exception handler just assumes this is a connection error and therefore makes a new connection every single time it receives that string. And because the server sends that every single time, every single connection is aborted and a new one is made. But before that, the set variables are sent to the client, which means it displays the set variables, however it does this on every connection, so on_set is called multiple times per second. This makes me pretty upset because the use of except Exception, which is known to be bad practice, has converted a relatively easy to diagnose runtime error into a logic error which I had to spend an hour debugging. I hope to, at some point, review these issues. If possible, it would be ideal to add this as a rule to the linter.

TL;DR: I am about to make a commit that closes this issue. I just need to clean up.

[faretek1]

I just made the commit. I'm going to add a new beta release to PyPI. Please close this issue if it works for you. You should revert the from scratchattach.cloud.cloud import CustomCloud change.

[faretek1]

The new version has been published. pip install scratchattach==3.0.0b4. Does this work for you?