Merge pull request #113 from SummerGGift/723

【完善】MicroPython 自动补全优化

Author: armink

docs/code-completion/array.py

@@ -20,7 +20,7 @@ def __init__(self) -> None:
     """
     ...
 
-    def append(val) -> None:
+    def append(self, val) -> None:
         """
         将一个新元素追加到数组的末尾。
         示例：
@@ -34,7 +34,7 @@ def append(val) -> None:
         """
         ...
 
-    def extend(iterable) -> None:
+    def extend(self, iterable) -> None:
         """
         将一个新的数组追加到数组的末尾，注意追加的数组和原来数组的数据类型要保持一致。
         示例：

docs/code-completion/machine.py

@@ -78,6 +78,8 @@ class Pin(object):
     LOW_POWER = ...  # type: int
     MED_POWER = ...  # type: int
     HIGH_POWER = ...  # type: int
+    OUT_PP = ...  # type: int
+    OUT_OD = ...  # type: int
 
     def __init__(self, id: Any, mode: int = -1, pull: int = -1, *,
                  value: Optional[int] = None,
@@ -157,7 +159,7 @@ def init(self, value: int, drive: int, alt: int, mode: int = -1, pull: int = -1)
         """
         ...
 
-    def value(self, x: Optional[int]) -> Optional[int]:
+    def value(self, x: Optional[int] = None) -> Optional[int]:
         """This method allows to set and get the value of the pin, depending on
         whether the argument **x** is supplied or not.
 
@@ -343,7 +345,7 @@ def any(self) -> int:
         """
         ...
 
-    def read(self, nbytes: Optional[int]) -> bytes:
+    def read(self, nbytes: Optional[int] = None) -> bytes:
         """Read characters. If ``nbytes`` is specified then read at most that many
         bytes, otherwise read as much data as possible.
 
@@ -390,7 +392,9 @@ class SPI(object):
     LSB = ...  # type: int
     MSB = ...  # type: int
 
-    def __init__(self, id: int) -> None:
+    def __init__(self, id: int, baudrate: int = 1000000, polarity: int = 0, phase: int = 0,
+             bits: int = 8, firstbit: int = MSB, sck: Optional[Pin] = None,
+             mosi: Optional[Pin] = None, miso: Optional[Pin] = None) -> None:
         """
         Construct an SPI object on the given bus, ``id``. Values of id depend
         on a particular port and its hardware. Values 0, 1, etc. are commonly
@@ -463,7 +467,7 @@ def write_readinto(self, write_buf: bytearray, read_buf: bytearray) -> None:
 
 
 class I2C(object):
-    def __init__(self, id: int, *, scl: Pin, sda: Pin, freq: int = 400000) -> None:
+    def __init__(self, id: int, scl: Pin = None, sda: Pin = None, freq: int = 400000) -> None:
         """Construct and return a new I2C object.
 
         :param id: Particular I2C peripheral (-1 for software implementation).
@@ -580,7 +584,7 @@ def readfrom_mem_into(self, addr: int, memaddr: int, buf, *, addrsize=8) -> None
         """
         ...
 
-    def writeto_mem(self, addr: int, memaddr: int, *, addrsize=8) -> None:
+    def writeto_mem(self, addr: int, memaddr: int, addrsize=8) -> None:
         """Write ``buf`` to the slave specified by ``addr`` starting from the
         memory address specified by ``memaddr``. The argument ``addrsize`` specifies
         the address size in bits (on ESP8266 this argument is not recognised
@@ -676,7 +680,7 @@ def __init__(self, id: int) -> None:
         :param id: Timer ID.
         """
 
-    def init(mode : Timer.PERIODIC, period : int, callback : func) -> None:
+    def init(self, mode : Timer.PERIODIC, period : int, callback : func) -> None:
         """
         Init the timer. Start the timer, and enable the timer peripheral.
         """
@@ -699,7 +703,7 @@ def __init__(self, id: int, channel: int) -> None:
         """
         """
 
-    def init(channel) -> None:
+    def init(self, channel : int) -> None:
         """
         根据输入的层参数初始化 ADC 对象，入参为使用的 ADC 对象通道号；
         """
@@ -711,7 +715,7 @@ def deinit(self) -> None:
         """
         ...
 
-    def read() -> None:
+    def read(self) -> None:
         """
         用于获取并返回当前 ADC 对象的采样值。例如当前采样值为 2048，对应设备的分辨率为 12位，当前设备参考电压为 3.3V ，则该 ADC 对象通道上实际电压值的计算公式为：采样值 * 参考电压  /  （1 <<  分辨率位数），即 vol = 2048 / 4096 * 3.3 V = 1.15V。
         """
@@ -733,7 +737,7 @@ def __init__(self, id: int, channel: int, freq: int, duty: int) -> None:
         """
         """
 
-    def init(channel, freq, duty) -> None:
+    def init(self, channel : int, freq : int, duty : int) -> None:
         """
         根据输入的参数初始化 PWM 对象。
         """
@@ -745,13 +749,13 @@ def deinit(self) -> None:
         """
         ...
 
-    def freq(freq)-> None:
+    def freq(self, freq : int = None)-> None:
         """
         用于获取或者设置 PWM 对象的频率，频率的范围为 [1, 156250]。如果参数为空，返回当前 PWM 对象的频率；如果参数非空，则使用该参数设置当前 PWM 对象的频率。
         """
         ...
 
-    def duty(duty) -> None:
+    def duty(self, duty : int = None) -> None:
         """
         用于获取或者设置 PWM 对象的占空比数值，占空比数值的范围为 [0, 255]，例如 duty = 100，表示当前设备占空比为 100/255 = 39.22% 。如果参数为空，返回当前 PWM 对象的占空比数值；如果参数非空，则使用该参数设置当前 PWM 对象的占空比数值。
         """
@@ -784,46 +788,53 @@ def __init__(self) -> None:
         """
         """
 
-    def light(value) -> None:
+    def light(self, value : int) -> None:
         """
         控制是否开启 LCD 背光，入参为 True 则打开 LCD 背光，入参为 False 则关闭 LCD 背光。
         """
         ...
 
-    def fill(color) -> None:
+    def fill(self, color : int) -> None:
         """
         根据给定的颜色填充整个屏幕，支持多种颜色，可以传入的参数有：
 
         - WHITE BLACK BLUE BRED GRED GBLUE RED MAGENTA GREEN CYAN YELLOW BROWN BRRED GRAY GRAY175 GRAY151 GRAY240
         """
         ...
 
-    def pixel(x, y, color) -> None:
+    def pixel(self, x : int, y : int , color : int) -> None:
         """
         向指定的位置（x, y）画点，点的颜色为 color 指定的颜色，可指定的颜色和上一个功能相同。
         注意：(x, y)  坐标的范围是 0 - 239，使用下面的方法对坐标进行操作时同样需要遵循此限制。
         """
         ...
 
-    def text(str, x, y, size) -> None:
+    def set_color(self, back_color : int, fore_color : int) -> None:
+        """
+        设置 LCD 屏幕的前景色和背景色。
+        """
+        ...
+
+
+    def text(self, input_str : str, x : int, y : int, size : int) -> None:
         """
         在指定的位置（x,y）写入字符串，字符串由 str 指定，字体的大小由 size 指定，size 的大小可为 16，24，32。
         """
         ...
 
-    def line(x1, y1, x2, y2) -> None:
+    def line(self, x1 : int, y1 : int, x2 : int, y2 : int) -> None:
         """
         在 LCD 上画一条直线，起始地址为 （x1, y1），终点为（x2, y2）。
         """
         ...
 
-    def rectangle(x1, y1, x2, y2) -> None:
+    def rectangle(self, x1 : int, y1 : int, x2 : int, y2 : int) -> None:
         """
         在 LCD 上画一个矩形，左上角的位置为（x1, y1），右下角的位置为（x2, y2）。
         """
         ...
 
-    def circle(x1, y1, r) -> None:
+    def circle(self, x1 : int, y1 : int, r : int) -> None:
         """
         在 LCD 上画一个圆形，圆心的位置为（x1, y1），半径长度为 r。。
         """
@@ -832,7 +843,7 @@ def circle(x1, y1, r) -> None:
 
 class WDT(object):
 
-    def __init__(self) -> None:
+    def __init__(self, timeout : int) -> None:
         """
         Construct a new watchdog object.
         """

docs/code-completion/network.py

@@ -20,35 +20,34 @@ class WLAN(object):
     STAT_CONNECT_FAIL = ...  # type: int
     STAT_GOT_IP = ...  # type: int
 
-    def __init__(self, interface_id: int) -> None:
-    """
-    """
-    ...
+    def __init__(self, interface_id : int) -> None:
+        """初始化一个 wlan 对象"""
+        ...
 
-    def active(is_active : int) -> None:
+    def active(self, is_active : int) -> None:
         """
         - active([is_active])
         如果向该方法传入布尔数值，传入 True 则使能卡，传入 False 则禁止网卡。否则，如果不传入参数，则查询当前网卡的状态。
         """
         ...
 
-    def connect(ssid, password) -> None:
+    def connect(self, ssid: str, password : str) -> None:
         """使用指定的账号和密码链接指定的无线热点。"""
         ...
 
-    def disconnect() -> None:
+    def disconnect(self) -> None:
         """从当前链接的无线网络中断开。"""
         ...
 
-    def scan() -> None:
+    def scan(self) -> None:
         """
         扫描当前可以连接的无线网络。
         只能在 STA 模式下进行扫描，使用元组列表的形式返回 WiFi 接入点的相关信息。
         （ssid, bssid, channel, rssi, authmode, hidden）
         """
         ...
 
-    def status(param) -> None:
+    def status(self, param : str) -> None:
         """
         - status([param])
         返回当前无线连接的状态。
@@ -59,13 +58,13 @@ def status(param) -> None:
         """
         ...
 
-    def isconnected() -> None:
+    def isconnected(self) -> None:
         """
         在 STA 模式时，如果已经连接到 WiFi 网络，并且获得了 IP 地址，则返回 True。
         如果处在 AP 模式，此时已经与客户端建立连接，则返回 True。其他情况下都返回 False。"""
         ...
 
-    def ifconfig(config: tuple) -> None:
+    def ifconfig(self, config: tuple) -> None:
         """
         ifconfig([(ip, subnet, gateway, dns)])
         获取或者设置网络接口的参数，IP 地址，子网掩码，网关，DNS 服务器。
@@ -75,7 +74,7 @@ def ifconfig(config: tuple) -> None:
         """
         ...
 
-    def config(param) -> None:
+    def config(self, mac : str = None, essid : str = None, password : str = None, hidden : int = 0, channel : int = 0) -> None:
         """
         - config(param=value, ...)
         获取或者设置一般网络接口参数，这些方法允许处理标准的 ip 配置之外的其他参数，如 WLAN.ifconfig() 函数处理的参数。

docs/code-completion/select.py

@@ -40,7 +40,7 @@ class poll(string):
     def __init__(self) -> None:
     ...
 
-    def register(obj) -> None:
+    def register(self, obj) -> None:
         """
         - register(obj[, eventmask])
         注册一个用以监控的对象，并设置被监控对象的监控标志位 flag。
@@ -54,7 +54,7 @@ def register(obj) -> None:
         """
         ...
 
-    def unregister(obj) -> None:
+    def unregister(self, obj) -> None:
         """
         解除监控的对象的注册。
 
@@ -69,7 +69,7 @@ def unregister(obj) -> None:
         """
         ...
 
-    def modify(obj, eventmask) -> None:
+    def modify(self, obj, eventmask) -> None:
         """
         修改已注册的对象监控标志。
 
@@ -85,7 +85,7 @@ def modify(obj, eventmask) -> None:
         """
         ...
 
-    def poll(timeout) -> None:
+    def poll(self, timeout) -> None:
         """
         - poll([timeout])
         等待至少一个已注册的对象准备就绪。

docs/code-completion/uctypes.py

@@ -31,7 +31,7 @@ class struct(addr, descriptor, type):
     def __init__(self) -> None:
     ...
 
-    def sizeof(struct) -> None:
+    def sizeof(self, struct) -> None:
         """
         按字节返回数据的大小。参数可以是类或者数据对象 (或集合)。 示例：
 
@@ -44,7 +44,7 @@ def sizeof(struct) -> None:
         """
         ...
 
-    def addressof(obj) -> None:
+    def addressof(self, obj) -> None:
         """
         返回对象地址。参数需要是 bytes, bytearray 。 示例：
 
@@ -54,7 +54,7 @@ def addressof(obj) -> None:
         """
         ...
 
-    def bytes_at(addr, size)-> None:
+    def bytes_at(self, addr, size)-> None:
         """
         捕捉从 addr 开始到 size 个地址偏移量结束的内存数据为 bytearray 对象并返回。 示例：
 
@@ -64,7 +64,7 @@ def bytes_at(addr, size)-> None:
         """
         ...
 
-    def bytearray_at(addr, size) -> None:
+    def bytearray_at(self, addr, size) -> None:
         """
         捕捉给定大小和地址内存为 bytearray 对象。与 bytes_at() 函数不同的是，它可以被再次写入，可以访问给定地址的参数。 示例：
 

docs/code-completion/uhashlib.py

@@ -15,15 +15,15 @@ class sha256(data):
     def __init__(self) -> None:
     ...
 
-    def update(data) -> None:
+    def update(self, data) -> None:
         """将更多二进制数据放入哈希表中。"""
         ...
 
-    def digest() -> None:
+    def digest(self) -> None:
         """返回字节对象哈希的所有数据。调用此方法后，将无法将更多数据送入哈希。"""
         ...
 
-    def hexdigest() -> None:
+    def hexdigest(self) -> None:
         """此方法没有实现， 使用 ubinascii.hexlify(hash.digest()) 达到类似效果。"""
         ...
 
@@ -36,15 +36,15 @@ class sha1(data):
     def __init__(self) -> None:
     ...
 
-    def update(data) -> None:
+    def update(self, data) -> None:
         """将更多二进制数据放入哈希表中。"""
         ...
 
-    def digest() -> None:
+    def digest(self) -> None:
         """返回字节对象哈希的所有数据。调用此方法后，将无法将更多数据送入哈希。"""
         ...
 
-    def hexdigest() -> None:
+    def hexdigest(self) -> None:
         """此方法没有实现， 使用 ubinascii.hexlify(hash.digest()) 达到类似效果。"""
         ...
 
@@ -58,14 +58,14 @@ class md5(data):
     def __init__(self) -> None:
     ...
 
-    def update(data) -> None:
+    def update(self, data) -> None:
         """将更多二进制数据放入哈希表中。"""
         ...
 
-    def digest() -> None:
+    def digest(self) -> None:
         """返回字节对象哈希的所有数据。调用此方法后，将无法将更多数据送入哈希。"""
         ...
 
-    def hexdigest() -> None:
+    def hexdigest(self) -> None:
         """此方法没有实现， 使用 ubinascii.hexlify(hash.digest()) 达到类似效果。"""
         ...