refactor: Maintain exports order (__all__)

Author: pawamoy

src/_griffe/agents/inspector.py

@@ -526,7 +526,7 @@ def handle_attribute(self, node: ObjectNode, annotation: str | Expr | None = Non
         parent.set_member(node.name, attribute)
 
         if node.name == "__all__":
-            parent.exports = set(node.obj)
+            parent.exports = list(node.obj)
         self.extensions.call("on_instance", node=node, obj=attribute, agent=self)
         self.extensions.call("on_attribute_instance", node=node, attr=attribute, agent=self)
 

src/_griffe/agents/visitor.py

@@ -638,7 +638,7 @@ def visit_augassign(self, node: ast.AugAssign) -> None:
                 and isinstance(node.op, ast.Add)
             )
             if all_augment:
-                # we assume exports is not None at this point
+                # We assume `exports` is not `None` at this point.
                 self.current.exports.extend(  # type: ignore[union-attr]
                     [
                         name if isinstance(name, str) else ExprName(name.name, parent=name.parent)

src/_griffe/loader.py

@@ -269,7 +269,7 @@ def expand_exports(self, module: Module, seen: set | None = None) -> None:
         if module.exports is None:
             return
 
-        expanded = set()
+        expanded = []
         for export in module.exports:
             # It's a name: we resolve it, get the module it comes from,
             # recurse into it, and add its exports to the current ones.
@@ -283,12 +283,12 @@ def expand_exports(self, module: Module, seen: set | None = None) -> None:
                 if next_module.path not in seen:
                     self.expand_exports(next_module, seen)
                 try:
-                    expanded |= next_module.exports
+                    expanded += [export for export in next_module.exports if export not in expanded]
                 except TypeError:
                     logger.warning("Unsupported item in %s.__all__: %s (use strings only)", module.path, export)
             # It's a string, simply add it to the current exports.
             else:
-                expanded.add(export)
+                expanded.append(export)
         module.exports = expanded
 
         # Make sure to expand exports in all modules.

src/_griffe/models.py

@@ -455,7 +455,7 @@ def __init__(
         while the values are the actual names of the objects (`from ... import REAL_NAME as ...`).
         """
 
-        self.exports: set[str] | list[str | ExprName] | None = None
+        self.exports: list[str | ExprName] | None = None
         """The names of the objects exported by this (module) object through the `__all__` variable.
 
         Exports can contain string (object names) or resolvable names,
@@ -1276,7 +1276,7 @@ def imports(self) -> dict[str, str]:
         return self.final_target.imports
 
     @property
-    def exports(self) -> set[str] | list[str | ExprName] | None:
+    def exports(self) -> list[str | ExprName] | None:
         """The names of the objects exported by this (module) object through the `__all__` variable.
 
         Exports can contain string (object names) or resolvable names,

tests/test_models.py

@@ -36,7 +36,7 @@ def test_submodule_exports() -> None:
     assert sub.is_wildcard_exposed
 
     assert not private.is_wildcard_exposed
-    root.exports = {"_private"}
+    root.exports = ["_private"]
     assert private.is_wildcard_exposed
 
 

tests/test_visitor.py

@@ -172,15 +172,19 @@ def absolute(self, path: str | Path) -> str | Path:
 @pytest.mark.parametrize(
     "statements",
     [
-        """__all__ = moda_all + modb_all + modc_all + ["CONST_INIT"]""",
+        """__all__ = ["CONST_INIT"] + moda_all + modb_all + modc_all""",
         """__all__ = ["CONST_INIT", *moda_all, *modb_all, *modc_all]""",
         """
         __all__ = ["CONST_INIT"]
         __all__ += moda_all + modb_all + modc_all
         """,
         """
-        __all__ = moda_all + modb_all + modc_all
-        __all__ += ["CONST_INIT"]
+        __all__ = ["CONST_INIT"] + moda_all + modb_all
+        __all__ += modc_all
+        """,
+        """
+        __all__ = ["CONST_INIT"] + moda_all + modb_all
+        __all__ += [*modc_all]
         """,
         """
         __all__ = ["CONST_INIT"]
@@ -215,7 +219,7 @@ def test_parse_complex__all__assignments(statements: str) -> None:
         package = loader.load(tmp_package.name)
         loader.resolve_aliases()
 
-        assert package.exports == {"CONST_INIT", "CONST_A", "CONST_B", "CONST_C"}
+        assert package.exports == ["CONST_INIT", "CONST_A", "CONST_B", "CONST_C"]
 
 
 def test_dont_crash_on_nested_functions_in_init() -> None: