Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Issue#18 (Sourcery refactored) #20

Open
wants to merge 1 commit into
base: development---signed
Choose a base branch
from

Conversation

sourcery-ai[bot]
Copy link

@sourcery-ai sourcery-ai bot commented Nov 3, 2020

Pull Request #19 refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

NOTE: As code is pushed to the original Pull Request, Sourcery will
re-run and update (force-push) this Pull Request with new refactorings as
necessary. If Sourcery finds no refactorings at any point, this Pull Request
will be closed automatically.

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 development---signed branch, then run:

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

@sourcery-ai sourcery-ai bot requested a review from schnipdip November 3, 2020 01:21
lcd = character_lcd.Character_LCD_RGB_I2C(i2c, lcd_columns, lcd_rows)

return lcd
return character_lcd.Character_LCD_RGB_I2C(i2c, lcd_columns, lcd_rows)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function init_lcd refactored with the following changes:

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

Comment on lines -93 to +91
if connected_usb == None:
if connected_usb is None:
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function check_usb refactored with the following changes:

  • Use x is None rather than x == None (none-compare)

Comment on lines -163 to +166

lcd.clear()
lcd.message = "Mounting Devices"
time.sleep(0.5)

if os.path.exists(check_path_backup):
pass
else:
if not os.path.exists(check_path_backup):
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Function mount_usb refactored with the following changes:

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

Comment on lines -309 to +315

device_add = True
while device_add == True:
while device_add:
#shutdown RPI
if lcd.down_button:
lcd.clear()
shutdown()

#reboot RPI
if lcd.up_button:
lcd.clear()
restart()

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines 309-340 refactored with the following changes:

  • Simplify comparison to boolean (simplify-boolean-comparison)

@sourcery-ai
Copy link
Author

sourcery-ai bot commented Nov 3, 2020

Sourcery Code Quality Report

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

Quality metrics Before After Change
Complexity 3.36 ⭐ 3.21 ⭐ -0.15 👍
Method Length 61.57 🙂 61.21 🙂 -0.36 👍
Working memory 7.86 🙂 7.86 🙂 0.00
Quality 77.96% 78.15% 0.19% 👍
Other metrics Before After Change
Lines 335 329 -6
Changed files Quality Before Quality After Quality Change
linux/dumper/dumper_lcd.py 77.96% ⭐ 78.15% ⭐ 0.19% 👍

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

File Function Complexity Length Working Memory Quality Recommendation
linux/dumper/dumper_lcd.py mount_usb 4 ⭐ 141 😞 14 😞 53.30% 🙂 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!

Let us know what you think of it by mentioning @sourcery-ai in a comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants