test, doc(hansbug): split treetensor.common.Object out of the original position

docs/source/api_doc/common/index.rst

@@ -4,5 +4,6 @@ treetensor.common
 .. toctree::
     :maxdepth: 3
 
-    trees.auto
-    wrappers.auto
+    object
+    trees
+    wrappers

docs/source/api_doc/common/object.rst

+treetensor.common.object
+===============================
+
+.. currentmodule:: treetensor.common
+
+Object
+-----------------
+
+.. autoclass:: Object
+    :members: __init__
+

docs/source/api_doc/common/trees.rst

+treetensor.common.trees
+==============================
+
+.. py:currentmodule:: treetensor.common.trees
+
+print_tree
+------------------
+
+.. autofunction:: print_tree
+
+
+BaseTreeStruct
+-----------------------
+
+.. autoclass:: BaseTreeStruct
+    :members:
+

docs/source/api_doc/common/trees.rstc

-treetensor.common.trees
\ No newline at end of file

docs/source/api_doc/common/wrappers.rst

+treetensor.common.wrappers
+===============================
+
+.. py:currentmodule:: treetensor.common
+
+kwreduce
+-------------------
+
+.. autofunction:: kwreduce
+
+
+vreduce
+-------------------
+
+.. autofunction:: vreduce
+
+
+ireduce
+-------------------
+
+.. autofunction:: ireduce
+

docs/source/api_doc/common/wrappers.rstc

-treetensor.common.wrappers
\ No newline at end of file

test/common/__init__.py

+from .test_object import TestCommonObject
 from .test_trees import TestCommonTrees

test/common/test_object.py

+import pytest
+from treevalue import typetrans, TreeValue
+
+from treetensor.common import Object
+
+
+@pytest.mark.unittest
+class TestCommonObject:
+    def test_object(self):
+        t = Object(1)
+        assert isinstance(t, int)
+        assert t == 1
+
+        assert Object({'a': 1, 'b': 2}) == typetrans(TreeValue({
+            'a': 1, 'b': 2
+        }), Object)

test/common/test_trees.py

@@ -2,9 +2,9 @@ import io
 
 import pytest
 import torch
-from treevalue import typetrans, TreeValue, general_tree_value
+from treevalue import general_tree_value
 
-from treetensor.common import Object, print_tree
+from treetensor.common import print_tree
 
 
 def text_compares(expected, actual):
@@ -24,15 +24,6 @@ Expected: {e}
 
 @pytest.mark.unittest
 class TestCommonTrees:
-    def test_object(self):
-        t = Object(1)
-        assert isinstance(t, int)
-        assert t == 1
-
-        assert Object({'a': 1, 'b': 2}) == typetrans(TreeValue({
-            'a': 1, 'b': 2
-        }), Object)
-
     def test_print_tree(self):
         class _TempTree(general_tree_value()):
             def __repr__(self):

treetensor/common/__init__.py

+from .object import *
 from .trees import *
 from .wrappers import *

treetensor/common/object.py

+from .trees import BaseTreeStruct, clsmeta
+
+__all__ = [
+    "Object",
+]
+
+
+def _object(obj):
+    return obj
+
+
+class Object(BaseTreeStruct, metaclass=clsmeta(_object, allow_dict=True)):
+    def __init__(self, data):
+        """
+        In :class:`treetensor.common.Object`, object or object tree can be initialized.
+
+        Examples::
+
+            >>> from treetensor.common import Object
+            >>> Object(1)
+            1
+
+            >>> Object({'a': 1, 'b': 2, 'x': {'c': 233}})
+            <Object 0x7fe00b1153a0>
+            ├── a --> 1
+            ├── b --> 2
+            └── x --> <Object 0x7fe00b115ee0>
+                └── c --> 233
+        """
+        super(BaseTreeStruct, self).__init__(data)

treetensor/common/trees.py

@@ -13,7 +13,7 @@ from treevalue.utils import post_process
 from ..utils import replaceable_partial, args_mapping
 
 __all__ = [
-    'BaseTreeStruct', "Object",
+    'BaseTreeStruct',
     'print_tree', 'clsmeta',
 ]
 
@@ -118,11 +118,3 @@ def clsmeta(func, allow_dict: bool = False):
                 return _result
 
     return _MetaClass
-
-
-def _object(obj):
-    return obj
-
-
-class Object(BaseTreeStruct, metaclass=clsmeta(_object, allow_dict=True)):
-    pass