WIP - getRead/WriteClasses pruning:

Kept isActive check although this must be handled in patchFile

Mopy/bash/game/oblivion/patcher/importers.py:

Initially I did this here too

@@ -39,2 +39,3 @@ class RoadImporter(ImportPatcher, _ARoadImporter):
     logMsg = u'\n=== ' + _(u'Worlds Patched')
+    _read_write_records = ('CELL', 'WRLD', 'ROAD',)
...

but keep in mind there is a silly override in ImportPatcher

    def getReadClasses(self):
        """Returns load factory classes needed for reading."""
        return tuple(
            x.classType for x in self.srcClasses) if self.isActive else ()

This needs some thought - we could bin this along with classestemp
attribute, seems to just complicate stuff

We also must make sure we import correctly

@@ -86,3 +86,3 @@ def _overhaul_compat(self, mods, _skip_id):
 class ListsMerger(_AListsMerger, ListPatcher):
-    _read_write_records = bush.game.listTypes
+    _read_write_records = bush.game.listTypes # is it imported correctly ?

We should add an assert_game_set() on all files that use bush.game to avoid
nasty surprises

Finally, all this needs better names - _read_record_signatures and some
properties to replace getRead/WriteClasses (or rather override class
variables)

Author: Utumno

Mopy/bash/game/oblivion/patcher/special.py

@@ -62,17 +62,14 @@ class _AAlchemicalCatalogs(SpecialPatcher):
     default_isEnabled = True
 
 class AlchemicalCatalogs(_AAlchemicalCatalogs,Patcher):
+    _read_write_records = ('INGR',)
 
     #--Patch Phase ------------------------------------------------------------
     def initPatchFile(self, patchFile):
         super(AlchemicalCatalogs, self).initPatchFile(patchFile)
         self.isActive = (GPath(u'COBL Main.esm') in patchFile.loadSet)
         self.id_ingred = {}
 
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return ('INGR',) if self.isActive else ()
-
     def getWriteClasses(self):
         """Returns load factory classes needed for writing."""
         return ('BOOK',) if self.isActive else ()
@@ -375,6 +372,7 @@ def _pLog(self, log, count):
             log(u'  * %s: %d' % (srcMod.s, count[srcMod]))
 
 class CoblExhaustion(_ACoblExhaustion,ListPatcher):
+    _read_write_records = ('SPEL',)
 
     #--Patch Phase ------------------------------------------------------------
     def initPatchFile(self, patchFile):
@@ -411,14 +409,6 @@ def initData(self,progress):
             self.readFromText(getPatchesPath(srcFile))
             progress.plus()
 
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return ('SPEL',) if self.isActive else ()
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return ('SPEL',) if self.isActive else ()
-
     def scanModFile(self,modFile,progress):
         if not self.isActive: return
         mapper = modFile.getLongMapper()
@@ -558,6 +548,7 @@ def _pLog(self, log, changed):
             log(u'* %s: %d' % (mod.s, changed[mod]))
 
 class MFactMarker(_AMFactMarker,ListPatcher):
+    _read_write_records = ('FACT',)
 
     #--Patch Phase ------------------------------------------------------------
     def initPatchFile(self, patchFile):
@@ -588,14 +579,6 @@ def initData(self,progress):
                     if not rankName: rankName = _(u'Member')
                     id_info[longid] = (morphName,rankName)
 
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return ('FACT',) if self.isActive else ()
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return ('FACT',) if self.isActive else ()
-
     def scanModFile(self, modFile, progress):
         """Scan modFile."""
         if not self.isActive: return
@@ -775,6 +758,8 @@ class _ASEWorldEnforcer(SpecialPatcher):
     default_isEnabled = True
 
 class SEWorldEnforcer(_ASEWorldEnforcer,Patcher):
+    _read_write_records = ('QUST',)
+
     #--Patch Phase ------------------------------------------------------------
     def initPatchFile(self, patchFile):
         super(SEWorldEnforcer, self).initPatchFile(patchFile)
@@ -792,14 +777,6 @@ def initPatchFile(self, patchFile):
                         break
         self.isActive = bool(self.cyrodiilQuests)
 
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return ('QUST',) if self.isActive else ()
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return ('QUST',) if self.isActive else ()
-
     def scanModFile(self,modFile,progress):
         if not self.isActive: return
         if modFile.fileInfo.name == GPath(u'Oblivion.esm'): return

Mopy/bash/patcher/base.py

@@ -74,18 +74,15 @@ def initPatchFile(self, patchFile):
 class Patcher(_Abstract_Patcher):
     """Abstract base class for patcher elements performing a PBash patch - must
     be just before Abstract_Patcher in MRO.""" ##: "performing" ? how ?
-    # would it make any sense to make getRead/WriteClasses() into classmethods
-    # and just define an attribute in the classes - so getReadClasses(cls):
-    # return cls.READ and have in subclasses just READ = 'AMMO' (say)
+    _read_write_records = ()
 
-    #--Patch Phase ------------------------------------------------------------
     def getReadClasses(self):
         """Returns load factory classes needed for reading."""
-        return ()
+        return self.__class__._read_write_records if self.isActive else ()
 
     def getWriteClasses(self):
         """Returns load factory classes needed for writing."""
-        return ()
+        return self.__class__._read_write_records if self.isActive else ()
 
     def initData(self,progress):
         """Compiles material, i.e. reads source text, esp's, etc. as

Mopy/bash/patcher/patchers/multitweak_clothes.py

@@ -236,21 +236,13 @@ class _AClothesTweaker(AMultiTweaker):
     text = _(u"Tweak clothing weight and blocking.")
 
 class ClothesTweaker(_AClothesTweaker,MultiTweaker):
+    _read_write_records = ('CLOT',)
 
     tweaks = sorted(itertools.chain(
         (ClothesTweak_Unblock(*x) for x in _AClothesTweaker._unblock),
         (ClothesTweak_MaxWeight(*x) for x in _AClothesTweaker._max_weight)),
         key=lambda a: a.label.lower())
 
-    #--Patch Phase ------------------------------------------------------------
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return ('CLOT',) if self.isActive else ()
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return ('CLOT',) if self.isActive else ()
-
     def scanModFile(self,modFile,progress):
         if not self.isActive or 'CLOT' not in modFile.tops: return
         mapper = modFile.getLongMapper()

Mopy/bash/patcher/patchers/multitweak_settings.py

@@ -205,20 +205,12 @@ class GmstTweaker(MultiTweaker, _AGmstTweaker):
     editOrder = 29
     class_tweaks = [(GlobalsTweak, bush.game.GlobalsTweaks),
                     (GmstTweak, bush.game.GmstTweaks)]
-
-    #--Patch Phase ------------------------------------------------------------
-    def getReadClasses(self):
-        """Returns load factory classes needed for writing."""
-        return ('GMST','GLOB') if self.isActive else ()
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return ('GMST','GLOB') if self.isActive else ()
+    _read_write_records = ('GMST', 'GLOB')
 
     def scanModFile(self,modFile,progress):
         if not self.isActive: return
         mapper = modFile.getLongMapper()
-        for blockType in ['GMST','GLOB']:
+        for blockType in self._read_write_records:
             if blockType not in modFile.tops: continue
             modBlock = getattr(modFile,blockType)
             patchBlock = getattr(self.patchFile,blockType)

Mopy/bash/patcher/patchers/special.py

@@ -93,29 +93,21 @@ def _overhaul_compat(self, mods, _skip_id):
             self.OverhaulUOPSkips = set()
 
 class ListsMerger(_AListsMerger, ListPatcher):
+    _read_write_records = bush.game.listTypes # bush.game must be set!
 
     #--Patch Phase ------------------------------------------------------------
     def initPatchFile(self, patchFile):
         super(ListsMerger, self).initPatchFile(patchFile)
         self.srcs_ordered = self.srcs
         self.srcs = set(self.srcs) & patchFile.loadSet
-        self.listTypes = bush.game.listTypes
-        self.type_list = dict([(type,{}) for type in self.listTypes])
+        self.type_list = dict([(rec, {}) for rec in self._read_write_records])
         self.masterItems = {}
         self.mastersScanned = set()
         self.levelers = None #--Will initialize later
         self.empties = set()
         _skip_id = lambda x: (GPath(u'Oblivion.esm'), x)
         self._overhaul_compat(self.srcs, _skip_id)
 
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return self.listTypes
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return self.listTypes
-
     def scanModFile(self, modFile, progress):
         """Add lists from modFile."""
         #--Level Masters (complete initialization)
@@ -127,10 +119,10 @@ def scanModFile(self, modFile, progress):
                 self.delevMasters.update(bosh.modInfos[leveler].get_masters())
         #--Begin regular scan
         modName = modFile.fileInfo.name
-        modFile.convertToLongFids(self.listTypes)
+        modFile.convertToLongFids(self._read_write_records)
         #--PreScan for later Relevs/Delevs?
         if modName in self.delevMasters:
-            for list_type in self.listTypes:
+            for list_type in self._read_write_records:
                 for levList in getattr(modFile,list_type).getActiveRecords():
                     masterItems = self.masterItems.setdefault(levList.fid,{})
                     masterItems[modName] = set(
@@ -141,7 +133,7 @@ def scanModFile(self, modFile, progress):
         isRelev = (u'Relev' in configChoice)
         isDelev = (u'Delev' in configChoice)
         #--Scan
-        for list_type in self.listTypes:
+        for list_type in self._read_write_records:
             levLists = self.type_list[list_type]
             newLevLists = getattr(modFile,list_type)
             for newLevList in newLevLists.getActiveRecords():
@@ -190,7 +182,7 @@ def buildPatch(self,log,progress):
         #--Save to patch file
         for label, type in ((_(u'Creature'), 'LVLC'), (_(u'Actor'), 'LVLN'),
                 (_(u'Item'), 'LVLI'), (_(u'Spell'), 'LVSP')):
-            if type not in self.listTypes: continue
+            if type not in self._read_write_records: continue
             log.setHeader(u'=== '+_(u'Merged %s Lists') % label)
             patchBlock = getattr(self.patchFile,type)
             levLists = self.type_list[type]
@@ -210,7 +202,7 @@ def buildPatch(self,log,progress):
         if not self.remove_empty_sublists: return
         for label, type in ((_(u'Creature'), 'LVLC'), (_(u'Actor'), 'LVLN'),
                 (_(u'Item'), 'LVLI'), (_(u'Spell'), 'LVSP')):
-            if type not in self.listTypes: continue
+            if type not in self._read_write_records: continue
             patchBlock = getattr(self.patchFile,type)
             levLists = self.type_list[type]
             #--Empty lists
@@ -465,27 +457,19 @@ class FidListsMerger(_AListsMerger,ListPatcher):
     tip = _(u"Merges changes to formid lists from all active mods.")
     autoKey = {u'Deflst'}
     iiMode = True
+    _read_write_records = ('FLST',)
 
     #--Patch Phase ------------------------------------------------------------
     def initPatchFile(self, patchFile):
         """Prepare to handle specified patch mod. All functions are called
         after this."""
         super(FidListsMerger, self).initPatchFile(patchFile)
         self.srcMods = set(self.getConfigChecked()) & patchFile.loadSet
-        self.listTypes = ('FLST',)
-        self.type_list = dict([(type,{}) for type in self.listTypes])
+        self.type_list = dict([(rec, {}) for rec in self._read_write_records])
         self.masterItems = {}
         self.mastersScanned = set()
         self.levelers = None #--Will initialize later
 
-    def getReadClasses(self):
-        """Returns load factory classes needed for reading."""
-        return self.listTypes
-
-    def getWriteClasses(self):
-        """Returns load factory classes needed for writing."""
-        return self.listTypes
-
     def scanModFile(self, modFile, progress):
         """Add lists from modFile."""
         #--Level Masters (complete initialization)
@@ -497,10 +481,10 @@ def scanModFile(self, modFile, progress):
                 self.deflstMasters.update(bosh.modInfos[leveler].get_masters())
         #--Begin regular scan
         modName = modFile.fileInfo.name
-        modFile.convertToLongFids(self.listTypes)
+        modFile.convertToLongFids(self._read_write_records)
         #--PreScan for later Deflsts?
         if modName in self.deflstMasters:
-            for list_type in self.listTypes:
+            for list_type in self._read_write_records:
                 for levList in getattr(modFile,list_type).getActiveRecords():
                     masterItems = self.masterItems.setdefault(levList.fid,{})
                     # masterItems[modName] = set([entry.listId for entry in levList.entries])
@@ -510,7 +494,7 @@ def scanModFile(self, modFile, progress):
         configChoice = self.configChoices.get(modName,tuple())
         isDeflst = (u'Deflst' in configChoice)
         #--Scan
-        for list_type in self.listTypes:
+        for list_type in self._read_write_records:
             levLists = self.type_list[list_type]
             newLevLists = getattr(modFile,list_type)
             for newLevList in newLevLists.getActiveRecords():