diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ubinascii.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ubinascii.md" index 7966accf9ee3ff351826dc2db717db20a6387d16..d16cec11fd681c4141dc87ce3436c2df46bbb9ff 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ubinascii.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/ubinascii.md" @@ -1,9 +1,6 @@ +# class ubinascii - 二进制与ASCII转换 -``` -本文阐述了QuecPython的ubinascii模块的用法，描述了ubinascii模块最新版本的特性。 -``` - 该模块实现了二进制数据与各种ASCII编码之间的转换(双向)。该模块实现相应CPython模块的子集，更多信息请参阅阅CPython文档：[binascii](https://docs.python.org/3.5/library/binascii.html#module-binascii) ## 构造函数 diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uhashlib.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uhashlib.md" index 444876f0652b81946ea892976474eb4ce6dd411f..fdc6c5d5d1af0c6e61949cffe343b5a748246624 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uhashlib.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uhashlib.md" @@ -1,12 +1,8 @@ - - -``` -本文阐述了QuecPython的uhashlib模块的用法，描述了uhashlib模块最新版本的特性。 -``` +# class uhashlib - 哈希算法 该模块实现二进制数据散列算法。 -> 注意：目前仅支持sha256，sha1，MD5。 +> 目前仅支持sha256，sha1，MD5。 **示例：** @@ -65,7 +61,7 @@ class uhashlib.md5(bytes) ## 方法 -### hash_obj.update() +### `hash_obj.update()` ```python hash_obj.update(bytes) @@ -77,10 +73,10 @@ hash_obj.update(bytes) - `bytes` - 需要被加密的bytes类型数据。 -### hash_obj.digest() +### `hash_obj.digest()` ```python -hash_obj.digest(bytes) +hash_obj.digest() ``` 返回通过哈希传递的所有数据的散列，数据为字节类型。调用此方法后，无法再将更多的数据送入散列。 diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/usocket.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/usocket.md" index 838ebd34f6f938a022453a62429b6eab012a3322..c1928e4e1de3dcfe055ccef686d922ca8c6ee9c2 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/usocket.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/usocket.md" @@ -1,9 +1,6 @@ +# class usocket - socket模块 -``` -本文阐述了QuecPython的usocket模块的用法，描述了usocket模块最新版本的特性。 -``` - 该模块提供对BSD套接字接口的访问。该模块实现相应CPython模块的子集。更多信息请参阅阅CPython文档：[socket](https://docs.python.org/3.5/library/socket.html#module-socket) **示例：** @@ -33,22 +30,22 @@ if __name__ == '__main__': if stagecode == 3 and subcode == 1: socket_log.info('Network connection successful!') - # 创建一个socket实例 - sock = usocket.socket(usocket.AF_INET, usocket.SOCK_STREAM) - # 解析域名 - sockaddr=usocket.getaddrinfo('www.tongxinmao.com', 80)[0][-1] - # 建立连接 - sock.connect(sockaddr) - # 向服务端发送消息 - ret=sock.send('GET /News HTTP/1.1\r\nHost: www.tongxinmao.com\r\nAccept-Encoding: deflate\r\nConnection: keep-alive\r\n\r\n') - socket_log.info('send %d bytes' % ret) - #接收服务端消息 - data=sock.recv(256) - socket_log.info('recv %s bytes:' % len(data)) - socket_log.info(data.decode()) - - # 关闭连接 - sock.close() + # 创建一个socket实例 + sock = usocket.socket(usocket.AF_INET, usocket.SOCK_STREAM) + # 解析域名 + sockaddr=usocket.getaddrinfo('www.tongxinmao.com', 80)[0][-1] + # 建立连接 + sock.connect(sockaddr) + # 向服务端发送消息 + ret=sock.send('GET /News HTTP/1.1\r\nHost: www.tongxinmao.com\r\nAccept-Encoding: deflate\r\nConnection: keep-alive\r\n\r\n') + socket_log.info('send %d bytes' % ret) + #接收服务端消息 + data=sock.recv(256) + socket_log.info('recv %s bytes:' % len(data)) + socket_log.info(data.decode()) + + # 关闭连接 + sock.close() else: socket_log.info('Network connection failed! stagecode = {}, subcode = {}'.format(stagecode, subcode)) ``` @@ -118,7 +115,8 @@ socket.bind(address) 该方法用于套接字绑定指定address，必须尚未绑定。 -> **注意**：1.作为服务器时，需要进行绑定，以固定服务器的address。2.作为客户端时，绑定address用来指定套接字进行数据处理（配合usocket.TCP_CUSTOMIZE_PORT使用）。 +> 1.作为服务器时，需要进行绑定，以固定服务器的address。 +2.作为客户端时，绑定address用来指定套接字进行数据处理（配合usocket.TCP_CUSTOMIZE_PORT使用）。 **参数描述** @@ -227,7 +225,7 @@ socket.sendall(bytes) ``` 该方法用于套接字将所有数据都发送到套接字。与`send()`方法不同的是，此方法将尝试通过依次逐块发送数据来发送所有数据。 -注意：该方法再非阻塞套接字上的行为是不确定的，建议再MicroPython中，使用 `write()` 方法，该方法具有相同的“禁止短写”策略来阻塞套接字，并且将返回在非阻塞套接字上发送的字节数。 +> 该方法再非阻塞套接字上的行为是不确定的，建议再MicroPython中，使用 `write()` 方法，该方法具有相同的“禁止短写”策略来阻塞套接字，并且将返回在非阻塞套接字上发送的字节数。。 **参数描述：** @@ -353,7 +351,8 @@ socket.getsocketsta() 该方法用于获取TCP套接字的状态。 -> **注意**：1.BG95平台不支持该API。2.如果调用了 `socket.close()` 方法之后，再调用 `socket.getsocketsta()` 会返回-1，因为此时创建的对象资源等都已经被释放。 +> 1.BG95平台不支持该API。 +2.如果调用了 `socket.close()` 方法之后，再调用 `socket.getsocketsta()` 会返回-1，因为此时创建的对象资源等都已经被释放。 **返回值：** @@ -374,50 +373,50 @@ socket.getsocketsta() ## 常量 -### usocket.AF_INET +### `usocket.AF_INET` 地址族，IPV4类型。 -### usocket.AF_INET6 +### `usocket.AF_INET6` 地址族，IPV6类型。 -### usocket.SOCK_STREAM +### `usocket.SOCK_STREAM` socket类型，TCP的流式套接字。 -### usocket.SOCK_DGRAM +### `usocket.SOCK_DGRAM` socket类型，UDP的数据包套接字。 -### usocket.SOCK_RAW +### `usocket.SOCK_RAW` socket类型，原始套接字。 -### usocket.IPPROTO_TCP +### `usocket.IPPROTO_TCP` 协议号，TCP协议。 -### usocket.IPPROTO_UDP +### `usocket.IPPROTO_UDP` 协议号，UDP协议。 -### usocket.IPPROTO_TCP_SER +### `usocket.IPPROTO_TCP_SER` 协议号，TCP服务器。 -### usocket.TCP_CUSTOMIZE_PORT +### `usocket.TCP_CUSTOMIZE_PORT` 协议号，TCP客户端自定义address使用。 -### usocket.SOL_SOCKET +### `usocket.SOL_SOCKET` 套接字选项级别。 -### usocket.SO_REUSEADDR +### `usocket.SO_REUSEADDR` socket功能选项，允许设置端口复用。 -### usocket.TCP_KEEPALIVE +### `usocket.TCP_KEEPALIVE` socket功能选项，设置TCP保活包间隔时间。 diff --git "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uzlib.md" "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uzlib.md" index 08c8641b125fc7d6d6723c66024118b4cc53318e..ba1f9a4db2468bd8ea5147ca62b3c709328feb47 100644 --- "a/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uzlib.md" +++ "b/docs/API_reference/zh/QuecPython\346\240\207\345\207\206\345\272\223/uzlib.md" @@ -1,13 +1,10 @@ +# class uhashlib - zlib解压缩 -``` -本文阐述了QuecPython的uzlib模块的用法，描述了uzlib模块最新版本的特性。 -``` +该模块解压缩用[DEFLATE算法](https://en.wikipedia.org/wiki/DEFLATE)压缩二进制数据 （通常在zlib库和gzip存档器中使用）。该模块实现相应CPython模块的子集，更多信息请参阅阅CPython文档：[zlib](https://docs.python.org/3.5/library/zlib.html#module-zlib) -该模块解压缩用[DEFLATE算法](https://en.wikipedia.org/wiki/DEFLATE)压缩的二进制数据 （通常在zlib库和gzip存档器中使用）。该模块实现相应CPython模块的子集，更多信息请参阅阅CPython文档：[zlib](https://docs.python.org/3.5/library/zlib.html#module-zlib) - -> 注意：1.压缩尚未实现。2.解压缩前，应检查模块内可使用的空间，确保有足够空间解压文件。 +> 1.压缩尚未实现。2.解压缩前，应检查模块内可使用的空间，确保有足够空间解压文件。 ## 构造函数 @@ -18,7 +15,12 @@ uzlib.decompress(data, wbits=0, bufsize=0) ``` -返回解压后的 bytes 对象。`wbits`是解压时使用的DEFLATE字典窗口大小（8-15，字典大小是`wbits`值的2的幂）。如果该值为正，则假定`data`为zlib流（带有zlib标头），如果为负，则假定为原始的DEFLATE流。`bufsize`参数是为了与CPython兼容，将被忽略。 +返回解压后的 bytes 对象。 + +**参数描述：** +- `data` - 需要解压的数据。 +- `wbits` - 解压时使用的DEFLATE字典窗口大小（8-15，字典大小是`wbits`值的2的幂）。如果该值为正，则假定`data`为zlib流（带有zlib标头），如果为负，则假定为原始的DEFLATE流。 +- `bufsize` - 为了与CPython兼容，将被忽略。 ### `uzlib.DecompIO` diff --git "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/uping.md" "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/uping.md" index 1fe8aad5727fd6f780a9a274824d7105bf5a48aa..d0a42d2b59d780b149f083b0e4d94534ecc56388 100644 --- "a/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/uping.md" +++ "b/docs/API_reference/zh/QuecPython\347\261\273\345\272\223/uping.md" @@ -41,13 +41,11 @@ uping.ping(HOST, SOURCE=None, COUNT=4, INTERVAL=1000, SIZE=64, TIMEOUT=5000, qui **参数描述：** -| 参数 | 类型 | 说明 | -| -------- | ---- | ------------------------------------------------------------ | -| HOST | str | 所要ping的域名地址, 例如"baidu.com" | -| SOURCE | str | 源地址, 用于绑定, 一般情况下不需要传 | -| COUNT | int | 默认是4次, 发送4次ping包 | -| INTERVAL | int | 间隔时间, 单位:ms, 默认1000ms | -| SIZE | int | 每次读取的包大小默认64, 无需修改 | -| TIMEOUT | int | 超时时间, 单位:ms, 默认5000ms | -| quiet | bool | 默认:false,打印直接输出。若设为True, 调用start默认打印的值会被转换成对象返回。 | +- `HOST` - 主机名，字符串类型，所要ping的域名地址, 例如"baidu.com"。 +- `SOURCE` - 源地址，字符串类型，用于绑定, 一般情况下不需要传。 +- `COUNT` - 默认请求次数，整型，默认是4次,发送4次ping包。 +- `INTERVAL` - 间隔时间，整型，用于绑定, 一般情况下不需要传。 +- `SIZE` - 每次读取的包大小，整型，默认64, 无需修改。 +- `TIMEOUT` - 超时时间，整型，单位:ms, 默认5000ms。 +- `quiet` - 打印是否直接输出，布尔类型，默认:false,打印直接输出。若设为True, 调用start默认打印的值会被转换成对象返回。