Sourcery refactored main branch #1

sourcery-ai · 2023-10-23T16:27:34Z

Branch main 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 main branch, then run:

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

Help us improve this pull request!

sourcery-ai

Sourcery timed out performing refactorings.

Due to GitHub API limits, only the first 60 comments can be shown.

sourcery-ai · 2023-10-23T16:27:37Z

Doc/conf.py

 # General substitutions.
 project = 'Python'
-copyright = '2001-%s, Python Software Foundation' % time.strftime('%Y')
+copyright = f"2001-{time.strftime('%Y')}, Python Software Foundation"


Lines 52-378 refactored with the following changes:

Replace interpolated string formatting with f-string [×2] (replace-interpolation-with-fstring)

Use f-string instead of string concatenation [×6] (use-fstring-for-concatenation)

Merge dictionary assignment with declaration [×3] (merge-dict-assign)

This removes the following comments ( why? ):

# The font size ('10pt', '11pt' or '12pt'). # The paper size ('letter' or 'a4'). # Additional stuff for the LaTeX preamble.

sourcery-ai · 2023-10-23T16:27:37Z

Doc/includes/dbpickle.py

-            # If obj does not have a persistent ID, return None. This means obj
-            # needs to be pickled as usual.
-            return None
+        return ("MemoRecord", obj.key) if isinstance(obj, MemoRecord) else None


Function DBPickler.persistent_id refactored with the following changes:

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

This removes the following comments ( why? ):

# If obj does not have a persistent ID, return None. This means obj # key, which refers to a specific record in the database. # Here, our persistent ID is simply a tuple, containing a tag and a # needs to be pickled as usual.

sourcery-ai · 2023-10-23T16:27:37Z

Doc/includes/email-headers.py

-print('To: {}'.format(headers['to']))
-print('From: {}'.format(headers['from']))
-print('Subject: {}'.format(headers['subject']))
+print(f"To: {headers['to']}")
+print(f"From: {headers['from']}")
+print(f"Subject: {headers['subject']}")

 # You can also access the parts of the addresses:
-print('Recipient username: {}'.format(headers['to'].addresses[0].username))
-print('Sender name: {}'.format(headers['from'].addresses[0].display_name))
+print(f"Recipient username: {headers['to'].addresses[0].username}")
+print(f"Sender name: {headers['from'].addresses[0].display_name}")


Lines 19-25 refactored with the following changes:

Replace call to format with f-string [×5] (use-fstring-for-formatting)

sourcery-ai · 2023-10-23T16:27:37Z

Doc/includes/email-read-alternative.py

-if richest['content-type'].maintype == 'text':
-    if richest['content-type'].subtype == 'plain':
-        for line in richest.get_content().splitlines():
-            print(line)
-        sys.exit()
-    elif richest['content-type'].subtype == 'html':
-        body = richest
-    else:
-        print("Don't know how to display {}".format(richest.get_content_type()))
-        sys.exit()
-elif richest['content-type'].content_type == 'multipart/related':
+if (
+    richest['content-type'].maintype == 'text'
+    and richest['content-type'].subtype == 'plain'
+):
+    for line in richest.get_content().splitlines():
+        print(line)
+    sys.exit()
+elif (
+    richest['content-type'].maintype == 'text'
+    and richest['content-type'].subtype == 'html'
+):
+    body = richest
+elif (
+    richest['content-type'].maintype == 'text'
+    or richest['content-type'].content_type != 'multipart/related'
+):
+    print(f"Don't know how to display {richest.get_content_type()}")
+    sys.exit()
+else:
    body = richest.get_body(preferencelist=('html'))
    for part in richest.iter_attachments():
-        fn = part.get_filename()
-        if fn:
+        if fn := part.get_filename():


Lines 46-70 refactored with the following changes:

Merge duplicate blocks in conditional (merge-duplicate-blocks)

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

Use named expression to simplify assignment and conditional (use-named-expression)

Remove redundant conditional [×2] (remove-redundant-if)

sourcery-ai · 2023-10-23T16:27:37Z

Doc/includes/minidom-example.py

-    for node in nodelist:
-        if node.nodeType == node.TEXT_NODE:
-            rc.append(node.data)
+    rc = [node.data for node in nodelist if node.nodeType == node.TEXT_NODE]


Function getText refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2023-10-23T16:27:38Z

Doc/includes/tzinfo_examples.py

-        if self.dst(dt):
-            return self.dstname
-        else:
-            return self.stdname
+        return self.dstname if self.dst(dt) else self.stdname


Function USTimeZone.tzname refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:38Z

Doc/tools/check-warnings.py

-    line_numbers = list(itertools.chain(*line_ranges))
-
-    return line_numbers
+    return list(itertools.chain(*line_ranges))


Function get_diff_lines refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:38Z

Doc/tools/check-warnings.py

-    non_null_matches = [warning for warning in warning_matches if warning]
-    return non_null_matches
+    return [warning for warning in warning_matches if warning]


Function filter_and_parse_warnings refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:39Z

Doc/tools/check-warnings.py

-    warnings_touched = [
+    return [
        warning
        for warning in warnings_infile
        if int(warning["line"]) in touched_para_lines
    ]
-    return warnings_touched


Function filter_warnings_by_diff refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:39Z

Doc/tools/check-warnings.py

-    warnings_touched = warnings_added + list(
-        itertools.chain(*warnings_modified_touched)
-    )
-
-    return warnings_touched
+    return warnings_added + list(itertools.chain(*warnings_modified_touched))


Function process_touched_warnings refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:41Z

Doc/tools/check-warnings.py

-    problem_files = sorted(should_be_clean & files_with_nits)
-    if problem_files:
+    if problem_files := sorted(should_be_clean & files_with_nits):


Function fail_if_regression refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2023-10-23T16:27:41Z

Doc/tools/check-warnings.py

-    files_with_no_nits = files_with_expected_nits - files_with_nits
-    if files_with_no_nits:
+    if files_with_no_nits := files_with_expected_nits - files_with_nits:


Function fail_if_improved refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2023-10-23T16:27:41Z

Doc/tools/extensions/asdl_highlight.py

+

Lines 29-32 refactored with the following changes:

Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)

sourcery-ai · 2023-10-23T16:27:41Z

Doc/tools/extensions/c_annotations.py

-                    refcount = None
-                else:
-                    refcount = int(refcount)
+                refcount = None if not refcount or refcount == "null" else int(refcount)


Function Annotations.__init__ refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:41Z

Doc/tools/extensions/c_annotations.py

-            # Stable ABI annotation. These have two forms:
-            #   Part of the [Stable ABI](link).
-            #   Part of the [Stable ABI](link) since version X.Y.
-            # For structs, there's some more info in the message:
-            #   Part of the [Limited API](link) (as an opaque struct).
-            #   Part of the [Stable ABI](link) (including all members).
-            #   Part of the [Limited API](link) (Only some members are part
-            #       of the stable ABI.).
-            # ... all of which can have "since version X.Y" appended.
-            record = self.stable_abi_data.get(name)
-            if record:
+            if record := self.stable_abi_data.get(name):


Function Annotations.add_annotations refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

Simplify conditional into switch-like form [×2] (switch)

Swap if/else to remove empty if body (remove-pass-body)

This removes the following comments ( why? ):

# Part of the [Limited API](link) (as an opaque struct). # Part of the [Stable ABI](link) since version X.Y. # Stable ABI annotation. These have two forms: # ... all of which can have "since version X.Y" appended. # Stable ABI was introduced in 3.2. # For structs, there's some more info in the message: # Part of the [Stable ABI](link) (including all members). # Part of the [Stable ABI](link). # of the stable ABI.). # Part of the [Limited API](link) (Only some members are part

sourcery-ai · 2023-10-23T16:27:42Z

Doc/tools/extensions/pyspecific.py

-            f.write(('topics = ' + pformat(self.topics) + '\n').encode('utf-8'))
+            f.write((f'topics = {pformat(self.topics)}' + '\n').encode('utf-8'))


Function PydocTopicsBuilder.finish refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:42Z

Doc/tools/extensions/pyspecific.py

-        signode += addnodes.desc_addname(' '+args, ' '+args)
+        signode += addnodes.desc_addname(f' {args}', f' {args}')


Function parse_pdb_command refactored with the following changes:

Use f-string instead of string concatenation [×2] (use-fstring-for-concatenation)

sourcery-ai · 2023-10-23T16:27:42Z

Doc/tools/extensions/pyspecific.py

-                ref = nodes.reference("", nodes.Text("[{}]".format(i)), internal=True)
+                ref = nodes.reference("", nodes.Text(f"[{i}]"), internal=True)
                try:
-                    ref['refuri'] = "{}#{}".format(
-                        app.builder.get_relative_uri(fromdocname, doc),
-                        label,
-                    )
+                    ref['refuri'] = f"{app.builder.get_relative_uri(fromdocname, doc)}#{label}"


Function process_audit_events refactored with the following changes:

Replace call to format with f-string [×2] (use-fstring-for-formatting)

sourcery-ai · 2023-10-23T16:27:42Z

Lib/__future__.py

-        return "_Feature" + repr((self.optional,
-                                  self.mandatory,
-                                  self.compiler_flag))
+        return f"_Feature{repr((self.optional, self.mandatory, self.compiler_flag))}"


Function _Feature.__repr__ refactored with the following changes:

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

sourcery-ai · 2023-10-23T16:27:43Z

Lib/_aix_support.py

-    fp = open("/tmp/_aix_support.%s"%(
-        os.getpid(),), "w+b")
+    fp = open(f"/tmp/_aix_support.{os.getpid()}", "w+b")

    with contextlib.closing(fp) as fp:
        if capture_stderr:
-            cmd = "%s >'%s' 2>&1" % (commandstring, fp.name)
+            cmd = f"{commandstring} >'{fp.name}' 2>&1"
        else:
-            cmd = "%s 2>/dev/null >'%s'" % (commandstring, fp.name)
+            cmd = f"{commandstring} 2>/dev/null >'{fp.name}'"


Function _read_cmd_output refactored with the following changes:

Replace interpolated string formatting with f-string [×3] (replace-interpolation-with-fstring)

sourcery-ai · 2023-10-23T16:27:45Z

Lib/_aix_support.py

-    # type: () -> List[int]
-    gnu_type = sysconfig.get_config_var("BUILD_GNU_TYPE")
-    if not gnu_type:
+    if gnu_type := sysconfig.get_config_var("BUILD_GNU_TYPE"):
+        return _aix_vrtl(vrmf=gnu_type)
+    else:
        raise ValueError("BUILD_GNU_TYPE is not defined")
-    return _aix_vrtl(vrmf=gnu_type)


Function _aix_bgt refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

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

Swap if/else branches (swap-if-else-branches)

This removes the following comments ( why? ):

# type: () -> List[int]

sourcery-ai · 2023-10-23T16:27:45Z

Lib/_collections_abc.py

-        if cls is Hashable:
-            return _check_methods(C, "__hash__")
-        return NotImplemented
+        return _check_methods(C, "__hash__") if cls is Hashable else NotImplemented


Function Hashable.__subclasshook__ 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)

sourcery-ai · 2023-10-23T16:27:45Z

Lib/_collections_abc.py

-        if cls is Awaitable:
-            return _check_methods(C, "__await__")
-        return NotImplemented
+        return _check_methods(C, "__await__") if cls is Awaitable else NotImplemented


Function Awaitable.__subclasshook__ 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)

sourcery-ai · 2023-10-23T16:27:45Z

Lib/_collections_abc.py

-        if cls is Iterable:
-            return _check_methods(C, "__iter__")
-        return NotImplemented
+        return _check_methods(C, "__iter__") if cls is Iterable else NotImplemented


Function Iterable.__subclasshook__ 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)

sourcery-ai · 2023-10-23T16:27:45Z

Lib/_collections_abc.py

-        if cls is Sized:
-            return _check_methods(C, "__len__")
-        return NotImplemented
+        return _check_methods(C, "__len__") if cls is Sized else NotImplemented


Function Sized.__subclasshook__ 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)

sourcery-ai · 2023-10-23T16:27:46Z

Lib/_markupbase.py

        rawdata = self.rawdata
-        nlines = rawdata.count("\n", i, j)
-        if nlines:
+        if nlines := rawdata.count("\n", i, j):


Function ParserBase.updatepos refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

sourcery-ai · 2023-10-23T16:27:47Z

Lib/_markupbase.py

-                m = _declstringlit_match(rawdata, j)
-                if not m:
+                if m := _declstringlit_match(rawdata, j):
+                    j = m.end()
+                else:
                    return -1 # incomplete
-                j = m.end()


Function ParserBase.parse_declaration refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

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

Swap if/else branches (swap-if-else-branches)

Replace interpolated string formatting with f-string (replace-interpolation-with-fstring)

sourcery-ai · 2023-10-23T16:27:47Z

Lib/_markupbase.py

-                meth = getattr(self, "_parse_doctype_" + name)
+                meth = getattr(self, f"_parse_doctype_{name}")


Function ParserBase._parse_doctype_subset refactored with the following changes:

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

Swap if/else branches (swap-if-else-branches)

Remove unnecessary else after guard condition (remove-unnecessary-else)

sourcery-ai · 2023-10-23T16:27:47Z

Lib/_markupbase.py

-        if '>' in rawdata[j:]:
-            return rawdata.find(">", j) + 1
-        return -1
+        return rawdata.find(">", j) + 1 if '>' in rawdata[j:] else -1


Function ParserBase._parse_doctype_element 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)

sourcery-ai · 2023-10-23T16:27:47Z

Lib/_markupbase.py

-                m = _declstringlit_match(rawdata, j)
-                if m:
+                if m := _declstringlit_match(rawdata, j):


Function ParserBase._parse_doctype_attlist refactored with the following changes:

Use named expression to simplify assignment and conditional (use-named-expression)

code-review-doctor

Looks good. Worth considering though. View full project report here.

code-review-doctor · 2023-10-23T16:29:22Z

Lib/antigravity.py

    # https://xkcd.com/426/
    h = hashlib.md5(datedow, usedforsecurity=False).hexdigest()
-    p, q = [('%f' % float.fromhex('0.' + x)) for x in (h[:16], h[16:32])]
+    p, q = ['%f' % float.fromhex(f'0.{x}') for x in (h[:16], h[16:32])]


f-string is easier to read, write, and less computationally expensive than legacy string formatting. More details.

code-review-doctor · 2023-10-23T16:29:22Z

Lib/argparse.py

-                    parts.append('%*s%s\n' % (help_position, '', line))
-
-        # or add a newline if the description doesn't end with one
+                parts.extend('%*s%s\n' % (help_position, '', line) for line in help_lines[1:])


f-string is easier to read, write, and less computationally expensive than legacy string formatting. Read more.

code-review-doctor · 2023-10-23T16:29:22Z

Lib/argparse.py

-                result = '[%s [%s ...]]' % metavar
-            else:
-                result = '[%s ...]' % metavar
+            return '[%s [%s ...]]' % metavar if len(metavar) == 2 else f'[{metavar} ...]'


As above, Consider using f-string instead.

code-review-doctor · 2023-10-23T16:29:22Z

Lib/argparse.py

+            return '[%s [%s ...]]' % metavar if len(metavar) == 2 else f'[{metavar} ...]'
        elif action.nargs == ONE_OR_MORE:
-            result = '%s [%s ...]' % get_metavar(2)
+            return '%s [%s ...]' % get_metavar(2)


Likewise, Consider using f-string instead.

code-review-doctor · 2023-10-23T16:29:23Z

Doc/tools/extensions/escape4chm.py

-            return '&#%d;' % codepoint
-        else:
-            return '&%s;' % name
+        return '&#%d;' % codepoint if name is None else f'&{name};'


f-string is easier to read, write, and less computationally expensive than legacy string formatting. More.

code-review-doctor · 2023-10-23T16:29:23Z

Lib/dis.py

        lines.append("Free variables:")
-        for i_n in enumerate(co.co_freevars):
-            lines.append("%4d: %s" % i_n)
+        lines.extend("%4d: %s" % i_n for i_n in enumerate(co.co_freevars))


Same as above: Consider using f-string instead.

code-review-doctor · 2023-10-23T16:29:23Z

Lib/dis.py

        lines.append("Cell variables:")
-        for i_n in enumerate(co.co_cellvars):
-            lines.append("%4d: %s" % i_n)
+        lines.extend("%4d: %s" % i_n for i_n in enumerate(co.co_cellvars))


Similarly, Consider using f-string instead.

code-review-doctor · 2023-10-23T16:29:24Z

Lib/enum.py

-            return "<flag %r>" % cls.__name__
+    def __repr__(self):
+        if Flag is not None and issubclass(self, Flag):
+            return "<flag %r>" % self.__name__


f-string is easier to read, write, and less computationally expensive than legacy string formatting. Explained here.

code-review-doctor · 2023-10-23T16:29:24Z

Lib/enum.py

+            return "<flag %r>" % self.__name__
        else:
-            return "<enum %r>" % cls.__name__
+            return "<enum %r>" % self.__name__


Likewise, Consider using f-string instead.

code-review-doctor · 2023-10-23T16:29:24Z

Lib/enum.py

+    if self._name_ is not None:
        return self._name_
+    cls_name = self.__class__.__name__
+    return "%s(%r)" % (cls_name, self._value_)


Again, Consider using f-string instead.

'Refactored by Sourcery'

69ad0ce

sourcery-ai bot requested a review from Powerm4 October 23, 2023 16:27

sourcery-ai bot commented Oct 23, 2023

View reviewed changes

code-review-doctor bot suggested changes Oct 23, 2023

View reviewed changes

		f.write(('topics = ' + pformat(self.topics) + '\n').encode('utf-8'))
		f.write((f'topics = {pformat(self.topics)}' + '\n').encode('utf-8'))

		signode += addnodes.desc_addname(' '+args, ' '+args)
		signode += addnodes.desc_addname(f' {args}', f' {args}')

		meth = getattr(self, "_parse_doctype_" + name)
		meth = getattr(self, f"_parse_doctype_{name}")

Sourcery refactored main branch #1

Are you sure you want to change the base?

Sourcery refactored main branch #1

Uh oh!

Conversation

sourcery-ai bot commented Oct 23, 2023

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Oct 23, 2023