EADST

适用于代码Agent的Python代码编写规则

下面是我的放到code rule里的Python代码编写规则

代码风格规范

1. 文档字符串

  • 每个使用 def 定义的函数、方法,以及每个使用 class 定义的类,都必须添加 """...""" 形式的文档字符串。
  • 文档字符串应清晰说明函数或类的功能和用途。
  • 函数或方法的文档字符串应说明关键参数的类型、含义,以及返回值的类型和含义。

2. 类型表达方式

  • 函数和方法的参数及返回值不得使用 Python 类型注解。
  • 禁止使用 arg: int、name: str、-> bool 等类型注解写法。
  • 参数及返回值的类型信息应统一写在文档字符串中。

示例:

def get_user_name(user_id):
    """根据用户 ID 获取用户名。

    Args:
        user_id (int): 用户的唯一标识。

    Returns:
        str: 用户名。
    """

3. 行宽限制

  • 每行代码的长度不得超过 120 个字符。
  • 该限制适用于代码、注释、字符串以及文档字符串中的代码示例。
  • 超过限制时,应通过换行、括号或拆分表达式的方式调整,禁止仅为缩短行宽而使用含义不清的缩写。

4. 二元运算符空格

  • 所有二元运算符的前后必须各保留一个空格。
  • 本规则适用于算术运算符、比较运算符、赋值运算符、逻辑运算符、位运算符等。
  • 一元运算符不适用本规则。

正确示例:

x == 1
x < 1
total = a + b
remainder = value % divisor
is_valid = enabled and ready
flags = read_flag | write_flag
相关标签
About Me
XD
Goals determine what you are going to be.
Category
标签云
LLAMA 多进程 RGB GPTQ JSON AI Permission COCO UNIX Sklearn FP16 Markdown Interview Algorithm Paddle API网关 logger Domain Disk Magnet GoogLeNet Google git-lfs XGBoost 域名 v0.dev 证件照 DeepSeek PDB SQLite Dataset Miniforge Windows FP64 TSV Diagram IndexTTS2 Pillow Github Card Ptyhon Logo 关于博主 hf TTS Pandas Git BTC 递归学习法 Website Plate Mixtral BeautifulSoup git Streamlit Knowledge Template Gemma CSV CTC 个人博客 阿里云 Heatmap ChatGPT Datetime ONNX Paper Web 音频 图形思考法 搞笑 Llama Jev Hotel Pytorch Tiktoken 强化学习 FastAPI 腾讯云 算法题 v2ray FP8 VGG-16 TensorRT Breakpoint 版权 Base64 OpenCV NLTK LoRA Plotly Password UI HaggingFace MD5 Harness EXCEL C++ Django GPT4 llama.cpp 报税 icon NameSilo GIT RL Random Baidu CEIR Bipartite 继承 Distillation Math CLAP GGML Vmess transformers Search Python Nginx diffusers HuggingFace 自我改进 CUDA 顶会 Color DeepStream SQL Qwen Video 多线程 BF16 Agent News XML Hilton WAN OpenAI 长期记忆 Crawler OCR Tensor uwsgi 第一性原理 Translation LeetCode printf Freesound Numpy Bert YOLO torchinfo Augmentation Excel Clash Bitcoin Qwen2.5 Qwen2 Quantize scipy FlashAttention Conda Rebuttal 云服务器 WebCrawler Firewall Statistics Safetensors Bin SAM Attention LLM PIP Use PDF TensorFlow Proxy 论文 Transformers ModelScope Data 净利润 Image2Text 公式 Pickle tar NLP InvalidArgumentError SVR Food 论文速读 Input PyTorch CV Shortcut VPN Linux Tracking Animate uWSGI Jupyter SPIE Anaconda tqdm ms-swift LaTeX Hungarian Zip Review API Quantization 飞书 CC Jetson RAR CAM FP32 Michelin 财报 QWEN Land 图标 ResNet-50 Docker Cloudreve mmap PyCharm Vim VSCode Claude Ubuntu 签证
站点统计

本站现有博文340篇,共被浏览1015546次

本站已经建立2717天!

热门文章
文章归档
回到顶部