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

Player trainer profile link & relatives #81

Merged
merged 6 commits into from
Dec 8, 2024
Merged

Conversation

McAroon
Copy link
Contributor

@McAroon McAroon commented Dec 5, 2024

A couple of additions to the player profile.
Also fixed the social media xpath, since apparently the element's class has been changed.

Example output:

GET http://localhost:8000/players/3111/profile

{
  "id": "3111",
  "url": "https://www.transfermarkt.com/zinedine-zidane/profil/spieler/3111",
  "name": "Zinédine Zidane",
  "description": "Zinédine Zidane ➤ former footballer from France ➤ Attacking Midfield ➤ last club: Real Madrid ➤ * Jun 23, 1972 in Marseille, France",
  "nameInHomeCountry": "Zinédine Yazid Zidane",
  "imageURL": "https://img.a.transfermarkt.technology/portrait/header/3111-1478769687.jpg?lm=1",
  "dateOfBirth": "Jun 23, 1972",
  "placeOfBirth": {
    "city": "Marseille",
    "country": "France"
  },
  "age": "52",
  "height": "1,85m",
  "citizenship": [
    "France",
    "Algeria"
  ],
  "isRetired": true,
  "retiredSince": "Jul 10, 2006",
  "position": {
    "main": "Attacking Midfield",
    "other": [
      "Left Midfield"
    ]
  },
  "foot": "both",
  "club": {
    "name": "Retired",
    "joined": "Jul 10, 2006",
    "lastClubID": "418",
    "lastClubName": "Real Madrid"
  },
  "socialMedia": [
    "http://instagram.com/zidane"
  ],
  "trainerProfile": {
    "id": "21284",
    "url": "/zinedine-zidane/profil/trainer/21284",
    "position": "Investor"
  },
  "relatives": [
    {
      "id": "106825",
      "url": "/enzo-zidane/profil/spieler/106825",
      "name": "Enzo Zidane",
      "profileType": "player"
    },
    {
      "id": "283489",
      "url": "/luca-zidane/profil/spieler/283489",
      "name": "Luca Zidane",
      "profileType": "player"
    },
    {
      "id": "337917",
      "url": "/theo-zidane/profil/spieler/337917",
      "name": "Théo Zidane",
      "profileType": "player"
    },
    {
      "id": "362744",
      "url": "/elyaz-zidane/profil/spieler/362744",
      "name": "Elyaz Zidane",
      "profileType": "player"
    },
    {
      "id": "581411",
      "url": "/driss-zidane/profil/spieler/581411",
      "name": "Driss Zidane",
      "profileType": "player"
    }
  ],
  "updatedAt": "2024-12-05T13:02:01.132544"
}

image

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced player profile functionality to include related players and trainers.
    • Added trainer profile information and relatives' data to player profiles.
  • Bug Fixes

    • Updated XPath expressions for improved data extraction related to social media and profiles.
  • Tests

    • Updated test cases to validate new fields in player profiles, including relatives and trainer information.

Copy link

coderabbitai bot commented Dec 5, 2024

Walkthrough

The pull request introduces enhancements to the TransfermarktPlayerProfile class by adding a private method __parse_player_relatives for parsing related players and trainers from player profiles. It also updates the get_player_profile method to include new fields in the response dictionary, capturing trainer profile information and related players. Additionally, modifications to the Profile class in app/utils/xpath.py update XPath expressions and add new attributes for extracting trainer and relative data. Corresponding updates to tests ensure the expected schema reflects these changes.

Changes

File Change Summary
app/services/players/profile.py - Added method __parse_player_relatives(self) -> list.
- Updated get_player_profile(self) -> dict to include trainerProfile and relatives.
app/utils/xpath.py - Updated SOCIAL_MEDIA XPath expression.
- Added attributes: TRAINER_PROFILE_URL, TRAINER_PROFILE_POSITION, RELATIVES, RELATIVE_URL, RELATIVE_NAME.
tests/players/test_players_profile.py - Updated expected schema in tests to include new fields: relatives, trainerProfile, and joined in relevant tests.

Possibly related PRs

Poem

🐇 In the fields where players play,
New paths for trainers come to stay.
With relatives close, their stories unfold,
In profiles now richer, their tales are told.
Hopping through data, we cheer with delight,
For every new change makes our future bright! 🌟


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 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

@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

🧹 Outside diff range and nitpick comments (2)
app/services/players/profile.py (1)

31-53: Add type hints and fix trailing comma.

The implementation looks good, but could benefit from type hints for better code maintainability and IDE support.

-    def __parse_player_relatives(self) -> list:
+    def __parse_player_relatives(self) -> list[dict[str, str]]:
         """
         Parse the list of related players or trainers from the 'Further information' section on the player page
         Returns:
-            list: A list of dictionaries, each containing ID, profile URL, name, and profile type
+            list[dict[str, str]]: A list of dictionaries, each containing ID, profile URL, name, and profile type
         """
         relatives = self.page.xpath(Players.Profile.RELATIVES)

         result = []
         for relative in relatives:
             url = trim(relative.xpath(Players.Profile.RELATIVE_URL))
             name = trim(relative.xpath(Players.Profile.RELATIVE_NAME))
             result.append(
                 {
                     "id": extract_from_url(url),
                     "url": url,
                     "name": name,
-                    "profileType": "player" if "spieler" in url else "trainer"
+                    "profileType": "player" if "spieler" in url else "trainer",
                 }
             )
🧰 Tools
🪛 Ruff (0.8.0)

49-49: Trailing comma missing

Add trailing comma

(COM812)

tests/players/test_players_profile.py (1)

54-61: Add trailing comma in schema definition.

For consistency with Python style guidelines, add trailing commas in the schema definition.

             "relatives": [
                 {
                     "id": And(str, len_greater_than_0),
                     "url": And(str, len_greater_than_0),
                     "name": And(str, len_greater_than_0),
-                    "profileType": And(str, len_greater_than_0)
+                    "profileType": And(str, len_greater_than_0),
                 }
             ],
🧰 Tools
🪛 Ruff (0.8.0)

60-60: Trailing comma missing

Add trailing comma

(COM812)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cc72645 and 0451045.

📒 Files selected for processing (3)
  • app/services/players/profile.py (3 hunks)
  • app/utils/xpath.py (1 hunks)
  • tests/players/test_players_profile.py (2 hunks)
🧰 Additional context used
🪛 Ruff (0.8.0)
app/services/players/profile.py

49-49: Trailing comma missing

Add trailing comma

(COM812)

tests/players/test_players_profile.py

60-60: Trailing comma missing

Add trailing comma

(COM812)


210-210: Trailing comma missing

Add trailing comma

(COM812)

🔇 Additional comments (4)
app/services/players/profile.py (1)

111-116: LGTM! Trainer profile and relatives integration looks good.

The implementation maintains consistency with existing patterns and properly integrates the new fields.

tests/players/test_players_profile.py (1)

199-211: LGTM! Comprehensive test coverage for new fields.

The schema validation for trainer profile and relatives is thorough and consistent with existing patterns.

🧰 Tools
🪛 Ruff (0.8.0)

210-210: Trailing comma missing

Add trailing comma

(COM812)

app/utils/xpath.py (2)

50-57: LGTM! Well-structured XPath expressions for new fields.

The XPath expressions for trainer profile and relatives are well-organized and follow the established patterns.


49-49: Verify the social media toolbar class change.

The social media XPath has been updated to use the new class name. Let's verify this change is consistent across different player profiles.

@felipeall
Copy link
Owner

@McAroon thank you for your contribution, I really appreciate it!

@felipeall felipeall merged commit 09c2bc5 into felipeall:main Dec 8, 2024
@McAroon
Copy link
Contributor Author

McAroon commented Dec 10, 2024

@felipeall and thank you for the API!
We've made a bingo with its help if you want to check it out :) https://quingo.s2nog.net/

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.

2 participants