UPDATED rat_in_maze.py by Muhammadummerr · Pull Request #9148 · TheAlgorithms/Python

Muhammadummerr · 2023-09-30T20:00:49Z

Describe your change:

Fixes #9066
I have made updates to the rat_in_maze.py file to enhance code clarity.
These updates include:

Adding more descriptive comments to explain the logic and steps of the maze-solving algorithm.
Introducing variables that allow for easy customization of the source and destination cells within the maze.
Refactor path representation in solution:

Previously, in solution, paths were represented as 1s, but I have updated it to use 0s to align with the standard convention where 0s represent paths and 1s represent walls.

Updated the return type to 'solution maze' if a path exists; otherwise, it returns 'None'.

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

Checklist:

…mmit tests while raising PR.

cclauss · 2023-10-01T01:04:13Z

backtracking/rat_in_maze.py

+    source_column: int,
+    destination_row: int,
+    destination_column: int,
+) -> list[list[int]] | None:


Returning two different datatypes pushes work on the caller. Please consider raising an exception if there is no solution.

See my remark in the general discussion of this Pull Request.

Suggested change

) -> list[list[int]] | None:

) -> list[list[int]]:

…into new_branch

Muhammadummerr · 2023-10-02T04:49:31Z

@cclauss Is there something I'm missing?

dlesnoff · 2023-10-03T14:44:22Z

Ok so @Muhammadummerr old pull request was reopened here.

@cclauss Is there something I'm missing?

Returning two different datatypes pushes work on the caller. Please consider raising an exception if there is no solution.

@cclaus If an exception is raised, the caller still has to wrap each function call in a try-except clause and catch the correct exception. In Nim, I would use an Option type (the equivalent of Result type in Rust, I guess?).
Maybe in Python, the closest to an Option type would be a dataclass with a list[list[int]] attribute and a boolean flag?
The caller would have to check for the boolean flag before accessing the maze, but at least the program would not crash in that case.
Exceptions are frequent in other Python Algorithm snippets, but they are often used for a bad user input. Here, the None type is a frequent and expected output of the algorithm.

cclauss · 2023-10-03T15:30:13Z

It is very true that Nim and Rust have cooler ways of dealing with exception states that Python does but raising Exceptions are quite Pythonic and are preferred to multiple different datatypes.

Muhammadummerr · 2023-10-03T17:01:01Z

Okay,Based on my understanding of your request, the program should return both the solution maze and a flag.
1.If the flag's value is one, it will indicate that a solution exists, and the path in the solution maze will be represented by 0s.
2.If the flag is 0, it means that a solution was not found, and the solution maze will consist of only 1s.

cclauss · 2023-10-03T18:42:12Z

No. The function should return a solution if there is one and raise an ValueError if there is no solution.

Muhammadummerr · 2023-10-03T18:51:24Z

I have made these changes.

Muhammadummerr · 2023-10-03T18:53:47Z

Okay, my mistake. I need to make some more changes. Thanks.

dlesnoff · 2023-10-04T12:05:13Z

Do we really care about changing the initial and destination cells in the maze?

I do not really see the benefit of it and it just makes the implementation harder to read and understand.

dlesnoff · 2023-10-04T12:08:40Z

backtracking/rat_in_maze.py

-    [0, 0, 0, 0, 1]
-    True
+    >>> solve_maze(maze,0,0,len(maze)-1,len(maze)-1)
+    [[0, 1, 1, 1, 1], [0, 0, 0, 0, 1], [1, 1, 1, 0, 1],\


Why is the output on the same line now? It makes reading the solution harder.

https://docs.python.org/3/library/doctest.html#doctest.NORMALIZE_WHITESPACE will allow you to have doctests that ignore the whitespace so the matrix can look like a matrix.

…into new_branch

for more information, see https://pre-commit.ci

Muhammadummerr · 2023-10-04T16:22:56Z

All Test case are passed on my device but failing in build check.

…into new_branch

cclauss · 2023-10-04T17:08:42Z

Looking better!

cclauss · 2023-10-04T17:09:35Z

________________ [doctest] backtracking.rat_in_maze.solve_maze _________________
028 aiming to reach a destination cell.
029 The maze consists of walls (1s) and open paths (0s).
030 By providing custom row and column values, the source and destination
031 cells can be adjusted.
032 >>> maze = [[0, 1, 0, 1, 1],
033 ... [0, 0, 0, 0, 0],
034 ... [1, 0, 1, 0, 1],
035 ... [0, 0, 1, 0, 0],
036 ... [1, 0, 0, 1, 0]]
037 >>> solve_maze(maze,0,0,len(maze)-1,len(maze)-1)
Expected:
[[0, 1, 1, 1, 1],
[0, 0, 0, 0, 1],
[1, 1, 1, 0, 1],
[1, 1, 1, 0, 0],
[1, 1, 1, 1, 0]]
Got:
[[0, 1, 1, 1, 1], [0, 0, 0, 0, 1], [1, 1, 1, 0, 1], [1, 1, 1, 0, 0], [1, 1, 1, 1, 0]]

/home/runner/work/Python/Python/backtracking/rat_in_maze.py:37: DocTestFailure

Muhammadummerr · 2023-10-04T17:46:44Z

________________ [doctest] backtracking.rat_in_maze.solve_maze _________________ 028 aiming to reach a destination cell. 029 The maze consists of walls (1s) and open paths (0s). 030 By providing custom row and column values, the source and destination 031 cells can be adjusted. 032 >>> maze = [[0, 1, 0, 1, 1], 033 ... [0, 0, 0, 0, 0], 034 ... [1, 0, 1, 0, 1], 035 ... [0, 0, 1, 0, 0], 036 ... [1, 0, 0, 1, 0]] 037 >>> solve_maze(maze,0,0,len(maze)-1,len(maze)-1) Expected: [[0, 1, 1, 1, 1], [0, 0, 0, 0, 1], [1, 1, 1, 0, 1], [1, 1, 1, 0, 0], [1, 1, 1, 1, 0]] Got: [[0, 1, 1, 1, 1], [0, 0, 0, 0, 1], [1, 1, 1, 0, 1], [1, 1, 1, 0, 0], [1, 1, 1, 1, 0]]

/home/runner/work/Python/Python/backtracking/rat_in_maze.py:37: DocTestFailure

This same test case passed on my local device because I used (optionflags=doctest.NORMALIZE_WHITESPACE), so why is it failing here?

Muhammadummerr · 2023-10-04T17:57:44Z

Do we really care about changing the initial and destination cells in the maze?

I do not really see the benefit of it and it just makes the implementation harder to read and understand.

I guess; it would be more helpful for understanding to run the program with different source and destination points to find the path.

Muhammadummerr · 2023-10-04T18:22:40Z

Does this program require any further changes, or is it okay as it is?

backtracking/rat_in_maze.py

cclauss · 2023-10-04T18:34:17Z

backtracking/rat_in_maze.py

    import doctest

-    doctest.testmod()
+    doctest.testmod(optionflags=doctest.NORMALIZE_WHITESPACE)


Does this work?!?

Does this work?!?

Yes, it's working on my local machine, but it's not working on the build test. That's why I added '# doctest: +NORMALIZE_WHITESPACE' to each test.

UPDATED rat_in_maze.py

9450821

algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Sep 30, 2023

Update reddit.py in Webprogramming b/c it was causing error in pre-co…

9a1d65f

…mmit tests while raising PR.

Muhammadummerr requested a review from cclauss as a code owner September 30, 2023 20:09

cclauss reviewed Oct 1, 2023

View reviewed changes

Muhammadummerr and others added 3 commits October 1, 2023 14:36

Merge branch 'TheAlgorithms:master' into new_branch

741bb72

UPDATED rat_in_maze.py

1b2a9e6

Merge branch 'new_branch' of https://github.com/Muhammadummerr/Python …

726bc5c

…into new_branch

Muhammadummerr requested a review from cclauss October 1, 2023 12:35

dlesnoff reviewed Oct 4, 2023

View reviewed changes

Muhammadummerr and others added 5 commits October 4, 2023 20:34

Merge branch 'TheAlgorithms:master' into new_branch

d9e1956

fixed return type to only maze,otherwise raise valueError.

49e6dee

Merge branch 'new_branch' of https://github.com/Muhammadummerr/Python …

b59a85d

…into new_branch

fixed whitespaces error,improved matrix visual.

cedaf35

[pre-commit.ci] auto fixes from pre-commit.com hooks

775d6cd

for more information, see https://pre-commit.ci

algorithms-keeper bot added the tests are failing Do not merge until tests pass label Oct 4, 2023

updated.

c740da3

Muhammadummerr added 2 commits October 4, 2023 21:28

Try

591c098

Merge branch 'new_branch' of https://github.com/Muhammadummerr/Python …

9c89c79

…into new_branch

updated

1539b6f

updated

e169d07

algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Oct 4, 2023

cclauss approved these changes Oct 4, 2023

View reviewed changes

algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 4, 2023

Apply suggestions from code review

8013870

algorithms-keeper bot added the awaiting reviews This PR is ready to be reviewed label Oct 4, 2023

cclauss merged commit c16d2f8 into TheAlgorithms:master Oct 4, 2023

algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 4, 2023

isidroas mentioned this pull request Jan 25, 2025

dh isidroas/Python#1

Closed

14 tasks

Uh oh!

Conversation

Muhammadummerr commented Sep 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your change:

Checklist:

Uh oh!

cclauss Oct 1, 2023

Choose a reason for hiding this comment

Uh oh!

dlesnoff Oct 3, 2023

Choose a reason for hiding this comment

Uh oh!

dlesnoff Oct 4, 2023

Choose a reason for hiding this comment

Uh oh!

Muhammadummerr commented Oct 2, 2023

Uh oh!

dlesnoff commented Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cclauss commented Oct 3, 2023

Uh oh!

Muhammadummerr commented Oct 3, 2023

Uh oh!

cclauss commented Oct 3, 2023

Uh oh!

Muhammadummerr commented Oct 3, 2023

Uh oh!

Muhammadummerr commented Oct 3, 2023

Uh oh!

dlesnoff commented Oct 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dlesnoff Oct 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cclauss Oct 4, 2023

Choose a reason for hiding this comment

Uh oh!

Muhammadummerr commented Oct 4, 2023

Uh oh!

cclauss commented Oct 4, 2023

Uh oh!

cclauss commented Oct 4, 2023

Uh oh!

Muhammadummerr commented Oct 4, 2023

Uh oh!

Muhammadummerr commented Oct 4, 2023

Uh oh!

Muhammadummerr commented Oct 4, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cclauss Oct 4, 2023

Choose a reason for hiding this comment

Uh oh!

Muhammadummerr Oct 4, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Muhammadummerr commented Sep 30, 2023 •

edited

Loading

dlesnoff commented Oct 3, 2023 •

edited

Loading

dlesnoff commented Oct 4, 2023 •

edited

Loading

dlesnoff Oct 4, 2023 •

edited

Loading