cousins_in_a_binary_tree.py

[DivyanshRajSoni]

Describe your change:

Describe your change:

• Add an algorithm
• Fix a bug or typo in an existing algorithm
• Add or change doctests
• Documentation change

Checklist:

• I have read CONTRIBUTING.md.
• This pull request is all my own 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 #ISSUE-NUMBER".

"Fixes #ISSUE-NUMBER".

[algorithms-keeper]

Click here to look at the relevant links ⬇️

🔗 Relevant Links

Repository:

• Contributing guidelines
• Project Euler solution guidelines

Python:

• Formatted string literals (f-strings)
• Type hints
• doctest
• unittest
• pytest

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.

[algorithms-keeper]

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

Please provide type hint for the parameter: val

[algorithms-keeper]

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

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

Please provide type hint for the parameter: root

Please provide descriptive name for the parameter: x

Please provide type hint for the parameter: x

Please provide descriptive name for the parameter: y

Please provide type hint for the parameter: y