Fix: Set default for assists field to None in PlayerStat model

[zack-fathi]

This PR fixes a validation error encountered when the Transfermarkt API returns player stats without an "assists" field or with a placeholder value (such as "-"). The change made was this:

Updated the PlayerStat model to set a default value of None for assists, ensuring the API doesn't raise validation errors when this field is missing.

class PlayerStat(TransfermarktBaseModel):
    competition_id: str
    competition_name: str
    season_id: str
    club_id: str
    appearances: Optional[int]
    goals: Optional[int]
    assists: Optional[int] = None  # Set default to None to avoid validation errors
    yellow_cards: Optional[int]
    red_cards: Optional[int]
    minutes_played: Optional[int]

I have verified this change both through unit tests and manual testing. Specifically:

• I ran the API locally and retrieved stats for every Premier League player.
• The assists field now correctly handles missing or placeholder values (e.g., "-") and sets them to None, preventing validation errors.
• All expected data loaded successfully without triggering ResponseValidationError.

Summary by CodeRabbit

• Bug Fixes
  • Improved consistency for player assist statistics by ensuring that if an assist value isn’t provided, it now defaults to a safe, defined value for more reliable data handling.

[coderabbitai]

Walkthrough

The update modifies the PlayerStat class in app/schemas/players/stats.py by assigning a default value of None to the assists attribute. Previously, the attribute was declared without a default, and now it explicitly defaults to None when not provided during instantiation.

Changes

File(s)	Change Summary
app/schemas/.../stats.py	Updated PlayerStat.assists to have a default value of None.

Poem

I'm a hopping rabbit full of cheer,
Tweaking code brings joy so near.
In PlayerStat, a change so fine,
assists now defaults, making it divine.
With every line, my heart's aflutter—code magic in every clutter!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

app/schemas/players/stats.py (1)

13-13: The default value addition addresses the validation issue effectively.

Setting a default value of None for the assists field resolves the validation error when the Transfermarkt API returns data without this field or with placeholder values like "-". This is a clean solution that maintains the optional nature of the field while preventing validation failures.

However, I notice that other similar fields (appearances, goals, yellow_cards, red_cards, minutes_played) are also defined as Optional[int] without default values. For consistency and to prevent similar issues with these fields, consider applying the same pattern to them:

    appearances: Optional[int]
    goals: Optional[int]
    assists: Optional[int] = None
-   yellow_cards: Optional[int]
-   red_cards: Optional[int]
-   minutes_played: Optional[int]
+   yellow_cards: Optional[int] = None
+   red_cards: Optional[int] = None
+   minutes_played: Optional[int] = None

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 04235c0 and fc2e8fe.

📒 Files selected for processing (1)

• app/schemas/players/stats.py (1 hunks)