Consolidate tuf metadata interface function names

Rename:
read_from_json -> from_json_file
write_to_json -> to_json_file
as_dict -> to_dict
as_json -> to_json

Signed-off-by: Lukas Puehringer <[email protected]>

Author: Lukas Puehringer

tests/test_api.py

@@ -90,7 +90,7 @@ def test_generic_read(self):
                 ('targets', Targets)]:
 
             path = os.path.join(self.repo_dir, 'metadata', metadata + '.json')
-            metadata_obj = Metadata.read_from_json(path)
+            metadata_obj = Metadata.from_json_file(path)
 
             # Assert that generic method instantiates the right inner class for
             # each metadata type
@@ -104,39 +104,39 @@ def test_generic_read(self):
             f.write(json.dumps(bad_metadata).encode('utf-8'))
 
         with self.assertRaises(ValueError):
-            Metadata.read_from_json(bad_metadata_path)
+            Metadata.from_json_file(bad_metadata_path)
 
         os.remove(bad_metadata_path)
 
 
     def test_compact_json(self):
         path = os.path.join(self.repo_dir, 'metadata', 'targets.json')
-        metadata_obj = Metadata.read_from_json(path)
+        metadata_obj = Metadata.from_json_file(path)
         self.assertTrue(
-                len(metadata_obj.as_json(compact=True)) <
-                len(metadata_obj.as_json()))
+                len(metadata_obj.to_json(compact=True)) <
+                len(metadata_obj.to_json()))
 
 
     def test_read_write_read_compare(self):
         for metadata in ['snapshot', 'timestamp', 'targets']:
             path = os.path.join(self.repo_dir, 'metadata', metadata + '.json')
-            metadata_obj = Metadata.read_from_json(path)
+            metadata_obj = Metadata.from_json_file(path)
 
             path_2 = path + '.tmp'
-            metadata_obj.write_to_json(path_2)
-            metadata_obj_2 = Metadata.read_from_json(path_2)
+            metadata_obj.to_json_file(path_2)
+            metadata_obj_2 = Metadata.from_json_file(path_2)
 
             self.assertDictEqual(
-                    metadata_obj.as_dict(),
-                    metadata_obj_2.as_dict())
+                    metadata_obj.to_dict(),
+                    metadata_obj_2.to_dict())
 
             os.remove(path_2)
 
 
     def test_sign_verify(self):
         # Load sample metadata (targets) and assert ...
         path = os.path.join(self.repo_dir, 'metadata', 'targets.json')
-        metadata_obj = Metadata.read_from_json(path)
+        metadata_obj = Metadata.from_json_file(path)
 
         # ... it has a single existing signature,
         self.assertTrue(len(metadata_obj.signatures) == 1)
@@ -181,7 +181,7 @@ def test_metadata_base(self):
         # with real data
         snapshot_path = os.path.join(
                 self.repo_dir, 'metadata', 'snapshot.json')
-        md = Metadata.read_from_json(snapshot_path)
+        md = Metadata.from_json_file(snapshot_path)
 
         self.assertEqual(md.signed.version, 1)
         md.signed.bump_version()
@@ -196,7 +196,7 @@ def test_metadata_base(self):
     def test_metadata_snapshot(self):
         snapshot_path = os.path.join(
                 self.repo_dir, 'metadata', 'snapshot.json')
-        snapshot = Metadata.read_from_json(snapshot_path)
+        snapshot = Metadata.from_json_file(snapshot_path)
 
         # Create a dict representing what we expect the updated data to be
         fileinfo = snapshot.signed.meta
@@ -212,7 +212,7 @@ def test_metadata_snapshot(self):
     def test_metadata_timestamp(self):
         timestamp_path = os.path.join(
                 self.repo_dir, 'metadata', 'timestamp.json')
-        timestamp = Metadata.read_from_json(timestamp_path)
+        timestamp = Metadata.from_json_file(timestamp_path)
 
         self.assertEqual(timestamp.signed.version, 1)
         timestamp.signed.bump_version()

tuf/api/metadata.py

@@ -75,21 +75,22 @@ def __init__(
         self.signed = signed
         self.signatures = signatures
 
-    def as_dict(self) -> JsonDict:
-        """Returns the JSON-serializable dictionary representation of self. """
-        return {
-            'signatures': self.signatures,
-            'signed': self.signed.as_dict()
-        }
 
-    def as_json(self, compact: bool = False) -> None:
+    def to_json(self, compact: bool = False) -> None:
         """Returns the optionally compacted JSON representation of self. """
         return json.dumps(
-                self.as_dict(),
+                self.to_dict(),
                 indent=(None if compact else 1),
                 separators=((',', ':') if compact else (',', ': ')),
                 sort_keys=True)
 
+    def to_dict(self) -> JsonDict:
+        """Returns the JSON-serializable dictionary representation of self. """
+        return {
+            'signatures': self.signatures,
+            'signed': self.signed.to_dict()
+        }
+
     def sign(self, key: JsonDict, append: bool = False) -> JsonDict:
         """Creates signature over 'signed' and assigns it to 'signatures'.
 
@@ -151,9 +152,8 @@ def verify(self, key: JsonDict) -> bool:
 
         return True
 
-
     @classmethod
-    def read_from_json(
+    def from_json_file(
             cls, filename: str,
             storage_backend: Optional[StorageBackendInterface] = None
             ) -> 'Metadata':
@@ -196,7 +196,7 @@ def read_from_json(
                 signed=inner_cls(**signable['signed']),
                 signatures=signable['signatures'])
 
-    def write_to_json(
+    def to_json_file(
             self, filename: str, compact: bool = False,
             storage_backend: StorageBackendInterface = None) -> None:
         """Writes the JSON representation of self to file storage.
@@ -214,10 +214,9 @@ def write_to_json(
 
         """
         with tempfile.TemporaryFile() as f:
-            f.write(self.as_json(compact).encode('utf-8'))
+            f.write(self.to_json(compact).encode('utf-8'))
             persist_temp_file(f, filename, storage_backend)
 
-
 class Signed:
     """A base class for the signed part of TUF metadata.
 
@@ -278,7 +277,7 @@ def bump_version(self) -> None:
         """Increments the metadata version number by 1."""
         self.version += 1
 
-    def as_dict(self) -> JsonDict:
+    def to_dict(self) -> JsonDict:
         """Returns the JSON-serializable dictionary representation of self. """
         return {
             '_type': self._type,
@@ -312,9 +311,9 @@ def __init__(self, meta: JsonDict = None, **kwargs) -> None:
         # TODO: Is there merit in creating classes for dict fields?
         self.meta = meta
 
-    def as_dict(self) -> JsonDict:
+    def to_dict(self) -> JsonDict:
         """Returns the JSON-serializable dictionary representation of self. """
-        json_dict = super().as_dict()
+        json_dict = super().to_dict()
         json_dict.update({
             'meta': self.meta
         })
@@ -361,9 +360,9 @@ def __init__(self, meta: JsonDict = None, **kwargs) -> None:
         super().__init__(**kwargs)
         self.meta = meta
 
-    def as_dict(self) -> JsonDict:
+    def to_dict(self) -> JsonDict:
         """Returns the JSON-serializable dictionary representation of self. """
-        json_dict = super().as_dict()
+        json_dict = super().to_dict()
         json_dict.update({
             'meta': self.meta
         })
@@ -446,9 +445,9 @@ def __init__(
         self.targets = targets
         self.delegations = delegations
 
-    def as_dict(self) -> JsonDict:
+    def to_dict(self) -> JsonDict:
         """Returns the JSON-serializable dictionary representation of self. """
-        json_dict = super().as_dict()
+        json_dict = super().to_dict()
         json_dict.update({
             'targets': self.targets,
             'delegations': self.delegations,