Initial commit.

Author: githubChenchi

.gitignore

@@ -0,0 +1,6 @@
+*.log
+dist
+quecpython.egg-info
+build/
+.idea
+__pycache__

README.md

@@ -0,0 +1,95 @@
+# pyi文件介绍
+
+本文件主要简单介绍pyi文件如何编写。详细介绍请参阅：<https://peps.python.org/pep-0484/>
+
+什么是pyi文件？
+在Python3中，`.pyi`文件是存根文件(stub file)。这个"pyi"中的"i"代表接口即interface，作为公共接口。
+**存根文件仅包含模块公共接口的描述，没有任何实现。**
+
+编写请参考模板：`usocket.pyi`
+
+# 示例讲解
+
+## 示例一
+
+以下是pyi文件的函数定义
+
+- 1、如下参数后通过冒号标识该参数的类型（python基础类型：str、int、list、tuple...更多自定义类型参阅PEP484）。
+- 2、函数定义关键字def语句中，形参列表后，冒号前通过`-> {类型}`来标识当前函数的返回值类型。
+- 3、函数体首行注释（注：必须是三对双引号的注释且必须是函数体首行）
+- 4、文档建议采用reStructuredText风格。详细请参阅：<https://wiki.python.org/moin/reStructuredText>
+
+```python
+def getaddrinfo(host: str, port: int = 8080):
+    """Parses the domain name of DNS. —— （此处是当前函数的简略注释信息。）
+
+    Parses the domain name of the host (host) and port (port) into a 5-tuple sequence used to create the socket. The structure of the tuple is below:
+    (family, type, proto, canonname, sockaddr) —— （此处是当前函数的详细注释信息。）
+    
+    @param host: The domain name of the host.
+    @param port: The port.
+    @return: (family, type, proto, canonname, sockaddr)
+    """
+    ...  # 注：pyi文件中允许使用"..."代替任何实现细节。它是仅包含类型信息的文件，没有运行时代码。另，此处函数体可以留空，`...`是非必要的。
+```
+
+## 示例二
+
+该示例表示一个只有单行文档注释的函数定义。
+
+```python
+def allocate_lock():
+    """Creates and Return a mutex object."""
+```
+
+
+## 示例三
+
+```python
+AF_INET = ...  # 地址族，IPV4类型。
+AF_INET6 = ...  # 地址族，IPV6类型。
+SOCK_STREAM = ...  # socket类型，TCP的流式套接字。
+IPPROTO_TCP = ...  # 协议号，TCP协议。
+IPPROTO_UDP = ...  # 协议号，UDP协议。
+
+
+class socket(object):
+    """Socket"""
+
+    def __init__(self, af=AF_INET, type=SOCK_STREAM, proto=IPPROTO_TCP):
+        """Socket对象初始化函数。
+    	
+    	NOTE:
+        根据给定的地址族、套接字类型以及协议类型参数，创建一个新的套接字对象。
+        在大多数情况下不需要指定proto，也不建议这样做，因为某些MicroPython端口可能会省略IPPROTO_*常量。
+    
+        @af:地址族（参考常量说明）。
+        @type:socket类型（参考常量说明）。
+        @proto:协议号（参考常量说明）。
+        """
+    
+    def bind(self, address: tuple = ("192.168.0.1", 80)):
+        """该方法用于套接字绑定指定address，必须尚未绑定。
+    	
+    	NOTE:
+        1、作为服务器时，需要进行绑定，以固定服务器的address。
+        2、作为客户端时，绑定address用来指定套接字进行数据处理（配合usocket.TCP_CUSTOMIZE_PORT使用）。
+    
+        @address:包含地址和端口号的元组或列表。
+        """
+    
+    def listen(self, backlog: int):
+        """该方法用于套接字服务端开启监听客户端连接，可指定最大客户端连接数。
+    
+        @backlog:接受套接字的最大个数，至少为0。
+        """
+    
+    def accept(self):
+        """该方法用于套接字服务端接受连接请求。
+    
+        @return:成功返回元组，包含新的套接字和客户端地址以及客户端端口，形式为：(conn,address,port)。
+        conn,新的套接字对象，用来和客户端交互;
+        address,连接到服务器的客户端地址;
+        port,连接到服务器的客户端端口。
+        """
+```

README.rst

@@ -0,0 +1,17 @@
+News
+====
+
+- October 2023: quecpython_api_stubs 0.1.1 released!
+
+Overview
+========
+
+Provides a programing autocomplete of QuecPython for IDE.It is pure Python and works on
+Python 3.7+.
+
+Install most recent stable with "pip install quecpython_api_stubs".
+
+Useful links:
+
+- Project on PyPI: https://pypi.org/project/quecpython_api_stubs/
+- The documentation for latest code is at: https://github.com/QuecPython/quecpython_api_stubs

VERSION

@@ -0,0 +1 @@
+0.0.1

build.sh

@@ -0,0 +1,2 @@
+# enter `thonny-quecpython_stubs` dir then execute below shell command
+python setup.py sdist bdist_wheel

quecpython_stubs/__init__.pyi

@@ -0,0 +1,23 @@
+import win32api
+import win32con
+from pathlib import Path
+
+
+def load():
+    # 获取QuecPython的环境变量
+    QUECPYTHON_PATH = str(Path(__file__).parent)
+    # 打开环境变量键
+    key = win32api.RegOpenKeyEx(
+        win32con.HKEY_LOCAL_MACHINE,
+        'SYSTEM\\CurrentControlSet\\Control\\Session Manager\\Environment',
+        0,
+        win32con.KEY_ALL_ACCESS
+    )
+    # 更新环境变量值
+    win32api.RegSetValueEx(key, 'PYTHONPATH', 0, 2, QUECPYTHON_PATH)
+    # 关闭键
+    win32api.RegCloseKey(key)
+
+
+if __name__ == '__main__':
+    load()

quecpython_stubs/__main__.py

@@ -0,0 +1,110 @@
+"""
+Function:
+_thread module contains features related to thread operations, and provides methods for creating and deleting threads, and interfaces related to mutex and semaphore.
+
+Descriptions taken from:
+https://python.quectel.com/doc/API_reference/en/stdlib/_thread.html
+"""
+
+
+def get_ident():
+    """Requires the current thread number.
+
+    @return: Returns the current thread number.
+    """
+
+def stack_size(size):
+    """ set thread stack size
+    Setting or getting the stack size which is used to create a thread (Unit: byte) depends on whether size is provided. The stack size is 8448 bytes by default, with a minimum of 8192 bytes.
+
+    @param size: Sets the stack size which is used to create a thread when size is provided.
+    @return: Returns the stack size which is used to create a thread when size is not provided.
+    """
+
+def start_new_thread(function, args):
+    """create new thread.
+    Creates a thread to receive the executing function and the parameter of the executed function, and passes an empty tuple if function has no parameters.
+
+    @param function: The executing function of the thread.
+    @param args: The parameter of the executing function of the thread, which passes an empty tuple when the function has no parameters.
+    @return: Returns the ID of the created thread.
+    """
+
+def threadIsRunning(thread_id):
+    """check if thread is running or not according to `thread_id`.
+
+    :param thread_id: thread ident, a int type.
+    :return: True or False
+    """
+
+def stop_thread(thread_id):
+    """Deletes a thread. The main thread cannot be deleted.
+
+    @param thread_id: The returned ID when the thread is created. If the value is 0, the current thread is deleted.
+    @return: None
+    """
+
+def get_heap_size():
+    """Gets the remaining size of heap in the system.
+
+    @return: Returns the remaining size of heap in the system. (Unit: byte)
+    """
+
+class Lock(object):
+
+    def acquire(self):
+        """Acquires the lock.
+
+        @return: True-Successful execution; False-Failed execution.
+        """
+
+    def release(self):
+        """Releases the lock."""
+
+    def locked(self):
+        """Returns the status of the lock.
+
+        @return: True indicates the status of the lock has been required by some thread; False indicates the status of the lock has not been required by the thread.
+        """
+
+def allocate_lock() -> Lock:
+    """Creates a mutex object.
+
+    @return: Returns the created mutex object.
+    """
+
+def delete_lock(lock):
+    """Deletes the created mutex.
+
+    @param lock: The returned mutex object when the mutex is created.
+    @return: None
+    """
+
+class Semphore(object):
+
+
+    def acquire(self):
+        """Acquires the semphore."""
+
+    def release(self):
+        """Releases the semphore."""
+
+    def getCnt(self):
+        """Gets the maximum value of the semaphore count and the current remaining count value.
+
+        @return: (maxCnt, curCnt)-tuple: maxCnt is the maximum count value, and curCnt is the current remaining count value.
+        """
+
+def allocate_semphore(initcount) -> Semphore:
+    """Creates a semphore object.
+
+    @param initcount: The initial count value and also the maximum value of the semaphore.
+    @return: Returns the created semphore object.
+    """
+
+def delete_semphore(semphore):
+    """Deletes the created semphore.
+
+    @param semphore: The returned semphore object when the semphore is created.
+    @return: None
+    """

quecpython_stubs/_thread.pyi

@@ -0,0 +1,36 @@
+"""
+Function:
+The app_fota module is used for user file upgrades.
+
+Descriptions taken from:
+https://python.quectel.com/doc/API_reference/en/syslib/app_fota.html
+"""
+
+
+class new(object):
+
+    def __init__(self):
+        """Creates an app_fota object."""
+
+    def download(self, url, file_name):
+        """Downloads a single file.
+
+        :param url: String type. The URL of the file to be downloaded.
+        :param file_name: String type. The absolute path of the local file to be upgraded.
+        :return: 0-Successful execution; -1-Failed execution.
+        """
+
+    def bulk_download(self, info):
+        """Downloads bulk files.
+
+        :param info: List type. The bulk download lists. Each element of the list is a dictionary containing url and file_name.
+        :return: Returns the list of failed downloads in list type when the download fails.Returns NULL when the download succeeds.
+        """
+
+    def set_update_flag(self):
+        """Sets the upgrade flag.
+
+        fter the upgrade flag is set, call the restart interface to restart the module.
+        After that, the upgrade process can be started.
+        You can enter the application once the upgrade completes.
+        """

quecpython_stubs/app_fota.pyi

@@ -0,0 +1,21 @@
+"""
+Function:
+This module provides a method for sending AT commands, allowing the QuecPython module to send AT commands through Python code.
+
+Descriptions taken from:
+https://python.quectel.com/doc/API_reference/en/syslib/atcmd.html
+"""
+
+
+def sendSync(atcmd, resp, include_str, timeout):
+    """Sends an AT command to the module.
+
+    :param atcmd: String type. The AT command to be sent, and '\r\n' should be included.
+    :param resp: String type. The string content returned by the AT command.
+    :param include_str: String type. Keyword. The specific values are shown in the table below
+    Value	Description
+    Empty string	Gets all data returned by the AT command (excluding result data such as 'OK') and puts the data into the resp parameter.
+    None-empty string	Filter data containing the keyword and puts the data into the resp parameter.
+    :param timeout: Integer type. Timeout. Unit: second.
+    :return: Returns an integer value. 0 indicates successful execution and other values indicate failed execution.
+    """