Skip to content

Commit

Permalink
Make abstract __repr__ implementation (#107)
Browse files Browse the repository at this point in the history
  • Loading branch information
zmadie authored Jan 31, 2024
1 parent 3d3aba6 commit 4facc3e
Show file tree
Hide file tree
Showing 23 changed files with 5 additions and 82 deletions.
3 changes: 0 additions & 3 deletions roblox/assets.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,3 @@ def __init__(self, client: Client, data: dict):
self.minimum_membership_level: int = data["MinimumMembershipLevel"]
self.content_rating_type_id: int = data["ContentRatingTypeId"]
self.sale_availability_locations = data["SaleAvailabilityLocations"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} type={self.type}>"
5 changes: 1 addition & 4 deletions roblox/badges.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def __init__(self, data: dict):
self.win_rate_percentage: int = data["winRatePercentage"]

def __repr__(self):
return f"<{self.__class__.__name__} awarded_count={self.awarded_count}>"
return f"<{self.__class__.__name__} past_day_awarded_count={self.past_day_awarded_count} awarded_count={self.awarded_count} win_rate_percentage={self.win_rate_percentage}>"


class Badge(BaseBadge):
Expand Down Expand Up @@ -80,6 +80,3 @@ def __init__(self, client: Client, data: dict):

self.statistics: BadgeStatistics = BadgeStatistics(data=data["statistics"])
self.awarding_universe: PartialUniverse = PartialUniverse(client=client, data=data["awardingUniverse"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"
3 changes: 2 additions & 1 deletion roblox/bases/baseitem.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ class BaseItem:
id = None

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id}>"
attributes_repr = "".join(f" {key}={value!r}" for key, value in self.__dict__.items() if not key.startswith("_"))
return f"<{self.__class__.__name__}{attributes_repr}>"

def __int__(self):
return self.id
Expand Down
2 changes: 1 addition & 1 deletion roblox/chat.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def __init__(self, data: dict):
self.is_connect_tab_enabled: bool = data["isConnectTabEnabled"]

def __repr__(self):
return f"<{self.__class__.__name__} chat_enabled={self.chat_enabled}>"
return f"<{self.__class__.__name__} chat_enabled={self.chat_enabled} is_active_chat_user={self.is_active_chat_user} is_connect_tab_enabled={self.is_connect_tab_enabled}>"


class ChatProvider:
Expand Down
5 changes: 1 addition & 4 deletions roblox/conversations.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def __init__(self, data: dict):
self.is_default_title: bool = data["isDefaultTitle"]

def __repr__(self):
return f"<{self.__class__.__name__} title_for_viewer={self.title_for_viewer!r}>"
return f"<{self.__class__.__name__} title_for_viewer={self.title_for_viewer!r} is_default_title={self.is_default_title}>"


class Conversation(BaseConversation):
Expand Down Expand Up @@ -105,6 +105,3 @@ def __init__(self, client: Client, data: dict):
client=client,
data=data["conversationUniverse"]
)

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} title={self.title!r}>"
3 changes: 0 additions & 3 deletions roblox/friends.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,3 @@ def __init__(self, client: Client, data: dict):
self.presence_type: Optional[int] = data.get("presenceType")
self.is_deleted: bool = data["isDeleted"]
self.friend_frequent_rank: int = data["friendFrequentRank"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} is_online={self.is_online}>"
3 changes: 0 additions & 3 deletions roblox/gamepasses.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,3 @@ def __init__(self, client: Client, data: dict):
self.display_name: str = data["displayName"]
# TODO: add product here
self.price: Optional[int] = data["price"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} price={self.price}>"
3 changes: 0 additions & 3 deletions roblox/groups.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,6 @@ def __init__(self, client: Client, data: dict):
self.is_locked: bool = data.get("isLocked") or False
self.has_verified_badge: bool = data["hasVerifiedBadge"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} owner={self.owner}>"

async def update_shout(self, message: str, update_self: bool = True) -> Tuple[Optional[Shout], Optional[Shout]]:
"""
Updates the shout.
Expand Down
12 changes: 0 additions & 12 deletions roblox/instances.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ def __init__(self, client: Client, data: dict):

super().__init__(client=self._client, instance_id=data["instanceId"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} type={self.type}>"


class AssetInstance(ItemInstance):
"""
Expand All @@ -62,9 +59,6 @@ def __init__(self, client: Client, data: dict):

self.asset: BaseAsset = BaseAsset(client=self._client, asset_id=data["id"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} type={self.type} asset={self.asset}>"


class BadgeInstance(ItemInstance):
"""
Expand All @@ -77,9 +71,6 @@ def __init__(self, client: Client, data: dict):

self.badge: BaseBadge = BaseBadge(client=self._client, badge_id=data["id"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} type={self.type} badge={self.badge}>"


class GamePassInstance(ItemInstance):
"""
Expand All @@ -92,9 +83,6 @@ def __init__(self, client: Client, data: dict):

self.gamepass: BaseGamePass = BaseGamePass(client=self._client, gamepass_id=data["id"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} type={self.type} gamepass={self.gamepass}>"


instance_classes = {
"asset": AssetInstance,
Expand Down
6 changes: 0 additions & 6 deletions roblox/jobs.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,6 @@ def __init__(self, client: Client, data: dict):
data=data["Thumbnail"]
)

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"


class GameInstance(BaseJob):
"""
Expand Down Expand Up @@ -115,9 +112,6 @@ def __init__(self, client: Client, data: dict):
self.join_script: str = data["JoinScript"]
self.app_join_script: str = data["RobloxAppJoinScript"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id!r} capacity{self.capacity}>"


class GameInstances:
"""
Expand Down
3 changes: 0 additions & 3 deletions roblox/members.py
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,3 @@ def __init__(self, client: Client, data: dict, group: BaseGroup):

self.role: PartialRole = PartialRole(client=self._client, data=data["role"])
self.group: BaseGroup = group

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} role={self.role}>"
3 changes: 0 additions & 3 deletions roblox/partials/partialbadge.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,3 @@ def __init__(self, client: Client, data: dict):
super().__init__(client=client, badge_id=self.id)

self.awarded: datetime = parse(data["awardedDate"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} awarded={self.awarded}>"
6 changes: 0 additions & 6 deletions roblox/partials/partialgroup.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@ def __init__(self, client: Client, data: dict):

super().__init__(client, self.id)

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"


class UniversePartialGroup(BaseGroup):
"""
Expand All @@ -69,6 +66,3 @@ def __init__(self, client: Client, data: dict):
self.has_verified_badge: bool = data["hasVerifiedBadge"]

super().__init__(client, self.id)

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"
3 changes: 0 additions & 3 deletions roblox/partials/partialrole.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,3 @@ def __init__(self, client: Client, data: dict):
super().__init__(client=self._client, role_id=self.id)
self.name: str = data["name"]
self.rank: int = data["rank"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} rank={self.rank}>"
3 changes: 0 additions & 3 deletions roblox/partials/partialuniverse.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@ def __init__(self, client: Client, data: dict):
self.name: str = data["name"]
self.root_place: BasePlace = BasePlace(client=client, place_id=data["rootPlaceId"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"


class ChatPartialUniverse(BaseUniverse):
"""
Expand Down
3 changes: 0 additions & 3 deletions roblox/partials/partialuser.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,6 @@ def __init__(self, client: Client, data: dict):
self.display_name: str = data.get("displayName")
self.has_verified_badge: bool = data.get("hasVerifiedBadge", False) or data.get("HasVerifiedBadge", False)

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} display_name={self.display_name!r}>"


class RequestedUsernamePartialUser(PartialUser):
"""
Expand Down
3 changes: 0 additions & 3 deletions roblox/places.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,3 @@ def __init__(self, client: Client, data: dict):
self.price: int = data["price"]
self.image_token: str = data["imageToken"]
self.has_verified_badge: bool = data["hasVerifiedBadge"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"
3 changes: 0 additions & 3 deletions roblox/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,3 @@ def __init__(self, client: Client, data: dict):
self.version_id: int = data["versionId"]
self.created: datetime = parse(data["created"])
self.updated: datetime = parse(data["updated"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r}>"
3 changes: 0 additions & 3 deletions roblox/robloxbadges.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,3 @@ def __init__(self, client: Client, data: dict):
self.name: str = data["name"]
self.description: str = data["description"]
self.image_url: str = data["imageUrl"]

def __repr__(self):
return f"<{self.__class__.__name__} name={self.name!r}>"
3 changes: 0 additions & 3 deletions roblox/roles.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,6 @@ def __init__(self, client: Client, data: dict, group: BaseGroup = None):
self.rank: int = data["rank"]
self.member_count: Optional[int] = data.get("memberCount")

def __repr__(self):
return f"<{self.__class__.__name__} name={self.name!r} rank={self.rank} member_count={self.member_count}>"

def get_members(self, page_size: int = 10, sort_order: SortOrder = SortOrder.Ascending,
max_items: int = None) -> PageIterator:
"""
Expand Down
3 changes: 0 additions & 3 deletions roblox/sociallinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,3 @@ def __init__(self, client: Client, data: dict):
self.title: str = data["title"]
self.url: str = data["url"]
self.type: SocialLinkType = SocialLinkType(data["type"])

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} url={self.url!r} type={self.type!r} title={self.title!r}"
3 changes: 0 additions & 3 deletions roblox/universes.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,3 @@ def __init__(self, client: Client, data: dict):
# gameRating seems to be null across all games, so I omitted it from this class.
self.is_favorited_by_user: bool = data["isFavoritedByUser"]
self.favorited_count: int = data["favoritedCount"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} creator={self.creator}>"
3 changes: 0 additions & 3 deletions roblox/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,3 @@ def __init__(self, client: Client, data: dict):
self.description: str = data["description"]
self.created: datetime = parse(data["created"])
self.has_verified_badge: bool = data["hasVerifiedBadge"]

def __repr__(self):
return f"<{self.__class__.__name__} id={self.id} name={self.name!r} display_name={self.display_name!r}>"

0 comments on commit 4facc3e

Please sign in to comment.