summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-04-19 16:43:54 -0400
committerNed Batchelder <ned@nedbatchelder.com>2021-04-19 16:43:54 -0400
commit1b23b795f5507ac0b6911e3972f8b2806efefe35 (patch)
tree2e8bbcb774785b1fa2ad3d2d7a858247f33a860b
parent90815d959dfff9c42629e3467d6e1a410cce6d04 (diff)
downloadpython-coveragepy-git-1b23b795f5507ac0b6911e3972f8b2806efefe35.tar.gz
docs: clarify that loads/dumps are not related to data files
-rw-r--r--coverage/sqldata.py9
1 files changed, 8 insertions, 1 deletions
diff --git a/coverage/sqldata.py b/coverage/sqldata.py
index a150fdfd..205c56c0 100644
--- a/coverage/sqldata.py
+++ b/coverage/sqldata.py
@@ -320,6 +320,10 @@ class CoverageData(SimpleReprMixin):
suitable for use with :meth:`loads` in the same version of
coverage.py.
+ Note that this serialization is not what gets stored in coverage data
+ files. This method is meant to produce bytes that can be transmitted
+ elsewhere and then deserialized with :meth:`loads`.
+
Returns:
A byte string of serialized data.
@@ -333,11 +337,14 @@ class CoverageData(SimpleReprMixin):
@contract(data='bytes')
def loads(self, data):
- """Deserialize data from :meth:`dumps`
+ """Deserialize data from :meth:`dumps`.
Use with a newly-created empty :class:`CoverageData` object. It's
undefined what happens if the object already has data in it.
+ Note that this is not for reading data from a coverage data file. It
+ is only for use on data you produced with :meth:`dumps`.
+
Arguments:
data: A byte string of serialized data produced by :meth:`dumps`.