|
| 1 | +# 0.1.9 |
| 2 | + |
| 3 | +测试通过,发布正式版 |
| 4 | + |
| 5 | +# 0.1.8 |
| 6 | + |
| 7 | +更新内容如下 |
| 8 | + |
| 9 | +# 文件名称: common_maths.py |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +--- |
| 14 | + |
| 15 | +## 函数部分: |
| 16 | + |
| 17 | +#### 函数 create_dir |
| 18 | + |
| 19 | +``` |
| 20 | +在指定路径下创建名称为{dir_name}的文件夹 |
| 21 | +Args: |
| 22 | + dir_name: 文件夹名称 |
| 23 | + path: 要创建文件夹的路径,默认为当前路径 |
| 24 | +
|
| 25 | +Returns: |
| 26 | + 无 |
| 27 | +``` |
| 28 | + |
| 29 | +#### 函数 get_max_diff |
| 30 | + |
| 31 | +``` |
| 32 | +参数: |
| 33 | + two_dimensional_array: 二维数组 |
| 34 | +返回值: |
| 35 | + 每一列里面最大值和最小值的差值,类型是一个一维数组 |
| 36 | +功能: |
| 37 | + 传入一个二维数组,函数返回每一列里面最大值和最小值的差值。 |
| 38 | +``` |
| 39 | + |
| 40 | +#### 函数 remove_outliers_iqr |
| 41 | + |
| 42 | +``` |
| 43 | +参数: |
| 44 | + data: 二维数组 |
| 45 | +返回值: |
| 46 | + 去除异常值后的二维数组和有效的行索引,类型是一个元组 |
| 47 | +功能: |
| 48 | + 四分位距法去除传入的二维数组中的异常值,注意是对于每一列来说的自己的异常值 |
| 49 | +``` |
| 50 | + |
| 51 | +#### 函数 export_to_csv |
| 52 | + |
| 53 | +``` |
| 54 | +参数: |
| 55 | + array_data: 二维数组,要保存的数据 |
| 56 | + file_name: 字符串,CSV文件的名称(不包含扩展名) |
| 57 | + output_directory: 字符串,保存文件的目录路径,默认为当前目录 |
| 58 | +返回: |
| 59 | + None |
| 60 | +功能: |
| 61 | + 将给定的二维数组保存到指定目录中的CSV文件。如果文件已存在,则追加数据,并在每次写入时添加空行作为分隔符。 |
| 62 | +``` |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +## 类部分: |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +# 文件名称: source2md.py |
| 71 | + |
| 72 | +--- |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## 函数部分: |
| 77 | + |
| 78 | +#### 函数 dir2md |
| 79 | + |
| 80 | +``` |
| 81 | +Args: |
| 82 | + source_dir: 待处理目录 |
| 83 | + output_dir: 输出目录 |
| 84 | + single_file: 是否将所有文件放到一个md文件中 |
| 85 | +``` |
| 86 | + |
| 87 | +#### 函数 extract_info |
| 88 | + |
| 89 | +``` |
| 90 | +功能: |
| 91 | + 解析python文件,提取函数和类信息 |
| 92 | +Args: |
| 93 | + file_path: 待处理文件路径 |
| 94 | +Returns: |
| 95 | + function_docs: 函数信息 |
| 96 | + class_info: 类信息 |
| 97 | +``` |
| 98 | + |
| 99 | +#### 函数 all_save_markdown |
| 100 | + |
| 101 | +``` |
| 102 | +功能: |
| 103 | + 将提取的函数和类信息保存为markdown文件 |
| 104 | +Args: |
| 105 | + file_path: 待处理文件路径 |
| 106 | + output_path: 保存路径 |
| 107 | + function_docs: 函数信息 |
| 108 | + class_info: 类信息 |
| 109 | +Returns: |
| 110 | + 无 |
| 111 | +``` |
| 112 | + |
| 113 | +#### 函数 all2md |
| 114 | + |
| 115 | +``` |
| 116 | +功能:调用,将一个python文件中的函数和类信息提取出来,并保存为markdown文件 |
| 117 | +Args: |
| 118 | + file_path: 字符串,python文件的路径 |
| 119 | + output_path: 字符串,markdown文件的保存路径 |
| 120 | +Returns: |
| 121 | + 无 |
| 122 | +``` |
| 123 | + |
| 124 | +#### 函数 extract_function_docs_from_file |
| 125 | + |
| 126 | +``` |
| 127 | +从 Python 文件中提取函数的 docstring(注释部分)。 |
| 128 | +
|
| 129 | +参数: |
| 130 | + file_path: 字符串,Python 文件的路径。 |
| 131 | +
|
| 132 | +返回: |
| 133 | + 字典,键为函数名,值为函数的 docstring。 |
| 134 | +``` |
| 135 | + |
| 136 | +#### 函数 save_docs_to_markdown |
| 137 | + |
| 138 | +``` |
| 139 | +将函数的 docstring 保存到 Markdown 文件中。 |
| 140 | +
|
| 141 | +参数: |
| 142 | + docs: 字典,包含函数名和 docstring 的映射。 |
| 143 | + output_path: 字符串,Markdown 文件的保存路径。 |
| 144 | +``` |
| 145 | + |
| 146 | +#### 函数 pyFun2md |
| 147 | + |
| 148 | +``` |
| 149 | +将 Python 文件中提取 docstring 并保存为 Markdown 文件。 |
| 150 | +
|
| 151 | +参数: |
| 152 | + source_file: 字符串,源 Python 文件的路径。 |
| 153 | + output_md: 字符串,输出 Markdown 文件的路径。 |
| 154 | +``` |
| 155 | + |
| 156 | +--- |
| 157 | + |
| 158 | +## 类部分: |
| 159 | + |
| 160 | +--- |
| 161 | + |
| 162 | +# 0.1.7 |
| 163 | + |
| 164 | +与 0.1.8 相同 |
| 165 | + |
| 166 | +# 0.1.6 |
| 167 | + |
| 168 | +发布至正式版 |
| 169 | + |
| 170 | +# 0.1.5 |
| 171 | + |
| 172 | +更新以下内容 |
| 173 | + |
| 174 | +注:所有的函数调用方式都是 |
| 175 | +`myz_tools.文件名称.函数名称(必要的参数)` |
| 176 | + |
| 177 | +各项函数均已通过单元测试 |
| 178 | + |
| 179 | +## py2md.py 文件内容 |
| 180 | + |
| 181 | +``` |
| 182 | +主函数,用于从 Python 文件中提取 docstring 并保存为 Markdown 文件。 |
| 183 | +
|
| 184 | +参数: |
| 185 | + source_file: 字符串,源 Python 文件的路径。 |
| 186 | + output_md: 字符串,输出 Markdown 文件的路径。 |
| 187 | +``` |
| 188 | + |
| 189 | +## common_maths.py 文件内容 |
| 190 | + |
| 191 | +### create_dir |
| 192 | + |
| 193 | +``` |
| 194 | +参数: |
| 195 | + dir_name: 文件夹名称 |
| 196 | + path: 要创建文件夹的路径,默认为当前路径 |
| 197 | +返回值: |
| 198 | + 无 |
| 199 | +功能: |
| 200 | + 在指定路径下创建名称为{dir_name}的文件夹 |
| 201 | +``` |
| 202 | + |
| 203 | +### get_max_diff |
| 204 | + |
| 205 | +``` |
| 206 | +参数: |
| 207 | + two_dimensional_array: 二维数组 |
| 208 | +返回值: |
| 209 | + 每一列里面最大值和最小值的差值,类型是一个一维数组 |
| 210 | +功能: |
| 211 | + 传入一个二维数组,函数返回每一列里面最大值和最小值的差值。 |
| 212 | +``` |
| 213 | + |
| 214 | +### remove_outliers_iqr |
| 215 | + |
| 216 | +``` |
| 217 | +参数: |
| 218 | + data: 二维数组 |
| 219 | +返回值: |
| 220 | + 去除异常值后的二维数组和有效的行索引,类型是一个元组 |
| 221 | +功能: |
| 222 | + 四分位距法去除传入的二维数组中的异常值,注意是对于每一列来说的自己的异常值 |
| 223 | +``` |
| 224 | + |
| 225 | +### export_to_csv |
| 226 | + |
| 227 | +``` |
| 228 | +参数: |
| 229 | + array_data: 二维数组,要保存的数据 |
| 230 | + file_name: 字符串,CSV文件的名称(不包含扩展名) |
| 231 | + output_directory: 字符串,保存文件的目录路径,默认为当前目录 |
| 232 | +返回: |
| 233 | + None |
| 234 | +功能: |
| 235 | + 将给定的二维数组保存到指定目录中的CSV文件。如果文件已存在,则追加数据,并在每次写入时添加空行作为分隔符。 |
| 236 | +``` |
| 237 | + |
| 238 | +# 0.1.4 |
| 239 | + |
| 240 | +from .mytest import \* |
| 241 | + |
| 242 | +测试结果 |
| 243 | +调用 myz_tools.my_test1()结果为 |
| 244 | +AttributeError: module 'myz_tools' has no attribute 'my_test1' |
| 245 | + |
| 246 | +# 0.1.3 |
| 247 | + |
| 248 | +from . import \* |
| 249 | + |
| 250 | +测试成功,可以通过 myz_tools.mytest.my_test2()调用 |
| 251 | + |
| 252 | +# 0.1.2 |
| 253 | + |
| 254 | +测试内容: |
| 255 | +md 格式原因,下划线下划线换为--表示 |
| 256 | +--init--.py 为空 |
| 257 | + |
| 258 | +测试结果 |
| 259 | +ModuleNotFoundError: No module named 'mytest' |
0 commit comments