![\"The](\"https:\/\/ieeecs-media.computer.org\/wp-media\/2022\/12\/27232231\/The-importance-of-following-a-Python-style-guide.jpg\")
Writing code is one thing; writing beautiful, easily understandable code that others can use just as easily as you is a completely different matter altogether. It\u2019s not always easy or intuitive to create neat code in Python, which begs the age-old question, do we have to? And what does neat, clear code even look like?<\/p>\n
We\u2019re going to break down what makes a Python style guide necessary, as well as the most important elements of a style guide. Read on to learn how you can perfect the way you write your Python code.<\/p>\n
\u00a0<\/p>\n
Why do you need a style guide?<\/h2>\n
\n
How often have you come across a piece of code that took you far longer to understand than to read?<\/p>\n
Chances are, if you regularly work with code written by other people, you\u2019ll have had at least a few run-ins with some messy, barely-comprehensible code that makes you wish you had time to rewrite all of it. That\u2019s the direct result of unclearly written code. It leads to poor code reuse and maintainability, which means it can\u2019t be used in other places or easily maintained.<\/p>\n
With a style guide, you can make sure that your own code never puts anyone else\u2014including yourself\u2014in that position.<\/p>\n
Style guides see to two absolutely vital things in your code: legibility and consistency. By setting out rules for exactly how things should be written, style guides help you guarantee your coding style will be consistent all across the board. They also ensure that the status quo is legible code.<\/p>\n
Let\u2019s consider an analogy: say you\u2019re looking for a consulting proposal template. The first one you come across switches between American and British English spellings, the second one\u2019s layout is confusing, so you don\u2019t know what to enter where, and the third uses a font that\u2019s so hard to read, it slows you down. Without a style guide, that\u2019s what unclear code looks like.<\/p>\n
Now let\u2019s consider what happens when the template creators use a style guide. Suddenly, you\u2019ve got scannable proposal templates that are both easy to read and simple to use, because the font and layout are clear, and the spelling style is consistent. That\u2019s the effect a style guide should have on your code.<\/p>\n
\u00a0<\/p>\n
\n
\u00a0<\/p>\n
Want More Career-focused News? Subscribe to Build Your Career Newsletter Today!<\/strong><\/p>\n \u00a0<\/p>\n \u00a0<\/p>\n Free to use image sourced from Pexels<\/p>\n That\u2019s why we need style guides like Python Enhancement Proposal 8 (PEP 8). Next, we\u2019ll take a look at some of the most important components of that guide.<\/p>\n \u00a0<\/p>\n When you look at a segment of code, before you even read it, the first thing that strikes the eye is the way in which the person who wrote it used indents. That\u2019s why it\u2019s one of the most important aspects of a Python style guide.<\/p>\n The expected standard in Python is to use four spaces. This creates a clean look for your code, and makes it easier to find what you\u2019re looking for at a glance.<\/p>\n Here\u2019s an example of the difference it can make:<\/p>\n Both of the latter examples make your code less legible. In the case of the first one, your eyes don\u2019t intuitively know where the function stops, while the second one looks sloppy and somewhat random. In contrast, the first example is clean, well-laid-out, and easy to take in at a glance.<\/p>\n \u00a0<\/p>\n Sure, it might be impossible to get every name fully consistent across objects, functions, and more, but that doesn\u2019t mean we shouldn\u2019t try. The more consistent your naming conventions are, the neater your code looks and the easier it is to find what you need.<\/p>\n One aspect of this is patterns. For example, let\u2019s say you\u2019re naming variables that relate to free electronic signatures. Here\u2019s how to, and how not to, go about that:<\/p>\n #Good example #Bad example As you can see, following one pattern consistently leads to a cleaner look. In the same way, you\u2019ll want to find a good balance between overly long names, and names that are too short to convey any meaning.<\/p>\n #Good example #Bad example You\u2019ll also want to avoid starting a name of any kind with a number, or including special characters, especially if those characters are likely to crop up elsewhere in your code. Instead, do the right thing and choose clear, concise, no-nonsense names that anyone can understand.<\/p>\n \u00a0<\/p>\n Blank lines and whitespaces can go a long way towards improving a code.<\/p>\n For example, if you\u2019re writing multiple functions, it can get confusing pretty quickly if you don\u2019t implement spaces between each individual one. Even if they\u2019re not strictly necessary to make the code work, they help immensely with boosting legibility.<\/p>\n Free to use image sourced from Pexels<\/p>\n However, with that said, there are rules surrounding whitespaces. They shouldn\u2019t be used immediately after a bracket, or before commas, semicolons, or colons. They also shouldn\u2019t separate characters and opening brackets, regardless of whether it visually spaces things out.<\/p>\n Assignment operators, comparisons, and booleans should always be surrounded by whitespaces. This helps them remain legible and clear to readers.<\/p>\n \u00a0<\/p>\n Your code shouldn\u2019t be written like a private journal, because it\u2019s not only for you to read. Instead, you should use comments to address future readers and provide necessary clarification.<\/p>\n When writing comments, ensure you\u2019re as clear and concise as possible. This isn\u2019t the place for flowery language or extra words\u2014get your point across in as few words as you can, and move on.<\/p>\n \u00a0<\/p>\n It\u2019s clear that a style guide creates rules that lead to cleaner, more legible code. That\u2019s a wonderful thing for people who regularly work with code\u2014and for anyone who\u2019s trying to learn from the way others do things.<\/p>\n At the same time, a style guide doesn\u2019t have to dictate every aspect of a piece of code. It should establish the way that code should look and be written, but it shouldn\u2019t act as a way to restrict or limit the contents of your code.<\/p>\n In other words, your Python style guide should make it easier, never harder, to write more code.<\/p>\n Following the rules the style guide sets out should always help you create code you can be proud of. When the code looks beautiful and is legible to just about anyone who tries to read it, it\u2019s a sign you\u2019ve written great code.<\/p>\n \u00a0<\/p>\n \u00a0<\/p>\n Disclaimer:<\/strong> The author is completely responsible for the content of this article. The opinions expressed are their own and do not represent IEEE\u2019s position nor that of the Computer Society nor its Leadership.<\/p>\n<\/div><\/div>\n
\nIndents<\/h2>\n
\n#Correct use of indentation\nIf (your_first_condition and\n your_second_condition):\n perform_specified_action\n\n#Incorrect use of indentation\nIf (your_first_condition and\nyour_second_condition):\nperform_specified_action\n\n#Another incorrect use of indentation\nIf (your_first_condition and\n\t\tyour_second_condition):\n\tperform_specified_action\n<\/pre>\n
Names<\/h2>\n
\n
FreeSigs, FreeElectronicSigs, ElectronicSigsFree<\/p>\n
freeSignatures, FreeElecSigs, electronic_signatures_free<\/p>\n
free_signatures, elec_signatures_free<\/p>\n
electronic_signatures_available_for_free_online, esigfree, esf<\/p>\nSpaces<\/h2>\n
\nComments<\/h2>\n
\nPython style guide: parting thoughts<\/h2>\n
\nAbout the Writer<\/h2>\n
\n![\"Yauhen](\"https:\/\/ieeecs-media.computer.org\/wp-media\/2022\/08\/30224158\/Yauhen-Zaremba-Pandadoc-e1666035147284-150x150.jpg\")
Yauhen Zaremba is the Director of Demand Generation at PandaDoc, all-in-one document management software for almost all document types including this PandaDoc flooring contract template. He\u2019s been a marketer for 10+ years, and for the last five years, he\u2019s been entirely focused on the electronic signature, proposal, and document management markets. Yauhen has experience speaking at niche conferences where he enjoys sharing his expertise with other curious marketers. And in his spare time, he is an avid fisherman and takes nearly 20 fishing trips every year.<\/p>\n