Skip to content

cocorum.jsonhandles

This module provides abstract classes for wrapping JSON data blocks returned by the API in a Python object with attributes / properties. This library does not contain any classes or functions meant to be used directly.

JSON handles

Abstract classes for handling JSON data.

Copyright 2026 Wilbur Jaywright d.b.a. Marswide BGL.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

S.D.G.

JSONObj

Abstract class for handling a JSON data block as an object

Source code in cocorum/jsonhandles.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
class JSONObj():
    """Abstract class for handling a JSON data block as an object"""

    def __init__(self, jsondata: dict):
        """Abstract class for handling a JSON data block as an object.

    Args:
        jsondata (dict): The JSON data block of an API object.
        """

        self._jsondata = jsondata

    def __getitem__(self, key: str):
        """Get a key from the JSON"""
        return self._jsondata[key]

    @property
    def get(self):
        """Get a key from the JSON with fallback"""
        return self._jsondata.get

get property

Get a key from the JSON with fallback

__getitem__(key)

Get a key from the JSON

Source code in cocorum/jsonhandles.py 
39
40
41
def __getitem__(self, key: str):
    """Get a key from the JSON"""
    return self._jsondata[key]

__init__(jsondata)

Abstract class for handling a JSON data block as an object.

Parameters:

Name Type Description Default
jsondata dict

The JSON data block of an API object.

 required
Source code in cocorum/jsonhandles.py 
30
31
32
33
34
35
36
37
def __init__(self, jsondata: dict):
    """Abstract class for handling a JSON data block as an object.

Args:
    jsondata (dict): The JSON data block of an API object.
    """

    self._jsondata = jsondata

JSONUserAction

Bases: JSONObj

Abstract class for Rumble JSON user actions

Source code in cocorum/jsonhandles.py 
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class JSONUserAction(JSONObj):
    """Abstract class for Rumble JSON user actions"""

    def __init__(self, jsondata: dict):
        """Abstract class for Rumble JSON user actions.

    Args:
        jsondata (dict): The JSON block for a single Rumble user action.
        """

        JSONObj.__init__(self, jsondata)
        self.__profile_pic = None

    def __eq__(self, other: Any) -> bool:
        """Is this user equal to another?

        Args:
            other (Any): Object to compare to.

        Returns:
            Comparison (bool): Did it fit the criteria?
        """

        # Check if the compared string is our username, or base 36 user ID if we have one
        if isinstance(other, str):
            # We have a base 36 user ID
            if hasattr(self, "user_id_b36"):
                return other in (self.username, self.user_id_b36)

            # We only have our username
            return self.username == other

        # Check if the compared object has a username and if it matches our own
        if hasattr(other, "username"):
            return self.username == other.username

        # Check if the compared object has a user ID in base 36 and if it matches our own, if we have one
        if hasattr(self, "user_id_b36") and hasattr(other, "user_id_b36"):
            return self.user_id_b36 == other.user_id_b36

        return False

    def __str__(self) -> str:
        """Follower as a string"""
        return self.username

    def __repr__(self) -> str:
        """String to represent this object"""
        return f"{type(self).__name__}(username='{self.username}')"

    @property
    def username(self) -> str:
        """The username"""
        return self["username"]

    @property
    def profile_pic_url(self) -> str:
        """The user's profile picture URL"""
        return self["profile_pic_url"]

    @property
    def profile_pic(self) -> bytes:
        """The user's profile picture as a bytes string"""
        if not self.profile_pic_url:  # The profile picture is blank
            return b''

        if not self.__profile_pic:  # We never queried the profile pic before
            response = requests.get(
                self.profile_pic_url, timeout=static.Delays.request_timeout)
            assert response.status_code == 200, "Status code " + \
                str(response.status_code)

            self.__profile_pic = response.content

        return self.__profile_pic

profile_pic property

The user's profile picture as a bytes string

profile_pic_url property

The user's profile picture URL

username property

The username

__eq__(other)

Is this user equal to another?

Parameters:

Name Type Description Default
other Any

Object to compare to.

 required

Returns:

Name Type Description
Comparison bool

Did it fit the criteria?
Source code in cocorum/jsonhandles.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def __eq__(self, other: Any) -> bool:
    """Is this user equal to another?

    Args:
        other (Any): Object to compare to.

    Returns:
        Comparison (bool): Did it fit the criteria?
    """

    # Check if the compared string is our username, or base 36 user ID if we have one
    if isinstance(other, str):
        # We have a base 36 user ID
        if hasattr(self, "user_id_b36"):
            return other in (self.username, self.user_id_b36)

        # We only have our username
        return self.username == other

    # Check if the compared object has a username and if it matches our own
    if hasattr(other, "username"):
        return self.username == other.username

    # Check if the compared object has a user ID in base 36 and if it matches our own, if we have one
    if hasattr(self, "user_id_b36") and hasattr(other, "user_id_b36"):
        return self.user_id_b36 == other.user_id_b36

    return False

__init__(jsondata)

Abstract class for Rumble JSON user actions.

Parameters:

Name Type Description Default
jsondata dict

The JSON block for a single Rumble user action.

 required
Source code in cocorum/jsonhandles.py 
52
53
54
55
56
57
58
59
60
def __init__(self, jsondata: dict):
    """Abstract class for Rumble JSON user actions.

Args:
    jsondata (dict): The JSON block for a single Rumble user action.
    """

    JSONObj.__init__(self, jsondata)
    self.__profile_pic = None

__repr__()

String to represent this object

Source code in cocorum/jsonhandles.py 
95
96
97
def __repr__(self) -> str:
    """String to represent this object"""
    return f"{type(self).__name__}(username='{self.username}')"

__str__()

Follower as a string

Source code in cocorum/jsonhandles.py 
91
92
93
def __str__(self) -> str:
    """Follower as a string"""
    return self.username

S.D.G.