# python_utils

**Repository Path**: lainyu/utils

## Basic Information

- **Project Name**: python_utils
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-16
- **Last Updated**: 2021-04-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: toolkit

## README

# Utils 项目说明

此项目按照操作系统不同模块划分，写了一些python可能会用到的工具函数。

## 使用

1. 每个方法都有说明，望仔细阅读
2. 由于每个项目需求不一，这些工具函数可能主要用于提供一个方便快捷的解决方案，如果不符合需求可以复制到本地自行修改。
3. 如果有遇到BUG，欢迎指出并修改，大家都可以clone一份到本地方便添加修改

## 文档生成
项目内的html文件是用pydoc工具生成的python函数的说明文档，生成的命令为:
```shell
python -m pydoc -w module_name
# module_name = file_tools or others python script without '.py'
```

## 注释风格
python的注释风格需要统一为: 

```python
def method_name(arg1, arg2):
    """
        ---method usage introduction---
        :param arg1: ---arg1 introduction---
        :param arg2: ---arg2 introduction---
        :return: ---return result introduction---
    """
    res = arg1 + arg2
    return res
```

1. 注释写在方法名下面， 用3个双引号包着
2. 需要有方法使用的简单介绍
3. 参数说明
4. 返回值说明，如果没有返回值，则不做说明