Concise

Concise

2022/05/31

-----

https://pixabay.com/zh/photos/feet-legs-swimming-pool-submerged-1853291/

-----

一、linter

「你以為我會說先去把 PEP 8 讀完或是買哪本書嗎？那你就錯了！讀 PEP 8 要花的時間太多，而且親身經歷之前可能都不太能理解，讀起來會枯燥乏味。這種事就交給我吧，我下一篇會挑一些 PEP 8 的重點來講。所以到底要從哪開始？當然是他X的打開你的 EditorConfig 和 linter！！抱歉有點激動，這是我每次跟新夥伴合作，收到第一個 PR 時的 OS。」

二、代碼佈局

◎ 善用空行跟縮排 [1]。

「◎ 使用四個空格代替 Tab。

◎ 每行的上限設為 79 個字元。

◎ class 與 function 之前有兩空行。

◎ class 裡面的 method 之間有一空行。

◎ def 不接空行。

◎ ()、[]、{} 裡面不接空格。

◎ 運算子兩邊接空格。

◎ 傳遞關鍵字參數或定義默認參數值時，切勿在 = 周圍使用空格。」[2]。

命名

「◎ 對模組、變數、屬性、函數和方法名使用 snake_case，而不是 CamelCase。

◎ class 使用 CamelCase。

◎ 

◎ 變數名稱裡不使用變數型態。」[2]。

-----

References

一、一般

[1] 空行讓Python更簡潔 — iapyeh documentation

https://iapyeh.readthedocs.io/en/latest/blogs/technical/docs_style_review_twisted.html

# 推薦

[2] The ultimate Python style guidelines - Blog | luminousmen

https://luminousmen.com/post/the-ultimate-python-style-guidelines

-----

二、Google

# 推薦

# Google 

[3] [Python] 值得參考的 Coding Style 整理筆記 - Clay-Technology World

https://clay-atlas.com/blog/2020/07/23/python-%E5%80%BC%E5%BE%97%E5%8F%83%E8%80%83%E7%9A%84-coding-style-%E6%95%B4%E7%90%86%E7%AD%86%E8%A8%98/

# Google 

[4] Python風格規範 — Google 開源專案風格指南

https://tw-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules.html

# Google 

[5] styleguide | Style guides for Google-originated open-source projects

https://google.github.io/styleguide/pyguide.html

-----

三、PEP8

# 推薦

# PEP8

[6] Python Coding Style | 辛西亞的技能樹

https://cynthiachuang.github.io/Python-Coding-Style/

# 推薦

# PEP8

[7] 隨手養成 Python 好習慣 － PEP8 Coding Style、Vim 基本設定 | My.APOLLO

https://myapollo.com.tw/zh-tw/python-pep8-and-vim-configs/

# PEP8

[8] Code Style — The Hitchhiker's Guide to Python

https://docs.python-guide.org/writing/style/

# PEP8

[9] PEP 8 -- Style Guide for Python Code - Jiayun

https://wiki.jiayun.info/PEP_8_--_Style_Guide_for_Python_Code

# PEP8

[10] PEP 8 – Style Guide for Python Code | peps.python.org

https://peps.python.org/pep-0008/

-----

四、pylint

# 推薦

# pylint

[11] Python coding style 1: 基本概念 & linter – ianlini

https://ianliniblog.wordpress.com/2017/05/03/python-coding-style-1-%E5%9F%BA%E6%9C%AC%E6%A6%82%E5%BF%B5-linter/

# pylint

[12] Is there a python style checker that works on notebooks in google colab? - Stack Overflow

https://stackoverflow.com/questions/62154714/is-there-a-python-style-checker-that-works-on-notebooks-in-google-colab

# pylint

# line number

[13] python - How to show line numbers in Google Colaboratory? - Stack Overflow

https://stackoverflow.com/questions/49182502/how-to-show-line-numbers-in-google-colaboratory

# pylint

# no new line

[14] pep8 - Python flake8 py reporting W391 (no newline at end of file) incorrectly - Stack Overflow

https://stackoverflow.com/questions/58785380/python-flake8-py-reporting-w391-no-newline-at-end-of-file-incorrectly

-----