每周学习笔记(2018-11-17)

1. Redis 作者关于写代码注释的一点想法

http://antirez.com/news/124
Redis 的代码注释清晰简洁,堪称典范。
这篇文章作者分享自己写注释的一点心得,推荐一读。

概括起来注释包括:

  • Function comments 放在函数里面,减少读代码者需要额外的思考负担
  • Design comments 通常放在一个文件的开头,整个文件的概述、原理等
  • Why comments 解释一些实现方法的原因
  • Teacher comments 解释一些非编程领域的人可能不了解的信息,如数学、图形学等
  • 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 直接执行 SQL 语句

SQLAlchemy 虽然提供了方便的ORM,但有时候需要直接执行一些语句,有不想用其他连接库的时候,可以直接用engine.connect()来执行。

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 输出到当前页面或者文件,可以通过参数或者管道控制。

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/

其实作为运维,对于时间管理也是相同的道理:珍惜时间的人应该能够尽量按照自己的计划来工作,而不是等待紧急时间,一直处于救火状态。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,123评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,031评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,723评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,357评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,412评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,760评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,904评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,672评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,118评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,456评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,599评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,264评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,857评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,731评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,956评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,286评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,465评论 2 348

推荐阅读更多精彩内容