Sourcery refactored tuning branch #1

sourcery-ai · 2023-01-18T19:02:42Z

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

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

Help us improve this pull request!

sourcery-ai · 2023-01-18T19:02:45Z

modules/silicon_design/scripts/build/images/provision/papermill-launcher

-parameters = dict(
-    (k, expand_path(v))
-    for k, v in args(params_args)
-)
+parameters = {k: expand_path(v) for k, v in args(params_args)}


Lines 24-27 refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:45Z

radlab-launcher/radlab.py

-        r = requests.get('https://www.googleapis.com/oauth2/v3/tokeninfo?access_token=' + token)
+        r = requests.get(
+            f'https://www.googleapis.com/oauth2/v3/tokeninfo?access_token={token}'
+        )


Function radlabauth refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:45Z

radlab-launcher/radlab.py

-            elif (select_proj != '1' and select_proj != '2'):
+            elif select_proj != '1':
                sys.exit(Fore.RED + "\nError Occured - INVALID choice.\n")
        else:
            projid = input(Fore.YELLOW + Style.BRIGHT + "\nEnter the Project ID for RAD Lab management" + Style.RESET_ALL + ': ').strip()
-    else:
-        pass
-
-    os.system("gcloud config set project " + projid)
-    os.system("gcloud auth application-default set-quota-project "  + projid )
+    os.system(f"gcloud config set project {projid}")
+    os.system(f"gcloud auth application-default set-quota-project {projid}")


Function set_proj refactored with the following changes:

Remove redundant conditional (remove-redundant-if)

Remove redundant pass statement (remove-redundant-pass)

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

sourcery-ai · 2023-01-18T19:02:45Z

radlab-launcher/radlab.py

-    # Hardcoded Org level required RAD Lab Launcher roles
-    launcherorgroles = ['roles/iam.organizationRoleViewer']
-
    credentials = GoogleCredentials.get_application_default()

    service0 = discovery.build('cloudresourcemanager', 'v3', credentials=credentials)
-    request0 = service0.projects().getIamPolicy(resource='projects/' + projid)
+    request0 = service0.projects().getIamPolicy(resource=f'projects/{projid}')


Function launcherperm refactored with the following changes:

Move assignments closer to their usage (move-assign)

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

Remove redundant pass statement [×2] (remove-redundant-pass)

This removes the following comments ( why? ):

# Check for Required roles on RAD Lab Management Project

sourcery-ai · 2023-01-18T19:02:46Z

radlab-launcher/radlab.py

-    if 'folders' in parent:
-        credentials = GoogleCredentials.get_application_default()
-        s = discovery.build('cloudresourcemanager', 'v3', credentials=credentials)
-        req = s.folders().get(name=parent)
-        res = req.execute()
-        return findorg(res['parent'])
-    else:
+    if 'folders' not in parent:
        # print(Fore.GREEN + "Org identified: " + Style.BRIGHT + parent + Style.RESET_ALL)
        return parent
+    credentials = GoogleCredentials.get_application_default()
+    s = discovery.build('cloudresourcemanager', 'v3', credentials=credentials)
+    req = s.folders().get(name=parent)
+    res = req.execute()
+    return findorg(res['parent'])


Function findorg refactored with the following changes:

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

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

sourcery-ai · 2023-01-18T19:02:48Z

tools/check-tf-plan.py

-            print("----------> RUN FOR: " + dir)
+            print(f"----------> RUN FOR: {dir}")


            try:
                # IF MODULE EXISTS: Copying main directory in temp folder
-                shutil.copytree(GITHUB_WORKSPACE+'/'+dir, os.getcwd()+'/temp/'+dir)
+                shutil.copytree(f'{GITHUB_WORKSPACE}/{dir}', f'{os.getcwd()}/temp/{dir}')

                # Deleting added/modified & removed files
                for mfile in modified_files:
-                    if os.path.exists(os.getcwd()+'/temp/'+mfile):
-                        print("Deleting file: " + mfile)
-                        os.remove(os.getcwd()+'/temp/'+mfile)
+                    if os.path.exists(f'{os.getcwd()}/temp/{mfile}'):
+                        print(f"Deleting file: {mfile}")
+                        os.remove(f'{os.getcwd()}/temp/{mfile}')

                for rfile in removed_files:
-                    if os.path.exists(os.getcwd()+'/temp/'+rfile):
-                        print("Deleting file: " + rfile)
-                        os.remove(os.getcwd()+'/temp/'+rfile)
+                    if os.path.exists(f'{os.getcwd()}/temp/{rfile}'):
+                        print(f"Deleting file: {rfile}")
+                        os.remove(f'{os.getcwd()}/temp/{rfile}')
            except:
                # IF MODULE DONOT EXISTS: Creating temp module folder
-                os.makedirs(os.getcwd()+'/temp/'+dir)
+                os.makedirs(f'{os.getcwd()}/temp/{dir}')


Function main refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:48Z

tools/check-tf-plan.py

-        response = requests.get('https://api.github.com/repos/'+ GITHUB_REPOSITORY +'/pulls/'+ str(pr) +'/files')
+        response = requests.get(
+            f'https://api.github.com/repos/{GITHUB_REPOSITORY}/pulls/{str(pr)}/files'
+        )


Function pr_files refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:48Z

tools/check-tf-plan.py

-  # print(path)
-  if not os.path.exists(path):
-      os.makedirs(path)
+    # print(path)
+    if not os.path.exists(path):
+        os.makedirs(path)

-  # print('Beginning file download with requests')
-  r = requests.get(raw)
-  with open(path + '/' + os.path.basename(file), 'wb') as f:
-      f.write(r.content)
+    # print('Beginning file download with requests')
+    r = requests.get(raw)
+    with open(f'{path}/{os.path.basename(file)}', 'wb') as f:
+        f.write(r.content)


Function downloadprfiles refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:48Z

tools/check-tf-plan.py

-  modified_files_dir = []
-  removed_files_dir = []
-
-  for file in modified_files:
-    modified_files_dir.append(os.path.dirname(file))
-
-  for file in removed_files:
-    removed_files_dir.append(os.path.dirname(file))
-
-  working_directories = modified_files_dir + removed_files_dir
-  working_directories = list(set(working_directories))
+    modified_files_dir = [os.path.dirname(file) for file in modified_files]
+    removed_files_dir = [os.path.dirname(file) for file in removed_files]
+    working_directories = modified_files_dir + removed_files_dir
+    working_directories = list(set(working_directories))

 #   print("Working Directories:")
 #   print(working_directories)
-
-  modules = [x for x in working_directories if x.startswith('modules/')]
-  modules = [x for x in modules if x.count('/') == 1]
-  print("Modules Updated:")
-  print(modules)

-  return modules
+    modules = [x for x in working_directories if x.startswith('modules/')]
+    modules = [x for x in modules if x.count('/') == 1]
+    print("Modules Updated:")
+    print(modules)
+
+    return modules


Function get_updated_modules refactored with the following changes:

Move assignment closer to its usage within a block [×2] (move-assign-in-block)

Convert for loop into list comprehension [×2] (list-comprehension)

sourcery-ai · 2023-01-18T19:02:48Z

tools/check-tf-plan.py

-  tr = Terraform(working_dir=dir)
-
-  return_code_init, stdout_init, stderr_init = tr.init_cmd(capture_output=False)
-  return_code_plan, stdout_plan, stderr_plan = tr.plan_cmd(capture_output=False,var={'billing_account_id':'ABCD-EFGH-IJKL-MNOP', 'organization_id':'1234567890', 'random_id': '1234'})
-  
-  path = os.getcwd()+'/temp/'
-  if(return_code_init == 1):
-    comment = 'Terraform Init FAILED'
-    status = 'fail'
-  if(return_code_plan == 1):
-    comment = 'Terraform Plan FAILED'
-    status = 'fail'
-  else: 
-    comment = 'Terraform Init & Terraform Plan SUCCESSFUL'
-    status = 'pass'
-  
-  return comment, status
+    tr = Terraform(working_dir=dir)
+
+    return_code_init, stdout_init, stderr_init = tr.init_cmd(capture_output=False)
+    return_code_plan, stdout_plan, stderr_plan = tr.plan_cmd(capture_output=False,var={'billing_account_id':'ABCD-EFGH-IJKL-MNOP', 'organization_id':'1234567890', 'random_id': '1234'})
+
+    path = f'{os.getcwd()}/temp/'
+    if(return_code_init == 1):
+      comment = 'Terraform Init FAILED'
+      status = 'fail'
+    if(return_code_plan == 1):
+      comment = 'Terraform Plan FAILED'
+      status = 'fail'
+    else: 
+      comment = 'Terraform Init & Terraform Plan SUCCESSFUL'
+      status = 'pass'
+
+    return comment, status


Function tf refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:52Z

tools/check-tf-plan.py

-        response  = requests.post('https://api.github.com/repos/'+ GITHUB_REPOSITORY +'/issues/'+ str(pr) +'/comments', data=json.dumps(data), headers=headers)
-        # print(response.text)
+        response = requests.post(
+            f'https://api.github.com/repos/{GITHUB_REPOSITORY}/issues/{str(pr)}/comments',
+            data=json.dumps(data),
+            headers=headers,
+        )
+            # print(response.text)


Function commentpr refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:52Z

tools/check_boilerplate.py

-    print('\n'.join(' - {}'.format(s) for s in warnings))
+    print('\n'.join(f' - {s}' for s in warnings))


Function main refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:52Z

tools/check_documentation.py

-    for variable in variables:
-      if not variable.description:
-        errors.append(f'variable {variable.name} has no description')
+    errors.extend(f'variable {variable.name} has no description'
+                  for variable in variables if not variable.description)
    if sorted(variable_names) != variable_names:
      message = f'variable order should be: {sorted(variable_names)}'
      errors.append(message)

    outputs = tfdoc.get_outputs(subpath)
    output_names = [v.name for v in outputs]
-    for output in outputs:
-      if not output.description:
-        errors.append(f'output {output.name} has no description')
+    errors.extend(f'output {output.name} has no description'
+                  for output in outputs if not output.description)


Function check_path refactored with the following changes:

Replace a for append loop with list extend [×2] (for-append-to-extend)

Remove empty elif clause (remove-pass-elif)

sourcery-ai · 2023-01-18T19:02:52Z

tools/notifications.py

-        response = requests.get('https://api.github.com/repos/'+ GITHUB_REPOSITORY +'/issues')
-        return response
+        return requests.get(f'https://api.github.com/repos/{GITHUB_REPOSITORY}/issues')


Function open_issue refactored with the following changes:

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

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

sourcery-ai · 2023-01-18T19:02:53Z

tools/notifications.py

-        response = requests.get('https://api.github.com/repos/'+ GITHUB_REPOSITORY +'/issues/'+ str(number) +'/comments')
+        response = requests.get(
+            f'https://api.github.com/repos/{GITHUB_REPOSITORY}/issues/{str(number)}/comments'
+        )


Function issuecommentcheck refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:54Z

tools/tfdoc.py

-  for line in format_variables(variables):
-    buffer.append(line)
+  buffer.extend(iter(format_variables(variables)))
  buffer.append('\n## Outputs\n')
-  for line in format_outputs(outputs):
-    buffer.append(line)
+  buffer.extend(iter(format_outputs(outputs)))


Function get_doc refactored with the following changes:

Replace a for append loop with list extend [×2] (for-append-to-extend)

Simplify generator expression [×2] (simplify-generator)

sourcery-ai · 2023-01-18T19:02:54Z

tools/tfdoc.py

-    m = re.search('(?sm)%s.*%s' % (MARK_BEGIN, MARK_END), readme)
+    m = re.search(f'(?sm){MARK_BEGIN}.*{MARK_END}', readme)


Function replace_doc refactored with the following changes:

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

sourcery-ai · 2023-01-18T19:02:55Z

tools/tfdoc.py

-      variables += [v for v in parse_items(
-          file.read(), RE_VARIABLES, VariableToken, Variable, VariableData)]
+      variables += list(
+          parse_items(file.read(), RE_VARIABLES, VariableToken, Variable,
+                      VariableData))


Function get_variables refactored with the following changes:

Replace identity comprehension with call to collection constructor (identity-comprehension)

sourcery-ai · 2023-01-18T19:02:55Z

tools/tfdoc.py

-      outputs += [o for o in parse_items(
-          file.read(), RE_OUTPUTS, OutputToken, Output, OutputData)]
+      outputs += list(
+          parse_items(file.read(), RE_OUTPUTS, OutputToken, Output,
+                      OutputData))


Function get_outputs refactored with the following changes:

Replace identity comprehension with call to collection constructor (identity-comprehension)

sourcery-ai · 2023-01-18T19:02:55Z

tools/tfdoc.py

-  m = re.search('(?sm)%s.*%s' % (MARK_BEGIN, MARK_END), readme)
-  if not m:
+  if m := re.search(f'(?sm){MARK_BEGIN}.*{MARK_END}', readme):
+    return get_doc(variables, outputs) in readme
+  else:
    return
-  return get_doc(variables, outputs) in readme


Function check_state refactored with the following changes:

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

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

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

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

sourcery-ai · 2023-01-18T19:02:58Z

Sourcery Code Quality Report

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

Quality metrics	Before	After	Change
Complexity	22.99 😞	22.65 😞	-0.34 👍
Method Length	99.50 🙂	99.56 🙂	0.06 👎
Working memory	12.02 😞	12.13 😞	0.11 👎
Quality	49.97% 😞	50.01% 🙂	0.04% 👍

Other metrics	Before	After	Change
Lines	2026	2037	11

Changed files	Quality Before	Quality After	Quality Change
modules/silicon_design/scripts/build/images/provision/papermill-launcher	84.26% ⭐	83.60% ⭐	-0.66% 👎
radlab-launcher/radlab.py	36.38% 😞	36.66% 😞	0.28% 👍
radlab-launcher/terraform_installer.py	49.49% 😞	54.43% 🙂	4.94% 👍
tools/build_readme.py	66.54% 🙂	66.22% 🙂	-0.32% 👎
tools/check-license.py	76.08% ⭐	76.18% ⭐	0.10% 👍
tools/check-tf-plan.py	53.42% 🙂	52.23% 🙂	-1.19% 👎
tools/check_boilerplate.py	60.33% 🙂	60.41% 🙂	0.08% 👍
tools/check_documentation.py	50.05% 🙂	54.71% 🙂	4.66% 👍
tools/notifications.py	50.27% 🙂	49.94% 😞	-0.33% 👎
tools/service-catalog.py	48.95% 😞	48.86% 😞	-0.09% 👎
tools/tfdoc.py	76.66% ⭐	76.03% ⭐	-0.63% 👎

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

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
radlab-launcher/radlab.py	moduleperm	128 ⛔	928 ⛔	24 ⛔	2.28% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
radlab-launcher/radlab.py	launcherperm	38 ⛔	399 ⛔	19 ⛔	12.31% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
tools/check-tf-plan.py	main	34 ⛔	309 ⛔	13 😞	22.06% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
tools/notifications.py	main	28 😞	254 ⛔	16 ⛔	23.22% ⛔	Refactor to reduce nesting. Try splitting into smaller methods. Extract out complex expressions
radlab-launcher/radlab.py	module_deploy_common_settings	16 🙂	307 ⛔	22 ⛔	24.76% ⛔	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'

043755e

sourcery-ai bot requested a review from joamatab January 18, 2023 19:02

sourcery-ai bot commented Jan 18, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sourcery refactored tuning branch #1

Sourcery refactored tuning branch #1

sourcery-ai bot commented Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot Jan 18, 2023

sourcery-ai bot commented Jan 18, 2023

		print('\n'.join(' - {}'.format(s) for s in warnings))
		print('\n'.join(f' - {s}' for s in warnings))

		m = re.search('(?sm)%s.*%s' % (MARK_BEGIN, MARK_END), readme)
		m = re.search(f'(?sm){MARK_BEGIN}.*{MARK_END}', readme)

Sourcery refactored tuning branch #1

Are you sure you want to change the base?

Sourcery refactored tuning branch #1

Conversation

sourcery-ai bot commented Jan 18, 2023

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot Jan 18, 2023

Choose a reason for hiding this comment

sourcery-ai bot commented Jan 18, 2023

Sourcery Code Quality Report

Legend and Explanation