feat: add from_dict, to_json, and general cleanup

Author: chriswblake

openproficiency/TranscriptEntry.py

@@ -2,7 +2,7 @@
 
 import json
 from datetime import datetime
-from typing import Optional
+from typing import Optional, Union
 from .ProficiencyScore import ProficiencyScore
 
 
@@ -17,15 +17,14 @@ def __init__(
         topic_id: str,
         score: float,
         issuer: str,
-
         # Optional
         timestamp: Optional[datetime] = None,
     ):
         # Required
         self.user_id = user_id
         self._proficiency_score = ProficiencyScore(
             topic_id=topic_id,
-            score=score
+            score=score,
         )
         self.issuer = issuer
 
@@ -39,21 +38,43 @@ def proficiency_score(self) -> ProficiencyScore:
         return self._proficiency_score
 
     # Methods
-    def to_dict(self) -> dict:
-        """Convert Topic to JSON-serializable dictionary."""
+    def to_dict(self) -> dict[str, Union[str, int, float]]:
+        """Convert TranscriptEntry to JSON-serializable dictionary."""
         return {
             "user_id": self.user_id,
             "topic_id": self._proficiency_score.topic_id,
             "score": self._proficiency_score.score,
             "issuer": self.issuer,
-            "timestamp": self.timestamp.isoformat()
+            "timestamp": self.timestamp.isoformat(),
         }
 
     def to_json(self) -> str:
-        """Convert Topic to JSON string."""
+        """Convert TranscriptEntry to JSON string."""
         return json.dumps(self.to_dict())
 
+    # Methods - Class
+    @classmethod
+    def from_dict(cls, data: dict[str, Union[str, int, float]]) -> "TranscriptEntry":
+        """Create a TranscriptEntry from a dictionary."""
+        return cls(
+            user_id=data["user_id"],
+            topic_id=data["topic_id"],
+            score=data["score"],
+            issuer=data["issuer"],
+            timestamp=datetime.fromisoformat(data["timestamp"]),
+        )
+
+    @classmethod
+    def from_json(cls, json_str: str) -> "TranscriptEntry":
+        """Create a TranscriptEntry from a JSON string."""
+        return cls.from_dict(json.loads(json_str))
+
     # Debugging
     def __repr__(self) -> str:
         """String representation of TranscriptEntry."""
-        return f"TranscriptEntry(user_id='{self.user_id}', topic_id='{self._proficiency_score.topic_id}', score={self._proficiency_score.score}, issuer='{self.issuer}')"
+        return (
+            f"TranscriptEntry(user_id='{self.user_id}', "
+            f"topic_id='{self._proficiency_score.topic_id}', "
+            f"score={self._proficiency_score.score}, "
+            f"issuer='{self.issuer}'"
+        )

tests/TranscriptEntry_test.py

@@ -1,7 +1,7 @@
 """Tests for the TranscriptEntry class."""
 
 from datetime import datetime
-from openproficiency import TranscriptEntry, ProficiencyScore, ProficiencyScoreName
+from openproficiency import TranscriptEntry
 
 
 class TestTranscriptEntry:
@@ -21,13 +21,13 @@ def test_init_required_params(self):
             user_id=user_id,
             topic_id=topic_id,
             score=score,
-            issuer=issuer
+            issuer=issuer,
         )
 
         # Assert
         assert entry.user_id == user_id
-        assert entry._proficiency_score.topic_id == topic_id
-        assert entry._proficiency_score.score == score
+        assert entry.proficiency_score.topic_id == topic_id
+        assert entry.proficiency_score.score == score
         assert entry.issuer == issuer
         assert entry.timestamp is not None
 
@@ -47,7 +47,7 @@ def test_init_with_optional_params(self):
             topic_id=topic_id,
             score=score,
             issuer=issuer,
-            timestamp=timestamp
+            timestamp=timestamp,
         )
 
         # Assert
@@ -68,7 +68,7 @@ def test_init_default_timestamp(self):
             user_id=user_id,
             topic_id=topic_id,
             score=score,
-            issuer=issuer
+            issuer=issuer,
         )
         after = datetime.now()
 
@@ -85,7 +85,7 @@ def test_proficiency_score(self):
             user_id="user-123",
             topic_id="git-commit",
             score=0.8,
-            issuer="github-learn"
+            issuer="github-learn",
         )
 
         # Act
@@ -106,7 +106,7 @@ def test_to_dict(self):
             topic_id="git-commit",
             score=0.8,
             issuer="github-learn",
-            timestamp=datetime(2024, 1, 15, 10, 30, 0)
+            timestamp=datetime(2024, 1, 15, 10, 30, 0),
         )
 
         # Act
@@ -118,7 +118,7 @@ def test_to_dict(self):
             "topic_id": "git-commit",
             "score": 0.8,
             "issuer": "github-learn",
-            "timestamp": "2024-01-15T10:30:00"
+            "timestamp": "2024-01-15T10:30:00",
         }
 
     def test_to_json(self):
@@ -130,7 +130,7 @@ def test_to_json(self):
             topic_id="git-commit",
             score=0.8,
             issuer="github-learn",
-            timestamp=datetime(2024, 1, 15, 10, 30, 0)
+            timestamp=datetime(2024, 1, 15, 10, 30, 0),
         )
 
         # Act
@@ -153,7 +153,7 @@ def test_repr(self):
             user_id="user-123",
             topic_id="git-commit",
             score=0.8,
-            issuer="github-learn"
+            issuer="github-learn",
         )
 
         # Act