RobotFramework框架之导入自己打包的python程序（十五）

news2024/11/16 17:52:48

引言

RobotFramework自动化框架（以下简称RF）之前文章我们讲了通过import第三方的library（RequestsLibrary等），在实际项目中第三方的包并不能满足我们的需要，此时我们可自己编写python模块（.py文件）或者包，以实现特定的功能。

下面以一个简单的例子讲解如何在RF中引用自己打包的python包。

功能描述：编写一个python程序，实现数字的运算。

1、使用setup函数打包python程序

1.1 创建一个python文件为NumerCalc.py，并定义一个同名的class。（RF导入单个的python文件时需要文件名和class名为同一个）

#导入keyword，定义中文name，方便RF中使用
from robot.api.deco import keyword

class NumberCalc(object):

  @keyword (name="两个数之和")
  def number_sum(self,number_a:int,number_b:int):
  	return number_a + number_b

1.2 将NumerCalc.py存放目录NumberCalc中，并创建空文件__init__.py，同时创建version.py用于存放版本号。

version.py文件用于配置版本号

1.3 在umberCalc同级目录下创建setup.py文件用于打包python程序。

setup.py文件内容如下

import os
from distutils.core import setup
#获取版本号
version_file = os.path.join(os.path.dirname(__file__), "NumbeCalc", 'version.py')
exec(compile(open(version_file).read(), version_file, 'exec'))

setup(name='NumbeCalc',
			version=VERSION,
			description='xxxxxxx',
      author='xxxxxxxx',
      author_email='xxxxxxx@123.com',
      install_requires= [],
      packages=['NumbeCalc'],
      classifiers=[
      "'Programming Language :: Python :: 3',"
      ],
      package_data={
      '': ['*.ini'],
      'bandwidth_reporter': ['*.ini']
      },
      )
#以下是一些参数的介绍
'''
name : 打包后包的文件名
version : 版本号
author : 作者
author_email : 作者的邮箱
py_modules : 要打包的.py文件
packages: 打包的python文件夹
include_package_data : 项目里会有一些非py文件,比如html和js等,这时候就要靠include_package_data 和 package_data 来指定了。package_data:一般写成{‘your_package_name’: [“files”]}, include_package_data还没完,还需要修改MANIFEST.in文件.MANIFEST.in文件的语法为: include xxx/xxx/xxx/.ini/(所有以.ini结尾的文件,也可以直接指定文件名)
license : 支持的开源协议
description : 对项目简短的一个形容
ext_modules : 是一个包含Extension实例的列表,Extension的定义也有一些参数。
ext_package : 定义extension的相对路径
requires : 定义依赖哪些模块
provides : 定义可以为哪些模块提供依赖
data_files :指定其他的一些文件(如配置文件),规定了哪些文件被安装到哪些目录中。如果目录名是相对路径,则是相对于sys.prefix或sys.exec_prefix的路径。如果没有提供模板,会被添加到MANIFEST文件中。
'''

1.4 打开cmd命令，进入以上目录，执行python setup.py sdist，会生成tar.gz结尾的压缩文件。