TencentのPythonコーディング標準

著作権通知：この記事は、CSDNブロガー「TianyuanProdigalSon」を対象としています。
元のリンク：https：//blog.csdn.net/xufive/article/details/84957425

pythonファイルの構成

説明を簡単にするために、最初にデモ

#! /usr/bin/env python
# - *- coding: utf-8-*-"""通常、これはこのドキュメントの説明（docstring）であり、ピリオド、疑問符、または感嘆符で終わる必要があります!

この行の前に空白行があるはずです。このドキュメントの説明を続けてください
ドキュメントの説明を1行で終了できる場合は、末尾の3つの二重引用符を折り返す必要はありません。それ以外の場合は、次のようになります。
"""

import os, time
import datetime
import math

import numpy as np
import xlrd, xlwt, xlutils

import youth_mongodb
import youth_curl

BASE_PATH = r"d:\YouthGit"
LOG_FILE = u"実行ログ.txt"classGameRoom(object):"""ゲームルーム"""

 def __init__(self, name, limit=100,**kwds):"""コンストラクタ!

  名前ゲームルームの名前
  制限
  kwdsパラメータ辞書
        """

  pass

def craete_and_start():"""ゲームルームを作成して開始します"""

 pass

if __name__ =='__main__':
 # オープンゲームサービス
 start()

Linuxプラットフォームでは、pythonソースコードファイルは次の部分で構成されている必要があります。 Windowsプラットフォームでは、最初の項目は省略できます。

  1. 通訳者宣言
  2. エンコーディングフォーマット宣言
  3. モジュールコメントまたはdocstring
  4. モジュールのインポート
  5. 定数およびグローバル変数宣言
  6. トップレベルの定義（関数またはクラスの定義）
  7. コードを実行する

エンコーディングフォーマット宣言

通常、エンコード形式の宣言が必要です。 pythonソースコードファイルでエンコード形式が宣言されていない場合、pythonインタープリターはデフォルトでASCIIエンコードを使用します。ソースファイルに非ASCII文字が含まれると、pythonインタープリターはエラーを報告します。 UTF-8を例にとると、次の2つのエンコード形式の宣言は規則に準拠しています。

# - *- coding: utf-8-*-

# coding = utf-8

私は常にUTF-8エンコード形式を使用し、最初の宣言方法を使用するのが好きです。

Windowsプラットフォームでは、エンコード形式の宣言はpythonファイルの最初の行にある必要があります。 Linuxプラットフォームでは、エンコード形式の宣言は通常pythonファイルの2行目にあり、最初の行はpythonインタープリターのパス宣言です。

#! /usr/bin/env python
# - *- coding: utf-8-*-

インデント

インデントには4つのスペースを使用します。タブを使用したり、タブとスペースを混在させたりしないでください。行の連結には、通常4スペースのぶら下げインデントを使用します。例えば：

var_dict ={'name':'xufive','mail':'[email protected]'}

引用マーク

コメント

番号の後にスペースがあり、段落は空白行で区切られています（＃も必要です）：

 # コメントをブロックする
 # コメントをブロックする
    #
 # コメントをブロックする
 # コメントをブロックする

インラインコメントでは、少なくとも2つのスペースとステートメントを使用して区切ります。

age +=1  #1歳年上

複数の等しい記号で区切られた、より重要なコメント段落は、より目を引くものになり、重要性を強調することができます。

 server=gogame(room, options)

    # =====================================
 # ここにゴミを捨てないでください!!!
 # ===================================== if __name__ =='__main__':
  server.run()

空白行

スペース

**Docstring **

docstringは、パッケージ、モジュール、クラス、または関数の最初のステートメントです。これらの文字列は、オブジェクトの__doc__メンバーによって自動的に抽出され、pydocによって使用されます。 docstringには三重二重引用符（ "" "）を使用します。docstringの内容を1行に記述できない場合、最初の行はピリオド、疑問符、または感嘆符で終わり、その後に空白行が続き、最後の三重二重引用符は独自の行にある必要があります。

モジュールのインポート

インポートは、モジュールのコメントとドキュメント文字列の後、モジュールのグローバル変数と定数の前に、常にファイルの先頭に配置する必要があります。インポートは、最も一般的なものから最も一般的でないものの順にグループ化し、グループ間に空白行を含める必要があります。

  1. 標準ライブラリのインポート
  2. サードパーティのライブラリのインポート
  3. アプリケーション固有のインポート

次のインポート方法は避ける必要があります。

from math import*

命名規則

推奨読書：
[ヘビーシェアリング]推奨システムをゼロから1に構築するためのガイドラインに関するホワイトペーパー.pdf（48ページのダウンロードリンク付き）
[ヘビーウェイト]数千万のインテリジェントレコメンデーションシステムのアーキテクチャの進化
Xiaohongshuアーキテクチャの責任者：推奨システムでのFlinkの適用、25 ppt
106 「AdvancedPython」ページの中国語版（ダウンロード添付）
19 Pythonを学んだ後、1歳の大学生に最も人気のある音楽アプリケーションを作成する方法

この記事を読んで学んだことはありますか？より多くの人に転送して共有してください

Recommended Posts

TencentのPythonコーディング標準