Sourcery refactored master branch by sourcery-ai[bot] · Pull Request #1 · avendesora/ClassicComputerScienceProblemsInPython

sourcery-ai · 2022-03-21T19:41:56Z

Branch master refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

See our documentation here.

Run Sourcery locally

Reduce the feedback loop during development by using the Sourcery editor plugin:

Review changes via command line

To manually merge these changes, make sure you're on the master branch, then run:

git fetch origin sourcery/master
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

sourcery-ai · 2022-03-21T19:41:58Z

Chapter1/fib2.py

-    if n < 2:  # base case
-        return n
-    return fib2(n - 2) + fib2(n - 1)  # recursive case
+    return n if n < 2 else fib2(n - 2) + fib2(n - 1)


Function fib2 refactored with the following changes:

Lift code into else after jump in control flow (reintroduce-else)

Replace if statement with if expression (assign-if-exp)

This removes the following comments ( why? ):

# base case # recursive case

sourcery-ai · 2022-03-21T19:41:58Z

Chapter1/fib4.py

-    if n < 2:  # base case
-        return n
-    return fib4(n - 2) + fib4(n - 1)  # recursive case
+    return n if n < 2 else fib4(n - 2) + fib4(n - 1)


Function fib4 refactored with the following changes:

Lift code into else after jump in control flow (reintroduce-else)

Replace if statement with if expression (assign-if-exp)

This removes the following comments ( why? ):

# base case # recursive case

sourcery-ai · 2022-03-21T19:41:58Z

Chapter1/trivial_compression.py

                self.bit_string |= 0b11
            else:
-                raise ValueError("Invalid Nucleotide:{}".format(nucleotide))
+                raise ValueError(f"Invalid Nucleotide:{nucleotide}")


Function CompressedGene._compress refactored with the following changes:

Replace call to format with f-string. (use-fstring-for-formatting)

sourcery-ai · 2022-03-21T19:41:58Z

Chapter1/trivial_compression.py

-            if bits == 0b00:  # A
+            if bits == 0b00:
                gene += "A"
-            elif bits == 0b01:  # C
+            elif bits == 0b01:
                gene += "C"
-            elif bits == 0b10:  # G
+            elif bits == 0b10:
                gene += "G"
-            elif bits == 0b11:  # T
+            elif bits == 0b11:
                gene += "T"
            else:
-                raise ValueError("Invalid bits:{}".format(bits))
+                raise ValueError(f"Invalid bits:{bits}")


Function CompressedGene.decompress refactored with the following changes:

Simplify conditional into switch-like form (switch)

Replace call to format with f-string. (use-fstring-for-formatting)

This removes the following comments ( why? ):

# C # T # G # A

sourcery-ai · 2022-03-21T19:41:58Z

Chapter1/trivial_compression.py

-    print("original is {} bytes".format(getsizeof(original)))
+    print(f"original is {getsizeof(original)} bytes")
    compressed: CompressedGene = CompressedGene(original)  # compress
-    print("compressed is {} bytes".format(getsizeof(compressed.bit_string)))
+    print(f"compressed is {getsizeof(compressed.bit_string)} bytes")
    print(compressed)  # decompress
-    print("original and decompressed are the same: {}".format(original == compressed.decompress()))
+    print(
+        f"original and decompressed are the same: {original == compressed.decompress()}"
+    )


Lines 60-64 refactored with the following changes:

Replace call to format with f-string. (use-fstring-for-formatting)

sourcery-ai · 2022-03-21T19:42:00Z

Chapter3/send_more_money.py

-    possible_digits: Dict[str, List[int]] = {}
-    for letter in letters:
-        possible_digits[letter] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+    possible_digits: Dict[str, List[int]] = {
+        letter: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] for letter in letters
+    }
+


Lines 49-51 refactored with the following changes:

Convert for loop into dictionary comprehension (dict-comprehension)

sourcery-ai · 2022-03-21T19:42:00Z

Chapter3/word_search.py

 def generate_grid(rows: int, columns: int) -> Grid:
    # initialize grid with random letters
-    return [[choice(ascii_uppercase) for c in range(columns)] for r in range(rows)]
+    return [[choice(ascii_uppercase) for _ in range(columns)] for _ in range(rows)]


Function generate_grid refactored with the following changes:

Replace unused for index with underscore (for-index-underscore)

sourcery-ai · 2022-03-21T19:42:01Z

Chapter3/word_search.py

-    locations: Dict[str, List[List[GridLocation]]] = {}
-    for word in words:
-        locations[word] = generate_domain(word, grid)
+    locations: Dict[str, List[List[GridLocation]]] = {
+        word: generate_domain(word, grid) for word in words
+    }
+


Lines 77-79 refactored with the following changes:

Convert for loop into dictionary comprehension (dict-comprehension)

sourcery-ai · 2022-03-21T19:42:01Z

Chapter4/dijkstra.py

-    for i in range(len(distances)):
-        distance_dict[wg.vertex_at(i)] = distances[i]
-    return distance_dict
+    return {wg.vertex_at(i): distances[i] for i in range(len(distances))}


Function distance_array_to_vertex_dict refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Convert for loop into dictionary comprehension (dict-comprehension)

sourcery-ai · 2022-03-21T19:42:01Z

Chapter4/dijkstra.py

-    edge_path: WeightedPath = []
    e: WeightedEdge = path_dict[end]
-    edge_path.append(e)
+    edge_path: WeightedPath = [e]


Function path_dict_to_path refactored with the following changes:

Simplify sequence comparison (simplify-len-comparison)

Merge append into list declaration (merge-list-append)

Move assignment closer to its usage within a block (move-assign-in-block)

sourcery-ai · 2022-03-21T19:42:04Z

Chapter4/graph.py

-        desc: str = ""
-        for i in range(self.vertex_count):
-            desc += f"{self.vertex_at(i)} -> {self.neighbors_for_index(i)}\n"
-        return desc
+        return "".join(
+            f"{self.vertex_at(i)} -> {self.neighbors_for_index(i)}\n"
+            for i in range(self.vertex_count)
+        )


Function Graph.__str__ refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Use str.join() instead of for loop (use-join)

sourcery-ai · 2022-03-21T19:42:05Z

Chapter4/mst.py


 def total_weight(wp: WeightedPath) -> float:
-    return sum([e.weight for e in wp])
+    return sum(e.weight for e in wp)


Function total_weight refactored with the following changes:

Replace unneeded comprehension with generator (comprehension-to-generator)

sourcery-ai · 2022-03-21T19:42:05Z

Chapter4/weighted_graph.py

-        distance_tuples: List[Tuple[V, float]] = []
-        for edge in self.edges_for_index(index):
-            distance_tuples.append((self.vertex_at(edge.v), edge.weight))
-        return distance_tuples
+        return [
+            (self.vertex_at(edge.v), edge.weight)
+            for edge in self.edges_for_index(index)
+        ]


Function WeightedGraph.neighbors_for_index_with_weights refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2022-03-21T19:42:05Z

Chapter4/weighted_graph.py

-        desc: str = ""
-        for i in range(self.vertex_count):
-            desc += f"{self.vertex_at(i)} -> {self.neighbors_for_index_with_weights(i)}\n"
-        return desc
+        return "".join(
+            f"{self.vertex_at(i)} -> {self.neighbors_for_index_with_weights(i)}\n"
+            for i in range(self.vertex_count)
+        )


Function WeightedGraph.__str__ refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Use str.join() instead of for loop (use-join)

sourcery-ai · 2022-03-21T19:42:05Z

Chapter5/simple_equation.py

-        else: # otherwise mutate y
-            if random() > 0.5:
-                self.y += 1
-            else:
-                self.y -= 1
+        elif random() > 0.5:
+            self.y += 1
+        else:
+            self.y -= 1


Function SimpleEquation.mutate refactored with the following changes:

Merge else clause's nested if statement into elif (merge-else-if-into-elif)

This removes the following comments ( why? ):

# otherwise mutate y

sourcery-ai · 2022-03-21T19:42:06Z

Chapter8/connectfour.py

-            segment: List[Tuple[int, int]] = []
-            for t in range(segment_length):
-                segment.append((c, r + t))
+            segment: List[Tuple[int, int]] = [(c, r + t) for t in range(segment_length)]
            segments.append(segment)

    # generate the horizontal segments
    for c in range(num_columns - segment_length + 1):
        for r in range(num_rows):
-            segment = []
-            for t in range(segment_length):
-                segment.append((c + t, r))
+            segment = [(c + t, r) for t in range(segment_length)]
            segments.append(segment)

    # generate the bottom left to top right diagonal segments
    for c in range(num_columns - segment_length + 1):
        for r in range(num_rows - segment_length + 1):
-            segment = []
-            for t in range(segment_length):
-                segment.append((c + t, r + t))
+            segment = [(c + t, r + t) for t in range(segment_length)]
            segments.append(segment)

    # generate the top left to bottom right diagonal segments
    for c in range(num_columns - segment_length + 1):
        for r in range(segment_length - 1, num_rows):
-            segment = []
-            for t in range(segment_length):
-                segment.append((c + t, r - t))
+            segment = [(c + t, r - t) for t in range(segment_length)]


Function generate_segments refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2022-03-21T19:42:06Z

Chapter8/connectfour.py

-        total: float = 0
-        for segment in C4Board.SEGMENTS:
-            total += self._evaluate_segment(segment, player)
-        return total
+        return sum(
+            self._evaluate_segment(segment, player) for segment in C4Board.SEGMENTS
+        )


Function C4Board.evaluate refactored with the following changes:

Inline variable that is immediately returned (inline-immediately-returned-variable)

Convert for loop into call to sum() (sum-comprehension)

sourcery-ai · 2022-03-21T19:42:06Z

Chapter8/connectfour.py

-                display += f"{self.position[c][r]}" + "|"
+                display += f"{self.position[c][r]}|"


Function C4Board.__repr__ refactored with the following changes:

Use f-string instead of string concatenation (use-fstring-for-concatenation)

sourcery-ai · 2022-03-21T19:42:06Z

Chapter8/tictactoe.py

        if self.is_win and self.turn == player:
            return -1
-        elif self.is_win and self.turn != player:
+        elif self.is_win:


Function TTTBoard.evaluate refactored with the following changes:

Remove redundant conditional (remove-redundant-if)

sourcery-ai · 2022-03-21T19:42:06Z

Chapter9/phone_number_mnemonics.py

-    letter_tuples: List[Tuple[str, ...]] = []
-    for digit in phone_number:
-        letter_tuples.append(phone_mapping.get(digit, (digit,)))
+    letter_tuples: List[Tuple[str, ...]] = [
+        phone_mapping.get(digit, (digit,)) for digit in phone_number
+    ]
+


Function possible_mnemonics refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2022-03-21T19:42:10Z

Sourcery Code Quality Report

✅ Merging this PR will increase code quality in the affected files by 0.29%.

Quality metrics	Before	After	Change
Complexity	4.80 ⭐	4.31 ⭐	-0.49 👍
Method Length	36.16 ⭐	35.62 ⭐	-0.54 👍
Working memory	5.92 ⭐	5.92 ⭐	0.00
Quality	77.73% ⭐	78.02% ⭐	0.29% 👍

Other metrics	Before	After	Change
Lines	1315	1302	-13

Changed files	Quality Before	Quality After	Quality Change
Chapter1/fib2.py	96.22% ⭐	96.77% ⭐	0.55% 👍
Chapter1/fib4.py	95.75% ⭐	96.44% ⭐	0.69% 👍
Chapter1/trivial_compression.py	78.73% ⭐	78.90% ⭐	0.17% 👍
Chapter2/dna_search.py	88.03% ⭐	87.53% ⭐	-0.50% 👎
Chapter2/generic_search.py	84.70% ⭐	84.48% ⭐	-0.22% 👎
Chapter2/maze.py	76.24% ⭐	76.14% ⭐	-0.10% 👎
Chapter2/missionaries.py	67.60% 🙂	67.69% 🙂	0.09% 👍
Chapter3/csp.py	84.98% ⭐	84.61% ⭐	-0.37% 👎
Chapter3/map_coloring.py	78.42% ⭐	80.41% ⭐	1.99% 👍
Chapter3/queens.py	78.57% ⭐	79.21% ⭐	0.64% 👍
Chapter3/send_more_money.py	69.20% 🙂	69.21% 🙂	0.01% 👍
Chapter3/word_search.py	64.40% 🙂	65.67% 🙂	1.27% 👍
Chapter4/dijkstra.py	68.63% 🙂	67.63% 🙂	-1.00% 👎
Chapter4/graph.py	79.04% ⭐	78.82% ⭐	-0.22% 👎
Chapter4/mst.py	71.82% 🙂	71.82% 🙂	0.00%
Chapter4/weighted_graph.py	80.69% ⭐	79.84% ⭐	-0.85% 👎
Chapter5/simple_equation.py	88.00% ⭐	88.69% ⭐	0.69% 👍
Chapter6/data_point.py	95.45% ⭐	94.80% ⭐	-0.65% 👎
Chapter7/layer.py	77.33% ⭐	78.47% ⭐	1.14% 👍
Chapter7/util.py	89.57% ⭐	90.21% ⭐	0.64% 👍
Chapter8/connectfour.py	73.87% 🙂	78.00% ⭐	4.13% 👍
Chapter8/tictactoe.py	86.28% ⭐	86.62% ⭐	0.34% 👍
Chapter9/phone_number_mnemonics.py	94.87% ⭐	93.30% ⭐	-1.57% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
Chapter2/missionaries.py	MCState.successors	24 😞	232 ⛔	8 🙂	39.97% 😞	Refactor to reduce nesting. Try splitting into smaller methods
Chapter8/tictactoe.py	TTTBoard.is_win	9 🙂	216 ⛔	13 😞	43.28% 😞	Try splitting into smaller methods. Extract out complex expressions
Chapter3/word_search.py	generate_domain	17 🙂	133 😞	10 😞	49.15% 😞	Try splitting into smaller methods. Extract out complex expressions
Chapter8/connectfour.py	generate_segments	12 🙂	150 😞	9 🙂	53.47% 🙂	Try splitting into smaller methods
Chapter3/send_more_money.py	SendMoreMoneyConstraint.satisfied	2 ⭐	125 😞	15 😞	55.89% 🙂	Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

⭐ excellent
🙂 good
😞 poor
⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

'Refactored by Sourcery'

e84476c

sourcery-ai bot requested a review from avendesora March 21, 2022 19:41

sourcery-ai bot commented Mar 21, 2022

View reviewed changes

		display += f"{self.position[c][r]}" + "\|"
		display += f"{self.position[c][r]}\|"

Conversation

sourcery-ai bot commented Mar 21, 2022

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 21, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Mar 21, 2022

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

0 participants