Skip to content

[py] webkitgtk: log_path -> log_output#14618

Merged
diemol merged 7 commits intoSeleniumHQ:trunkfrom
Delta456:webkit_service
Oct 28, 2024
Merged

[py] webkitgtk: log_path -> log_output#14618
diemol merged 7 commits intoSeleniumHQ:trunkfrom
Delta456:webkit_service

Conversation

@Delta456
Copy link
Copy Markdown
Member

@Delta456 Delta456 commented Oct 18, 2024 •
edited by qodo-code-review Bot
Loading

User description

Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.

Description

Changes log_path to log_output because it is an outdated parameter and log_output is the updated parameter

Motivation and Context

super.__init__ still calls log_file which is not there anymore so this PR updates it to log_output.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

PR Type

enhancement

Description

  • Changed the parameter name from log_path to log_output in the Service class to reflect updated naming conventions.
  • Modified the constructor to use the new log_output parameter, ensuring compatibility with the updated API.
  • This change addresses the issue where super.__init__ was incorrectly referencing a non-existent log_file.

Changes walkthrough 📝

Relevant files
Enhancement
service.py
Update parameter from `log_path` to `log_output` in Service class

py/selenium/webdriver/webkitgtk/service.py

  • Updated parameter name from log_path to log_output.
  • Modified the initialization to use log_output instead of log_file.
  • Adjusted the constructor to reflect the updated parameter.
    		•  +4/-4     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Oct 18, 2024

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Potential Bug
    The log_output file is always opened, even if it's None. This might cause an error if no log file is specified.

    Resource Management
    The opened file for log_output is not being closed explicitly. This might lead to resource leaks.

    @qodo-code-review
    Copy link
    Copy Markdown
    Contributor

    qodo-code-review Bot commented Oct 18, 2024 •
    edited
    Loading

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Possible issue
    ✅ Handle potential None value for log_output to prevent errors when opening the file
    Suggestion Impact:The suggestion was directly implemented by adding a conditional check to handle the case where log_output is None.

    code diff:

    -        log_output = open(log_output, "wb")
+        log_output = open(log_output, "wb") if log_output else None

    Consider handling the case where log_output is None to avoid potential errors when
    trying to open a file with a None path.

    py/selenium/webdriver/webkitgtk/service.py [45]

    -log_output = open(log_output, "wb")
+log_output = open(log_output, "wb") if log_output else None
    • Apply this suggestion
    Suggestion importance[1-10]: 9

    Why: This suggestion addresses a potential bug where attempting to open a file with a None path could lead to an error. It ensures that the code handles the case where log_output is None, which is crucial for preventing runtime errors.

    		9
    Best practice
    Use a context manager for file handling to ensure proper resource management

    Consider using a context manager or explicitly closing the file to ensure proper
    resource management.

    py/selenium/webdriver/webkitgtk/service.py [45-52]

    -log_output = open(log_output, "wb")
-super().__init__(
-    executable_path=executable_path,
-    port=port,
-    log_output=log_output,
-    env=env,
-    **kwargs,
-)
+with open(log_output, "wb") as log_file:
+    super().__init__(
+        executable_path=executable_path,
+        port=port,
+        log_output=log_file,
+        env=env,
+        **kwargs,
+    )
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    Why: The suggestion to use a context manager for file handling is a best practice that ensures proper resource management and prevents potential file descriptor leaks. It enhances the robustness of the code.

    		8

    💡 Need additional feedback ? start a PR chat

    AutomatedTester
    AutomatedTester reviewed Oct 19, 2024
    View reviewed changes
    Copy link
    Copy Markdown
    Member

    @AutomatedTester AutomatedTester left a comment

    Choose a reason for hiding this comment

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

    This change is likely to break for people if they are using kwargs. We should add the new one and have the other item deprecated

    @Delta456
    Copy link
    Copy Markdown
    Member Author

    Delta456 commented Oct 21, 2024

    Should be done now

    @VietND96 VietND96 added the C-py Python Bindings label Oct 23, 2024
    @A1exKH
    Copy link
    Copy Markdown

    A1exKH commented Oct 26, 2024

    LGTM.

    @diemol diemol merged commit ddfb3d8 into SeleniumHQ:trunk Oct 28, 2024
    @Delta456 Delta456 deleted the webkit_service branch November 6, 2024 10:30
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @AutomatedTester AutomatedTester AutomatedTester left review comments

    @diemol diemol diemol approved these changes

    Assignees

    No one assigned

    Labels

    C-py Python Bindings P-enhancement PR with a new feature Review effort [1-5]: 2

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    6 participants

    @Delta456 @A1exKH @AutomatedTester @diemol @VietND96 @harsha509