edsl 0.1.27.dev2__py3-none-any.whl → 0.1.28__py3-none-any.whl

edsl/study/ObjectEntry.py

@@ -0,0 +1,97 @@
+import time
+from typing import Optional, Dict, Any, Type
+
+
+class ObjectEntry:
+    def __init__(
+        self,
+        variable_name: str,
+        object: Any,
+        description: str,
+        coop_info: Optional[Dict[str, Any]] = None,
+        created_at: Optional[float] = None,
+        edsl_class_name: Optional[str] = None,
+    ):
+        self.created_at = created_at or time.time()
+        self.variable_name = variable_name
+        self.object = object
+        self.edsl_class_name = edsl_class_name or object.__class__.__name__
+        self.description = description
+        self.coop_info = coop_info
+
+    @classmethod
+    def _get_class(self, obj_dict: Dict[str, Any]) -> Type:
+        "Get the class of an object from its dictionary representation."
+        class_name = obj_dict["edsl_class_name"]
+        if class_name == "QuestionBase":
+            from edsl import QuestionBase
+
+            return QuestionBase
+        else:
+            from edsl.Base import RegisterSubclassesMeta
+
+            return RegisterSubclassesMeta._registry[class_name]
+
+    def __repr__(self) -> str:
+        return f"ObjectEntry(variable_name='{self.variable_name}', object={self.object!r}, description='{self.description}', coop_info={self.coop_info}, created_at={self.created_at}, edsl_class_name='{self.edsl_class_name}')"
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {
+            "created_at": self.created_at,
+            "variable_name": self.variable_name,
+            "object": self.object.to_dict(),
+            "edsl_class_name": self.edsl_class_name,
+            "description": self.description,
+            "coop_info": self.coop_info,
+        }
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, Any]) -> "ObjectEntry":
+        d["object"] = cls._get_class(d["object"]).from_dict(d["object"])
+        return cls(**d)
+
+    @property
+    def hash(self) -> str:
+        return str(hash(self.object))
+
+    def add_to_namespace(self) -> None:
+        globals()[self.variable_name] = self.object
+
+    @property
+    def coop_info(self) -> Optional[Dict[str, Any]]:
+        return self._coop_info
+
+    @coop_info.setter
+    def coop_info(self, coop_info: Optional[Dict[str, Any]]) -> None:
+        self._coop_info = coop_info
+
+    def view_on_coop(self) -> None:
+        if self.coop_info is None:
+            print("Object not pushed to coop")
+            return
+        url = self.coop_info["url"]
+        import webbrowser
+
+        webbrowser.open(url)
+
+    def push(self, refresh: bool = False) -> Dict[str, Any]:
+        if self.coop_info is None or refresh:
+            self.coop_info = self.object.push(description=self.description)
+            print(
+                f"Object {self.variable_name} pushed to coop with info: {self._coop_info}"
+            )
+        else:
+            print(
+                f"Object {self.variable_name} already pushed to coop with info: {self._coop_info}"
+            )
+
+
+if __name__ == "__main__":
+    from edsl import QuestionFreeText
+
+    q = QuestionFreeText.example()
+
+    oe = ObjectEntry("q", q, "This is a question")
+    d = oe.to_dict()
+    new_oe = ObjectEntry.from_dict(d)
+    # print(oe.coop_info)

edsl/study/ProofOfWork.py

@@ -0,0 +1,110 @@
+import hashlib
+import time
+from typing import Optional, Any, Dict, List
+
+
+class ProofOfWork:
+    def __init__(
+        self,
+        input_data: Optional[Any] = None,
+        proof: Optional[Dict[int, List[Dict[str, Any]]]] = None,
+    ):
+        self.input_data = input_data
+        self.proof = proof or {}
+
+    def add_input_data(self, input_data: Any) -> None:
+        self.input_data = input_data
+
+    def to_dict(self) -> Dict[str, Any]:
+        return {"input_data": self.input_data, "proof": self.proof}
+
+    @classmethod
+    def from_dict(cls, data: Dict[str, Any]) -> "ProofOfWork":
+        return cls(data["input_data"], data["proof"])
+
+    def __repr__(self) -> str:
+        return f"ProofOfWork(input_data={self.input_data}, proof={self.proof})"
+
+    def to_hash(self, nonce: int) -> str:
+        """
+        Hash the input data combined with the nonce.
+
+        Returns:
+        str: The resulting hash.
+        """
+        hash_input = self.input_data + str(nonce)
+        return hashlib.md5(hash_input.encode()).hexdigest()
+
+    def verify_work(self) -> bool:
+        for difficulty in self.proof:
+            for proof in self.proof[difficulty]:
+                nonce = proof["nonce"]
+                hash_result = self.to_hash(nonce)
+                prefix = "0" * difficulty
+                if not hash_result.startswith(prefix):
+                    return False
+                if hash_result != proof["hash"]:
+                    return False
+        return True
+
+    def add_proof(self, difficulty: int, starting_nonce: Optional[int] = None) -> None:
+        """
+        Find a nonce that results in a hash with `difficulty` number of leading zeros.
+
+        Returns:
+        int, str: The nonce that solves the proof of work and the resulting hash.
+        """
+        # Convert the difficulty into a string of zeros for comparison
+        prefix = "0" * difficulty
+        if not starting_nonce:
+            import random
+
+            starting_nonce = random.randint(0, 1000000)
+        nonce = starting_nonce
+        start = time.time()
+        while True:
+            # Combine the input data with the nonce and hash it
+            hash_result = self.to_hash(nonce)
+
+            # Check if the hash meets the difficulty requirement
+            if hash_result.startswith(prefix):
+                cycles = nonce - starting_nonce
+                end = time.time()
+                if difficulty in self.proof:
+                    self.proof[difficulty].append(
+                        {
+                            "nonce": nonce,
+                            "hash": hash_result,
+                            "time": end - start,
+                            "cycles": cycles,
+                        }
+                    )
+                else:
+                    self.proof[difficulty] = [
+                        {
+                            "nonce": nonce,
+                            "hash": hash_result,
+                            "time": end - start,
+                            "cycles": cycles,
+                        }
+                    ]
+                return
+
+            nonce += 1
+
+
+if __name__ == "__main__":
+    from edsl.study import ProofOfWork
+
+    p = ProofOfWork("hello world")
+    p.add_proof(3)
+    print(p)
+    p.add_proof(6)
+    print(p)
+
+    # Takes about a minute to run
+    p.add_proof(7)
+    print(p)
+
+    ok = p.verify_work()
+    print(ok)

edsl/study/SnapShot.py

@@ -0,0 +1,77 @@
+from typing import Generator
+import inspect
+
+
+class SnapShot:
+    def __init__(self, namespace, exclude=None):
+        self.namespace = namespace
+
+        if exclude is None:
+            self.exclude = []
+        else:
+            self.exclude = exclude
+
+        self.edsl_objects = dict(self._get_edsl_objects(namespace=self.namespace))
+        self.edsl_classes = dict(self._get_edsl_classes(namespace=self.namespace))
+
+    def _all_object_keys(self):
+        return self.namespace.keys()
+
+    def __repr__(self):
+        return f"SnapShot(edsl_objects={self.edsl_objects}, edsl_classes={self.edsl_objects})"
+
+    def _get_edsl_classes(
+        self, namespace: dict
+    ) -> Generator[tuple[str, type], None, None]:
+        """Get all EDSL classes in the namespace.
+
+        :param namespace: The namespace to search for EDSL classes. The default is the global namespace.
+
+        >>> sn = SnapShot(namespace = {})
+        >>> sn.edsl_classes
+        {}
+
+        >>> from edsl.data.Cache import Cache
+        >>> sn = SnapShot(namespace = globals())
+        >>> sn.edsl_classes
+        {'Cache': <class 'edsl.data.Cache.Cache'>}
+        """
+        from edsl.Base import RegisterSubclassesMeta
+        from edsl import QuestionBase
+
+        all_edsl_objects = RegisterSubclassesMeta.get_registry()
+
+        for name, value in namespace.items():
+            if (
+                inspect.isclass(value)
+                and name in all_edsl_objects
+                and value != RegisterSubclassesMeta
+            ):
+                yield name, value
+            if inspect.isclass(value) and issubclass(value, QuestionBase):
+                yield name, value
+
+    def _get_edsl_objects(self, namespace) -> Generator[tuple[str, type], None, None]:
+        """Get all EDSL objects in the global namespace.
+
+        >>> sn = SnapShot(namespace = globals())
+        >>> sn.edsl_objects
+        {}
+
+        """
+        from edsl.Base import Base
+        from edsl.study.Study import Study
+
+        for name, value in namespace.items():
+            if (
+                hasattr(value, "to_dict")
+                and not inspect.isclass(value)
+                and value.__class__ not in [o.__class__ for o in self.exclude]
+            ):
+                yield name, value
+
+
+if __name__ == "__main__":
+    import doctest
+
+    doctest.testmod(optionflags=doctest.ELLIPSIS)