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

Merge from master #577

Merged
merged 25 commits into from
Dec 25, 2024
Merged

Merge from master #577

merged 25 commits into from
Dec 25, 2024

Conversation

ikostan
Copy link
Member

@ikostan ikostan commented Dec 25, 2024

Summary by Sourcery

Add "Complete The Pattern #5 - Even Ladder" kata, tests and workflows.

New Features:

Tests:

Merge pull request #572 from iKostanOrg/master
./kyu_8/closest_elevator/closest_elevator.py:8:1: E302 expected 2 blank lines, found 1
def elevator(left: int, right: int, call: int) -> str:
./kyu_8/enumerable_magic_25/test_take.py:65:27: E127 continuation line over-indented for visual indent
                          n=n,
                          ^
./kyu_8/enumerable_magic_25/test_take.py:66:27: E127 continuation line over-indented for visual indent
                          expected=expected,
                          ^
./kyu_8/enumerable_magic_25/test_take.py:67:27: E127 continuation line over-indented for visual indent
                          result=actual_result)
Error: kyu_8/closest_elevator/README.md:21 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.36.1/doc/md040.md
suggestion (code-quality): Convert for loop into list comprehension (list-comprehension)
Trailing newlines

kyu_8/logical_calculator/
test_logical_calculator_error.py

62
            self.assertEqual(str(calc_err.value), err)
Unnecessary parens after 'with' keyword

kyu_8/logical_calculator/
test_logical_calculator_error.py

51
            "</p>")
52
        # pylint: enable=R0801
53
        with (allure.step("Pass an array with invalid operator.")):
54
            arr: list = []
55
            op: str = 'RO'  # invalid operator
Unused print_log imported from utils.log_func

kyu_8/logical_calculator/
test_logical_calculator_error.py

13
from utils.log_func import print_log
Merge pull request #575 from iKostanOrg/master
./kyu_7/complete_the_pattern_5_even_ladder/solution.py:8:1: E302 expected 2 blank lines, found 1
def pattern(n: int) -> str:
^
1     E302 expected 2 blank lines, found 1
kyu_8/logical_calculator/test_logical_calculator_error.py:35 in public method `test_logical_calc_value_error`:
        D205: 1 blank line required between summary line and description (found 0)

        Multi-line docstrings consist of a summary line just like a one-line
        docstring, followed by a blank line, followed by a more elaborate
        description. The summary line may be used by automatic indexing tools;
        it is important that it fits on one line and is separated from the
        rest of the docstring by a blank line.
Copy link
Contributor

sourcery-ai bot commented Dec 25, 2024

Reviewer's Guide by Sourcery

This pull request implements a pydocstyle check in the CI pipeline and adds a new kata 'Complete The Pattern #5 - Even Ladder'. It also includes minor updates to existing files such as adding Allure annotations, updating print statements, and fixing YAML formatting.

Class diagram for new kata implementation

classDiagram
    class pattern {
        +pattern(n: int) -> str
    }
    note for pattern "Complete The Pattern #5 - Even Ladder
Generates pattern up to n/2 lines
Returns empty string if n <= 1"
Loading

File-Level Changes

Change Details Files
Added pydocstyle check to CI
  • Added a pydocstyle job to the CI pipeline.
  • Created a new workflow file for pydocstyle configuration and execution.
.github/workflows/lint_test_build_pipeline.yml
.github/workflows/pydocstyle.yml
Implemented 'Complete The Pattern #5 - Even Ladder' kata
  • Added the kata to the README file.
  • Created test cases for the kata solution.
  • Implemented the kata solution.
  • Created a README file for the kata.
  • Created an init.py file for the kata's directory
kyu_7/README.md
kyu_7/coloured_triangles/test_triangle.py
kyu_7/complete_the_pattern_5_even_ladder/test_pattern.py
kyu_7/complete_the_pattern_5_even_ladder/README.md
kyu_7/complete_the_pattern_5_even_ladder/solution.py
kyu_7/complete_the_pattern_5_even_ladder/__init__.py
Updated existing files with minor changes
  • Updated the README file with a new kata entry and formatting changes.
  • Updated print statements in test files to use keyword arguments.
  • Fixed YAML formatting in workflow files.
  • Updated README files with formatting changes.
  • Added a new line to the end of a Python file.
  • Added a test case for ValueError in the logical calculator kata solution.
kyu_7/README.md
kyu_8/enumerable_magic_25/test_take.py
.github/workflows/markdown_lint.yml
kyu_8/closest_elevator/README.md
kyu_8/closest_elevator/closest_elevator.py
kyu_8/logical_calculator/test_logical_calculator_error.py

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

Copy link

codecov bot commented Dec 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.48%. Comparing base (f1d31ca) to head (cb8aece).
Report is 26 commits behind head on kyu8.

Additional details and impacted files
@@            Coverage Diff             @@
##             kyu8     #577      +/-   ##
==========================================
+ Coverage   90.39%   90.48%   +0.09%     
==========================================
  Files         172      174       +2     
  Lines        2550     2565      +15     
==========================================
+ Hits         2305     2321      +16     
+ Misses        245      244       -1     

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 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.

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@ikostan ikostan merged commit d7524a4 into kyu8 Dec 25, 2024
37 checks passed
ikostan added a commit that referenced this pull request Dec 25, 2024
Merge pull request #577 from iKostanOrg/master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant