hive-nectar 0.0.10__py3-none-any.whl → 0.1.0__py3-none-any.whl

nectar/blockchainobject.py

@@ -101,11 +101,39 @@ class BlockchainObject(dict):
         *args,
         **kwargs,
     ):
-        if blockchain_instance is None:
-            if kwargs.get("steem_instance"):
-                blockchain_instance = kwargs["steem_instance"]
-            elif kwargs.get("hive_instance"):
-                blockchain_instance = kwargs["hive_instance"]
+        """
+        Initialize a BlockchainObject, setting its identifier and optionally loading or caching its data.
+
+        This constructor accepts a variety of `data` forms:
+        - dict or instance of `klass`: uses the mapping directly as the object's data.
+        - int: treated as a block number (identifier) and stored under `id_item`.
+        - str: treated as an object identifier string and stored under `id_item`.
+        - other scalar identifiers: validated with test_valid_objectid and may trigger a lookup.
+
+        Behavioral notes:
+        - If `lazy` is False the constructor may call refresh() to populate the object from the blockchain.
+        - If `use_cache` is True and not lazy, the object will be stored in the class-level cache and marked as cached.
+        - Raises ValueError if `data` is a list, set, or tuple (these collection types are not supported).
+
+        Parameters:
+            data: dict, instance, int, str, or identifier
+                The source for the object's data or its identifier.
+            klass (optional): type
+                If provided and `data` is an instance of this type, the instance's mapping is used directly.
+            space_id (int, optional):
+                Numeric namespace for the object type (defaults to 1).
+            object_id (optional):
+                Explicit object id value — kept for callers that supply it but not otherwise interpreted by the constructor.
+            lazy (bool, optional):
+                If True, defer loading object contents (do not call refresh()).
+            use_cache (bool, optional):
+                If True and not lazy, store the constructed object in the class cache.
+            id_item (str, optional):
+                Key name used to read/write the object's identifier in the underlying mapping (defaults to "id").
+
+        Raises:
+            ValueError: if `data` is a list, set, or tuple.
+        """
         self.blockchain = blockchain_instance or shared_blockchain_instance()
         self.cached = False
         self.identifier = None