Move the DepotFile class to utils.

Author: GraylinKim

docs/source/primaryresources.rst docs/source/mainobjects.rstdocs/source/primaryresources.rst renamed to docs/source/mainobjects.rst

@@ -12,7 +12,6 @@
 import urlparse, time
 from sc2reader import utils
 from sc2reader import log_utils
-from sc2reader.objects import DepotFile
 from sc2reader.resources import Resource, Replay, Map, GameSummary, MapInfo, MapHeader, Localization
 
 @log_utils.loggable
@@ -186,7 +185,7 @@ 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):
+        if isinstance(resource, utils.DepotFile):
             resource = resource.url
 
         if isinstance(resource, basestring):

docs/source/utilityclasses.rst docs/source/utilities.rstdocs/source/utilityclasses.rst renamed to docs/source/utilities.rst

@@ -12,25 +12,6 @@
 ColorData = namedtuple('ColorData',['a','r','g','b'])
 BnetData = namedtuple('BnetData',['gateway','unknown2','subregion','uid'])
 
-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]
-
-    @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):
     """
     The team object primarily a container object for organizing :class:`Player`

sc2reader/factories.py

@@ -11,7 +11,7 @@
 from sc2reader.events.game import *
 from sc2reader.events.message import *
 from sc2reader.events.tracker import *
-from sc2reader.utils import AttributeDict
+from sc2reader.utils import AttributeDict, DepotFile
 from sc2reader.decoders import BitPackedDecoder, ByteDecoder
 
 class Reader(object):

sc2reader/objects.py

@@ -24,7 +24,7 @@
 from sc2reader import exceptions
 from sc2reader.data import builds as datapacks
 from sc2reader.exceptions import SC2ReaderLocalizationError
-from sc2reader.objects import Player, Observer, Team, PlayerSummary, Graph, DepotFile, BuildEntry
+from sc2reader.objects import Player, Observer, Team, PlayerSummary, Graph, BuildEntry
 from sc2reader.constants import REGIONS, LOCALIZED_RACES, GAME_SPEED_FACTOR, LOBBY_PROPERTIES, GATEWAY_LOOKUP
 
 
@@ -761,7 +761,7 @@ def __init__(self, summary_file, filename=None, lang='enUS', **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(DepotFile(file_hash)) for file_hash in self.parts[0][6][7]]
+        self.s2mv_urls = [str(utils.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
@@ -807,7 +807,7 @@ def load_translations(self):
             files = list()
             for file_hash in localization[1]:
                 if file_hash[:4] != '\x00\x00\x00\x00':
-                    files.append(DepotFile(file_hash))
+                    files.append(utils.DepotFile(file_hash))
             self.localization_urls[language] = files
 
         # Grab the gateway from the one of the files

sc2reader/readers.py

@@ -8,6 +8,39 @@
 from sc2reader.exceptions import MPQError
 from sc2reader.constants import COLOR_CODES, COLOR_CODES_INV
 
+class DepotFile(object):
+    """
+    :param bytes: The raw bytes representing the depot file
+
+    The DepotFile object parses bytes for a dependency into their components
+    and assembles them into a URL so that the dependency can be fetched.
+    """
+
+    #: The url template for all DepotFiles
+    url_template = 'http://{0}.depot.battle.net:1119/{1}.{2}'
+
+    def __init__(self, bytes):
+        #: The server the file is hosted on
+        self.server = bytes[4:8].strip('\x00 ')
+
+        #: The unique content based hash of the file
+        self.hash = bytes[8:].encode('hex')
+
+        #: The extension of the file on the server
+        self.type = bytes[0:4]
+
+    @property
+    def url(self):
+        """ Returns url of the depot file. """
+        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 PersonDict(dict):
     """
     Supports lookup on both the player name and player id