每周學習筆記(2018-11-17)

1. Redis 作者關于寫代碼注釋的一點想法

http://antirez.com/news/124
Redis 的代碼注釋清晰簡潔浪汪,堪稱典范此迅。
這篇文章作者分享自己寫注釋的一點心得炕桨,推薦一讀吏饿。

概括起來注釋包括:

  • Function comments 放在函數(shù)里面庇楞,減少讀代碼者需要額外的思考負擔
  • Design comments 通常放在一個文件的開頭钦无,整個文件的概述丛忆、原理等
  • Why comments 解釋一些實現(xiàn)方法的原因
  • Teacher comments 解釋一些非編程領域的人可能不了解的信息祠汇,如數(shù)學、圖形學等
  • Checklist comments 解決一些比如改了這里代碼熄诡,也要修改那里代碼的問題
  • Guide comments 幫助引導讀者確認沒有誤解代碼
    ……

作者原話:

  • Writing good comments is harder than writing good code
  • 寫好注釋比寫好代碼更困難可很。

2. Python 中與和導入同等級目錄下的另一個模塊?

假設我有一個模塊my_module, 我為其寫了一些測試腳本放在tests目錄下凰浮。
一般情況下我抠,我并不想把這些測試腳本放在源碼文件里面,所以會這樣存放:

.
├── README.md
├── my_module
│   └── my_class.py
└── tests
    └── my_test.py

但是由于測試腳本并不在模塊里面袜茧,當需要導入這個模塊的時候菜拓,就有點麻煩,只能通過路徑的方法導入:

# tests/my_test.py
import sys
from os import path
sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )

from my_module import my_class

3. 使用 SQLAlchemy 直接執(zhí)行 SQL 語句

SQLAlchemy 雖然提供了方便的ORM惫周,但有時候需要直接執(zhí)行一些語句尘惧,有不想用其他連接庫的時候,可以直接用engine.connect()來執(zhí)行递递。

from sqlalchemy.sql import text

connection = engine.connect()

# recommended
cmd = 'select * from Employees where EmployeeGroup == :group'
employeeGroup = 'Staff'
employees = connection.execute(text(cmd), group = employeeGroup)

參考鏈接
https://stackoverflow.com/questions/17972020/how-to-execute-raw-sql-in-sqlalchemy-flask-app
https://chartio.com/resources/tutorials/how-to-execute-raw-sql-in-sqlalchemy/

4. Git diff 直接輸出到當前頁面

有時候我們需要將 git diff 輸出到當前頁面或者文件喷橙,可以通過參數(shù)或者管道控制啥么。

git --no-pager diff
git diff | cat # The latter also removes colour coding.

5. 一些有意思的句子

"Poor people spend their money and save what’s left. Rich people save their money and spend what’s left."

https://www.jimrohn.com/3-money-habits-separate-rich-poor/

其實作為運維,對于時間管理也是相同的道理:珍惜時間的人應該能夠盡量按照自己的計劃來工作贰逾,而不是等待緊急時間悬荣,一直處于救火狀態(tài)。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末疙剑,一起剝皮案震驚了整個濱河市氯迂,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌言缤,老刑警劉巖嚼蚀,帶你破解...
    沈念sama閱讀 206,723評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異管挟,居然都是意外死亡轿曙,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,485評論 2 382
  • 文/潘曉璐 我一進店門僻孝,熙熙樓的掌柜王于貴愁眉苦臉地迎上來导帝,“玉大人,你說我怎么就攤上這事穿铆∧ィ” “怎么了?”我有些...
    開封第一講書人閱讀 152,998評論 0 344
  • 文/不壞的土叔 我叫張陵荞雏,是天一觀的道長虐秦。 經常有香客問我,道長讯檐,這世上最難降的妖魔是什么羡疗? 我笑而不...
    開封第一講書人閱讀 55,323評論 1 279
  • 正文 為了忘掉前任染服,我火速辦了婚禮别洪,結果婚禮上,老公的妹妹穿的比我還像新娘柳刮。我一直安慰自己挖垛,他們只是感情好,可當我...
    茶點故事閱讀 64,355評論 5 374
  • 文/花漫 我一把揭開白布秉颗。 她就那樣靜靜地躺著痢毒,像睡著了一般。 火紅的嫁衣襯著肌膚如雪蚕甥。 梳的紋絲不亂的頭發(fā)上哪替,一...
    開封第一講書人閱讀 49,079評論 1 285
  • 那天,我揣著相機與錄音菇怀,去河邊找鬼凭舶。 笑死晌块,一個胖子當著我的面吹牛,可吹牛的內容都是我干的帅霜。 我是一名探鬼主播匆背,決...
    沈念sama閱讀 38,389評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼身冀!你這毒婦竟也來了钝尸?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 37,019評論 0 259
  • 序言:老撾萬榮一對情侶失蹤搂根,失蹤者是張志新(化名)和其女友劉穎珍促,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體剩愧,經...
    沈念sama閱讀 43,519評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡踢星,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,971評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了隙咸。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片沐悦。...
    茶點故事閱讀 38,100評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖五督,靈堂內的尸體忽然破棺而出藏否,到底是詐尸還是另有隱情,我是刑警寧澤充包,帶...
    沈念sama閱讀 33,738評論 4 324
  • 正文 年R本政府宣布副签,位于F島的核電站,受9級特大地震影響基矮,放射性物質發(fā)生泄漏淆储。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,293評論 3 307
  • 文/蒙蒙 一家浇、第九天 我趴在偏房一處隱蔽的房頂上張望本砰。 院中可真熱鬧,春花似錦钢悲、人聲如沸点额。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,289評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽还棱。三九已至,卻和暖如春惭等,著一層夾襖步出監(jiān)牢的瞬間珍手,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,517評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留琳要,地道東北人料扰。 一個月前我還...
    沈念sama閱讀 45,547評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像焙蹭,于是被迫代替她去往敵國和親晒杈。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 42,834評論 2 345

推薦閱讀更多精彩內容