创建Python模块的步骤如下:
创建模块文件
创建一个新的`.py`文件,例如`mymodule.py`。
在文件中定义函数、类或变量。
添加文档字符串
为函数或类添加文档字符串(docstring),说明其作用、参数和返回值。
组织模块结构
如果模块较大,可以创建一个包,包含一个`__init__.py`文件,表明该文件夹为包。
将`.py`文件放入包的目录中。
构建和发布 (可选):
创建`setup.py`文件,用于构建和发布模块。
使用`python setup.py sdist`命令构建源代码发布版。
(可选)使用`twine`上传到PyPI,以便其他人可以通过`pip`安装。
导入和使用模块
在其他Python脚本中使用`import`语句导入模块。
调用模块中的函数或类。
示例代码:
假设我们要创建一个名为`my_module`的模块,其中包含一个名为`addition`的函数,用于计算两个数字的和:
my_module/math.py
def addition(a, b):
"""
将两个数字相加并返回结果。
参数:
a -- int or float
b -- int or float
返回值:
int or float -- 两个数字的和
"""
return a + b
然后,在主脚本中导入并使用该模块:
main.py
import my_module
result = my_module.addition(1, 2)
print(result) 输出:3
确保`my_module`文件夹位于Python解释器可以找到的路径中,或者将其添加到`sys.path`