Skip to content

update graphs/breadth_first_search.py #3908

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

Merged
merged 2 commits into from
Dec 9, 2020
Merged

update graphs/breadth_first_search.py #3908

merged 2 commits into from
Dec 9, 2020

Conversation

taseikyo
Copy link
Contributor

@taseikyo taseikyo commented Nov 20, 2020

  • update naming style to snake_case
  • add type hints

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • 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 have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

- update naming style to snake_case
- add type hints
@ghost
Copy link

ghost commented Nov 20, 2020

Pull Request Report

@taseikyo Hello! I'm a bot made to check all the pull request Python files. First of all, I want to say thank you for your time and interest in this project and for opening a pull request.

I have detected errors in some of the Python files submitted in this pull request. Please read through the report and make the necessary changes. You can take a look at the relevant links provided after the report.

What are node paths?

The report contain headings and a checklist where the items are paths to the class/function/parameter where the error is present. Node paths are double colon :: separated names and can be any of the following format:

  • Class path: [file_name]::[class_name]
  • Function path: [file_name]::[function_name]
  • Function parameter path: [file_name]::[function_name]::[parameter_name]
  • Method path: [file_name]::[class_name]::[function_name]
  • Method parameter path: [file_name]::[class_name]::[function_name]::[parameter_name]

Following functions require tests [doctest/unittest/pytest]:

  • graphs/breadth_first_search.py::Graph::print_graph
  • graphs/breadth_first_search.py::Graph::add_edge
  • graphs/breadth_first_search.py::Graph::bfs

Following functions require return type hints:

NOTE: If the function returns None then provide the type hint as def function() -> None

  • graphs/breadth_first_search.py::Graph::__init__

Relevant links:

@ghost ghost added require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Nov 20, 2020
"""prints adjacency list representation of graaph"""
for i in self.vertices.keys():
for i in self.vertices:
print(i, " : ", " -> ".join([str(j) for j in self.vertices[i]]))
Copy link
Contributor

Choose a reason for hiding this comment

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

print(i, " : ", " -> ".join([str(j) for j in self.vertices[i]]))

edit to

print(i, " : ", " -> ".join(str(j) for j in self.vertices[i]))

@@ -43,17 +45,17 @@ def BFS(self, startVertex):

if __name__ == "__main__":
Copy link
Contributor

Choose a reason for hiding this comment

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

add

from doctest import testmod
testmod()

@ghost ghost removed require tests Tests [doctest/unittest/pytest] are required require type hints https://docs.python.org/3/library/typing.html labels Nov 20, 2020
Copy link
Member

@poyea poyea left a comment

Choose a reason for hiding this comment

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

Thank you for your pull request!🤩

@poyea poyea merged commit c39be1d into TheAlgorithms:master Dec 9, 2020
@taseikyo taseikyo deleted the patch branch December 9, 2020 09:45
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
* update graphs/breadth_first_search.py

- update naming style to snake_case
- add type hints

* add doctests
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
* update graphs/breadth_first_search.py

- update naming style to snake_case
- add type hints

* add doctests
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
* update graphs/breadth_first_search.py

- update naming style to snake_case
- add type hints

* add doctests
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
* update graphs/breadth_first_search.py

- update naming style to snake_case
- add type hints

* add doctests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants