micropython-stubber 1.24.1__py3-none-any.whl → 1.24.4__py3-none-any.whl

stubber/board/createstubs_db_min.py

@@ -38,8 +38,8 @@ L='port'
 K='.'
 I=AttributeError
 H=False
-G='/'
-E=None
+G=None
+E='/'
 D=OSError
 C='version'
 B=''
@@ -53,8 +53,9 @@ try:from collections import OrderedDict as l
 except O:from ucollections import OrderedDict as l
 __version__='v1.24.0'
 A3=2
-A4=2
-A5=['lib','/lib','/sd/lib','/flash/lib',K]
+A4=44
+A5=2
+A6=['lib','/lib','/sd/lib','/flash/lib',K]
 class J:
 	DEBUG=10;INFO=20;WARNING=30;ERROR=40;level=INFO;prnt=P
 	@staticmethod
@@ -72,7 +73,7 @@ class J:
 A=J.getLogger(t)
 J.basicConfig(level=J.INFO)
 class Stubber:
-	def __init__(B,path=E,firmware_id=E):
+	def __init__(B,path=B,firmware_id=B):
 		C=firmware_id
 		try:
 			if os.uname().release=='1.13.0'and os.uname().version<'v1.13-103':raise o('MicroPython 1.13.0 cannot be stubbed')
@@ -83,12 +84,12 @@ class Stubber:
 		else:B._fwid='{family}-v{version}-{port}'.format(**B.info)
 		B._start_free=F.mem_free()
 		if path:
-			if path.endswith(G):path=path[:-1]
+			if path.endswith(E):path=path[:-1]
 		else:path=get_root()
-		B.path='{}/stubs/{}'.format(path,B.flat_fwid).replace('//',G)
-		try:X(path+G)
+		B.path='{}/stubs/{}'.format(path,B.flat_fwid).replace('//',E)
+		try:X(path+E)
 		except D:A.error('error creating stub folder {}'.format(path))
-		B.problematic=['upip','upysh','webrepl_setup','http_client','http_client_ssl','http_server','http_server_ssl'];B.excluded=['webrepl','_webrepl','port_diag','example_sub_led.py','example_pub_button.py'];B.modules=[];B._json_name=E;B._json_first=H
+		B.problematic=['upip','upysh','webrepl_setup','http_client','http_client_ssl','http_server','http_server_ssl'];B.excluded=['webrepl','_webrepl','port_diag','example_sub_led.py','example_pub_button.py'];B.modules=[];B._json_name=G;B._json_first=H
 	def get_obj_attributes(L,item_instance):
 		H=item_instance;C=[];K=[]
 		for A in N(H):
@@ -114,39 +115,39 @@ class Stubber:
 		B=module_name
 		if B in C.problematic:A.warning('Skip module: {:<25}        : Known problematic'.format(B));return H
 		if B in C.excluded:A.warning('Skip module: {:<25}        : Excluded'.format(B));return H
-		I='{}/{}.pyi'.format(C.path,B.replace(K,G));F.collect();E=H
-		try:E=C.create_module_stub(B,I)
+		I='{}/{}.pyi'.format(C.path,B.replace(K,E));F.collect();G=H
+		try:G=C.create_module_stub(B,I)
 		except D:return H
-		F.collect();return E
-	def create_module_stub(J,module_name,file_name=E):
+		F.collect();return G
+	def create_module_stub(J,module_name,file_name=G):
 		I=file_name;C=module_name
-		if I is E:L=C.replace(K,'_')+'.pyi';I=J.path+G+L
-		else:L=I.split(G)[-1]
-		if G in C:C=C.replace(G,K)
-		N=E
-		try:N=__import__(C,E,E,'*');Q=F.mem_free();A.info('Stub module: {:<25} to file: {:<70} mem:{:>5}'.format(C,L,Q))
+		if I is G:L=C.replace(K,'_')+'.pyi';I=J.path+E+L
+		else:L=I.split(E)[-1]
+		if E in C:C=C.replace(E,K)
+		N=G
+		try:N=__import__(C,G,G,'*');Q=F.mem_free();A.info('Stub module: {:<25} to file: {:<70} mem:{:>5}'.format(C,L,Q))
 		except O:return H
 		X(I)
-		with M(I,h)as P:R=c(J.info).replace('OrderedDict(',B).replace('})','}');S='"""\nModule: \'{0}\' on {1}\n"""\n# MCU: {2}\n# Stubber: {3}\n'.format(C,J._fwid,R,__version__);P.write(S);P.write('from __future__ import annotations\nfrom typing import Any, Generator\nfrom _typeshed import Incomplete\n\n');J.write_object_stub(P,N,C,B)
+		with M(I,h)as P:R=c(J.info).replace('OrderedDict(',B).replace('})','}');S='"""\nModule: \'{0}\' on {1}\n"""\n# MCU: {2}\n# Stubber: {3}\n'.format(C,J._fwid,R,__version__);P.write(S);P.write('from __future__ import annotations\nfrom typing import Any, Final, Generator\nfrom _typeshed import Incomplete\n\n');J.write_object_stub(P,N,C,B)
 		J.report_add(C,I)
 		if C not in{'os','sys','logging','gc'}:
 			try:del N
 			except(D,r):A.warning('could not del new_module')
 		F.collect();return T
 	def write_object_stub(L,fp,object_expr,obj_name,indent,in_class=0):
-		Z=' at ...>';Y='generator';X='{0}{1}: {3} = {2}\n';W='bound_method';V='Incomplete';O=in_class;N='Exception';M=object_expr;K=' at ';J=fp;E=indent;F.collect()
+		Y=' at ...>';X='{0}{1}: {3} = {2}\n';W='bound_method';V='Incomplete';O=in_class;N='Exception';M=object_expr;K=' at ';J=fp;E=indent;F.collect()
 		if M in L.problematic:A.warning('SKIPPING problematic module:{}'.format(M));return
-		a,P=L.get_obj_attributes(M)
+		Z,P=L.get_obj_attributes(M)
 		if P:A.error(P)
-		for(C,H,I,b,d)in a:
+		for(C,H,I,a,c)in Z:
 			if C in['classmethod','staticmethod','BaseException',N]:continue
 			if C[0].isdigit():A.warning('NameError: invalid name {}'.format(C));continue
-			if I=="<class 'type'>"and R(E)<=A4*4:
+			if I=="<class 'type'>"and R(E)<=A5*4:
 				Q=B;S=C.endswith(N)or C.endswith('Error')or C in['KeyboardInterrupt','StopIteration','SystemExit']
 				if S:Q=N
 				D='\n{}class {}({}):\n'.format(E,C,Q)
 				if S:D+=E+'    ...\n';J.write(D);continue
-				J.write(D);L.write_object_stub(J,b,'{0}.{1}'.format(obj_name,C),E+'    ',O+1);D=E+'    def __init__(self, *argv, **kwargs) -> None:\n';D+=E+'        ...\n\n';J.write(D)
+				J.write(D);L.write_object_stub(J,a,'{0}.{1}'.format(obj_name,C),E+'    ',O+1);D=E+'    def __init__(self, *argv, **kwargs) -> None:\n';D+=E+'        ...\n\n';J.write(D)
 			elif any(A in I for A in[A0,z,'closure']):
 				T=V;U=B
 				if O>0:U='self, '
@@ -159,14 +160,13 @@ class Stubber:
 				if G in(x,v,w,y,'bytearray','bytes'):
 					if C.upper()==C:D='{0}{1}: Final[{3}] = {2}\n'.format(E,C,H,G)
 					else:D=X.format(E,C,H,G)
-				elif G in(g,f,e):c={g:'{}',f:'[]',e:'()'};D=X.format(E,C,c[G],G)
-				elif G in('object','set','frozenset','Pin',Y):
-					if G==Y:G='Generator'
-					D='{0}{1}: {2} ## = {4}\n'.format(E,C,G,I,H)
+				elif G in(g,f,e):b={g:'{}',f:'[]',e:'()'};D=X.format(E,C,b[G],G)
+				elif G in('object','set','frozenset','Pin'):D='{0}{1}: {2} ## = {4}\n'.format(E,C,G,I,H)
+				elif G=='generator':G='Generator';D='{0}def {1}(*args, **kwargs) -> Generator:  ## = {4}\n{0}    ...\n\n'.format(E,C,G,I,H)
 				else:
 					G=V
-					if K in H:H=H.split(K)[0]+Z
-					if K in H:H=H.split(K)[0]+Z
+					if K in H:H=H.split(K)[0]+Y
+					if K in H:H=H.split(K)[0]+Y
 					D='{0}{1}: {2} ## {3} = {4}\n'.format(E,C,G,I,H)
 				J.write(D)
 			else:J.write("# all other, type = '{0}'\n".format(I));J.write(E+C+' # type: Incomplete\n')
@@ -175,13 +175,13 @@ class Stubber:
 		A=self._fwid;B=' .()/\\:$'
 		for C in B:A=A.replace(C,'_')
 		return A
-	def clean(C,path=E):
-		if path is E:path=C.path
+	def clean(C,path=B):
+		if not path:path=C.path
 		A.info('Clean/remove files in folder: {}'.format(path))
-		try:os.stat(path);F=os.listdir(path)
+		try:os.stat(path);E=os.listdir(path)
 		except(D,I):return
-		for G in F:
-			B=i.format(path,G)
+		for F in E:
+			B=i.format(path,F)
 			try:os.remove(B)
 			except D:
 				try:C.clean(B);os.rmdir(B)
@@ -189,32 +189,32 @@ class Stubber:
 	def report_start(B,filename=j):
 		H='firmware';B._json_name=i.format(B.path,filename);B._json_first=T;X(B._json_name);A.info('Report file: {}'.format(B._json_name));F.collect()
 		try:
-			with M(B._json_name,h)as G:G.write('{');G.write(dumps({H:B.info})[1:-1]);G.write(k);G.write(dumps({t:{C:__version__},'stubtype':H})[1:-1]);G.write(k);G.write('"modules" :[\n')
-		except D as I:A.error(A1);B._json_name=E;raise I
+			with M(B._json_name,h)as E:E.write('{');E.write(dumps({H:B.info})[1:-1]);E.write(k);E.write(dumps({t:{C:__version__},'stubtype':H})[1:-1]);E.write(k);E.write('"modules" :[\n')
+		except D as I:A.error(A1);B._json_name=G;raise I
 	def report_add(B,module_name,stub_file):
 		if not B._json_name:raise s(A2)
 		try:
 			with M(B._json_name,'a')as C:
 				if not B._json_first:C.write(k)
 				else:B._json_first=H
-				E='{{"module": "{}", "file": "{}"}}'.format(module_name,stub_file.replace('\\',G));C.write(E)
+				F='{{"module": "{}", "file": "{}"}}'.format(module_name,stub_file.replace('\\',E));C.write(F)
 		except D:A.error(A1)
 	def report_end(B):
 		if not B._json_name:raise s(A2)
 		with M(B._json_name,'a')as C:C.write('\n]}')
 		A.info('Path: {}'.format(B.path))
 def X(path):
-	B=E=0
+	B=F=0
 	while B!=-1:
-		B=path.find(G,E)
+		B=path.find(E,F)
 		if B!=-1:
 			C=path[0]if B==0 else path[:B]
 			try:I=os.stat(C)
-			except D as F:
-				if F.args[0]==A3:
+			except D as G:
+				if G.args[0]in[A3,A4]:
 					try:A.debug('Create folder {}'.format(C));os.mkdir(C)
 					except D as H:A.error('failed to create folder {}'.format(C));raise H
-		E=B+1
+		F=B+1
 def Y(s):
 	C=' on '
 	if not s:return B
@@ -225,18 +225,18 @@ def Y(s):
 	if not W in s:return B
 	A=s.split(W)[1].split(K)[1];return A
 def _info():
-	a='ev3-pybricks';Z='pycom';X='pycopy';V='unix';T='win32';R='arch';P='cpu';M='ver';F='mpy';D='build'
+	a='ev3-pybricks';Z='pycom';X='pycopy';V='unix';T='win32';R='arch';P='cpu';M='ver';E='mpy';D='build'
 	try:J=sys.implementation[0]
 	except d:J=sys.implementation.name
-	A=l({S:J,C:B,D:B,M:B,L:sys.platform,U:'UNKNOWN',P:B,F:B,R:B})
+	A=l({S:J,C:B,D:B,M:B,L:sys.platform,U:'UNKNOWN',P:B,E:B,R:B})
 	if A[L].startswith('pyb'):A[L]='stm32'
 	elif A[L]==T:A[L]='windows'
 	elif A[L]=='linux':A[L]=V
-	try:A[C]=A6(sys.implementation.version)
+	try:A[C]=A7(sys.implementation.version)
 	except I:pass
-	try:K=sys.implementation._machine if'_machine'in N(sys.implementation)else os.uname().machine;A[U]=K;A[P]=K.split('with')[-1].strip();A[F]=sys.implementation._mpy if'_mpy'in N(sys.implementation)else sys.implementation.mpy if F in N(sys.implementation)else B
+	try:K=sys.implementation._machine if'_machine'in N(sys.implementation)else os.uname().machine;A[U]=K;A[P]=K.split('with')[-1].strip();A[E]=sys.implementation._mpy if'_mpy'in N(sys.implementation)else sys.implementation.mpy if E in N(sys.implementation)else B
 	except(I,Q):pass
-	A[U]=A7()
+	A[U]=A8()
 	try:
 		if'uname'in N(os):
 			A[D]=Y(os.uname()[3])
@@ -247,25 +247,25 @@ def _info():
 		try:b=os.uname();A[C]=b.release
 		except(Q,I,d):pass
 	for(c,e,f)in[(X,X,'const'),(Z,Z,'FAT'),(a,'pybricks.hubs','EV3Brick')]:
-		try:g=__import__(e,E,E,f);A[S]=c;del g;break
+		try:g=__import__(e,G,G,f);A[S]=c;del g;break
 		except(O,r):pass
 	if A[S]==a:A['release']='2.0.0'
 	if A[S]==u:
 		A[C]
 		if A[C]and A[C].endswith('.0')and A[C]>='1.10.0'and A[C]<='1.19.9':A[C]=A[C][:-2]
-	if F in A and A[F]:
-		G=int(A[F])
-		try:H=[E,'x86','x64','armv6','armv6m','armv7m','armv7em','armv7emsp','armv7emdp','xtensa','xtensawin','rv32imc'][G>>10]
+	if E in A and A[E]:
+		F=int(A[E])
+		try:H=[G,'x86','x64','armv6','armv6m','armv7m','armv7em','armv7emsp','armv7emdp','xtensa','xtensawin','rv32imc'][F>>10]
 		except Q:H='unknown'
 		if H:A[R]=H
-		A[F]='v{}.{}'.format(G&255,G>>8&3)
+		A[E]='v{}.{}'.format(F&255,F>>8&3)
 	if A[D]and not A[C].endswith(W):A[C]=A[C]+W
 	A[M]=f"{A[C]}-{A[D]}"if A[D]else f"{A[C]}";return A
-def A6(version):
+def A7(version):
 	A=version;B=K.join([c(A)for A in A[:3]])
 	if R(A)>3 and A[3]:B+=V+A[3]
 	return B
-def A7():
+def A8():
 	try:from boardname import BOARDNAME as C;A.info('Found BOARDNAME: {}'.format(C))
 	except O:A.warning('BOARDNAME not found');C=B
 	return C
@@ -273,7 +273,7 @@ def get_root():
 	try:A=os.getcwd()
 	except(D,I):A=K
 	B=A
-	for B in['/remote','/sd','/flash',G,A,K]:
+	for B in['/remote','/sd','/flash',E,A,K]:
 		try:C=os.stat(B);break
 		except D:continue
 	return B
@@ -295,8 +295,8 @@ def n():
 	try:A=bytes('abc',encoding='utf8');B=n.__module__;return H
 	except(o,I):return T
 a='modulelist.done'
-def A8(skip=0):
-	for E in A5:
+def A9(skip=0):
+	for E in A6:
 		B=E+'/modulelist.txt'
 		if not Z(B):continue
 		try:
@@ -311,9 +311,9 @@ def A8(skip=0):
 					yield A
 				break
 		except D:pass
-def A9(done):
+def AA(done):
 	with M(a,h)as A:A.write(c(done)+'\n')
-def AA():
+def AB():
 	A=0
 	try:
 		with M(a)as B:A=int(B.readline().strip())
@@ -325,11 +325,11 @@ def main():
 	else:A.info('Starting new run')
 	stubber=Stubber(path=read_path());B=0
 	if not C:stubber.clean();stubber.report_start(j)
-	else:B=AA();stubber._json_name=i.format(stubber.path,j)
-	for E in A8(B):
+	else:B=AB();stubber._json_name=i.format(stubber.path,j)
+	for E in A9(B):
 		try:stubber.create_one_stub(E)
 		except p:D.reset()
-		F.collect();B+=1;A9(B)
+		F.collect();B+=1;AA(B)
 	P('All modules have been processed, Finalizing report');stubber.report_end()
 if __name__=='__main__'or n():
 	if not Z('no_auto_stubber.txt'):

stubber/board/createstubs_mem.py

@@ -9,7 +9,7 @@
     - cross compilation, using mpy-cross, 
       to avoid the compilation step on the micropython device 
 
-This variant was generated from createstubs.py by micropython-stubber v1.24.0
+This variant was generated from createstubs.py by micropython-stubber v1.24.3
 """
 
 # Copyright (c) 2019-2024 Jos Verlinde
@@ -35,7 +35,8 @@ except ImportError:
     from ucollections import OrderedDict  # type: ignore
 
 __version__ = "v1.24.0"
-ENOENT = 2
+ENOENT = 2  # on most ports
+ENOMESSAGE = 44  # on pyscript
 _MAX_CLASS_LEVEL = 2  # Max class nesting
 LIBS = ["lib", "/lib", "/sd/lib", "/flash/lib", "."]
 
@@ -82,7 +83,7 @@ logging.basicConfig(level=logging.INFO)
 class Stubber:
     "Generate stubs for modules in firmware"
 
-    def __init__(self, path: str = None, firmware_id: str = None):  # type: ignore
+    def __init__(self, path: str = "", firmware_id: str = ""):  # type: ignore
         try:
             if os.uname().release == "1.13.0" and os.uname().version < "v1.13-103":  # type: ignore
                 raise NotImplementedError("MicroPython 1.13.0 cannot be stubbed")
@@ -241,7 +242,7 @@ class Stubber:
             info_ = str(self.info).replace("OrderedDict(", "").replace("})", "}")
             s = '"""\nModule: \'{0}\' on {1}\n"""\n# MCU: {2}\n# Stubber: {3}\n'.format(module_name, self._fwid, info_, __version__)
             fp.write(s)
-            fp.write("from __future__ import annotations\nfrom typing import Any, Generator\nfrom _typeshed import Incomplete\n\n")
+            fp.write("from __future__ import annotations\nfrom typing import Any, Final, Generator\nfrom _typeshed import Incomplete\n\n")
             self.write_object_stub(fp, new_module, module_name, "")
 
         self.report_add(module_name, file_name)
@@ -360,12 +361,16 @@ class Stubber:
                     s = "{0}{1}: {3} = {2}\n".format(indent, item_name, ev[t], t)
                 else:
                     # something else
-                    if t in ("object", "set", "frozenset", "Pin", "generator"):  # "FileIO"
+                    if t in ("object", "set", "frozenset", "Pin"):  # "FileIO"
                         # https://docs.python.org/3/tutorial/classes.html#item_instance-objects
                         # use these types for the attribute
-                        if t == "generator":
-                            t = "Generator"
                         s = "{0}{1}: {2} ## = {4}\n".format(indent, item_name, t, item_type_txt, item_repr)
+                    elif t == "generator":
+                        # either a normal or async Generator function
+                        t = "Generator"
+                        s = "{0}def {1}(*args, **kwargs) -> Generator:  ## = {4}\n{0}    ...\n\n".format(
+                            indent, item_name, t, item_type_txt, item_repr
+                        )
                     else:
                         # Requires Python 3.6 syntax, which is OK for the stubs/pyi
                         t = "Incomplete"
@@ -400,9 +405,9 @@ class Stubber:
             s = s.replace(c, "_")
         return s
 
-    def clean(self, path: str = None):  # type: ignore
+    def clean(self, path: str = ""):  # type: ignore
         "Remove all files from the stub folder"
-        if path is None:
+        if not path:
             path = self.path
         log.info("Clean/remove files in folder: {}".format(path))
         try:
@@ -483,7 +488,7 @@ def ensure_folder(path: str):
                 _ = os.stat(p)
             except OSError as e:
                 # folder does not exist
-                if e.args[0] == ENOENT:
+                if e.args[0] in [ENOENT, ENOMESSAGE]:
                     try:
                         log.debug("Create folder {}".format(p))
                         os.mkdir(p)
@@ -712,11 +717,11 @@ def is_micropython() -> bool:
 
         # b) https://docs.micropython.org/en/latest/genrst/builtin_types.html#bytes-with-keywords-not-implemented
         # Micropython: NotImplementedError
-        b = bytes("abc", encoding="utf8")  # type: ignore # lgtm [py/unused-local-variable]
+        b = bytes("abc", encoding="utf8")  # type: ignore
 
         # c) https://docs.micropython.org/en/latest/genrst/core_language.html#function-objects-do-not-have-the-module-attribute
         # Micropython: AttributeError
-        c = is_micropython.__module__  # type: ignore # lgtm [py/unused-local-variable]
+        c = is_micropython.__module__  # type: ignore
         return False
     except (NotImplementedError, AttributeError):
         return True