Sourcery refactored master branch #1

sourcery-ai · 2022-04-24T14:44:11Z

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-04-24T14:44:12Z

src/additions/test_pass.py

-    for number in range(100):
-        # It just don't do anything but for loop is still valid.
-        pass
+    pass


Function test_pass_in_loop refactored with the following changes:

Remove nested block which has no effect (remove-empty-nested-block)

This removes the following comments ( why? ):

# It just don't do anything but for loop is still valid.

sourcery-ai · 2022-04-24T14:44:12Z

src/classes/test_class_definition.py

            # that belongs to the class. It does not have to be named self , you can call it
            # whatever you like, but it has to be the first parameter of any function in the class.
-            return 'Hello ' + self.name
+            return f'Hello {self.name}'


Function test_class_definition.GreetingClass.say_hello refactored with the following changes:

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

sourcery-ai · 2022-04-24T14:44:13Z

src/classes/test_class_definition.py

        def say_goodbye(self):
            """Class method."""
-            return 'Goodbye ' + self.name
+            return f'Goodbye {self.name}'


Function test_class_definition.GreetingClass.say_goodbye refactored with the following changes:

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

sourcery-ai · 2022-04-24T14:44:13Z

src/classes/test_inheritance.py

    def get_full_id(self):
        """Get full employee id"""
-        return self.get_name() + ', ' + self.staff_id
+        return f'{self.get_name()}, {self.staff_id}'


Function Employee.get_full_id refactored with the following changes:

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

sourcery-ai · 2022-04-24T14:44:13Z

src/control_flow/test_continue.py

    rest_of_the_numbers = []

-    for number in range(0, 10):
+    for number in range(10):


Function test_continue_statement refactored with the following changes:

Replace range(0, x) with range(x) (remove-zero-from-range)

sourcery-ai · 2022-04-24T14:44:15Z

src/data_types/test_strings.py


-    # 'Py' 'thon'
-    python = 'Py' 'thon'
-    assert python == 'Python'


Function test_string_operators refactored with the following changes:

Remove redundant pass statement (remove-redundant-pass)

Inline variable that is only used once (inline-variable)

Remove assert True statements (remove-assert-true)

Simplify x == x -> True and x != x -> False (equality-identity)

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

This removes the following comments ( why? ):

# 'Py' 'thon'

sourcery-ai · 2022-04-24T14:44:15Z

src/data_types/test_strings.py

-    # To use formatted string literals, begin a string with f or F before the opening quotation
-    # mark or triple quotation mark. Inside this string, you can write a Python expression
-    # between { and } characters that can refer to variables or literal values.
-    year = 2018
    event = 'conference'

-    assert f'Results of the {year} {event}' == 'Results of the 2018 conference'
+    assert f'Results of the 2018 {event}' == 'Results of the 2018 conference'


Function test_string_formatting refactored with the following changes:

Inline variable that is only used once (inline-variable)

Remove redundant pass statement (remove-redundant-pass)

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

Simplify unnecessary nesting, casting and constant values in f-strings (simplify-fstring-formatting)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

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

Remove assert True statements (remove-assert-true)

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

Simplify x == x -> True and x != x -> False (equality-identity)

Replace f-string with no interpolated values with string (remove-redundant-fstring)

This removes the following comments ( why? ):

# To use formatted string literals, begin a string with f or F before the opening quotation # The String format() Method # between { and } characters that can refer to variables or literal values. # Basic usage of the str.format() method looks like this: # mark or triple quotation mark. Inside this string, you can write a Python expression

sourcery-ai · 2022-04-24T14:44:15Z

src/data_types/test_tuples.py

    # round-brackets).
    # The len() function returns the length of the tuple.
-    fruits_tuple_via_constructor = tuple(("apple", "banana", "cherry"))
+    fruits_tuple_via_constructor = "apple", "banana", "cherry"


Function test_tuples refactored with the following changes:

Unwrap a constant iterable constructor. (unwrap-iterable-construction)

Simplify sequence length comparison (simplify-len-comparison)

sourcery-ai · 2022-04-24T14:44:15Z

src/data_types/test_type_casting.py

 def test_type_casting_to_integer():
    """Type casting to integer"""

-    assert int(1) == 1


Function test_type_casting_to_integer refactored with the following changes:

Remove assert True statements (remove-assert-true)

Remove redundant pass statement (remove-redundant-pass)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

Simplify x == x -> True and x != x -> False (equality-identity)

sourcery-ai · 2022-04-24T14:44:15Z

src/data_types/test_type_casting.py

-    assert float(2.8) == 2.8
+    assert 2.8 == 2.8


Function test_type_casting_to_float refactored with the following changes:

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

sourcery-ai · 2022-04-24T14:44:16Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	1.43 ⭐	0.68 ⭐	-0.75 👍
Method Length	45.04 ⭐	43.03 ⭐	-2.01 👍
Working memory	3.89 ⭐	4.06 ⭐	0.17 👎
Quality	80.29% ⭐	81.30% ⭐	1.01% 👍

Other metrics	Before	After	Change
Lines	2140	2023	-117

Changed files	Quality Before	Quality After	Quality Change
src/additions/test_pass.py	99.57% ⭐	100.00% ⭐	0.43% 👍
src/classes/test_class_definition.py	96.11% ⭐	95.83% ⭐	-0.28% 👎
src/classes/test_inheritance.py	92.15% ⭐	92.14% ⭐	-0.01% 👎
src/control_flow/test_continue.py	82.42% ⭐	82.58% ⭐	0.16% 👍
src/control_flow/test_for.py	58.71% 🙂	60.47% 🙂	1.76% 👍
src/control_flow/test_while.py	93.51% ⭐	96.67% ⭐	3.16% 👍
src/data_types/test_lists.py	68.47% 🙂	71.47% 🙂	3.00% 👍
src/data_types/test_numbers.py	90.81% ⭐	91.37% ⭐	0.56% 👍
src/data_types/test_sets.py	81.79% ⭐	81.86% ⭐	0.07% 👍
src/data_types/test_strings.py	73.08% 🙂	72.80% 🙂	-0.28% 👎
src/data_types/test_tuples.py	75.30% ⭐	75.77% ⭐	0.47% 👍
src/data_types/test_type_casting.py	97.62% ⭐	98.25% ⭐	0.63% 👍
src/exceptions/test_handle_exceptions.py	71.63% 🙂	72.98% 🙂	1.35% 👍
src/files/test_file_methods.py	85.69% ⭐	86.13% ⭐	0.44% 👍
src/files/test_file_reading.py	93.58% ⭐	94.06% ⭐	0.48% 👍
src/functions/test_function_annotations.py	98.00% ⭐	97.92% ⭐	-0.08% 👎
src/functions/test_function_definition.py	88.99% ⭐	88.89% ⭐	-0.10% 👎
src/functions/test_function_keyword_arguments.py	81.66% ⭐	81.66% ⭐	0.00%
src/functions/test_function_scopes.py	95.79% ⭐	96.03% ⭐	0.24% 👍
src/functions/test_function_unpacking_arguments.py	90.83% ⭐	90.83% ⭐	0.00%
src/getting_started/test_variables.py	97.01% ⭐	100.00% ⭐	2.99% 👍
src/operators/test_arithmetic.py	82.94% ⭐	86.07% ⭐	3.13% 👍
src/operators/test_assigment.py	84.06% ⭐	84.36% ⭐	0.30% 👍
src/operators/test_identity.py	96.84% ⭐	96.84% ⭐	0.00%
src/operators/test_logical.py	91.20% ⭐	91.36% ⭐	0.16% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
src/control_flow/test_for.py	test_for_statement	5 ⭐	228 ⛔	8 🙂	55.81% 🙂	Try splitting into smaller methods
src/data_types/test_lists.py	test_list_comprehensions	1 ⭐	336 ⛔	6 ⭐	60.28% 🙂	Try splitting into smaller methods
src/data_types/test_strings.py	test_string_formatting	0 ⭐	198 😞	8 🙂	62.83% 🙂	Try splitting into smaller methods
src/data_types/test_lists.py	test_list_type	0 ⭐	226 ⛔	4 ⭐	70.90% 🙂	Try splitting into smaller methods
src/data_types/test_lists.py	test_nested_list_comprehensions	1 ⭐	159 😞	5 ⭐	72.64% 🙂	Try splitting into smaller methods

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!

sourcery-ai · 2022-04-24T14:44:19Z

src/data_types/test_type_casting.py

 def test_type_casting_to_string():
    """Type casting to string"""

-    assert str("s1") == 's1'


Function test_type_casting_to_string refactored with the following changes:

Remove assert True statements (remove-assert-true)

Remove redundant pass statement (remove-redundant-pass)

Remove unnecessary casts to int, str, float or bool (remove-unnecessary-cast)

Simplify x == x -> True and x != x -> False (equality-identity)

sourcery-ai · 2022-04-24T14:44:19Z

src/exceptions/test_handle_exceptions.py

-    except NameError:
+    except (NameError, ZeroDivisionError):
        # We should get here because of division by zero.
        exception_has_been_handled = True
-    except ZeroDivisionError:
-        # We should get here because of division by zero.
-        exception_has_been_handled = True
-


Function test_handle_exceptions refactored with the following changes:

Merge except handlers with identical code blocks (merge-except-handler)

sourcery-ai · 2022-04-24T14:44:19Z

src/files/test_file_methods.py

-    binary_file = open('src/files/binary_file', 'r')
-
-    # To read a file’s contents, call f.read(size), which reads some quantity of data and returns
-    # it as a string (in text mode) or bytes object (in binary mode). size is an optional numeric
-    # argument. When size is omitted or negative, the entire contents of the file will be read and
-    # returned; it’s your problem if the file is twice as large as your machine’s memory. Otherwise,
-    # at most size bytes are read and returned. If the end of the file has been reached, f.read()
-    # will return an empty string ('').
-    read_data = multi_line_file.read()
-
-    # pylint: disable=duplicate-code
-    assert read_data == 'first line\nsecond line\nthird line'
-
-    # To change the file object’s position, use f.seek(offset, from_what). The position is computed
-    # from adding offset to a reference point; the reference point is selected by the from_what
-    # argument. A from_what value of 0 measures from the beginning of the file, 1 uses the current
-    # file position, and 2 uses the end of the file as the reference point. from_what can be omitted
-    # and defaults to 0, using the beginning of the file as the reference point.
-    assert binary_file.seek(0) == 0  # Go to the 0th byte in the file
-    assert binary_file.seek(6) == 6  # Go to the 6th byte in the file
-
-    assert binary_file.read(1) == '6'
-
-    # f.readline() reads a single line from the file; a newline character (\n) is left at the end
-    # of the string, and is only omitted on the last line of the file if the file doesn’t end in a
-    # newline. This makes the return value unambiguous; if f.readline() returns an empty string,
-    # the end of the file has been reached, while a blank line is represented by '\n', a string
-    # containing only a single newline.
-    multi_line_file.seek(0)
-
-    assert multi_line_file.readline() == 'first line\n'
-    assert multi_line_file.readline() == 'second line\n'
-    assert multi_line_file.readline() == 'third line'
-    assert multi_line_file.readline() == ''
-
-    multi_line_file.close()
-    binary_file.close()
+    with open('src/files/binary_file', 'r') as binary_file:
+        # To read a file’s contents, call f.read(size), which reads some quantity of data and returns
+        # it as a string (in text mode) or bytes object (in binary mode). size is an optional numeric
+        # argument. When size is omitted or negative, the entire contents of the file will be read and
+        # returned; it’s your problem if the file is twice as large as your machine’s memory. Otherwise,
+        # at most size bytes are read and returned. If the end of the file has been reached, f.read()
+        # will return an empty string ('').
+        read_data = multi_line_file.read()
+
+        # pylint: disable=duplicate-code
+        assert read_data == 'first line\nsecond line\nthird line'
+
+        # To change the file object’s position, use f.seek(offset, from_what). The position is computed
+        # from adding offset to a reference point; the reference point is selected by the from_what
+        # argument. A from_what value of 0 measures from the beginning of the file, 1 uses the current
+        # file position, and 2 uses the end of the file as the reference point. from_what can be omitted
+        # and defaults to 0, using the beginning of the file as the reference point.
+        assert binary_file.seek(0) == 0  # Go to the 0th byte in the file
+        assert binary_file.seek(6) == 6  # Go to the 6th byte in the file
+
+        assert binary_file.read(1) == '6'
+
+        # f.readline() reads a single line from the file; a newline character (\n) is left at the end
+        # of the string, and is only omitted on the last line of the file if the file doesn’t end in a
+        # newline. This makes the return value unambiguous; if f.readline() returns an empty string,
+        # the end of the file has been reached, while a blank line is represented by '\n', a string
+        # containing only a single newline.
+        multi_line_file.seek(0)
+
+        assert multi_line_file.readline() == 'first line\n'
+        assert multi_line_file.readline() == 'second line\n'
+        assert multi_line_file.readline() == 'third line'
+        assert multi_line_file.readline() == ''
+
+        multi_line_file.close()


Function test_file_methods refactored with the following changes:

Use with when opening file to ensure closure (ensure-file-closed)

sourcery-ai · 2022-04-24T14:44:19Z

src/files/test_file_reading.py

-    # Open files without using 'with' statement.
-    file = open('src/files/multi_line_file.txt', 'r')
-
-    assert not file.closed
-
-    read_data = file.read()
+    with open('src/files/multi_line_file.txt', 'r') as file:
+        assert not file.closed

-    assert read_data == (
-        'first line\n'
-        'second line\n'
-        'third line'
-    )
+        read_data = file.read()

-    file.close()
+        assert read_data == (
+            'first line\n'
+            'second line\n'
+            'third line'
+        )


Function test_files_open refactored with the following changes:

Use with when opening file to ensure closure (ensure-file-closed)

This removes the following comments ( why? ):

# Open files without using 'with' statement.

sourcery-ai · 2022-04-24T14:44:19Z

src/functions/test_function_annotations.py

    This function has a positional argument, a keyword argument, and the return value annotated.
    """
-    return ham + ' and ' + eggs
+    return f'{ham} and {eggs}'


Function breakfast refactored with the following changes:

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

sourcery-ai · 2022-04-24T14:44:21Z

src/operators/test_arithmetic.py

-    # Addition.
-    assert 5 + 3 == 8
-
-    # Subtraction.
-    assert 5 - 3 == 2
-
-    # Multiplication.
-    assert 5 * 3 == 15
    assert isinstance(5 * 3, int)

    # Division.
    # Result of division is float number.
-    assert 5 / 3 == 1.6666666666666667
-    assert 8 / 4 == 2
+    assert 5 == 1.6666666666666667 * 3


Function test_arithmetic_operators refactored with the following changes:

Remove redundant pass statement (remove-redundant-pass)

Remove assert True statements (remove-assert-true)

Simplify numeric comparison (simplify-numeric-comparison)

Simplify x == x -> True and x != x -> False (equality-identity)

This removes the following comments ( why? ):

# Subtraction. # Multiplication. # Addition.

sourcery-ai · 2022-04-24T14:44:21Z

src/operators/test_assigment.py


-    # Assignment: =
-    number = 5
-    assert number == 5


Function test_assignment_operator refactored with the following changes:

Inline variable that is only used once (inline-variable)

Remove redundant pass statement (remove-redundant-pass)

Remove assert True statements (remove-assert-true)

Simplify x == x -> True and x != x -> False (equality-identity)

This removes the following comments ( why? ):

# Assignment: =

sourcery-ai · 2022-04-24T14:44:21Z

src/operators/test_assigment.py

-    # Assignment: +=
-    number = 5
-    number += 3
+    number = 5 + 3
    assert number == 8

-    # Assignment: -=
-    number = 5
-    number -= 3
+    number = 5 - 3
    assert number == 2

-    # Assignment: *=
-    number = 5
-    number *= 3
+    number = 5 * 3
    assert number == 15

-    # Assignment: /=
-    number = 8
-    number /= 4
+    number = 8 / 4


Function test_augmented_assignment_operators refactored with the following changes:

Replace assignment and augmented assignment with single assignment (merge-assign-and-aug-assign)

This removes the following comments ( why? ):

# Assignment: -= # Assignment: /= # Assignment: += # Assignment: *=

sourcery-ai · 2022-04-24T14:44:21Z

src/operators/test_identity.py

-    # is
-    # Returns true if both variables are the same object.
-
-    # Example:
-    # first_fruits_list and third_fruits_list are the same objects.
-    assert first_fruits_list is third_fruits_list
-
-    # is not
-    # Returns true if both variables are not the same object.
-
-    # Example:
-    # first_fruits_list and second_fruits_list are not the same objects, even if they have
-    # the same content
-    assert first_fruits_list is not second_fruits_list
-
-    # To demonstrate the difference between "is" and "==": this comparison returns True because
-    # first_fruits_list is equal to second_fruits_list.
-    assert first_fruits_list == second_fruits_list
+    assert third_fruits_list is third_fruits_list
+    assert third_fruits_list is not second_fruits_list
+    assert third_fruits_list == second_fruits_list


Function test_identity_operators refactored with the following changes:

Use previously assigned local variable (use-assigned-variable)

This removes the following comments ( why? ):

# Returns true if both variables are the same object. # is not # To demonstrate the difference between "is" and "==": this comparison returns True because # is # first_fruits_list and second_fruits_list are not the same objects, even if they have # first_fruits_list is equal to second_fruits_list. # Example: # the same content # first_fruits_list and third_fruits_list are the same objects. # Returns true if both variables are not the same object.

sourcery-ai · 2022-04-24T14:44:22Z

src/operators/test_logical.py

    # pylint: disable=unneeded-not
-    assert not first_number == second_number
+    assert first_number != second_number
    assert first_number != second_number


Function test_logical_operators refactored with the following changes:

Simplify logical expression using De Morgan identities (de-morgan)

'Refactored by Sourcery'

aa9b446

sourcery-ai bot requested a review from edson-github April 24, 2022 14:44

sourcery-ai bot commented Apr 24, 2022

View reviewed changes

Sourcery refactored master branch #1

Are you sure you want to change the base?

Sourcery refactored master branch #1

Uh oh!

Conversation

sourcery-ai bot commented Apr 24, 2022

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Apr 24, 2022

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Apr 24, 2022

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant