Bring localization resources into the SC2Factory.

Renames DepotHash to a more accurate DepotFile. Adds a new
Localization resource and methods to load them from the
factory class. Allows resources to use their parent factory
to load subresources.

Author: GraylinKim

sc2reader/factories.py

@@ -14,7 +14,8 @@
 from sc2reader import exceptions
 from sc2reader import utils
 from sc2reader import log_utils
-from sc2reader.resources import Resource, Replay, Map, GameSummary, MapInfo, MapHeader
+from sc2reader.objects import DepotFile
+from sc2reader.resources import Resource, Replay, Map, GameSummary, MapInfo, MapHeader, Localization
 
 class SC2Factory(object):
     """The SC2Factory class acts as a generic loader interface for all
@@ -69,6 +70,14 @@ def load_replays(self, sources, options=None, **new_options):
         """Loads a collection of sc2replay files, returns a generator."""
         return self.load_all(Replay, sources, options, extension='SC2Replay', **new_options)
 
+    def load_localization(self, source, options=None, **new_options):
+        """Loads a single s2ml file. Accepts file path, url, or file object."""
+        return self.load(Localization, source, options, **new_options)
+
+    def load_localizations(self, sources, options=None, **new_options):
+        """Loads a collection of s2ml files, returns a generator."""
+        return self.load_all(Localization, sources, options, extension='s2ml', **new_options)
+
     def load_map(self, source, options=None, **new_options):
         """Loads a single s2ma file. Accepts file path, url, or file object."""
         return self.load(Map, source, options, **new_options)
@@ -134,7 +143,7 @@ def load_all(self, cls, sources, options=None, **new_options):
 
     # Internal Functions
     def _load(self, cls, resource, filename, options):
-        obj = cls(resource, filename=filename, **options)
+        obj = cls(resource, filename=filename, factory=self, **options)
         for plugin in options.get('plugins',self._get_plugins(cls)):
             # TODO: What if you want to do a transform?
             plugin(obj)
@@ -170,6 +179,9 @@ def _load_resource(self, resource, options=None, **new_options):
         """http links, filesystem locations, and file-like objects"""
         options = options or self._get_options(Resource, **new_options)
 
+        if isinstance(resource, DepotFile):
+            resource = resource.url
+
         if isinstance(resource, basestring):
             if re.match(r'https?://',resource):
                 self.logger.info("Fetching remote resource: "+resource)

sc2reader/objects.py

@@ -14,17 +14,24 @@
 ColorData = namedtuple('ColorData',['a','r','g','b'])
 BnetData = namedtuple('BnetData',['unknown1','unknown2','subregion','uid'])
 
-class DepotHash(object):
+class DepotFile(object):
     url_template = 'http://{0}.depot.battle.net:1119/{1}.{2}'
 
     def __init__(self, bytes):
         self.server = bytes[4:8].strip('\x00 ')
         self.hash = bytes[8:].encode('hex')
         self.type = bytes[0:4]
 
-    def __str__(self):
+    @property
+    def url(self):
         return self.url_template.format(self.server, self.hash, self.type)
 
+    def __hash__(self):
+        return hash(self.url)
+
+    def __str__(self):
+        return self.url
+
 
 class Team(object):
     """

sc2reader/resources.py

@@ -15,7 +15,7 @@
 from sc2reader import utils
 from sc2reader import log_utils
 from sc2reader import readers, data
-from sc2reader.objects import Player, Observer, Team, PlayerSummary, Graph, DepotHash
+from sc2reader.objects import Player, Observer, Team, PlayerSummary, Graph, DepotFile
 from sc2reader.constants import REGIONS, LOCALIZED_RACES, GAME_SPEED_FACTOR, GAME_SPEED_CODES, RACE_CODES, PLAYER_TYPE_CODES, TEAM_COLOR_CODES, GAME_FORMAT_CODES, GAME_TYPE_CODES, DIFFICULTY_CODES
 
 
@@ -29,7 +29,8 @@ def real_type(teams):
 
 
 class Resource(object):
-    def __init__(self, file_object, filename=None, **options):
+    def __init__(self, file_object, filename=None, factory=None, **options):
+        self.factory = factory
         self.opt = utils.AttributeDict(options)
         self.logger = log_utils.get_logger(self.__class__)
         self.filename = filename or getattr(file_object,'name','Unavailable')
@@ -619,6 +620,17 @@ def get_url(cls, gateway, map_hash):
         else:
             return None
 
+class Localization(Resource):
+
+    def __init__(self, s2ml_file, **options):
+        super(Localization, self).__init__(s2ml_file, **options)
+        self.mapping = dict()
+        xml = ElementTree.parse(s2ml_file)
+        for entry in xml.findall('e'):
+            self.mapping[int(entry.attrib['id'])] = entry.text
+
+    def __getitem__(self, key):
+        return self.mapping[key]
 
 class GameSummary(Resource):
 
@@ -710,9 +722,7 @@ def __init__(self, summary_file, filename=None, **options):
         # The s2gs file also keeps reference to a series of s2mv files
         # Some of these appear to be encoded bytes and others appear to be
         # the preview images that authors may bundle with their maps.
-        self.s2mv_urls = [str(DepotHash(file_hash)) for file_hash in self.parts[0][6][7]]
-
-
+        self.s2mv_urls = [str(DepotFile(file_hash)) for file_hash in self.parts[0][6][7]]
 
     def load_translations(self):
         # This section of the file seems to map numerical ids to their
@@ -758,7 +768,7 @@ def load_translations(self):
             files = list()
             for file_hash in localization[1]:
                 if file_hash[:4] != '\x00\x00\x00\x00':
-                    files.append(DepotHash(file_hash))
+                    files.append(DepotFile(file_hash))
             self.localization_urls[language] = files
 
         # Grab the gateway from the one of the files
@@ -772,15 +782,12 @@ def load_translations(self):
         # For now we'll only do this for english localizations.
         self.lang_sheets = dict()
         self.translations =  dict()
-        for lang,urls in self.localization_urls.items():
+        for lang, files in self.localization_urls.items():
             if lang != 'enUS': continue
 
             sheets = dict()
-            for sheet, url in enumerate(urls):
-                print "Opening ", str(url)
-                xml = ElementTree.parse(urllib2.urlopen(str(url)))
-                translation = dict((int(e.attrib['id']),e.text) for e in xml.findall('e'))
-                sheets[sheet] = translation
+            for sheet, depot_file in enumerate(files):
+                sheets[sheet] = self.factory.load_localization(depot_file)
 
             translation = dict()
             for uid, (sheet, item) in self.id_map.items():
@@ -917,8 +924,6 @@ def load_players(self):
             player = PlayerSummary(struct[0][0])
             stats = self.player_stats[index]
             settings = self.player_settings[index]
-            print settings
-            print stats
             player.is_ai = not isinstance(struct[0][1], dict)
             if not player.is_ai:
                 player.region = self.region