kaixin 1.0.1

A Python package, a lot of features are integrated.

KaixinPackage1.0.1

此模块仅使用Windows系统进行测试过，其它平台报错或无效属于正常现象, 如果在其他平台或在Windows系统上发现程序报错或发现此说明书的错误，请及时联系, 邮件地址:[e-mail]

GitHub项目地址

---

1. 下载kaixin模块

此模块仅支持版本>=python3.8的python

依赖包：['datetime','calendar','requests','json','re','urllib','pickle','pygame','shutil','os','wave','pyaudio','aip','playsound','psutil']

• Windows 在cmd中输入：pip install kaixin下载模块

其他平台使用对应pip命令即可

---

2. 使用kaixin模块

1. 导入模块：

在下载模块后，在代码开头添加

import kaixin

也可以使用

from kaixin import ???  # 如使用此代码，下面所有的kaixin.都不需要，并且只能访问填写的函数，*为所有函数
# 或使用
import kaixin as ??  # 如果使用此代码，下面所有kaixin.都替换成[??].([??]为as ??中的??)

将???替换为要单独导入的函数名，??替换成要自定义的名称

选用其中一种方法即可

---

2. 模块的所有可调用类、函数：

• 所有可调用类:

  PrintColors, GetTime, Translation, GetWeather, Files, Joystick, Speech, PlaySound, Record
  

• 所有可调用函数：

check_process_running

---

3. 类说明：

• 类初始化方法 变量名 = kaixin.类()（实例化类）

1. GetTime类

__init__()没有任何要填的参数

GetTime类用于获取时间

所有方法：get_MothDate(year, month), times(), get_time(time_id), day(), time()

---

• get_MothDate(year, month)

函数用于获取某年某月的日历

函数需要两个参数year, month（两个参数的格式是int），其中year为某年，month为某月，函数会返回一个多行的str格式的值。

示例代码：

import kaixin   # 导入kaixin模块

Time = kaixin.GetTime()  # 实例化类，并赋值给Time变量

print(Time.get_MothDate(2023, 8))   # 使用Time.get_MothDate()输出2023年8月的日历

cmd输出：

    August 2023
Mo Tu We Th Fr Sa Su
    1  2  3  4  5  6
 7  8  9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31

---

• times()

函数用于获取日期和时间

此函数没有任何参数，返回值为str格式。

示例代码：

import kaixin   # 导入kaixin模块

Time = kaixin.GetTime()  # 实例化类，并赋值给Time变量

print(Time.times()) # 使用Time.times()输出当前日期与时间

cmd输出：

2023.08.15 10:14

---

• get_time(time_id)

函数用于获取time_id对应的当前时间

time_id参数为str格式，time_id为时间代码(%Y %m %d %H %M %S)

%Y是年 %m是月 %d是天 %H是时 %M是分 %S是秒，同datetime.datetime.now().strftime('...')

示例代码：

import kaixin   # 导入kaixin模块

Time = kaixin.GetTime()  # 实例化类，并赋值给Time变量

print(Time.get_time("%Y %m %d %H: %M: %S")) # 使用Time.time()输出当前的"%Y %m %d %H: %M: %S"格式时间

cmd输出：

2023 08 15 10: 34: 51

---

• day()

函数用于获取当前日期 此函数没有任何参数，会返回一个str格式的值

示例代码：

import kaixin   # 导入kaixin模块

Time = kaixin.GetTime()  # 实例化类，并赋值给Time变量

print(Time.day())	# 使用Time.day()输出当前日期

cmd输出：

2023.08.15

---

• time()

函数用于获取当前时间

此函数没有任何参数，会返回一个str格式的值

示例代码：

import kaixin   # 导入kaixin模块

Time = kaixin.GetTime()  # 实例化类，并赋值给Time变量

print(Time.time())	# 使用Time.time()输出当前时间

cmd输出：

14:51

---

2. Translation类

__init__()没有任何要填的参数

Translation类是翻译类**（需联网）**，只有一个函数：translate(word)

---

• translate(word)

函数用于中英互译，有一个参数word为要中英互译的字符串，为str格式，此函数返回值为str格式

示例代码：

import kaixin   # 导入kaixin模块

Translation = kaixin.Translation()  # 实例化类，并赋值给Translation变量

print(Translation.translate('你好！'))	# 使用Translation.translate()将'你好！'翻译成英文并输出

cmd输出：

Hello!

---

3. GetWeather类

_init_()没有任何要填的参数

GetWeather类是获取天气类**（需联网）**，同Translation类，也只有一个函数：get_weather()

---

• get_weather()

函数用于获取中国北京 的天气，此函数没有任何参数，返回值为list格式

示例代码：

import kaixin   # 导入kaixin模块

GetWeather = kaixin.GetWeather()  # 实例化类，并赋值给GetWeather变量

weather = GetWeather.get_weather()  # 获取当前中国北京的天气，并赋值给变量weather

# 输出
print(weather)
print('\n------------------------------------\n')
print(weather[0])
print(weather[1])
print(weather[2])

cmd输出：

['08月15日08时 周二', '晴', '33/26°C']

------------------------------------

08月15日08时 周二
晴
33/26°C

cmd输出列表的0值为当前中国北京的时间，1值为当前中国北京的天气，2值为当前中国北京的温度

---

3. Files类

_init_()有一个要填的参数：file_name

file_name为要操作文件的路径，str格式

Files类是用于操作文件的类

所有方法：save_file(file_content), read_file(), NameCopyFile(new_path, file_name), CopyFile(new_path), save_wave_file(data)

---

• save_file(file_content)

函数用于保存.kx格式的加密文件在file_name路径，不返回任何数据，此函数有一个参数file_content是要保存的内容，str格式

如果file_name路径中的文件不存在，就新建文件

文件目录：

主文件夹
|_ File.kx
|_ main.py

示例代码：

import kaixin   # 导入kaixin模块

Files = kaixin.Files('.\\File.kx')  # 实例化类，并赋值给Files变量

Files.save_file('Hello!')

File.kx解密后的内容:

• 原来:

  H
  

• 执行代码后：

  Hello!
  
  

如果没有找到'.\\File.kx'那就会自动在主文件夹下新建一个File.kx后再将内容设为Hello!

---

• read_file()

函数用于读取.kx格式的加密文件在file_name路径，此函数没有任何参数，返回file_name路径文件的解密后的内容，返回值为str格式

文件目录：

主文件夹
|_ File.kx
|_ main.py

File.kx解密后的内容:

What day is it today?

示例代码：

import kaixin   # 导入kaixin模块

Files = kaixin.Files('.\\File.kx')  # 实例化类，并赋值给Files变量

print(Files.read_file())

cmd输出：

What day is it today?

---

• NameCopyFile(new_path, file_name)

函数用于复制self.file_name路径的文件到new_path路径的文件并将文件名设为file_name。有两个参数new_path, file_name，new_path是要复制到的新路径，file_name是复制后的新文件名。

文件目录：

主文件夹
|_ 1文件夹
|  |_ a.txt
|_ 2文件夹
|_ main.py

示例代码：

import kaixin   # 导入kaixin模块

Files = kaixin.Files('.\\1文件夹\\a.txt')  # 实例化类，并赋值给Files变量

Files.NameCopyFile('.\\2文件夹', 'aa.txt')	# 复制.\\1文件夹\\a.txt到.\\2文件夹，并将文件重命名为aa.txt

文件目录（运行程序后）：

主文件夹
|_ 1文件夹
|  |_ a.txt
|_ 2文件夹
|  |_ aa.txt
|_ main.py

---

• CopyFile(new_path)

函数用于复制self.file_name路径的文件到new_path路径的文件，有一个参数new_path，new_path是要复制到的新路径。

文件目录：

主文件夹
|_ 1文件夹
|  |_ a.txt
|_ 2文件夹
|_ main.py

示例代码：

import kaixin   # 导入kaixin模块

Files = kaixin.Files('.\\1文件夹\\a.txt')  # 实例化类，并赋值给Files变量

Files.CopyFile('.\\2文件夹')	# 复制.\\1文件夹\\a.txt到.\\2文件夹

文件目录（运行程序后）：

主文件夹
|_ 1文件夹
|  |_ a.txt
|_ 2文件夹
|  |_ a.txt
|_ main.py

---

• save_wave_file(data)

不建议使用

说明：save_wave_file(data)可以将二进制数据作为wav格式文件 保存到file_name的路径文件下

二进制数据为list格式，如：[b'\x00\x00\x00\...']

---

4 Joystick类

_init_()有一个要填的参数：Number

Number为要连接的手柄序号，int格式

Joystick类是用于连接手柄

所有方法：GetNames(), QuitJoystick(), GetNumber(), GetName(), GetAxis(ButtonNumber), GetHat(HatNumber), GetButton(ButtonNumber)

---

• GetNames()

获取所有已连接手柄的名称，没有任何参数，返回值为list格式

• QuitJoystick()

退出手柄连接并卸载Pygame

• GetNumber()

获取手柄数量，返回值为int格式

• GetName()

获取当前连接手柄的名称

---

• GetAxis(ButtonNumber)是获取模拟值类型（遥感，扳机），ButtonNumber为要获取值的编号
• GetHat(HatNumber)是获取十字键，HatNumber为十字键的编号（一般是0）
• GetButton(ButtonNumber)是获取数字值（按钮），ButtonNumber为要获取值的编号

查看手柄按键编号可以使用print(kaixin.GetButton(0)) print(kaixin.GetButton(1))...来慢慢测试或使用此代码（代码来自：Pygame详解（十七）：joystick 模块_pygame joystick_来自江南的你的博客-CSDN博客）

---

5 Speech类

_init_()有三个要填的参数：Path, APPID, KEY, SECRET

Path为要识别的wav格式文件，str格式

APPID, KEY, SECRET为百度密钥参数

Speech类用于语音识别**（需联网）**，只有一个Print()函数

---

• Print()

Print()为开始语音识别，可以搭配Record类实现录音并语音转文字，也可以识别提前录制好的音频，此函数没有任何参数，会返回语音识别出的值

音频文件要是wav格式

---

6 PlaySound类

__init__()有三个要填的参数：Music, playing=False, loops=False

Music为音频的路径，playing为是否堵塞线程，loops为是否循环播放

PlaySound类用于播放音频，所有函数：Play(), Stop(), Pause(), UnPause()（全部 没有任何参数）

---

• Play() 用于开始播放音频
• Stop() 停止**（无限循环播放专用）**
• Pause() 暂停**（无限循环播放专用）**
• UnPause()继续**（无限循环播放专用）**

---

7 Record类

__init__()有两个要填的参数：time, path

time为要录制的时间，path是保存录音的文件路径（没有会自动创建）

Record类用于录音，只有一个record()函数

---

• record()

此函数没有任何参数，用于开始录制音频，在录制time参数指定的时间后会自动停止运行

使用前请检查电脑是否有麦克风或其他声音输入装置

---

8 PrintColors类

此类没有__init__()函数

此类用于在控制台输出彩色字符，在有些电脑上可能会失效。只有一个函数：Print(text, color='38', bold=0)

---

• Print(text, color='38', bold=0)

函数有三个参数：text, color='38', bold=0，text参数为要输出的内容，color为要输出的颜色，bold为是否粗体（必须是int格式的0和1，不能是True或False）

类有几个设定好的颜色：HEA_DER, OK_BLUE, OK_GREEN, WARNING, UNDERLINE, BOLD, NONE, FAIL，可以通过kaixin.PrintColors().颜色使用

其他颜色可以去网上查询python print 颜色编码

---

4. 函数说明：

• check_process_running(process_name)

仅适用于Windows

函数用于检测某个线程是否正在运行，参数：process_name为要检测线程的名称，返回值为True或False

---

Copyright (c) 2023 SongXinZhe