Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: listrr response being treated as a dict #979

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

davidemarcoli
Copy link
Collaborator

@davidemarcoli davidemarcoli commented Jan 21, 2025

Pull Request Check List

Resolves: #975, Resolves #959

  • Added tests for changed code.
  • Updated documentation for changed code.

Description:

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor
    • Improved the method for retrieving IMDb IDs in the Listrr API, enhancing attribute access and error handling.
    • Enhanced duplicate handling with warning logs for skipped duplicates.

Copy link
Contributor

coderabbitai bot commented Jan 21, 2025

Warning

Rate limit exceeded

@davidemarcoli has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 41 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e3b048d and f227696.

📒 Files selected for processing (1)
  • src/program/services/content/listrr.py (1 hunks)

Walkthrough

The pull request modifies the get_items_from_Listrr method within the ListrrAPI class. Key changes include replacing .get() calls with direct attribute access for pages and items. The method now attempts to access item.imDbId directly and incorporates a fallback to retrieve the IMDb ID via trakt_api if necessary. A nested try-except block has been introduced for handling potential AttributeError exceptions, enhancing logging for missing IDs and duplicates. The overall error handling for HTTP errors remains unchanged.

Changes

File Change Summary
src/program/apis/listrr_api.py Updated get_items_from_Listrr to use direct attribute access instead of .get() for pages and items; modified IMDb ID retrieval logic; enhanced duplicate handling with logging.

Assessment against linked issues

Objective Addressed Explanation
Listrr functionality
Error handling for attribute access
Resolution of 'get' attribute error

Possibly related PRs

Suggested reviewers

  • iPromKnight
  • Gaisberg

Poem

🐰 In the code where rabbits hop,
getattr() now takes the top,
With IDs fetched, both bright and clear,
Listrr's dance brings us good cheer!
Hopping through logs, we have no fear! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/program/apis/listrr_api.py (1)

58-59: Simplify attribute access for SimpleNamespace objects.

Since the response is parsed as SimpleNamespace (configured in ListrrRequestHandler), you can use direct attribute access with fallback values using the or operator for better readability.

-    total_pages = getattr(data, "pages", 1)
-    for item in getattr(data, "items", []):
+    total_pages = getattr(data, 'pages') or 1
+    for item in getattr(data, 'items') or []:
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a18a66c and 9a7c993.

📒 Files selected for processing (1)
  • src/program/apis/listrr_api.py (1 hunks)
🧰 Additional context used
🪛 Ruff (0.8.2)
src/program/apis/listrr_api.py

60-60: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)


63-63: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)


64-64: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)

🔇 Additional comments (1)
src/program/apis/listrr_api.py (1)

58-64: Add tests for Listrr response handling.

The changes modify how API responses are handled, but tests haven't been added according to the PR checklist. Please add tests to verify:

  1. Handling of responses with missing attributes
  2. Proper fallback to default values
  3. TMDb ID fallback scenario

Would you like me to help generate test cases for these scenarios?

🧰 Tools
🪛 Ruff (0.8.2)

60-60: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)


63-63: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)


64-64: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)

Comment on lines 60 to 64
imdb_id = getattr(item,"imDbId")
if imdb_id:
unique_ids.add(imdb_id)
elif content_type == "Movies" and item.get("tmDbId"):
imdb_id = self.trakt_api.get_imdbid_from_tmdb(item["tmDbId"])
elif content_type == "Movies" and getattr(item, "tmDbId"):
imdb_id = self.trakt_api.get_imdbid_from_tmdb(getattr(item, "tmDbId"))
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use direct attribute access with proper error handling.

Since we're working with SimpleNamespace objects, we should use direct attribute access with proper error handling to catch potential AttributeError exceptions.

-        imdb_id = getattr(item,"imDbId")
-        if imdb_id:
-            unique_ids.add(imdb_id)
-        elif content_type == "Movies" and getattr(item, "tmDbId"):
-            imdb_id = self.trakt_api.get_imdbid_from_tmdb(getattr(item, "tmDbId"))
+        try:
+            if item.imDbId:
+                unique_ids.add(item.imDbId)
+            elif content_type == "Movies" and item.tmDbId:
+                imdb_id = self.trakt_api.get_imdbid_from_tmdb(item.tmDbId)
+                if imdb_id:
+                    unique_ids.add(imdb_id)
+        except AttributeError:
+            # Skip items that don't have the expected attributes
+            continue
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
imdb_id = getattr(item,"imDbId")
if imdb_id:
unique_ids.add(imdb_id)
elif content_type == "Movies" and item.get("tmDbId"):
imdb_id = self.trakt_api.get_imdbid_from_tmdb(item["tmDbId"])
elif content_type == "Movies" and getattr(item, "tmDbId"):
imdb_id = self.trakt_api.get_imdbid_from_tmdb(getattr(item, "tmDbId"))
try:
if item.imDbId:
unique_ids.add(item.imDbId)
elif content_type == "Movies" and item.tmDbId:
imdb_id = self.trakt_api.get_imdbid_from_tmdb(item.tmDbId)
if imdb_id:
unique_ids.add(imdb_id)
except AttributeError:
# Skip items that don't have the expected attributes
continue
🧰 Tools
🪛 Ruff (0.8.2)

60-60: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)


63-63: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)


64-64: Do not call getattr with a constant attribute value. It is not any safer than normal property access.

Replace getattr with attribute access

(B009)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davidemarcoli its got a point :D

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

Copy link
Member

@dreulavelle dreulavelle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

take note of the code rabbit suggestion

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a7c993 and 7516aef.

📒 Files selected for processing (1)
  • src/program/apis/listrr_api.py (1 hunks)
🔇 Additional comments (2)
src/program/apis/listrr_api.py (2)

61-77: Well-structured error handling and logging!

The implementation correctly:

  • Uses proper error handling for attribute access
  • Includes clear fallback logic for TMDb IDs
  • Adds informative warning logs for missing IDs and duplicates

42-42: Add tests for the updated Listrr response handling.

The PR checklist indicates that tests haven't been added yet. Please add tests to verify:

  1. Successful IMDb ID retrieval
  2. Fallback to TMDb ID
  3. Error handling for missing attributes
  4. Duplicate handling

Would you like me to help generate test cases for these scenarios?

Comment on lines 58 to 59
total_pages = getattr(data, "pages", 1)
for item in getattr(data, "items", []):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use direct attribute access instead of getattr.

Using getattr with constant attribute values is not safer than direct attribute access. The static analysis tool also flags this as B009.

Apply this diff to use direct attribute access:

-                    total_pages = getattr(data, "pages", 1)
-                    for item in getattr(data, "items", []):
+                    total_pages = data.pages if hasattr(data, "pages") else 1
+                    for item in data.items if hasattr(data, "items") else []:

Committable suggestion skipped: line range outside the PR's diff.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/program/apis/listrr_api.py (1)

61-67: Consider restructuring for better readability.

While the logic is correct, the nested conditions and short-circuit evaluation could be more readable.

Consider this alternative structure:

-                        try:
-                            imdb_id = item.imDbId or (
-                                self.trakt_api.get_imdbid_from_tmdb(item.tmDbId) 
-                                if content_type == "Movies" and item.tmDbId 
-                                else None
-                            )
+                        try:
+                            imdb_id = item.imDbId
+                            if not imdb_id and content_type == "Movies":
+                                if hasattr(item, "tmDbId") and item.tmDbId:
+                                    imdb_id = self.trakt_api.get_imdbid_from_tmdb(item.tmDbId)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7516aef and e3b048d.

📒 Files selected for processing (1)
  • src/program/apis/listrr_api.py (1 hunks)
🔇 Additional comments (3)
src/program/apis/listrr_api.py (3)

58-59: LGTM! Safe attribute access implementation.

The changes correctly implement direct attribute access with proper fallback handling using hasattr checks.


68-77: LGTM! Comprehensive error handling with informative logs.

The implementation properly handles:

  • Null IMDb IDs
  • Duplicate entries with warning logs
  • Missing ID attributes with descriptive error messages

42-42: Add tests for the updated data parsing logic.

The PR checklist indicates that tests haven't been added. Since these changes involve critical data parsing logic, please add tests to verify:

  • Handling of missing attributes
  • TMDb ID fallback for movies
  • Duplicate detection

Would you like me to help generate test cases for these scenarios?

if not imdb_id:
continue
if imdb_id in unique_ids:
logger.warning(f"Skipping duplicate item {imdb_id}")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can remove this log message as its going to hit this quite a lot anyways by default?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Listrr not working docker dev listrr - types.SimpleNamespace' object has no attribute 'get'
2 participants