Merge pull request #373 from machow/feat-auto-no-sort-members

feat: add Auto member_order option

Author: machow

quartodoc/builder/blueprint.py

@@ -407,7 +407,12 @@ def _fetch_members(self, el: Auto, obj: dc.Object | dc.Alias):
         if not el.include_functions:
             options = {k: v for k, v in options.items() if not v.is_function}
 
-        return sorted(options)
+        if el.member_order == "alphabetical":
+            return sorted(options)
+        elif el.member_order == "source":
+            return list(options)
+        else:
+            raise ValueError(f"Unsupported value of member_order: {el.member_order}")
 
 
 class _PagePackageStripper(PydanticTransformer):

quartodoc/layout.py

@@ -225,6 +225,7 @@ class AutoOptions(_Base):
     dynamic: Union[None, bool, str] = None
     children: ChoicesChildren = ChoicesChildren.embedded
     package: Union[str, None, MISSING] = MISSING()
+    member_order: Literal["alphabetical", "source"] = "alphabetical"
     member_options: Optional["AutoOptions"] = None
 
     # for tracking fields users manually specify
@@ -275,6 +276,9 @@ class Auto(AutoOptions):
         Style for presenting members. Either separate, embedded, or flat.
     package:
         If specified, object lookup will be relative to this path.
+    member_order:
+        Order to present members in, either "alphabetical" or "source" order.
+        Defaults to alphabetical sorting.
     member_options:
         Options to apply to members. These can include any of the options above.
 

quartodoc/tests/test_builder_blueprint.py

@@ -260,6 +260,25 @@ def test_blueprint_fetch_members_dynamic():
     assert bp.members[0].obj.parent.path == name.replace(":", ".")
 
 
+@pytest.mark.parametrize("order", ["alphabetical", "source"])
+def test_blueprint_member_order(order):
+    auto = lo.Auto(
+        name="quartodoc.tests.example_class.C",
+        member_order=order,
+        include_functions=True,
+        include_attributes=False,
+        include_classes=False,
+    )
+    bp = blueprint(auto)
+    src_names = [entry.name for entry in bp.members]
+    dst_names = ["some_method", "some_class_method"]
+
+    if order == "alphabetical":
+        dst_names = sorted(dst_names)
+
+    assert src_names == dst_names
+
+
 def test_blueprint_member_options():
     auto = lo.Auto(
         name="quartodoc.tests.example",