Sourcery refactored develop branch #3

sourcery-ai · 2022-02-16T10:11:57Z

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

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

Help us improve this pull request!

sourcery-ai · 2022-02-16T10:11:58Z

clcache/__main__.py

-            nonCommand = getattr(namespace, "non_command", None)
-            if nonCommand:
+            if nonCommand := getattr(namespace, "non_command", None):


Function main.RemainderSetAction.__call__ refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:11:59Z

clcache/caching.py

-    if baseDir:
-        baseDir = os.path.normcase(baseDir)
-        if baseDir.endswith(os.path.sep):
-            baseDir = baseDir[0:-1]
-        return baseDir
-    else:
+    if not baseDir:
        # Converts empty string to None
        return None
+    baseDir = os.path.normcase(baseDir)
+    if baseDir.endswith(os.path.sep):
+        baseDir = baseDir[:-1]
+    return baseDir


Function normalizeBaseDir refactored with the following changes:

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

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

Replace a[0:x] with a[:x] and a[x:len(a)] with a[x:] (remove-redundant-slice-index)

sourcery-ai · 2022-02-16T10:11:59Z

clcache/caching.py

-        return os.path.join(self.manifestSectionDir, manifestHash + ".json")
+        return os.path.join(self.manifestSectionDir, f'{manifestHash}.json')


Function ManifestSection.manifestPath refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:11:59Z

clcache/caching.py

-                    ["/" + k + collapseBasedirInCmdPath(arg) for arg in arguments[k]]
+                    [
+                        f'/{k}{collapseBasedirInCmdPath(arg)}'
+                        for arg in arguments[k]
+                    ]
                )
+
            else:
-                commandLine.extend(["/" + k + arg for arg in arguments[k]])
+                commandLine.extend([f'/{k}{arg}' for arg in arguments[k]])


Function ManifestRepository.getManifestHash refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:11:59Z

clcache/caching.py

-        self._mutexName = "Local\\" + mutexName
+        self._mutexName = f'Local\\{mutexName}'


Function CacheLock.__init__ refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:12:01Z

clcache/caching.py

-    setOfSources = set(sourceFile for sourceFile, _ in sourceFiles)
+    setOfSources = {sourceFile for sourceFile, _ in sourceFiles}


Function filterSourceFiles refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:12:01Z

clcache/storage.py

-            key_prefix=(getStringHash(self.fileStrategy.dir) + "_").encode("UTF-8"),
+            key_prefix=f'{getStringHash(self.fileStrategy.dir)}_'.encode("UTF-8"),


Function CacheMemcacheStrategy.connect refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:12:01Z

clcache/storage.py

-        remote = self.remoteCache.getEntry(key)
-        if remote:
+        if remote := self.remoteCache.getEntry(key):


Function CacheFileWithMemcacheFallbackStrategy.getEntry refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:12:01Z

clcache/storage.py

-        local = self.localCache.getManifest(manifestHash)
-        if local:
+        if local := self.localCache.getManifest(manifestHash):
            printTraceStatement(
                "{} local manifest hit for {}".format(self, manifestHash)
            )
            return local
-        remote = self.remoteCache.getManifest(manifestHash)
-        if remote:
+        if remote := self.remoteCache.getManifest(manifestHash):


Function CacheFileWithMemcacheFallbackStrategy.getManifest refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:12:01Z

tests/test_integration.py

-            out = []
            lines = text.splitlines(True)
-            for line in lines:
-                out.append(line.replace("\r", "<CR>").replace("\n", "<LN>"))
+            out = [line.replace("\r", "<CR>").replace("\n", "<LN>") for line in lines]


Function TestCompileRuns.testPipedOutput.debugLinebreaks refactored with the following changes:

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

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2022-02-16T10:12:05Z

tests/test_integration.py

-            mpFlag = "/MP" + str(len(sources))
+            mpFlag = f'/MP{len(sources)}'


Function RunParallelBase.testOutput refactored with the following changes:

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

Remove unnecessary calls to str() from formatted values in f-strings (remove-str-from-fstring)

sourcery-ai · 2022-02-16T10:12:05Z

tests/test_performance.py

-        cls.sources = []
-        for i in range(1, TestConcurrency.NUM_SOURCE_FILES+1):
-            cls.sources.append(os.path.join(ASSETS_DIR, 'concurrency', 'file{:02d}.cpp'.format(i)))
+        cls.sources = [
+            os.path.join(ASSETS_DIR, 'concurrency', 'file{:02d}.cpp'.format(i))
+            for i in range(1, TestConcurrency.NUM_SOURCE_FILES + 1)
+        ]


Function TestConcurrency.setUpClass refactored with the following changes:

Convert for loop into list comprehension (list-comprehension)

sourcery-ai · 2022-02-16T10:12:05Z

tests/test_unit.py

-            else:
-                # We just want to know if we got a proper source file.
-                # Other AnalysisErrors are ignored.
-                pass


Function TestAnalyzeCommandLine._testSourceFilesOk refactored with the following changes:

Remove redundant pass statement (remove-redundant-pass)

This removes the following comments ( why? ):

# Other AnalysisErrors are ignored. # We just want to know if we got a proper source file.

sourcery-ai · 2022-02-16T10:12:05Z

tests/test_unit.py

-                for i in range(0, 999):
+                for i in range(999):


Function TestCompression.assertEntrySizeIsCorrect refactored with the following changes:

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

sourcery-ai · 2022-02-16T10:12:16Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	2.61 ⭐	2.52 ⭐	-0.09 👍
Method Length	49.37 ⭐	49.30 ⭐	-0.07 👍
Working memory	6.23 🙂	6.21 🙂	-0.02 👍
Quality	75.85% ⭐	75.94% ⭐	0.09% 👍

Other metrics	Before	After	Change
Lines	4207	4198	-9

Changed files	Quality Before	Quality After	Quality Change
clcache/main.py	53.13% 🙂	52.92% 🙂	-0.21% 👎
clcache/caching.py	75.21% ⭐	75.46% ⭐	0.25% 👍
clcache/storage.py	89.16% ⭐	88.92% ⭐	-0.24% 👎
tests/test_integration.py	71.58% 🙂	71.68% 🙂	0.10% 👍
tests/test_performance.py	65.72% 🙂	64.44% 🙂	-1.28% 👎
tests/test_unit.py	82.34% ⭐	82.34% ⭐	0.00%

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
clcache/caching.py	processDirect	24 😞	235 ⛔	16 ⛔	26.53% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
clcache/caching.py	CommandLineAnalyzer.parseArgumentsAndInputFiles	28 😞	180 😞	13 😞	31.97% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
tests/test_integration.py	TestCompileRuns.testPipedOutput	15 🙂	268 ⛔	13 😞	35.16% 😞	Try splitting into smaller methods. Extract out complex expressions
clcache/caching.py	CommandLineAnalyzer.analyze	19 😞	214.99 ⛔	11 😞	38.26% 😞	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
clcache/main.py	main	15 🙂	316 ⛔	10 😞	38.66% 😞	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'

a945600

sourcery-ai bot requested a review from kayhayen February 16, 2022 10:11

sourcery-ai bot commented Feb 16, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored develop branch #3

Sourcery refactored develop branch #3

sourcery-ai bot commented Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot Feb 16, 2022

sourcery-ai bot commented Feb 16, 2022

		return os.path.join(self.manifestSectionDir, manifestHash + ".json")
		return os.path.join(self.manifestSectionDir, f'{manifestHash}.json')

		self._mutexName = "Local\\" + mutexName
		self._mutexName = f'Local\\{mutexName}'

		setOfSources = set(sourceFile for sourceFile, _ in sourceFiles)
		setOfSources = {sourceFile for sourceFile, _ in sourceFiles}

		key_prefix=(getStringHash(self.fileStrategy.dir) + "_").encode("UTF-8"),
		key_prefix=f'{getStringHash(self.fileStrategy.dir)}_'.encode("UTF-8"),

		mpFlag = "/MP" + str(len(sources))
		mpFlag = f'/MP{len(sources)}'

Sourcery refactored develop branch #3

Are you sure you want to change the base?

Sourcery refactored develop branch #3

Conversation

sourcery-ai bot commented Feb 16, 2022

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot Feb 16, 2022

Choose a reason for hiding this comment

sourcery-ai bot commented Feb 16, 2022

Sourcery Code Quality Report

Legend and Explanation