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

Add hollow_diamond_alphabet function for printing alphabet diamond patterns. #12116

Closed
wants to merge 4 commits into from

Conversation

AniketPandey22
Copy link

Describe your change:

Certainly. I'll summarize the changes made to the program:

  1. Input Validation Enhancement:

    • More comprehensive input checks were added in the hollow_diamond_alphabet function.
    • A new get_valid_input function was created to handle user input separately.
  2. Error Handling Improvement:

    • Implemented specific error messages for different types of invalid input.
    • Added try-except block to catch ValueError for non-integer inputs.
  3. User Interface Updates:

    • Added option for the user to quit the program by entering 'q'.
    • Implemented a loop to allow multiple pattern generations in one session.
    • Included success messages after successful pattern printing.
  4. Code Structure Reorganization:

    • Split the code into three main functions for better modularity:
      a. hollow_diamond_alphabet: Pattern generation
      b. get_valid_input: Input handling and validation
      c. main: Overall program flow control
  5. Function Return Values:

    • Modified hollow_diamond_alphabet to return a boolean indicating success or failure.
    • get_valid_input now returns the validated input or None if the user quits.
  6. Main Function Addition:

    • Introduced a main function to control the program's flow.
    • Implemented the if __name__ == "__main__": idiom for proper script execution.
  7. Improved Readability:

    • Added more comments and docstrings for better code understanding.
    • Improved spacing and formatting for clearer code structure.

These changes make the program more robust, user-friendly, and adherent to good programming practices. The program now handles various edge cases and provides a better interactive experience for the user while maintaining its core functionality of generating hollow diamond patterns with alphabet characters.

  • [ ✓] Add an algorithm?
  • [✓ ] Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • [ ✓] I have read CONTRIBUTING.md.
  • [✓ ] This pull request is all my work -- I have not plagiarized.
  • [✓ ] I know that pull requests will not be merged if they fail the automated tests.
  • [ ✓] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [✓ ] All new Python files are placed inside an existing directory.
  • [✓ ] All filenames are in all lowercase characters with no spaces or dashes.
  • [✓ ] All functions and variable names follow Python naming conventions.
  • [ ✓] All function parameters and return values are annotated with Python type hints.
  • [ ✓] All functions have doctests that pass the automated testing.
  • [ ✓] All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • [✓ ] If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes Hollow diamond alphabets pattern #12107 ".

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 16, 2024
@algorithms-keeper algorithms-keeper bot added require descriptive names This PR needs descriptive function and/or variable names require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Oct 16, 2024
Copy link

@algorithms-keeper algorithms-keeper bot left a comment

Choose a reason for hiding this comment

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

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

Python:

Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.

algorithms-keeper commands and options

algorithms-keeper actions can be triggered by commenting on this PR:

  • @algorithms-keeper review to trigger the checks for only added pull request files
  • @algorithms-keeper review-all to trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.

NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.

@@ -0,0 +1,85 @@
def hollow_diamond_alphabet(n):

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file strings/hollow_diamond_alphabet.py, please provide doctest for the function hollow_diamond_alphabet

Please provide return type hint for the function: hollow_diamond_alphabet. If the function does not return a value, please provide the type hint as: def function() -> None:

Please provide descriptive name for the parameter: n

Please provide type hint for the parameter: n

return True


def get_valid_input():

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file strings/hollow_diamond_alphabet.py, please provide doctest for the function get_valid_input

Please provide return type hint for the function: get_valid_input. If the function does not return a value, please provide the type hint as: def function() -> None:



# Main program
def main():

Choose a reason for hiding this comment

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

As there is no test file in this pull request nor any test function or class in the file strings/hollow_diamond_alphabet.py, please provide doctest for the function main

Please provide return type hint for the function: main. If the function does not return a value, please provide the type hint as: def function() -> None:

@algorithms-keeper algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 16, 2024
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 16, 2024
@cclauss
Copy link
Member

cclauss commented Oct 22, 2024

Closing require_type_hints PRs to prepare for Hacktoberfest

@cclauss cclauss closed this Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed require descriptive names This PR needs descriptive function and/or variable names require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hollow diamond alphabets pattern
2 participants