PythonCodingRule

Py th o n 开 发 编 码 规 范 介 绍 1. 一 致 性 的 建 议 2. 代 码 的 布 局 缩 进 1. 制 表 符 还 是 空 格 ? 2. 行 的 最 大 长 度 3. 空 行 4. 编 码 5. 3. 导 入 4. 空 格 其 它 建 议 1. 5. 注 释 注 释 块 1. 行 内 注 释 2. 6. 文 档 化 7. 版 本 注 记 8. 命 名 约 定 描 述 :命 名 风 格 1. 说 明 :命 名 约 定 应 避 免 的 名 字 1. 模 块 名 2. 类 名 3. 异 常 名 4. 全 局 变 量 名 5. 函 数 名 6. 方 法 名 和 实 例 变 量 7. 继 承 的 设 计 8. 2. 9. 设 计 建 议 10 . 1. Py th o n C o di n gR u le 译 稿 Py th o n 开 发 编 码 规 范 开 发 编 码 规 范 开 发 编 码 规 范 开 发 编 码 规 范 1 . P y t h o n 开 发 编 码 规 范 1 . P y t h o n 开 发 编 码 规 范 1 . P y t h o n 开 发 编 码 规 范 1 . P y t h o n 开 发 编 码 规 范 - - - ho x id e 初 译 dr e a m in g k 校 对 发 布 04 07 24 - - - x y b 重 新 排 版 04 09 15 - - - Z o o m Qu ie t M o in M o in 美 化 05 06 10 用 用用用 Py th o n 进 行 开 发 时 的 编 码 风 格 约 定 进 行 开 发 时 的 编 码 风 格 约 定 进 行 开 发 时 的 编 码 风 格 约 定 进 行 开 发 时 的 编 码 风 格 约 定 原 文 :e pe s: PE P 00 8《 St yl e G u id e fo r Py th o n Co de 》 1 . 1 . 介 绍 1 . 1 . 介 绍 1 . 1 . 介 绍 1 . 1 . 介 绍 这 篇 文 档 所 给 出 的 编 码 约 定 适 用 于 在 主 要 的 Py th o n 发 布 版 本 中 组 成 标 准 库 的 Py th o n 代 码 . 请 查 阅 相 关 的 关 于 在 Py th o n 的 C实 现 中 C代 码 风 格 指 南 的 描 述 . 这 篇 文 档 改 编 自 G u id o 最 初 的 《 Py th o n 风 格 指 南 》 一 文 . 并 从 《 Ba rr y's st yl e gu id e》 中 添 加 了 部 分 内 容 . 在 有 冲 突 的 地 方 ， G u id e的 风 格 规 则 应 该 是 符 合 本 PE P的 意 图 (译 注 ： 就 是 当 有 冲 突 时 ， 应 以 G u id o 风 格 为 准 ) 这 篇 PE P也 许 仍 然 尚 未 完 成 (实 际 上 ， 它 可 能 永 远 不 会 结 束 ). 1 . 2 . 一 致 性 的 建 议 1 . 2 . 一 致 性 的 建 议 1 . 2 . 一 致 性 的 建 议 1 . 2 . 一 致 性 的 建 议 愚 蠢 得 使 用 一 致 性 是 无 知 的 妖 怪 愚 蠢 得 使 用 一 致 性 是 无 知 的 妖 怪 愚 蠢 得 使 用 一 致 性 是 无 知 的 妖 怪 愚 蠢 得 使 用 一 致 性 是 无 知 的 妖 怪 (A Fo o lis h C o n sis te n cy is th e H o bg o bl in o f L itt le M in ds ) 呆 板 的 坚 持 一 致 性 是 傻 的 没 边 了 ! - - Z o o m q 在 这 篇 风 格 指 导 中 的 一 致 性 是 重 要 的 . 在 一 个 项 目 内 的 一 致 性 更 重 要 . 在 一 个 模 块 或 函 数 内 的 一 致 性 最 重 要 . 但 最 重 要 的 是 :知 道 何 时 会 不 一 致 - - 有 时 只 是 没 有 实 施 风 格 指 导 . 当 出 现 疑 惑 时 , 运 用 你 的 最 佳 判 断 . 看 看 别 的 例 子 , 然 后 决 定 怎 样 看 起 来 更 好 . 并 且 要 不 耻 下 问 ! 打 破 一 条 既 定 规 则 的 两 个 好 理 由 : 当 应 用 这 个 规 则 是 将 导 致 代 码 可 读 性 下 降 , 即 便 对 某 人 来 说 , 他 已 经 习 惯 于 按 这 条 规 则 来 阅 读 代 码 了 . 1. 为 了 和 周 围 的 代 码 保 持 一 致 而 打 破 规 则 (也 许 是 历 史 原 因 ) - - 虽 然 这 也 是 个 清 除 其 它 混 乱 的 好 机 会 (真 正 的 X P风 格 ). 2. 1 . 3 . 代 码 的 布 局 1 . 3 . 代 码 的 布 局 1 . 3 . 代 码 的 布 局 1 . 3 . 代 码 的 布 局 (C o de la y- o u t) 1 . 3 . 1 . 缩 进 1 . 3 . 1 . 缩 进 1 . 3 . 1 . 缩 进 1 . 3 . 1 . 缩 进 (In de n ta tio n ) 使 用 Em ac s的 Py th o n - m o de 的 默 认 值 :4 个 空 格 一 个 缩 进 层 次 . 对 于 确 实 古 老 的 代 码 , 你 不 希 望 产 生 混 乱 , 可 以 继 续 使 用 8空 格 的 制 表 符 (8- sp ac e ta bs ). E m ac s Py th o n - m o de 自 动 发 现 文 件 中 主 要 的 缩 进 层 次 , 依 此 设 定 缩 进 参 数 . 1 . 3 . 2 . 制 表 符 还 是 空 格 ? 1 . 3 . 2 . 制 表 符 还 是 空 格 ? 1 . 3 . 2 . 制 表 符 还 是 空 格 ? 1 . 3 . 2 . 制 表 符 还 是 空 格 ? (T ab s o r Sp ac es ) 永 远 不 要 混 用 制 表 符 和 空 格 . 最 流 行 的 Py th o n 缩 进 方 式 是 仅 使 用 空 格 , 其 次 是 仅 使 用 制 表 符 . 混 合 着 制 表 符 和 空 格 缩 进 的 代 码 将 被 转 换 成 仅 使 用 空 格 . (在 Em ac s中 , 选 中 整 个 缓 冲 区 , 按 ES C- x 去 除 制 表 符 (un ta bi fy ).) 调 用 py th o n 命 令 行 解 释 器 时 使 用 - t选 项 , 可 对 代 码 中 不 合 法 得 混 合 制 表 符 和 空 格 发 出 警 告 (w ar n in gs ). 使 用 - tt时 警 告 (w ar n in gs )将 变 成 错 误 (er ro rs ).这 些 选 项 是 被 高 度 推 荐 的 . 对 于 新 的 项 目 , 强 烈 推 荐 仅 使 用 空 格 (sp ac es - o n ly )而 不 是 制 表 符 . 许 多 编 辑 器 拥 有 使 之 易 于 实 现 的 功 能 . (在 Em ac s中 , 确 认 in de n t- ta bs - m o de 是 n il) . 1 . 3 . 3 . 行 的 最 大 长 度 1 . 3 . 3 . 行 的 最 大 长 度 1 . 3 . 3 . 行 的 最 大 长 度 1 . 3 . 3 . 行 的 最 大 长 度 (M ax im u m Li n e Le n gt h) 周 围 仍 然 有 许 多 设 备 被 限 制 在 每 行 80 字 符 ;而 且 , 窗 口 限 制 在 80 个 字 符 使 将 多 个 窗 口 并 排 放 置 成 为 可 能 . 在 这 些 设 备 上 使 用 默 认 的 折 叠 (w ra pp in g)方 式 看 起 来 有 点 丑 陋 . 因 此 , 请 将 所 有 行 限 制 在 最 大 79 字 符 (E m ac s准 确 得 将 行 限 制 为 长 80 字 符 ), 对 顺 序 排 放 的 大 块 文 本 (文 档 字 符 串 或 注 释 ),推 荐 将 长 度 限 制 在 72 字 符 . 折 叠 长 行 的 首 选 方 法 是 使 用 Py ho n 支 持 的 圆 括 号 , 方 括 号 (br ac ke ts )和 花 括 号 (br ac es )内 的 行 延 续 . 如 果 需 要 , 你 可 以 在 表 达 式 周 围 增 加 一 对 额 外 的 圆 括 号 , 但 是 有 时 使 用 反 斜 杠 看 起 来 更 好 . 确 认 恰 当 得 缩 进 了 延 续 的 行 . Em ac s的 Py th o n - m o de 正 确 得 完 成 了 这 些 . 一 些 例 子 : To gg le lin e n u m be rs 1 c la s s R e c t a n g le (B lo b) : 2 3 de f _ _ in it _ _ (s e lf , w id t h, he ig ht , 4 c o lo r = ' bl a c k' , e m p ha s is = N o n e , hi g hl ig ht = 0) : 5 if w id t h = = 0 a n d he ig ht = = 0 a n d \ c o lo r = = ' r e d' a n d e m p ha s is = = ' s t r o n g ' o r \ hi g hl ig ht > 10 0: 6 r a is e V a lu e E r r o r , " s o r r y , y o u lo s e " 7 if w id t h = = 0 a n d he ig ht = = 0 a n d (c o lo r = = ' r e d' o r 8 e m p ha s is is N o n e ): 9 r a is e V a lu e E r r o r , " I do n ' t t hi n k s o " 10 B lo b. _ _ in it _ _ (s e lf , w id t h, he ig ht , 11 c o lo r , e m p ha s is , hi g hl ig ht ) 1 . 3 . 4 . 空 行 1 . 3 . 4 . 空 行 1 . 3 . 4 . 空 行 1 . 3 . 4 . 空 行 (B la n k Li n es ) 用 两 行 空 行 分 割 顶 层 函 数 和 类 的 定 义 , 类 内 方 法 的 定 义 用 单 个 空 行 分 割 . 额 外 的 空 行 可 被 用 于 (保 守 的 (sp ar in gl y)) 分 割 相 关 函 数 组 成 的 群 (gr o u ps o f r el at ed fu n ct io n s). 在 一 组 相 关 的 单 句 中 间 可 以 省 略 空 行 . (例 如 . 一 组 哑 元 (a se t o f d u m m y im pl em en ta tio n s)) . 当 空 行 用 于 分 割 方 法 (m et ho d)的 定 义 时 , 在 'c la ss '行 和 第 一 个 方 法 定 义 之 间 也 要 有 一 个 空 行 . 在 函 数 中 使 用 空 行 时 , 请 谨 慎 的 用 于 表 示 一 个 逻 辑 段 落 (in di ca te lo gi ca l s ec tio n s). Py th o n 接 受 co n to l-L (即 ^ L) 换 页 符 作 为 空 格 ;E m ac s(和 一 些 打 印 工 具 ) 视 这 个 字 符 为 页 面 分 割 符 , 因 此 在 你 的 文 件 中 , 可 以 用 他 们 来 为 相 关 片 段 (se ct io n s)分 页 . 1 . 3 . 5 . 编 码 1 . 3 . 5 . 编 码 1 . 3 . 5 . 编 码 1 . 3 . 5 . 编 码 (E n co di n gs )ep es :(P EP 26 3) Py th o n 核 心 发 布 中 的 代 码 必 须 始 终 使 用 A SC II或 La tin - 1编 码 (又 名 IS O - 88 59 - 1). 使 用 A SC II的 文 件 不 必 有 译 码 co o ki e(c o di n g co o ki e). La tin - 1仅 当 注 释 或 文 档 字 符 串 涉 及 作 者 名 字 需 要 La tin - 1时 才 被 使 用 ; 另 外 使 用 \x 转 义 字 符 是 在 字 符 串 中 包 含 非 A SC II( n o n - A SC II) 数 据 的 首 选 方 法 . 作 为 PE P 26 3实 现 代 码 的 测 试 套 件 的 部 分 文 件 是 个 例 外 . P y t ho n 2. 4 以 后 内 核 支 持 U n ic o de 了 ！ 不 论 什 么 情 况 使 用 U T F - 8 吧 ！ 这 是 王 道 ！ - - Zo o m Qu ie t 1 . 4 . 导 入 1 . 4 . 导 入 1 . 4 . 导 入 1 . 4 . 导 入 (Im po rt s) 通 常 应 该 在 单 独 的 行 中 导 入 (Im po rt s), 例 如 : N o : im p o r t s y s , o s Y e s : im p o r t s y s im p o r t o s 但 是 这 样 也 是 可 以 的 : fr o m t y p e s im p o r t S t r in g T y p e , L is t T y p e Im po rt s 通 常 被 放 置 在 文 件 的 顶 部 , 仅 在 模 块 注 释 和 文 档 字 符 串 之 后 , 在 模 块 的 全 局 变 量 和 常 量 之 前 . Im po rt s应 该 有 顺 序 地 成 组 安 放 . 标 准 库 的 导 入 (Im po rt s ) 1. 相 关 的 主 包 (m ajo r pa ck ag e)的 导 入 (即 , 所 有 的 em ai l包 在 随 后 导 入 ) 2. 特 定 应 用 的 导 入 (im po rt s) 3. 你 应 该 在 每 组 导 入 之 间 放 置 一 个 空 行 . 对 于 内 部 包 的 导 入 是 不 推 荐 使 用 相 对 导 入 的 . 对 所 有 导 入 都 要 使 用 包 的 绝 对 路 径 . 从 一 个 包 含 类 的 模 块 中 导 入 类 时 , 通 常 可 以 写 成 这 样 : fr o m M y C la s s im p o r t M y C la s s fr o m fo o . ba r . Y o u r C la s s im p o r t Y o u r C la s s 如 果 这 样 写 导 致 了 本 地 名 字 冲 突 , 那 么 就 这 样 写 im p o r t M y C la s s im p o r t fo o . ba r . Y o u r C la s s 即 使 用 " M y C l a s s . M y C l a s s " 和 " f o o . b a r . Y o u r C l a s s . Y o u r C l a s s " 1 . 5 . 空 格 1 . 5 . 空 格 1 . 5 . 空 格 1 . 5 . 空 格 (W hi te sp ac e in Ex pr es sio n s an d St at em en ts ) G u id o 不 喜 欢 在 以 下 地 方 出 现 空 格 : " s p a m ( h a m [ 1 ] , { e g g s : 2 } ) " . A l w a y s w r i t e t h i s a s " s p a m ( h a m [ 1 ] , { e g g s : 2 } ) " . 紧 挨 着 圆 括 号 , 方 括 号 和 花 括 号 的 , 如 :" s p a m ( h a m [ 1 ] , { e g g s : 2 } ) " . 要 始 终 将 它 写 成 " s p a m ( h a m [ 1 ] , { e g g s : 2 } ) " . " i f x = = 4 : p r i n t x , y ; x , y = y , x " . A lw ay s w rit e th is as " i f x = = 4 : p r i n t x , y ; x , y = y , x " . 紧 贴 在 逗 号 , 分 号 或 冒 号 前 的 , 如 : " i f x = = 4 : p r i n t x , y ; x , y = y , x " . 要 始 终 将 它 写 成 " i f x = = 4 : p r i n t x , y ; x , y = y , x " . 紧 贴 着 函 数 调 用 的 参 数 列 表 前 开 式 括 号 (op en pa re n th es is )的 , 如 " s p a m ( 1 ) " . 要 始 终 将 它 写 成 " s p a m ( 1 ) " . s l i c i n g , a s i n : " d i c t [ ' k e y ' ] = l i s t [ i n d e x ] " . A lw ay s w rit e th is as " d i c t [ ' k e y ' ] = l i s t [ i n d e x ] " . 紧 贴 在 索 引 或 切 片 (sl ic in g? 下 标 ?)开 始 的 开 式 括 号 前 的 , 如 : " d i c t [ ' k e y ' ] = l i s t [ i n d e x ] " . 要 始 终 将 它 写 成 " d i c t [ ' k e y ' ] = l i s t [ i n d e x ] " . 在 赋 值 (或 其 它 )运 算 符 周 围 的 用 于 和 其 它 并 排 的 一 个 以 上 的 空 格 , 如 : To gg le lin e n u m be rs 1 x = 1 2 y = 2 3 lo n g _ v a r ia bl e = 3 要 始 终 将 它 写 成 To gg le lin e n u m be rs 1 x = 1 2 y = 2 3 lo n g _ v a r ia bl e = 3 (不 要 对 以 上 任 意 一 条 和 他 争 论 - - - G u id o 养 成 这 样 的 风 格 超 过 20 年 了 . ) 1 . 5 . 1 . 其 它 建 议 1 . 5 . 1 . 其 它 建 议 1 . 5 . 1 . 其 它 建 议 1 . 5 . 1 . 其 它 建 议 (O th er R ec o m m en da tio n s) 始 终 在 这 些 二 元 运 算 符 两 边 放 置 一 个 空 格 :赋 值 (= ), 比 较 (= = , < , > , != , < > , < = , > = , in , n o t i n , is, is n o t), 布 尔 运 算 (an d, o r, n o t). * 按 你 的 看 法 在 算 术 运 算 符 周 围 插 入 空 格 . 始 终 保 持 二 元 运 算 符 两 边 空 格 的 一 致 . 一 些 例 子 : To gg le lin e n u m be rs 1 i = i+ 1 2 s u bm it t e d = s u bm it t e d + 1 3 x = x * 2 - 1 4 hy p o t 2 = x * x + y * y 5 c = (a + b) * (a - b) 6 c = (a + b) * (a - b) 不 要 在 用 于 指 定 关 键 字 参 数 或 默 认 参 数 值 的 '= '号 周 围 使 用 空 格 , 例 如 : To gg le lin e n u m be rs 1 de f c o m p le x (r e a l, im a g = 0. 0) : 2 r e t u r n m a g ic (r = r e a l, i= im a g ) 不 要 将 多 条 语 句 写 在 同 一 行 上 . N o : if fo o = = ' bl a h' : do _ bl a h_ t hi n g () Y e s : if fo o = = ' bl a h' : do _ bl a h_ t hi n g () N o : do _ o n e () ; do _ t w o () ; do _ t hr e e () Y e s : do _ o n e () do _ t w o () do _ t hr e e () 1 . 6 . 注 释 1 . 6 . 注 释 1 . 6 . 注 释 1 . 6 . 注 释 (C o m m en ts ) 同 代 码 不 一 致 的 注 释 比 没 注 释 更 差 . 当 代 码 修 改 时 , 始 终 优 先 更 新 注 释 ! 注 释 应 该 是 完 整 的 句 子 . 如 果 注 释 是 一 个 短 语 或 句 子 , 首 字 母 应 该 大 写 , 除 非 他 是 一 个 以 小 写 字 母 开 头 的 标 识 符 (永 远 不 要 修 改 标 识 符 的 大 小 写 ). 如 果 注 释 很 短 , 最 好 省 略 末 尾 的 句 号 (pe rio d? 结 尾 句 末 的 停 顿 ?也 可 以 是 逗 号 吧 , ) 注 释 块 通 常 由 一 个 或 多 个 由 完 整 句 子 构 成 的 段 落 组 成 , 每 个 句 子 应 该 以 句 号 结 尾 . 你 应 该 在 句 末 , 句 号 后 使 用 两 个 空 格 , 以 便 使 Em ac s的 断 行 和 填 充 工 作 协 调 一 致 (译 按 :应 该 说 是 使 这 两 种 功 能 正 常 工 作 , " . " 给 出 了 文 档 结 构 的 提 示 ). 用 英 语 书 写 时 , 断 词 和 空 格 是 可 用 的 . 非 英 语 国 家 的 Py th o n 程 序 员 :请 用 英 语 书 写 你 的 注 释 , 除 非 你 12 0% 的 确 信 这 些 代 码 不 会 被 不 懂 你 的 语 言 的 人 阅 读 . 我 就 是 坚 持 全 部 使 用 中 文 来 注 释 ， 真 正 要 发 布 脚 本 工 具 时 ， 再 想 E 文 的 ； 开 发 时 每 一 瞬 间 都 要 用 在 思 量 中 ， 坚 决 不 用 在 E 文 语 法 ， 单 词 的 回 忆 中 ！ - - Zo o m QU ie t 约 定 使 用 统 一 的 文 档 化 注 释 格 式 有 利 于 良 好 习 惯 和 团 队 建 议 ！ - - Co de Co m m en tin gR u le 1 . 6 . 1 . 注 释 块 1 . 6 . 1 . 注 释 块 1 . 6 . 1 . 注 释 块 1 . 6 . 1 . 注 释 块 (B lo ck Co m m en ts ) 注 释 块 通 常 应 用 于 跟 随 着 一 些 (或 者 全 部 )代 码 并 和 这 些 代 码 有 着 相 同 的 缩 进 层 次 . 注 释 块 中 每 行 以 '# '和 一 个 空 格 开 始 (除 非 他 是 注 释 内 的 缩 进 文 本 ). 注 释 块 内 的 段 落 以 仅 含 单 个 '# '的 行 分 割 . 注 释 块 上 下 方 最 好 有 一 空 行 包 围 (或 上 方 两 行 下 方 一 行 , 对 一 个 新 函 数 定 义 段 的 注 释 ). 1 . 6 . 2 . 行 内 注 释 1 . 6 . 2 . 行 内 注 释 1 . 6 . 2 . 行 内 注 释 1 . 6 . 2 . 行 内 注 释 (In lin e Co m m en ts ) (in lin e? 内 联 ?翻 成 " 行 内 " 比 较 好 吧 ) 一 个 行 内 注 释 是 和 语 句 在 同 一 行 的 注 释 . 行 内 注 释 应 该 谨 慎 适 用 . 行 内 注 释 应 该 至 少 用 两 个 空 格 和 语 句 分 开 . 它 们 应 该 以 '# '和 单 个 空 格 开 始 . x = x + 1 # I n c r e m e n t x 如 果 语 意 是 很 明 了 的 , 那 么 行 内 注 释 是 不 必 要 的 , 事 实 上 是 应 该 被 去 掉 的 . 不 要 这 样 写 : x = x + 1 # I n c r e m e n t x x = x + 1 # C o m p e n s a t e fo r bo r de r 但 是 有 时 , 这 样 是 有 益 的 : x = x + 1 # C o m p e n s a t e fo r bo r de r 1 . 7 . 文 档 化 1 . 7 . 文 档 化 1 . 7 . 文 档 化 1 . 7 . 文 档 化 (D o cu m en ta tio n St rin gs ) Co n v en tio n s fo r w rit in g go o d do cu m en ta tio n st rin gs (a. k. a. " do cs tr in gs " ) a re im m o rt al iz ed in ep es :P EP 25 7. 应 该 一 直 遵 守 编 写 好 的 文 档 字 符 串 (又 名 " do cs tr in gs " )的 约 定 (?实 在 不 知 道 怎 么 译 ) D o c u m e n t a t io n S t r in g s - - 文 档 化 字 符 ; 为 配 合 p y do c ; e p y do c , D o x y g e n 等 等 文 档 化 工 具 的 使 用 , 类 似 于 M o in M o in 语 法 , 约 定 一 些 字 符 , 以 便 自 动 提 取 转 化 为 有 意 义 的 文 档 章 节 等 等 文 章 元 素 ! - - Z o o m q 为 所 有 公 共 模 块 , 函 数 , 类 和 方 法 编 写 文 档 字 符 串 . 文 档 字 符 串 对 非 公 开 的 方 法 不 是 必 要 的 , 但 你 应 该 有 一 个 描 述 这 个 方 法 做 什 么 的 注 释 . 这 个 注 释 应 该 在 " de f" 这 行 后 . ep es :P EP 25 7 描 述 了 好 的 文 档 字 符 串 的 约 定 . 一 定 注 意 , 多 行 文 档 字 符 串 结 尾 的 " " " 应 该 单 独 成 行 , 例 如 : " " " R e t u r n a fo o ba n g O p t io n a l p lo t z s a y s t o fr o bn ic a t e t he bi z ba z fi r s t . " " " 对 单 行 的 文 档 字 符 串 , 结 尾 的 " " " 在 同 一 行 也 可 以 . 实 际 上 P y t ho n 自 个 儿 就 使 用 文 档 化 编 码 维 护 着 所 有 内 置 对 象 的 使 用 说 明 \ 不 信 的 话 常 试 : #p y t ho n > > > im p o r t t im e > > > di r (t im e ) [' _ _ do c _ _ ' , ' _ _ fi le _ _ ' , ' _ _ n a m e _ _ ' , ' a c c e p t 2d y e a r ' , ' a lt z o n e ' , ' a s c t im e ' , ' c lo c k' , ' c t im e ' , ' da y li g ht ' , ' g m t im e ' , ' lo c a lt im e ' , ' m kt im e ' , ' s le e p ' , ' s t r ft im e ' , ' s t r p t im e ' , ' s t r u c t _ t im e ' , ' t im e ' , ' t im e z o n e ' , ' t z n a m e ' , ' t z s e t ' ] > > > he lp (t im e . t im e ) H e lp o n bu il t - in fu n c t io n t im e in m o du le t im e : t im e (. . . ) t im e () - > fl o a t in g p o in t n u m be r R e t u r n t he c u r r e n t t im e in s e c o n ds s in c e t he E p o c h. F r a c t io n s o f a s e c o n d m a y be p r e s e n t if t he s y s t e m c lo c k p r o v id e s t he m . 1 . 8 . 版 本 注 记 1 . 8 . 版 本 注 记 1 . 8 . 版 本 注 记 1 . 8 . 版 本 注 记 (V er sio n Bo o kk ee pi n g) (我 觉 得 叫 " 注 记 " 更 好 ) 如 果 你 要 将 R CS 或 CV S的 杂 项 (cr u d)包 含 在 你 的 源 文 件 中 , 按 如 下 做 . To gg le lin e n u m be rs 1 _ _ v e r s io n _ _ = " $R e v is io n : 1. 4 $" 2 # $S o u r c e : E : /c v s r o o t /p y t ho n _ do c /p e p 8. t x t , v $ 这 个 行 应 该 包 含 在 模 块 的 文 档 字 符 串 之 后 , 所 有 代 码 之 前 , 上 下 用 一 个 空 行 分 割 . 对 于 C V S 的 服 务 器 工 作 标 记 更 应 该 在 代 码 段 中 明 确 出 它 的 使 用 如 ： 在 文 档 的 最 开 始 的 版 权 声 明 后 应 加 入 如 下 版 本 标 记 ： # 文 件 ： $i d$ # 版 本 ： $R e v is io n $ 这 样 的 标 记 在 提 交 给 配 置 管 理 服 务 器 后 ， 会 自 动 适 配 成 为 相 应 的 字 符 串 ， 如 ： # 文 件 ： $I d: u s s p . p y , v 1. 22 20 04 /0 7/ 21 04 : 47 : 41 hd E x p $ # 版 本 ： $R e v is io n : 1. 4 $ - - - - H D 1 . 9 . 命 名 约 定 1 . 9 . 命 名 约 定 1 . 9 . 命 名 约 定 1 . 9 . 命 名 约 定 (N am in g Co n v en tio n s) Py th o n 库 的 命 名 约 定 有 点 混 乱 , 所 以 我 们 将 永 远 不 能 使 之 变 得 完 全 一 致 - - - 不 过 还 是 有 公 认 的 命 名 规 范 的 . 新 的 模 块 和 包 (包 括 第 三 方 的 框 架 )必 须 符 合 这 些 标 准 , 但 对 已 有 的 库 存 在 不 同 风 格 的 , 保 持 内 部 的 一 致 性 是 首 选 的 . 1 . 9 . 1 . 描 述 : 命 名 风 格 1 . 9 . 1 . 描 述 : 命 名 风 格 1 . 9 . 1 . 描 述 : 命 名 风 格 1 . 9 . 1 . 描 述 : 命 名 风 格 (D es cr ip tiv e: N am in g St yl es ) 有 许 多 不 同 的 命 名 风 格 . 以 下 的 有 助 于 辨 认 正 在 使 用 的 命 名 风 格 , 独 立 于 它 们 的 作 用 . 以 下 的 命 名 风 格 是 众 所 周 知 的 : b (单 个 小 写 字 母 ) B (单 个 大 写 字 母 ) 小 写 串 如 :g et n am e 带 下 划 的 小 写 串 如 :_ ge tn am e 大 写 串 如 :G ET N A M E 带 下 划 的 大 写 串 如 :_ G ET N A M E Ca pi ta liz ed W o rd s(首 字 母 大 写 单 词 串 ) ( 或 Ca pW o rd s, Ca m el Ca se - - 这 样 命 名 是 由 于 它 的 字 母 错 落 有 致 的 样 子 而 来 的 . 这 有 时 也 被 当 作 St u dl yC ap s. 如 :G et N am e m ix ed Ca se (混 合 大 小 写 串 )(与 首 字 母 大 写 串 不 同 之 处 在 于 第 一 个 字 符 是 小 写 如 :g et N am e) Ca pi ta liz ed _ W o rd s_ W ith _ U n de rs co re s(带 下 划 线 的 首 字 母 大 写 串 ) ( 丑 陋 !) 还 有 一 种 使 用 特 别 前 缀 的 风 格 ， 用 于 将 相 关 的 名 字 分 成 组 . 这 在 Py th o n 中 不 常 用 , 但 是 出 于 完 整 性 要 提 一 下 . 例 如 , o s. st at ()函 数 返 回 一 个 tu pl e, 他 的 元 素 传 统 上 有 象 st _ m o de , st _ siz e, st