Changes between Version 15 and Version 16 of CodingStandards

Timestamp:

2011-09-26T22:41:20Z (13 years ago)

Author:

davidsarah

Comment:

s/_assert_consistency/_assert_invariants/

CodingStandards

@@ -82 +82 @@
 
 {{{
-def _assert_consistency(self):
+def _assert_invariants(self):
     # All of the keys in all of these dicts are required to be ids.
     for d in (self.bId2chunkobj, self.bId2peers, self.Idsofwantedblocks, self.Idsoflocatedblocks,):
@@ -95 +95 @@
 }}}      
 
-Now you can put {{{assert self._assert_consistency()}}} everywhere in your class where the class ought to be in an internally consistent state. For example, at the beginning of every externally-callable method. This technique can be very valuable in developing a complex class -- it catches bugs early, it isolates bugs into specific code paths, and it clarifies the internal structure of the class so that other developers can hack on it without subtle misunderstandings.
+Now you can put {{{assert self._assert_invariants()}}} everywhere in your class where the class ought to be in an internally consistent state. For example, at the beginning of every externally-callable method. This technique can be very valuable in developing a complex class -- it catches bugs early, it isolates bugs into specific code paths, and it clarifies the internal structure of the class so that other developers can hack on it without subtle misunderstandings.
+
+* we actually appear to only have one instance of this pattern in Tahoe at time of writing, in {{{allmydata.util.dictutil}}}. It has the disadvantage of cluttering up the logic with calls to {{{_assert_invariants}}}, and should probably be used sparingly. -- DavidSarah
 
 === configuration ===