Added full support for Upcoming Media Card and updated README.md #20

mkanet · 2024-03-25T05:10:00Z

Added support for Upcoming Media Cards' new interactive features and updated README.me.

boralyl

Thanks for submitting!

I did an initial review but I suspect there may be more required changes when the build actually runs. After you fix the translation file and push up that commit, you'll likely see more errors in the build show up due to formatting and test failures.

I'd recommend installing pre-commit pip install pre-commit and running the checks locally to see the problems or automatically fix formatting issues.

After installing, from the root directory run:

$ pre-commit run -a

boralyl · 2024-03-25T21:08:38Z

README.md

+| deep_link       | Clickable hyperlink to game on Steam website &nbsp;**\***      |
+
+
+• _Attributes marked with **\*** are for **upcoming_media_card** only._


This note probably isn't necessary as anyone could use any of the values for any automation.

boralyl · 2024-03-25T21:12:07Z

custom_components/steam_wishlist/__init__.py

@@ -20,7 +20,7 @@ async def async_setup_entry(
    url = entry.data["url"]
    # https://store.steampowered.com/wishlist/profiles/<steam-id>/wishlistdata/
    steam_id = url.split("/")[-3]
-    hass.data[DOMAIN][entry.entry_id] = SensorManager(hass, url)
+    hass.data[DOMAIN][entry.entry_id] = SensorManager(hass, entry, url)


I would recommend passing just the boolean value rather than the entire config entry instance.

Suggested change

hass.data[DOMAIN][entry.entry_id] = SensorManager(hass, entry, url)

store_all_wishlist_items = entry.options.get("show_all_wishlist_items", False)

hass.data[DOMAIN][entry.entry_id] = SensorManager(hass, store_all_wishlist_items, url)

This required to make several more changes for this to work. I'm happy to say it's all working now during testing.

boralyl · 2024-03-25T21:15:57Z

custom_components/steam_wishlist/entities.py

+            'line4_default': '$genres',
+            'icon': 'mdi:arrow-down-bold',
+        }
+        data_list = [placeholders] + [game for game in self.games if game["sale_price"]]


The filtering in the list comprehension isn't actually doing anything. Regardless if you've checked or not checked the show_all_wishlist_items this will return the entire wish list. This is because you are converting None to a str, "None", which is not falsey.

>>> bool("None") True

boralyl · 2024-03-25T21:23:48Z

custom_components/steam_wishlist/sensor_manager.py

+    def __init__(self, hass: core.HomeAssistant, config_entry, url: str) -> None:
        self.hass = hass
+        self.config_entry = config_entry


Only pass the boolean instead of the config entry instance.

Suggested change

def __init__(self, hass: core.HomeAssistant, config_entry, url: str) -> None:

self.hass = hass

self.config_entry = config_entry

def __init__(self, hass: core.HomeAssistant, store_all_wishlist_items: bool, url: str) -> None:

self.hass = hass

self.store_all_wishlist_items = store_all_wishlist_items

boralyl · 2024-03-25T21:25:35Z

custom_components/steam_wishlist/sensor_manager.py

-        """Add or remove sensors based on coordinator data."""
+        """Add or update sensors based on coordinator data."""


This will also remove sensors if you've removed them from your wish list, so let's keep that in the comment.

boralyl · 2024-03-25T21:27:53Z

custom_components/steam_wishlist/translations/pt-BR.json

+      "init": {
+        "title": "Opções",
+        "data": {
+          "show_all_wishlist_items": "Exiba também itens da lista de desejos não em promoção no Upcoming Media Card (reinicialização necessária)"


Suggested change

"show_all_wishlist_items": "Exiba também itens da lista de desejos não em promoção no Upcoming Media Card (reinicialização necessária)"

"show_all_wishlist_items": "Exiba também itens da lista de desejos não em promoção no Upcoming Media Card"

boralyl · 2024-03-25T21:31:46Z

custom_components/steam_wishlist/util.py

+    tags = game.get("tags", [])
+    tags_string = ", ".join(tags)


These aren't used at all.

Sorry I forgot to remove that. That was before I had added genres attribute as a string.

custom_components/steam_wishlist/translations/pt-BR.json

boralyl · 2024-03-25T21:45:59Z

custom_components/steam_wishlist/util.py

+        price_info = "Price information unavailable"
+
+
+    release_date = ("Release date:&nbsp;&nbsp;" + datetime.datetime.utcfromtimestamp(int(game.get("release_date", "0"))).strftime("%b %d, %Y") + "&nbsp;&nbsp;🆕" if datetime.datetime.utcnow() < datetime.datetime.utcfromtimestamp(int(game.get("release_date", "0")) + 86400) else "Released:&nbsp;&nbsp;" + datetime.datetime.utcfromtimestamp(int(game.get("release_date", "0"))).strftime("%b %d, %Y")) if str(game.get("release_date", "0")).isdigit() else "Unknown"


This is really hard to read, I'd factor this out into a new function. Generally speaking I wouldn't do more than a single ternary in a statement.

Also note that datetime.utcfromtimestamp and datetime.utcnow are deprecated. Pass in the timezone instead. e.g.

from datetime import datetime, timezone # replace datetime.utcfromtimestamp() with: datetime.fromtimestamp(timestamp, timezone.utc) # replace datetime.utcnow() with: datetime.now(timezone.utc)

See: https://blog.miguelgrinberg.com/post/it-s-time-for-a-change-datetime-utcnow-is-now-deprecated

boralyl · 2024-03-25T21:47:16Z

custom_components/steam_wishlist/util.py

-        "sale_price": sale_price,
-        "steam_id": game_id,
-        "title": game["name"],
+        "sale_price": sale_price if not config_entry.options.get("show_all_wishlist_items", True) else str(sale_price),


I'm not exactly sure why this is needed. Why would you want to use "None" instead of None?

Originally, I was looking for the simplest way to display all wishlist items instead of only on_sale items. I realized when switching to "None" instead of None for sale_price, that effectively did what I wanted; hence why I changed that line the way I did. There is probably a better way to do it; but, I just did whatever was quick and effective. In any case, after successfully making all the changes necessary to directly use boolean (store_all_wishlist_items) instead of config_entry that line now looks like this: "sale_price": str(sale_price) if store_all_wishlist_items else sale_price,

Let me know what you think. I already have the changes done in respect to your requests and my comments.

Added a callback to update the manager with the option value and schedule a sensor refresh with the option flow is completed.

…main

mkanet added 2 commits March 23, 2024 17:30

Added support for Upcoming Media Card and its new features

8fdf3f3

Updated README.md for Upcoming Media Card

b192f4c

boralyl requested changes Mar 25, 2024

View reviewed changes

mkanet and others added 5 commits April 3, 2024 13:22

Enhancements needed for PR to original Steam Wishlist repo

4b5088c

Readme commit

10ba3ee

Fix updating wish list attributes.

c622879

Added a callback to update the manager with the option value and schedule a sensor refresh with the option flow is completed.

Fix updating wish list attributes

c70bb96

Merge branch 'main' of https://github.com/mkanet/steam-wishlist into …

143bc8e

…main

boralyl self-requested a review April 4, 2024 18:39

boralyl added 6 commits April 4, 2024 12:36

Remove passing param to get_steam_game.

563b2ed

Merge branch 'main' of github.com:mkanet/steam-wishlist

9082821

Also run on pull requests

3a13046

Don't use a venv for uv

e613c17

Switch build to python 3.11

ce26aa4

Fix tests

f14ae09

boralyl approved these changes Apr 4, 2024

View reviewed changes

boralyl merged commit 9ca16a7 into boralyl:main Apr 4, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added full support for Upcoming Media Card and updated README.md #20

Added full support for Upcoming Media Card and updated README.md #20

mkanet commented Mar 25, 2024

boralyl left a comment

boralyl Mar 25, 2024

mkanet Mar 27, 2024

boralyl Mar 25, 2024

mkanet Mar 27, 2024

boralyl Mar 25, 2024

boralyl Mar 25, 2024

boralyl Mar 25, 2024

boralyl Mar 25, 2024

boralyl Mar 25, 2024

mkanet Mar 27, 2024

boralyl Mar 25, 2024

mkanet Mar 27, 2024

boralyl Mar 25, 2024

mkanet Mar 27, 2024 •

edited

Loading

		\| deep_link \| Clickable hyperlink to game on Steam website  \* \|


		• _Attributes marked with \* are for upcoming_media_card only._

	hass.data[DOMAIN][entry.entry_id] = SensorManager(hass, entry, url)
	store_all_wishlist_items = entry.options.get("show_all_wishlist_items", False)
	hass.data[DOMAIN][entry.entry_id] = SensorManager(hass, store_all_wishlist_items, url)

		"""Add or remove sensors based on coordinator data."""
		"""Add or update sensors based on coordinator data."""

	"show_all_wishlist_items": "Exiba também itens da lista de desejos não em promoção no Upcoming Media Card (reinicialização necessária)"
	"show_all_wishlist_items": "Exiba também itens da lista de desejos não em promoção no Upcoming Media Card"

		price_info = "Price information unavailable"


		release_date = ("Release date:  " + datetime.datetime.utcfromtimestamp(int(game.get("release_date", "0"))).strftime("%b %d, %Y") + "  🆕" if datetime.datetime.utcnow() < datetime.datetime.utcfromtimestamp(int(game.get("release_date", "0")) + 86400) else "Released:  " + datetime.datetime.utcfromtimestamp(int(game.get("release_date", "0"))).strftime("%b %d, %Y")) if str(game.get("release_date", "0")).isdigit() else "Unknown"

Added full support for Upcoming Media Card and updated README.md #20

Added full support for Upcoming Media Card and updated README.md #20

Conversation

mkanet commented Mar 25, 2024

boralyl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkanet Mar 27, 2024 • edited Loading

Choose a reason for hiding this comment

mkanet Mar 27, 2024 •

edited

Loading