Shulou(Shulou.com)06/02 Report--

This article introduces the knowledge of "how to use pycodestyle, a sharp tool to improve the readability of python code". In the operation of actual cases, many people will encounter such a dilemma, so let the editor lead you to learn how to deal with these situations. I hope you can read it carefully and be able to achieve something!

About PEP-8

The pycodestyle inspector provides code recommendations based on PEP-8 style conventions. So what exactly is PEP-8?

PEP stands for Python enhancement recommendations, and PEP-8 is a guide that outlines best practices for writing Python code. Its main goal is to improve the overall consistency and readability of the code by standardizing the code style.

Purpose

A quick glance at the PEP-8 documentation reveals that there are too many best practices to remember.

And, having spent so much effort on writing so many lines of code, you certainly don't want to waste more time manually checking the readability of the script.

This is where pycodestyle automatically analyzes the Python script and points out where the code can be improved.

Installation

Pip is the preferred installer, and you can install or upgrade pycodestyle by running the following command in the terminal:

# Install pycodestylepip install pycodestyle# Upgrade pycodestylepip install-basic usage of upgrade pycodestyle

The most direct use is to run pycodestyle in the terminal as a command on the Python script (.py file).

Let's demonstrate using the following sample script, named pycodestyle_sample_script.py:

# pycodestyle_sample_script.py # Import librariesimport numpy as np, pandas as pd# Take the users inputwords = raw_input ("Enter some text to translate to pig latin:") # Break apart the words into a listwords_list = words.split ('') for word in words_list: if len (word) > = 3: # For this pig latin translation We only want to translate words greater than 3 characters pig_latin = word + "% say"% (word [0]) pig_latin = pig_latin [1:] print (pig_latin) else: pass

We implement pycodestyle by running the following simple command:

Pycodestyle pycodestyle_sample_script.py

The output specifies the code location that violates the PEP-8 style convention:

A pair of numbers separated by colons in each line, such as 3:19, represent the line number and the word symbol, respectively.

For example, outputting a 6:64 E202 space before ")" means that on line 6, there is an unexpected space at the 64th character mark.

You can also check the frequency of errors by analyzing the statistics parameter:

Pycodestyle-- statistics-qq pycodestyle_sample_script.py

In the output above, we see four unexpected blanks before the closing parenthesis ")".

Advanced usage

We can also import pycodestyle directly into Python code to perform automated tests. This is useful for automatically testing the coding style consistency of multiple scripts.

For example, you can write the following classes to automatically check for compliance with the PEP-8 convention:

Import unittestimport pycodestyleclass TestCodeFormat (unittest.TestCase): def test_conformance (self): "Test that the scripts conform to PEP-8." Style = pycodestyle.StyleGuide (quiet=True) result = style.check_files (['file1.py',' file2.py']) self.assertEqual (result.total_errors, 0, "Found style errors")

You can also configure the tool to test against the style rule preferences we define. For example, we can delete specific errors that we do not want to detect in the check:

Style = pycodestyle.StyleGuide (ignore= ['E2019,' E202, 'E501'])

Alternatively, we can instruct pycodestyle to use different profiles (containing a specific set of style rules) together.

Import pycodestylestyle = pycodestyle.StyleGuide (config_file='/path/to/tox.ini') "how to use pycodestyle to improve the readability of python code" is introduced here. Thank you for your reading. If you want to know more about the industry, you can follow the website, the editor will output more high-quality practical articles for you!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.