Valid Parentheses - Merge pull request #543 from iKostanOrg/master #544

ikostan · 2024-11-30T05:31:23Z

Merge from master

Summary by Sourcery

Add a new solution for the 'Valid Parentheses' problem, including comprehensive unit tests and documentation.

New Features:

Add a new solution for the 'Valid Parentheses' problem, which checks if the order of parentheses in a string is valid.

Documentation:

Add documentation for the 'Valid Parentheses' problem, including a description, examples, and constraints.

Tests:

Introduce unit tests for the 'Valid Parentheses' function to verify its correctness with various test cases.

Merge from master

sourcery-ai · 2024-11-30T05:31:28Z

Reviewer's Guide by Sourcery

This pull request adds a new kata solution for "Valid Parentheses" problem and updates the README.md file to include it in the list of completed katas. The implementation includes a solution file and comprehensive test cases to verify the functionality.

Class diagram for Valid Parentheses solution

classDiagram
    class ValidParenthesesTestCase {
        +test_valid_parentheses_true()
        +test_valid_parentheses_false()
        +test_valid_parentheses_empty_string()
        +test_valid_parentheses_large_valid()
        +test_valid_parentheses_large_invalid()
    }
    class valid_parentheses {
        +valid_parentheses(paren_str: str) bool
    }
    class update_str {
        +update_str(paren_str: str, i: int) str
    }
    ValidParenthesesTestCase --> valid_parentheses
    valid_parentheses --> update_str
    note for ValidParenthesesTestCase "Unit tests for the valid_parentheses function"

File-Level Changes

Change	Details	Files
Added solution for Valid Parentheses kata	Implemented valid_parentheses function that validates parentheses string order Added helper function update_str to handle string manipulation Included edge case handling for empty strings and invalid patterns	`kyu_7/valid_parentheses/solution.py`
Added comprehensive test suite for Valid Parentheses solution	Created test cases for valid parentheses strings Added test cases for invalid parentheses strings Included tests for empty strings Added tests for large valid and invalid strings	`kyu_7/valid_parentheses/test_valid_parentheses.py`
Updated documentation and project structure	Added README.md with problem description and constraints Updated main README.md to include new kata in the list Added proper documentation and type hints to solution code	`kyu_7/valid_parentheses/README.md` `kyu_7/README.md`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time. You can also use
this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

We have skipped reviewing this pull request. Here's why:

We don't review packaging changes - Let us know if you'd like us to change this.
All of the files are larger than we can process. We're working on it!

codecov · 2024-11-30T05:32:15Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.01%. Comparing base (ab7708c) to head (d87e55d).
Report is 22 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #544   +/-   ##
=======================================
  Coverage   90.01%   90.01%           
=======================================
  Files         171      171           
  Lines        2574     2574           
=======================================
  Hits         2317     2317           
  Misses        257      257

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

codeclimate · 2024-11-30T05:32:17Z

Code Climate has analyzed commit d87e55d and detected 1 issue on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	1

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 90.0% (0.0% change).

View more on Code Climate.

kyu_7/valid_parentheses/solution.py

kyu_7/valid_parentheses/test_valid_parentheses.py

kyu_7/valid_parentheses/solution.py

kyu_7/valid_parentheses/test_valid_parentheses.py

Missing module docstring

kyu_7/valid_parentheses/test_valid_parentheses.py

Trailing newlines

Wrong continued indentation (add 1 space).

ikostan · 2024-11-30T06:48:08Z

@sourcery-ai

ikostan · 2024-11-30T06:48:52Z

@sourcery-ai review

sourcery-ai

Hey @ikostan - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

kyu_7/valid_parentheses/test_valid_parentheses.py

sourcery-ai · 2024-11-30T06:49:43Z

kyu_7/valid_parentheses/solution.py

+"""
+
+
+def valid_parentheses(paren_str: str) -> bool:


issue (complexity): Consider using a counter-based approach instead of string manipulation to validate parentheses

The current implementation unnecessarily rebuilds strings and uses nested loops, leading to O(n²) complexity. This can be simplified to O(n) using a counter approach that better expresses the intent:

def valid_parentheses(paren_str: str) -> bool: count = 0 for char in paren_str: if char == '(': count += 1 else: count -= 1 if count < 0: # Too many closing brackets return False return count == 0

This solution:

Eliminates string rebuilding and nested loops

Maintains the same functionality with better performance

Is more readable as it directly expresses the logic of matching pairs

sourcery-ai · 2024-11-30T06:49:44Z

kyu_7/valid_parentheses/test_valid_parentheses.py

+        for test_str in test_data:
+            with allure.step(f"Enter test string {test_data}"
+                             f"and verify that the function returns True."):
+                result: bool = valid_parentheses(test_str)
+                print_log(test_data=test_data, result=result)
+                self.assertTrue(result)


issue (code-quality): Avoid loops in tests. (no-loop-in-tests)

Explanation
Avoid complex code, like loops, in test functions.
Google's software engineering guidelines says:
"Clear tests are trivially correct upon inspection"
To reach that avoid complex code in tests:

loops

conditionals

Some ways to fix this:

Use parametrized tests to get rid of the loop.

Move the complex logic into helpers.

Move the complex part into pytest fixtures.

Complexity is most often introduced in the form of logic. Logic is defined via the imperative parts of programming languages such as operators, loops, and conditionals. When a piece of code contains logic, you need to do a bit of mental computation to determine its result instead of just reading it off of the screen. It doesn't take much logic to make a test more difficult to reason about.

Software Engineering at Google / Don't Put Logic in Tests

kyu_7/valid_parentheses/test_valid_parentheses.py

kyu_7/valid_parentheses/solution.py:53:19: R1736: Unnecessary list index lookup, use 'char' instead (unnecessary-list-index-lookup)

kyu_7/valid_parentheses/test_valid_parentheses.py:108:25: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation) kyu_7/valid_parentheses/test_valid_parentheses.py:130:26: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation) kyu_7/valid_parentheses/test_valid_parentheses.py:132:29: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation) kyu_7/valid_parentheses/test_valid_parentheses.py:154:26: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation) kyu_7/valid_parentheses/test_valid_parentheses.py:156:29: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation)

************* Module kyu_7.valid_parentheses.test_valid_parentheses kyu_7/valid_parentheses/test_valid_parentheses.py:130:26: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation) kyu_7/valid_parentheses/test_valid_parentheses.py:154:26: W1309: Using an f-string that does not have any interpolated variables (f-string-without-interpolation)

codeclimate · 2024-12-01T04:54:38Z

kyu_7/valid_parentheses/solution.py

+"""
+
+
+def valid_parentheses(paren_str: str) -> bool:


Function valid_parentheses has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.

issue (bug_risk): Fix incorrect parameter in print_log call The print_log is using test_data instead of test_str which could cause confusing log output. Should be print_log(test_data=test_str, result=result)

Merge pull request #543 from iKostanOrg/master

8723bc1

Merge from master

ikostan added documentation Improvements or additions to documentation codewars kyu_7 labels Nov 30, 2024

ikostan self-assigned this Nov 30, 2024

sourcery-ai bot reviewed Nov 30, 2024

View reviewed changes

ikostan added 4 commits November 29, 2024 21:36

Valid Parentheses

8696585

Merge branch 'kyu7' of https://github.com/iKostanOrg/codewars into kyu7

983584e

Create README.md

80d5b1c

Solution ready

313929a

codeclimate bot reviewed Nov 30, 2024

View reviewed changes

Update solution.py

c1cfe59

Missing module docstring

codeclimate bot reviewed Nov 30, 2024

View reviewed changes

kyu_7/valid_parentheses/test_valid_parentheses.py Outdated Show resolved Hide resolved

ikostan added 4 commits November 29, 2024 22:41

Update solution.py

6741ceb

Update test_valid_parentheses.py

18c197a

Trailing newlines

Update test_valid_parentheses.py

69f07a7

Wrong continued indentation (add 1 space).

@sourcery-ai

ab6ed0c

sourcery-ai bot approved these changes Nov 30, 2024

View reviewed changes

ikostan added 4 commits November 29, 2024 22:53

Update solution.py

4f9d623

kyu_7/valid_parentheses/solution.py:53:19: R1736: Unnecessary list index lookup, use 'char' instead (unnecessary-list-index-lookup)

Update solution.py

14b2efc

codeclimate bot reviewed Dec 1, 2024

View reviewed changes

ikostan added 2 commits November 30, 2024 20:56

Update test_valid_parentheses.py

d7a5a1e

Update test_valid_parentheses.py

d878cbc

issue (bug_risk): Fix incorrect parameter in print_log call The print_log is using test_data instead of test_str which could cause confusing log output. Should be print_log(test_data=test_str, result=result)

ikostan added 5 commits November 30, 2024 21:01

Update solution.py

c9dba87

Update solution.py

be39032

Update solution.py

6f0f5ac

Update solution.py

cde890e

Allure test report

d87e55d

ikostan merged commit f128538 into master Dec 1, 2024
21 of 22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Valid Parentheses - Merge pull request #543 from iKostanOrg/master #544

Valid Parentheses - Merge pull request #543 from iKostanOrg/master #544

ikostan commented Nov 30, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Nov 30, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

codecov bot commented Nov 30, 2024 •

edited

Loading

codeclimate bot commented Nov 30, 2024 •

edited

Loading

ikostan commented Nov 30, 2024

ikostan commented Nov 30, 2024

sourcery-ai bot left a comment

sourcery-ai bot Nov 30, 2024

sourcery-ai bot Nov 30, 2024

codeclimate bot Dec 1, 2024

Valid Parentheses - Merge pull request #543 from iKostanOrg/master #544

Valid Parentheses - Merge pull request #543 from iKostanOrg/master #544

Conversation

ikostan commented Nov 30, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Nov 30, 2024 • edited Loading

Reviewer's Guide by Sourcery

Class diagram for Valid Parentheses solution

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 30, 2024 • edited Loading

Codecov Report

codeclimate bot commented Nov 30, 2024 • edited Loading

ikostan commented Nov 30, 2024

ikostan commented Nov 30, 2024

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Nov 30, 2024

Choose a reason for hiding this comment

sourcery-ai bot Nov 30, 2024

Choose a reason for hiding this comment

codeclimate bot Dec 1, 2024

Choose a reason for hiding this comment

ikostan commented Nov 30, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Nov 30, 2024 •

edited

Loading

codecov bot commented Nov 30, 2024 •

edited

Loading

codeclimate bot commented Nov 30, 2024 •

edited

Loading