Magic-Spoiler
Magic-Spoiler copied to clipboard
CI: Add code scans & style checks
Run pylint and utilize our .pylintrc file.
Run isort to check sorting of imports.
Run mypy and utilize our mypy.ini file.
#214
while admirable in effort, please don't bother linting and formatting the spoiler code, the spoiler code is full of quickly written hacks and should rather be given a do over than a face lift
I don't want to sound harsh, if you'd really like to improve the spoiler system we can talk on discord how to change the code over from the current hacks to writing xml with the proper library
I did not plan to lint or reformat the current code. The intention was to see how a simple lint check on new code changes can be implemented to continuously improve and maintain a uniform code style going forward from there.
This will mostly be relevant once the code is improved and Zach's first version is overhauled at one point. I can not help with that task directly.
Style issues of the current code
************* Module magic_spoiler.__main__
magic_spoiler/__main__.py:54:10: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:66:14: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:78:18: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:198:15: W0703: Catching too general exception Exception (broad-except)
magic_spoiler/__main__.py:264:0: C0116: Missing function or method docstring (missing-function-docstring)
magic_spoiler/__main__.py:277:4: R1702: Too many nested blocks (9/5) (too-many-nested-blocks)
magic_spoiler/__main__.py:453:25: C0103: Argument name "f1" doesn't conform to snake_case naming style (invalid-name)
magic_spoiler/__main__.py:453:34: C0103: Argument name "f2" doesn't conform to snake_case naming style (invalid-name)
magic_spoiler/__main__.py:473:24: C0103: Argument name "f1" doesn't conform to snake_case naming style (invalid-name)
magic_spoiler/__main__.py:473:33: C0103: Argument name "f2" doesn't conform to snake_case naming style (invalid-name)
magic_spoiler/__main__.py:522:47: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:524:14: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:529:8: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:547:47: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:554:47: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:556:14: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:561:8: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:576:14: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
magic_spoiler/__main__.py:635:14: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
-----------------------------------
Your code has been rated at 9.41/10
I think you're selling yourself short there tom, learning a scripting language like python that has ample documentation and tutorials available would be no harder than learning to use github's yaml format for their workflows
Maybe you are right and I should give it a shot. However, currently I do not see that happening due to limited time. :/
you can take it step by step, I'd be happy to help you