feat: Stubs are created for referenced declarations in other packages (…

…#70) Closes #66 ### Summary of Changes Now limited stubs are created for imported classes from other packages. --------- Co-authored-by: megalinter-bot <[email protected]>
Safe-DS · Mar 3, 2024 · 522f38d · 522f38d
1 parent 78df1cd
commit 522f38d
Show file tree

Hide file tree

Showing 28 changed files with 488 additions and 220 deletions.
diff --git a/src/safeds_stubgen/stubs_generator/_generate_stubs.py b/src/safeds_stubgen/stubs_generator/_generate_stubs.py
diff --git a/tests/data/main_package/another_path/another_module.py b/tests/data/main_package/another_path/another_module.py
@@ -6,3 +6,7 @@
 
 class AnotherClass:
     pass
+
+
+class yetAnotherClass:
+    def another_function(self) -> str: ...
diff --git a/tests/data/various_modules_package/class_module.py b/tests/data/various_modules_package/class_module.py
@@ -1,3 +1,6 @@
+from tests.data.main_package.another_path.another_module import yetAnotherClass
+
+
 class ClassModuleEmptyClassA:
     ...
 
@@ -8,7 +11,7 @@ def __init__(self, a: int, b: ClassModuleEmptyClassA | None): ...
     def f(self): ...
 
 
-class ClassModuleClassC(ClassModuleEmptyClassA, ClassModuleClassB):
+class ClassModuleClassC(ClassModuleEmptyClassA, ClassModuleClassB, yetAnotherClass):
     attr_1: int
     attr_2: int
 

diff --git a/tests/safeds_stubgen/__snapshots__/test_main.ambr b/tests/safeds_stubgen/__snapshots__/test_main.ambr
@@ -122,6 +122,29 @@
         'type_parameters': list([
         ]),
       }),
+      dict({
+        'attributes': list([
+        ]),
+        'classes': list([
+        ]),
+        'constructor': None,
+        'docstring': dict({
+          'description': '',
+          'full_docstring': '',
+        }),
+        'id': 'main_package/another_path/another_module/yetAnotherClass',
+        'is_public': True,
+        'methods': list([
+          'main_package/another_path/another_module/yetAnotherClass/another_function',
+        ]),
+        'name': 'yetAnotherClass',
+        'reexported_by': list([
+        ]),
+        'superclasses': list([
+        ]),
+        'type_parameters': list([
+        ]),
+      }),
       dict({
         'attributes': list([
           'main_package/main_module/ModuleClass/attr_1',
@@ -307,6 +330,26 @@
     'enums': list([
     ]),
     'functions': list([
+      dict({
+        'docstring': dict({
+          'description': '',
+          'full_docstring': '',
+        }),
+        'id': 'main_package/another_path/another_module/yetAnotherClass/another_function',
+        'is_class_method': False,
+        'is_property': False,
+        'is_public': True,
+        'is_static': False,
+        'name': 'another_function',
+        'parameters': list([
+          'main_package/another_path/another_module/yetAnotherClass/another_function/self',
+        ]),
+        'reexported_by': list([
+        ]),
+        'results': list([
+          'main_package/another_path/another_module/yetAnotherClass/another_function/result_1',
+        ]),
+      }),
       dict({
         'docstring': dict({
           'description': '',
@@ -495,6 +538,7 @@
       dict({
         'classes': list([
           'main_package/another_path/another_module/AnotherClass',
+          'main_package/another_path/another_module/yetAnotherClass',
         ]),
         'docstring': '''
           Another Module Docstring.
@@ -554,6 +598,19 @@
     ]),
     'package': 'main_package',
     'parameters': list([
+      dict({
+        'assigned_by': 'IMPLICIT',
+        'default_value': None,
+        'docstring': dict({
+          'default_value': '',
+          'description': '',
+          'type': '',
+        }),
+        'id': 'main_package/another_path/another_module/yetAnotherClass/another_function/self',
+        'is_optional': False,
+        'name': 'self',
+        'type': None,
+      }),
       dict({
         'assigned_by': 'POSITION_OR_NAME',
         'default_value': None,
@@ -729,6 +786,19 @@
       }),
     ]),
     'results': list([
+      dict({
+        'docstring': dict({
+          'description': '',
+          'type': '',
+        }),
+        'id': 'main_package/another_path/another_module/yetAnotherClass/another_function/result_1',
+        'name': 'result_1',
+        'type': dict({
+          'kind': 'NamedType',
+          'name': 'str',
+          'qname': 'builtins.str',
+        }),
+      }),
       dict({
         'docstring': dict({
           'description': '',

diff --git a/tests/safeds_stubgen/api_analyzer/__snapshots__/test__get_api.ambr b/tests/safeds_stubgen/api_analyzer/__snapshots__/test__get_api.ambr
@@ -2035,6 +2035,7 @@
     'superclasses': list([
       'tests.data.various_modules_package.class_module.ClassModuleEmptyClassA',
       'tests.data.various_modules_package.class_module.ClassModuleClassB',
+      'tests.data.main_package.another_path.another_module.yetAnotherClass',
     ]),
     'type_parameters': list([
     ]),
@@ -6431,6 +6432,10 @@
     'id': 'various_modules_package/class_module',
     'name': 'class_module',
     'qualified_imports': list([
+      dict({
+        'alias': None,
+        'qualified_name': 'tests.data.main_package.another_path.another_module.yetAnotherClass',
+      }),
     ]),
     'wildcard_imports': list([
     ]),

diff --git a/...pshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[_module_3].sdsstub b/...pshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[_module_3].sdsstub
@@ -0,0 +1,4 @@
+@PythonModule("various_modules_package.file_creation._module_3")
+package variousModulesPackage.fileCreation.Module3
+
+class Reexported()
diff --git a/...pshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[_module_6].sdsstub b/...pshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[_module_6].sdsstub
@@ -0,0 +1,7 @@
+@PythonModule("various_modules_package.file_creation._module_6")
+package variousModulesPackage.fileCreation.Module6
+
+// TODO Result type information missing.
+@Pure
+@PythonName("public_reexported")
+fun publicReexported()
diff --git a/...test_generate_stubs/TestStubFileGeneration.test_stub_creation[_reexport_module_1].sdsstub b/...test_generate_stubs/TestStubFileGeneration.test_stub_creation[_reexport_module_1].sdsstub
@@ -0,0 +1,4 @@
+@PythonModule("various_modules_package._reexport_module_1")
+package variousModulesPackage.ReexportModule1
+
+class ReexportClass()
diff --git a/...test_generate_stubs/TestStubFileGeneration.test_stub_creation[_reexport_module_2].sdsstub b/...test_generate_stubs/TestStubFileGeneration.test_stub_creation[_reexport_module_2].sdsstub
@@ -0,0 +1,9 @@
+@PythonModule("various_modules_package._reexport_module_2")
+package variousModulesPackage.ReexportModule2
+
+// TODO Result type information missing.
+@Pure
+@PythonName("reexported_function_2")
+fun reexportedFunction2()
+
+class AnotherReexportClass()
diff --git a/...test_generate_stubs/TestStubFileGeneration.test_stub_creation[_reexport_module_4].sdsstub b/...test_generate_stubs/TestStubFileGeneration.test_stub_creation[_reexport_module_4].sdsstub
@@ -0,0 +1,4 @@
+@PythonModule("various_modules_package._reexport_module_4")
+package variousModulesPackage.ReexportModule4
+
+class FourthReexportClass()
diff --git a/...rate_stubs/test_abstract_creation.sdsstub → ...st_stub_creation[abstract_module].sdsstub b/...rate_stubs/test_abstract_creation.sdsstub → ...st_stub_creation[abstract_module].sdsstub
diff --git a/...alias_creation[aliasing_module_1].sdsstub → ..._stub_creation[aliasing_module_1].sdsstub b/...alias_creation[aliasing_module_1].sdsstub → ..._stub_creation[aliasing_module_1].sdsstub
diff --git a/...alias_creation[aliasing_module_2].sdsstub → ..._stub_creation[aliasing_module_2].sdsstub b/...alias_creation[aliasing_module_2].sdsstub → ..._stub_creation[aliasing_module_2].sdsstub
diff --git a/...alias_creation[aliasing_module_3].sdsstub → ..._stub_creation[aliasing_module_3].sdsstub b/...alias_creation[aliasing_module_3].sdsstub → ..._stub_creation[aliasing_module_3].sdsstub
diff --git a/...s__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[another_module].sdsstub b/...s__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[another_module].sdsstub
@@ -0,0 +1,4 @@
+@PythonModule("various_modules_package.another_path.another_module")
+package variousModulesPackage.anotherPath.anotherModule
+
+class AnotherClass()
diff --git a/...ubs/test_class_attribute_creation.sdsstub → ...t_stub_creation[attribute_module].sdsstub b/...ubs/test_class_attribute_creation.sdsstub → ...t_stub_creation[attribute_module].sdsstub
@@ -1,6 +1,8 @@
 @PythonModule("various_modules_package.attribute_module")
 package variousModulesPackage.attributeModule
 
+from tests.data.mainPackage.anotherPath.anotherModule import AnotherClass
+
 class AttributesClassA()
 
 class AttributesClassB() {
@@ -92,7 +94,7 @@ class AttributesClassB() {
 	@PythonName("attr_type_from_outside_package")
 	static attr attrTypeFromOutsidePackage: AnotherClass
 	@PythonName("attr_default_value_from_outside_package")
-	static attr attrDefaultValueFromOutsidePackage: () -> a: AnotherClass
+	static attr attrDefaultValueFromOutsidePackage: () -> param1: AnotherClass
 	@PythonName("init_attr")
 	attr initAttr: Boolean
 

diff --git a/...enerate_stubs/test_class_creation.sdsstub → ....test_stub_creation[class_module].sdsstub b/...enerate_stubs/test_class_creation.sdsstub → ....test_stub_creation[class_module].sdsstub
@@ -1,6 +1,8 @@
 @PythonModule("various_modules_package.class_module")
 package variousModulesPackage.classModule
 
+from tests.data.mainPackage.anotherPath.anotherModule import yetAnotherClass
+
 class ClassModuleEmptyClassA()
 
 class ClassModuleClassB(
@@ -13,7 +15,7 @@ class ClassModuleClassB(
 }
 
 // TODO Safe-DS does not support multiple inheritance.
-class ClassModuleClassC() sub ClassModuleEmptyClassA, ClassModuleClassB {
+class ClassModuleClassC() sub ClassModuleEmptyClassA, ClassModuleClassB, yetAnotherClass {
 	@PythonName("attr_1")
 	static attr attr1: Int
 	@PythonName("attr_2")

diff --git a/..._/test_generate_stubs/TestStubFileGeneration.test_stub_creation[docstring_module].sdsstub b/..._/test_generate_stubs/TestStubFileGeneration.test_stub_creation[docstring_module].sdsstub
@@ -0,0 +1,58 @@
+@PythonModule("various_modules_package.docstring_module")
+package variousModulesPackage.docstringModule
+
+class EpydocDocstringClass(
+	@PythonName("param_1") param1: String
+) {
+	@PythonName("attr_1")
+	static attr attr1: String
+
+	@Pure
+	@PythonName("epydoc_docstring_func")
+	fun epydocDocstringFunc(
+		x: Int,
+		y: Int
+	) -> result1: Boolean
+}
+
+class RestDocstringClass(
+	@PythonName("param_1") param1: String
+) {
+	@PythonName("attr_1")
+	static attr attr1: String
+
+	@Pure
+	@PythonName("rest_docstring_func")
+	fun restDocstringFunc(
+		x: Int,
+		y: Int
+	) -> result1: Boolean
+}
+
+class NumpyDocstringClass(
+	@PythonName("param_1") param1: String
+) {
+	@PythonName("attr_1")
+	static attr attr1: String
+
+	@Pure
+	@PythonName("numpy_docstring_func")
+	fun numpyDocstringFunc(
+		x: Int,
+		y: Int
+	) -> result1: Boolean
+}
+
+class GoogleDocstringClass(
+	@PythonName("param_1") param1: String
+) {
+	@PythonName("attr_1")
+	static attr attr1: String
+
+	@Pure
+	@PythonName("google_docstring_func")
+	fun googleDocstringFunc(
+		x: Int,
+		y: Int
+	) -> result1: Boolean
+}
diff --git a/...generate_stubs/test_enum_creation.sdsstub → ...n.test_stub_creation[enum_module].sdsstub b/...generate_stubs/test_enum_creation.sdsstub → ...n.test_stub_creation[enum_module].sdsstub
diff --git a/...rate_stubs/test_function_creation.sdsstub → ...st_stub_creation[function_module].sdsstub b/...rate_stubs/test_function_creation.sdsstub → ...st_stub_creation[function_module].sdsstub
@@ -1,6 +1,8 @@
 @PythonModule("various_modules_package.function_module")
 package variousModulesPackage.functionModule
 
+from tests.data.mainPackage.anotherPath.anotherModule import AnotherClass
+
 // TODO Result type information missing.
 @Pure
 @PythonName("public_no_params_no_result")
@@ -230,8 +232,8 @@ fun anyResults() -> result1: Any
 @Pure
 @PythonName("callable_type")
 fun callableType(
-	param: (a: String) -> (b: Int, c: String)
-) -> result1: (a: Int, b: Int) -> c: Int
+	param: (param1: String) -> (param2: Int, param3: String)
+) -> result1: (param1: Int, param2: Int) -> param3: Int
 
 // TODO Result type information missing.
 // TODO Some parameter have no type information.

diff --git a/...nerate_stubs/test_import_creation.sdsstub → ...test_stub_creation[import_module].sdsstub b/...nerate_stubs/test_import_creation.sdsstub → ...test_stub_creation[import_module].sdsstub
diff --git a/...enerate_stubs/test_type_inference.sdsstub → ...stub_creation[infer_types_module].sdsstub b/...enerate_stubs/test_type_inference.sdsstub → ...stub_creation[infer_types_module].sdsstub
@@ -21,7 +21,7 @@ class InferMyTypes(
 	@PythonName("infer_none")
 	static attr inferNone: Nothing?
 	@PythonName("infer_obj")
-	static attr inferObj: () -> a: InferMe
+	static attr inferObj: () -> param1: InferMe
 	// TODO Attribute has no type information.
 	@PythonName("init_infer")
 	attr initInfer

diff --git a/...apshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[module_1].sdsstub b/...apshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[module_1].sdsstub
@@ -0,0 +1,4 @@
+@PythonModule("various_modules_package.file_creation.module_1")
+package variousModulesPackage.fileCreation.module1
+
+class C()
diff --git a/...apshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[module_5].sdsstub b/...apshots__/test_generate_stubs/TestStubFileGeneration.test_stub_creation[module_5].sdsstub
@@ -0,0 +1,4 @@
+@PythonModule("various_modules_package.file_creation.package_1.module_5")
+package variousModulesPackage.fileCreation.package1.module5
+
+class C()
diff --git a/...rate_stubs/test_type_var_creation.sdsstub → ...st_stub_creation[type_var_module].sdsstub b/...rate_stubs/test_type_var_creation.sdsstub → ...st_stub_creation[type_var_module].sdsstub
diff --git a/...rate_stubs/test_variance_creation.sdsstub → ...st_stub_creation[variance_module].sdsstub b/...rate_stubs/test_variance_creation.sdsstub → ...st_stub_creation[variance_module].sdsstub
diff --git a/..._snapshots__/test_generate_stubs/test_file_creation_limited_stubs_outside_package.sdsstub b/..._snapshots__/test_generate_stubs/test_file_creation_limited_stubs_outside_package.sdsstub
@@ -0,0 +1,7 @@
+@PythonModule("tests.data.main_package.another_path.another_module")
+package tests.data.mainPackage.anotherPath.anotherModule
+
+class AnotherClass
+
+@PythonName("yetAnotherClass")
+class YetAnotherClass