Sourcery refactored main branch #1

sourcery-ai · 2022-03-02T16:11:50Z

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 · 2022-03-02T16:11:52Z

numpydoc/docscrape.py

-        if isinstance(data, list):
-            self._str = data
-        else:
-            self._str = data.split('\n')  # store string as list of lines
-
+        self._str = data if isinstance(data, list) else data.split('\n')


Function Reader.__init__ refactored with the following changes:

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

This removes the following comments ( why? ):

# store string as list of lines

sourcery-ai · 2022-03-02T16:11:52Z

numpydoc/docscrape.py

-        if not self.eof():
-            out = self[self._l]
-            self._l += 1
-            return out
-        else:
+        if self.eof():
            return ''
+        out = self[self._l]
+        self._l += 1
+        return out


Function Reader.read refactored with the following changes:

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

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

sourcery-ai · 2022-03-02T16:11:52Z

numpydoc/docscrape.py

-        if self._l + n < len(self._str):
-            return self[self._l + n]
-        else:
-            return ''
+        return self[self._l + n] if self._l + n < len(self._str) else ''


Function Reader.peek refactored with the following changes:

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

sourcery-ai · 2022-03-02T16:11:52Z

numpydoc/docscrape.py

-                if single_element_is_type:
-                    arg_name, arg_type = '', header
-                else:
-                    arg_name, arg_type = header, ''
-
+                arg_name, arg_type = ('', header) if single_element_is_type else (header, '')


Function NumpyDocString._parse_param_list refactored with the following changes:

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

sourcery-ai · 2022-03-02T16:11:52Z

numpydoc/docscrape.py

-        section_names = set([section for section, content in sections])
+        section_names = {section for section, content in sections}


Function NumpyDocString._parse refactored with the following changes:

Replace list(), dict() or set() with comprehension (collection-builtin-to-comprehension)

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

sourcery-ai · 2022-03-02T16:11:54Z

numpydoc/docscrape_sphinx.py

-            for line in self['References']:
-                m = re.match(r'.. \[([a-z0-9._-]+)\]', line, re.I)
-                if m:
-                    items.append(m.group(1))
+            items.extend(
+                m.group(1)
+                for line in self['References']
+                if (m := re.match(r'.. \[([a-z0-9._-]+)\]', line, re.I))
+            )
+


Function SphinxDocString._str_references refactored with the following changes:

Replace a for append loop with list extend (for-append-to-extend)

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

sourcery-ai · 2022-03-02T16:11:54Z

numpydoc/docscrape_sphinx.py

-        if (self.use_plots and re.search(IMPORT_MATPLOTLIB_RE, examples_str)
-                and 'plot::' not in examples_str):
-            out = []
-            out += self._str_header('Examples')
-            out += ['.. plot::', '']
-            out += self._str_indent(self['Examples'])
-            out += ['']
-            return out
-        else:
+        if (
+            not self.use_plots
+            or not re.search(IMPORT_MATPLOTLIB_RE, examples_str)
+            or 'plot::' in examples_str
+        ):
            return self._str_section('Examples')
+        out = []
+        out += self._str_header('Examples')
+        out += ['.. plot::', '']
+        out += self._str_indent(self['Examples'])
+        out += ['']
+        return out


Function SphinxDocString._str_examples refactored with the following changes:

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

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

sourcery-ai · 2022-03-02T16:11:54Z

numpydoc/docscrape_sphinx.py

-        ns = dict((k, '\n'.join(v)) for k, v in ns.items())
+        ns = {k: '\n'.join(v) for k, v in ns.items()}


Function SphinxDocString.__str__ refactored with the following changes:

Replace list(), dict() or set() with comprehension (collection-builtin-to-comprehension)

sourcery-ai · 2022-03-02T16:11:54Z

numpydoc/numpydoc.py

-        m = re.match(r'^\.\. +\[(%s)\]' %
-                     app.config.numpydoc_citation_re,
-                     line, re.I)
-        if m:
+        if m := re.match(
+            r'^\.\. +\[(%s)\]' % app.config.numpydoc_citation_re, line, re.I
+        ):
            references.add(m.group(1))

    if references:
        # we use a hash to mangle the reference name to avoid invalid names
        sha = hashlib.sha256()
        sha.update(name.encode('utf8'))
-        prefix = 'R' + sha.hexdigest()[:HASH_LEN]
+        prefix = f'R{sha.hexdigest()[:HASH_LEN]}'

        for r in references:
-            new_r = prefix + '-' + r
+            new_r = f'{prefix}-{r}'


Function rename_references refactored with the following changes:

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

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

sourcery-ai · 2022-03-02T16:11:55Z

numpydoc/numpydoc.py

-    sig = (doc['Signature']
-           or _clean_text_signature(getattr(obj, '__text_signature__', None)))
-    if sig:
+    if sig := (
+        doc['Signature']
+        or _clean_text_signature(getattr(obj, '__text_signature__', None))
+    ):


Function mangle_signature refactored with the following changes:

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

sourcery-ai · 2022-03-02T16:11:58Z

numpydoc/numpydoc.py

-    metadata = {'version': __version__,
+    return {'version': __version__,
                'parallel_read_safe': True}
-    return metadata


Function setup refactored with the following changes:

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

sourcery-ai · 2022-03-02T16:11:59Z

numpydoc/numpydoc.py

-    # Ensure that the validation check set contains only valid error codes
-    invalid_error_codes = config.numpydoc_validation_checks - valid_error_codes
-    if invalid_error_codes:
+    if (
+        invalid_error_codes := config.numpydoc_validation_checks
+        - valid_error_codes
+    ):


Function update_config refactored with the following changes:

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

Simplify generator expression (simplify-generator)

This removes the following comments ( why? ):

# Ensure that the validation check set contains only valid error codes

sourcery-ai · 2022-03-02T16:11:59Z

numpydoc/numpydoc.py

-    for i, line in enumerate(lines):
+    for line in lines:


Function match_items refactored with the following changes:

Remove unnecessary calls to enumerate when the index is not used (remove-unused-enumerate)

sourcery-ai · 2022-03-02T16:11:59Z

numpydoc/validate.py

-        for maxsplit in range(0, name.count(".") + 1):
+        for maxsplit in range(name.count(".") + 1):


Function Validator._load_obj refactored with the following changes:

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

sourcery-ai · 2022-03-02T16:11:59Z

numpydoc/validate.py

-            and not (not signature_params and not all_params)
+            and (signature_params or all_params)


Function Validator.parameter_mismatches refactored with the following changes:

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

sourcery-ai · 2022-03-02T16:11:59Z

numpydoc/xref.py

-        results = []
        tokens = pattern.split(s)
        n = len(tokens)
        if n > 1:
+            results = []


Function make_xref._split_and_apply_re refactored with the following changes:

Move assignments closer to their usage (move-assign)

sourcery-ai · 2022-03-02T16:12:00Z

numpydoc/tests/test_docscrape.py

-    for ii, (aa, bb) in enumerate(zip(a, b)):
+    for aa, bb in zip(a, b):


Function line_by_line_compare refactored with the following changes:

Remove unnecessary calls to enumerate when the index is not used (remove-unused-enumerate)

sourcery-ai · 2022-03-02T16:12:00Z

numpydoc/tests/test_docscrape.py

-            if func == 'func_h':
+            if (
+                func == 'func_h'
+                or func not in ['baz.obj_q', '~baz.obj_r']
+                and func != 'class_j'
+                and func in ['func_h1', 'func_h2']
+            ):
                assert role == 'meth'
-            elif func == 'baz.obj_q' or func == '~baz.obj_r':
+            elif func in ['baz.obj_q', '~baz.obj_r']:
                assert role == 'obj'
            elif func == 'class_j':
                assert role == 'class'
-            elif func in ['func_h1', 'func_h2']:
-                assert role == 'meth'


Function test_see_also refactored with the following changes:

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

Remove redundant conditional (remove-redundant-if)

Replace multiple comparisons of same variable with in operator (merge-comparisons)

sourcery-ai · 2022-03-02T16:12:00Z

numpydoc/tests/test_docscrape.py

-            if obj is None:
-                # Only instances have actual _data, not classes
-                return self
-            else:
-                return obj._data.axes[self.axis]
+            return self if obj is None else obj._data.axes[self.axis]


Function test_nonstandard_property.SpecialProperty.__get__ refactored with the following changes:

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

This removes the following comments ( why? ):

# Only instances have actual _data, not classes

sourcery-ai · 2022-03-02T16:12:00Z

numpydoc/tests/test_docscrape.py

-    cfg = dict()
+    cfg = {}


Function test_args_and_kwargs refactored with the following changes:

Replace dict() with {} (dict-literal)

sourcery-ai · 2022-03-02T16:12:05Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	12.73 🙂	11.94 🙂	-0.79 👍
Method Length	48.04 ⭐	47.83 ⭐	-0.21 👍
Working memory	7.31 🙂	7.31 🙂	0.00
Quality	67.70% 🙂	67.91% 🙂	0.21% 👍

Other metrics	Before	After	Change
Lines	3793	3759	-34

Changed files	Quality Before	Quality After	Quality Change
numpydoc/docscrape.py	67.61% 🙂	67.37% 🙂	-0.24% 👎
numpydoc/docscrape_sphinx.py	62.31% 🙂	62.48% 🙂	0.17% 👍
numpydoc/numpydoc.py	64.05% 🙂	63.98% 🙂	-0.07% 👎
numpydoc/validate.py	60.40% 🙂	61.52% 🙂	1.12% 👍
numpydoc/xref.py	37.18% 😞	37.18% 😞	0.00%
numpydoc/tests/test_docscrape.py	82.79% ⭐	83.05% ⭐	0.26% 👍

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
numpydoc/validate.py	validate	83 ⛔	615 ⛔	10 😞	17.01% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
numpydoc/numpydoc.py	mangle_docstrings	34 ⛔	281 ⛔	17 ⛔	18.24% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
numpydoc/xref.py	make_xref	40 ⛔	232 ⛔	13 😞	23.27% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
numpydoc/docscrape.py	NumpyDocString._parse_see_also	30 😞	211 ⛔	14 😞	27.12% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
numpydoc/docscrape_sphinx.py	SphinxDocString._str_member_list	28 😞	226 ⛔	13 😞	28.57% 😞	Refactor to reduce nesting. 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'

591cb4f

sourcery-ai bot requested a review from namurphy March 2, 2022 16:11

sourcery-ai bot commented Mar 2, 2022

View reviewed changes

		section_names = set([section for section, content in sections])
		section_names = {section for section, content in sections}

		ns = dict((k, '\n'.join(v)) for k, v in ns.items())
		ns = {k: '\n'.join(v) for k, v in ns.items()}

		for maxsplit in range(0, name.count(".") + 1):
		for maxsplit in range(name.count(".") + 1):

		and not (not signature_params and not all_params)
		and (signature_params or all_params)

		for ii, (aa, bb) in enumerate(zip(a, b)):
		for aa, bb in zip(a, b):

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 Mar 2, 2022

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Mar 2, 2022

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Mar 2, 2022

Sourcery Code Quality Report

Legend and Explanation

Uh oh!

Uh oh!