Refactoring Python code - Improve Readability and maintainability

[pratik-choudhari]

Who is the issue affecting?

Contributors and Maintainers

What is affected by this issue?

Readability, maintainability, debugging and code reviews

Comments

Hi @pradeeban, I was trying to read the code and figure out its workings. I had a hard time understanding the core Python modules.
Common issues noticed:

• type hinting
• function docstrings
• error handling
• complicated equality expressions
• string formatting

Sample Solution

The concore.write function can be refactored as follows (original on the left, modified in the right):

Scope

Throughout the project

[pratik-choudhari]

Additionally, If docstring, type hints and return types are added to functions, IDEs such as PyCharm can use this information and warn a developer if the parameters do not match with the type hints