Sourcery refactored master branch #103

sourcery-ai · 2020-06-24T00:30: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^

sourcery-ai · 2020-06-24T00:30:20Z

pygmt/tests/test_clib.py

-    out_fname = "test_call_module.txt"
    with clib.Session() as lib:
+        out_fname = "test_call_module.txt"


Function test_call_module refactored with the following changes:

Move assignments closer to their usage

sourcery-ai · 2020-06-24T00:30:20Z

pygmt/tests/test_clib.py

-            # Turns out wesn doesn't matter for Datasets
-            wesn = [0] * 6
            # Save the data to a file to see if it's being accessed correctly
            with GMTTempFile() as tmp_file:
+                # Turns out wesn doesn't matter for Datasets
+                wesn = [0] * 6


Function test_put_vector refactored with the following changes:

Move assignments closer to their usage

sourcery-ai · 2020-06-24T00:30:20Z

pygmt/tests/test_clib.py

-            # wesn doesn't matter for Datasets
-            wesn = [0] * 6
            # Save the data to a file to see if it's being accessed correctly
            with GMTTempFile() as tmp_file:
+                # wesn doesn't matter for Datasets
+                wesn = [0] * 6


Function test_put_matrix refactored with the following changes:

Move assignments closer to their usage

sourcery-ai · 2020-06-24T00:30:20Z

pygmt/tests/test_clib.py

-        vfargs = (
-            "GMT_IS_DATASET|GMT_VIA_MATRIX",
-            "GMT_IS_POINT",
-            "GMT_IS_GRID",  # The invalid direction argument
-            0,
-        )
        with pytest.raises(GMTInvalidInput):
+            vfargs = (
+                "GMT_IS_DATASET|GMT_VIA_MATRIX",
+                "GMT_IS_POINT",
+                "GMT_IS_GRID",  # The invalid direction argument
+                0,
+            )


Function test_virtual_file_bad_direction refactored with the following changes:

Move assignments closer to their usage

sourcery-ai · 2020-06-24T00:30:20Z

pygmt/tests/test_clib.py

-    size = 13
-    x = list(range(0, size, 1))
-    y = tuple(range(size, size * 2, 1))
-    z = range(size * 2, size * 3, 1)
    with clib.Session() as lib:
+        size = 13
+        x = list(range(0, size, 1))
+        y = tuple(range(size, size * 2, 1))
+        z = range(size * 2, size * 3, 1)


Function test_virtualfile_from_vectors_arraylike refactored with the following changes:

Move assignments closer to their usage

sourcery-ai · 2020-06-24T00:30:21Z

pygmt/tests/test_clib.py

-    def mock_defaults(api, name, value):  # pylint: disable=unused-argument
+    def mock_defaults(api, name, value):    # pylint: disable=unused-argument
        "Return an old version"
-        if name == b"API_VERSION":
-            value.value = b"5.4.3"
-        else:
-            value.value = b"bla"
+        value.value = b"5.4.3" if name == b"API_VERSION" else b"bla"


Function test_fails_for_wrong_version.mock_defaults refactored with the following changes:

Replace if statement with if expression

sourcery-ai · 2020-06-24T00:30:21Z

pygmt/tests/test_contour.py

    for variable in product([None, data[:, 0]], repeat=3):
        # Filter one valid configuration:
-        if not any(item is None for item in variable):
+        if all(item is not None for item in variable):


Function test_contour_fail_no_data refactored with the following changes:

Simplify inverted any() and all() calls

sourcery-ai · 2020-06-24T00:30:21Z

pygmt/tests/test_legend.py

-    specfile_contents = """
+    with GMTTempFile() as specfile:
+
+        with open(specfile.name, "w") as file:
+            specfile_contents = """


Function test_legend_specfile refactored with the following changes:

Move assignments closer to their usage

sourcery-ai · 2020-06-24T00:30:21Z

pygmt/tests/test_sphinx_gallery.py


    showed = [fig for fig in SHOWED_FIGURES]
-    for _ in range(len(SHOWED_FIGURES)):
+    for SHOWED_FIGURE in SHOWED_FIGURES:


Function test_pygmtscraper refactored with the following changes:

Simplify generator expression

Replace index in for loop with direct reference

sourcery-ai · 2020-07-12T09:39:02Z

Sourcery Code Quality Report (beta)

✅ Merging this PR will increase code quality in the affected files by 0.02 out of 10.

	Before	After	Change
Quality	8.25	8.27	0.02
Complexity	2.78	2.68	-0.1
Method Length	67.41	66.93	-0.49
Lines	6853	6827	-26

Changed files	Quality Before	Quality After	Quality Change
versioneer.py	7.78	7.81	0.03 ⬆️
pygmt/init.py	7.91	7.94	0.03 ⬆️
pygmt/_version.py	7.78	7.84	0.06 ⬆️
pygmt/base_plotting.py	7.45	7.45	0.0
pygmt/figure.py	8.82	8.82	0.01 ⬆️
pygmt/session_management.py	9.64	9.64	0.0
pygmt/sphinx_gallery.py	9.07	9.08	0.01 ⬆️
pygmt/clib/conversion.py	8.95	8.97	0.01 ⬆️
pygmt/clib/session.py	8.37	8.38	0.01 ⬆️
pygmt/datasets/earth_relief.py	8.24	8.28	0.04 ⬆️
pygmt/datasets/tutorial.py	9.43	9.47	0.04 ⬆️
pygmt/helpers/utils.py	8.6	8.61	0.01 ⬆️
pygmt/tests/test_clib.py	8.41	8.41	0.01 ⬆️
pygmt/tests/test_contour.py	8.79	8.79	0.0
pygmt/tests/test_legend.py	8.89	8.89	0.0
pygmt/tests/test_sphinx_gallery.py	8.24	8.29	0.05 ⬆️

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

File	Function	Quality	Recommendation
pygmt/base_plotting.py	BasePlotting.text	3.36	Split out functionality
versioneer.py	do_setup	3.55	Split out functionality
versioneer.py	git_pieces_from_vcs	3.84	Split out functionality
versioneer.py	get_cmdclass	3.84	Split out functionality
pygmt/_version.py	git_pieces_from_vcs	3.84	Split out functionality

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!

Let us know what you think of it via email or our Gitter!

sourcery-ai · 2020-07-12T09:39:10Z

versioneer.py

-    refs = set([r.strip() for r in refnames.strip("()").split(",")])
+    refs = {r.strip() for r in refnames.strip("()").split(",")}
    # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
    # just "foo-1.0". If we see a "tag: " prefix, prefer those.
    TAG = "tag: "
-    tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
+    tags = {r[len(TAG):] for r in refs if r.startswith(TAG)}


Function git_versions_from_keywords refactored with the following changes:

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

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

sourcery-ai · 2020-07-12T09:39:10Z

versioneer.py

-            if line.strip().startswith(versionfile_source):
-                if "export-subst" in line.strip().split()[1:]:
-                    present = True
+            if (
+                line.strip().startswith(versionfile_source)
+                and "export-subst" in line.strip().split()[1:]
+            ):
+                present = True


Function do_vcs_install refactored with the following changes:

Merge nested if conditions (merge-nested-ifs)

sourcery-ai · 2020-07-12T09:39:10Z

versioneer.py

-    for i in range(3):
+    for _ in range(3):


Function versions_from_parentdir refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:11Z

versioneer.py

-            if pieces["dirty"]:
-                rendered += ".dirty"
    else:
        # exception #1
        rendered = "0+untagged.%d.g%s" % (pieces["distance"],
                                          pieces["short"])
-        if pieces["dirty"]:
-            rendered += ".dirty"
+    if pieces["dirty"]:
+        rendered += ".dirty"


Function render_pep440 refactored with the following changes:

Hoist conditional out of nested conditional (hoist-if-from-if)

Hoist repeated code outside conditional statement (hoist-statement-from-if)

sourcery-ai · 2020-07-12T09:39:11Z

versioneer.py

-            if pieces["dirty"]:
-                rendered += ".dev0"
    else:
        # exception #1
        rendered = "0.post%d" % pieces["distance"]
-        if pieces["dirty"]:
-            rendered += ".dev0"
+    if pieces["dirty"]:
+        rendered += ".dev0"


Function render_pep440_old refactored with the following changes:

Hoist conditional out of nested conditional (hoist-if-from-if)

Hoist repeated code outside conditional statement (hoist-statement-from-if)

sourcery-ai · 2020-07-12T09:39:12Z

pygmt/session_management.py

-    prefix = "pygmt-session"
    with Session() as lib:
+        prefix = "pygmt-session"


Function begin refactored with the following changes:

Move assignments closer to their usage (move-assign)

sourcery-ai · 2020-07-12T09:39:13Z

pygmt/sphinx_gallery.py

        code.
        """
-        image_names = list()
+        image_names = []


Function PyGMTScraper.__call__ refactored with the following changes:

Replace list() with [] (list-literal)

sourcery-ai · 2020-07-12T09:39:13Z

pygmt/clib/conversion.py

        inc.append(coord_inc)

-    if any([i < 0 for i in inc]):  # Sort grid when there are negative increments
+    if any(i < 0 for i in inc):  # Sort grid when there are negative increments


Function dataarray_to_matrix refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:13Z

pygmt/clib/conversion.py

    """
-    arrays = [as_c_contiguous(np.asarray(i)) for i in vectors]
-    return arrays
+    return [as_c_contiguous(np.asarray(i)) for i in vectors]


Function vectors_to_arrays refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:13Z

pygmt/clib/session.py

-                pad = 0
-            else:
-                pad = self["GMT_PAD_DEFAULT"]
+            pad = 0 if "MATRIX" in family else self["GMT_PAD_DEFAULT"]


Function Session._parse_pad refactored with the following changes:

Swap positions of nested conditionals (swap-nested-ifs)

Hoist repeated code outside conditional statement (hoist-statement-from-if)

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

sourcery-ai · 2020-07-12T09:39:16Z

pygmt/clib/session.py

-        integer_value = sum(self[part] for part in parts)
-        return integer_value
+        return sum(self[part] for part in parts)


Function Session._parse_constant refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:16Z

pygmt/clib/session.py

-        if not all(len(i) == rows for i in arrays):
+        if any(len(i) != rows for i in arrays):


Function Session.virtualfile_from_vectors refactored with the following changes:

Invert any/all to simplify comparisons (invert-any-all)

sourcery-ai · 2020-07-12T09:39:16Z

pygmt/datasets/earth_relief.py

-    valid_resolutions = ["01d"]
-    valid_resolutions.extend(
-        [f"{res:02d}m" for res in [60, 30, 20, 15, 10, 6, 5, 4, 3, 2, 1]]
-    )
-    valid_resolutions.extend([f"{res:02d}s" for res in [30, 15]])
+    valid_resolutions = [
+        "01d",
+        *[f"{res:02d}m" for res in [60, 30, 20, 15, 10, 6, 5, 4, 3, 2, 1]],
+        *[f"{res:02d}s" for res in [30, 15]],
+    ]
+


Function _is_valid_resolution refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:16Z

pygmt/datasets/tutorial.py

-    data = pd.read_csv(
+    return pd.read_csv(
        fname, sep=r"\s+", names=["longitude", "latitude"], skiprows=1, comment=">"
    )
-    return data


Function load_ocean_ridge_points refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:16Z

pygmt/datasets/tutorial.py

-    data = pd.read_csv(
+    return pd.read_csv(
        fname, sep="\t", header=None, names=["longitude", "latitude", "bathymetry"]
    )
-    return data


Function load_sample_bathymetry refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:17Z

pygmt/tests/test_clib.py

-    size = 13
-    x = list(range(0, size, 1))
-    y = tuple(range(size, size * 2, 1))
-    z = range(size * 2, size * 3, 1)
    with clib.Session() as lib:
+        size = 13
+        x = list(range(0, size, 1))
+        y = tuple(range(size, size * 2, 1))
+        z = range(size * 2, size * 3, 1)


Function test_virtualfile_from_vectors_arraylike refactored with the following changes:

Move assignments closer to their usage (move-assign)

sourcery-ai · 2020-07-12T09:39:18Z

pygmt/tests/test_clib.py

-    def mock_defaults(api, name, value):  # pylint: disable=unused-argument
+    def mock_defaults(api, name, value):    # pylint: disable=unused-argument
        "Return an old version"
-        if name == b"API_VERSION":
-            value.value = b"5.4.3"
-        else:
-            value.value = b"bla"
+        value.value = b"5.4.3" if name == b"API_VERSION" else b"bla"


Function test_fails_for_wrong_version.mock_defaults refactored with the following changes:

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

sourcery-ai · 2020-07-12T09:39:18Z

pygmt/tests/test_contour.py

    for variable in product([None, data[:, 0]], repeat=3):
        # Filter one valid configuration:
-        if not any(item is None for item in variable):
+        if all(item is not None for item in variable):


Function test_contour_fail_no_data refactored with the following changes:

Invert any/all to simplify comparisons (invert-any-all)

sourcery-ai · 2020-07-12T09:39:18Z

pygmt/tests/test_legend.py

-    specfile_contents = """
+    with GMTTempFile() as specfile:
+
+        with open(specfile.name, "w") as file:
+            specfile_contents = """


Function test_legend_specfile refactored with the following changes:

Move assignments closer to their usage (move-assign)

sourcery-ai · 2020-07-12T09:39:18Z

pygmt/tests/test_sphinx_gallery.py


    showed = SHOWED_FIGURES.copy()
-    for _ in range(len(SHOWED_FIGURES)):
+    for SHOWED_FIGURE in SHOWED_FIGURES:


Function test_pygmtscraper refactored with the following changes:

Simplify generator expression (simplify-generator)

Replace index in for loop with direct reference (for-index-replacement)

Credit to weiji14#103 (comment).

sourcery-ai bot commented Jun 24, 2020

View reviewed changes

sourcery-ai bot force-pushed the sourcery/master branch from f63f29d to 45abfc0 Compare June 24, 2020 00:30

'Refactored by Sourcery'

e0a5cc0

sourcery-ai bot force-pushed the sourcery/master branch from 45abfc0 to e0a5cc0 Compare July 12, 2020 09:38

sourcery-ai bot commented Jul 12, 2020

View reviewed changes

weiji14 added a commit to GenericMappingTools/pygmt that referenced this pull request Jul 12, 2020

Replace unnecessary comprehension with generator

fe0fbc5

Credit to weiji14#103 (comment).

weiji14 closed this Feb 12, 2021

weiji14 deleted the sourcery/master branch February 12, 2021 02:09

		if not all(len(i) == rows for i in arrays):
		if any(len(i) != rows for i in arrays):

Sourcery refactored master branch #103

Sourcery refactored master branch #103

Uh oh!

Conversation

sourcery-ai bot commented Jun 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jun 24, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot commented Jul 12, 2020

Sourcery Code Quality Report (beta)

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

Choose a reason for hiding this comment

Uh oh!

sourcery-ai bot Jul 12, 2020

sourcery-ai bot commented Jun 24, 2020 •

edited

Loading