Replace all references to gateway with region.

Author: GraylinKim

CHANGELOG.rst

@@ -4,6 +4,7 @@ CHANGELOG
 0.7.0 -
 ---------------------------
 
+* All references to the gateway attribute have been replaced in favor of region; e.g. replay.region
 * Use generic UnitType and Ability classes for data. This means no more unit._type_class.__class__.__name__. But hopefully people were not doing that anyway.
 * Now a CorruptTrackerFileError is raised when the tracker file is corrupted (generally only older resume_from_replay replays)
 * Added replay.resume_from_replay flag. See replay.resume_user_info for additional info.

sc2reader/constants.py

@@ -108,7 +108,7 @@
 
 COLOR_CODES_INV = dict(zip(COLOR_CODES.values(), COLOR_CODES.keys()))
 
-REGIONS = {
+SUBREGIONS = {
     # United States
     'us': {
         1: 'us',

sc2reader/factories/plugins/replay.py

@@ -62,7 +62,7 @@ def toDict(replay):
 
     # Consolidate replay metadata into dictionary
     return {
-        'gateway': getattr(replay, 'gateway', None),
+        'region': getattr(replay, 'region', None),
         'map_name': getattr(replay, 'map_name', None),
         'file_time': getattr(replay, 'file_time', None),
         'filehash': getattr(replay, 'filehash', None),

sc2reader/objects.py

@@ -124,9 +124,6 @@ def __init__(self, sid, slot_data):
         #: The Battle.net region the entity is registered to
         self.region = GATEWAY_LOOKUP[int(parts[0])]
 
-        #: Deprecated, see Entity.region
-        self.gateway = self.region
-
         #: The Battle.net subregion the entity is registered to
         self.subregion = int(parts[2])
 
@@ -198,9 +195,6 @@ def __init__(self, pid, detail_data, attribute_data):
         #: The Battle.net region the entity is registered to
         self.region = GATEWAY_LOOKUP[detail_data['bnet']['region']]
 
-        #: Deprecated, see `Player.region`
-        self.gateway = self.region
-
         #: The Battle.net subregion the entity is registered to
         self.subregion = detail_data['bnet']['subregion']
 
@@ -346,12 +340,7 @@ class PlayerSummary():
     #: Subregion id of player
     subregion = int()
 
-    #: The player's gateway, such as us, eu
-    gateway = str()
-
-    #: The player's region, such as na, la, eu or ru.  This is
-    # provided for convenience, but as of 20121018 is strictly a
-    # function of gateway and subregion.
+    #: The player's region, such as us, eu, sea
     region = str()
 
     #: unknown1

sc2reader/resources.py

@@ -17,7 +17,7 @@
 from sc2reader.data import datapacks
 from sc2reader.exceptions import SC2ReaderLocalizationError, CorruptTrackerFileError
 from sc2reader.objects import Participant, Observer, Computer, Team, PlayerSummary, Graph, BuildEntry, MapInfo
-from sc2reader.constants import REGIONS, GAME_SPEED_FACTOR, LOBBY_PROPERTIES
+from sc2reader.constants import GAME_SPEED_FACTOR, LOBBY_PROPERTIES
 
 
 class Resource(object):
@@ -120,8 +120,8 @@ class Replay(Resource):
     #: The :class:`Length` of the replay in real time adjusted for the game speed
     real_length = None
 
-    #: The gateway the game was played on: us, eu, sea, etc
-    gateway = str()
+    #: The region the game was played on: us, eu, sea, etc
+    region = str()
 
     #: An integrated list of all the game events
     events = list()
@@ -211,7 +211,7 @@ def __init__(self, replay_file, filename=None, load_level=4, engine=sc2reader.en
         self.is_private = False
         self.map = None
         self.map_hash = ""
-        self.gateway = ""
+        self.region = ""
         self.events = list()
         self.teams, self.team = list(), dict()
 
@@ -329,13 +329,13 @@ def load_details(self):
 
             self.map_name = details['map_name']
 
-            self.gateway = details['cache_handles'][0].server.lower()
+            self.region = details['cache_handles'][0].server.lower()
             self.map_hash = details['cache_handles'][-1].hash
             self.map_file = details['cache_handles'][-1]
 
             #Expand this special case mapping
-            if self.gateway == 'sg':
-                self.gateway = 'sea'
+            if self.region == 'sg':
+                self.region = 'sea'
 
             dependency_hashes = [d.hash for d in details['cache_handles']]
             if hashlib.sha256('Standard Data: Swarm.SC2Mod'.encode('utf8')).hexdigest() in dependency_hashes:
@@ -467,7 +467,7 @@ def get_team(team_id):
         self.recorder = None
 
         entity_names = sorted(map(lambda p: p.name, self.entities))
-        hash_input = self.gateway+":"+','.join(entity_names)
+        hash_input = self.region+":"+','.join(entity_names)
         self.people_hash = hashlib.sha256(hash_input.encode('utf8')).hexdigest()
 
         # The presence of observers and/or computer players makes this not actually ladder
@@ -616,17 +616,17 @@ class Map(Resource):
     #: The map description as written by author
     description = str()
 
-    def __init__(self, map_file, filename=None, gateway=None, map_hash=None, **options):
+    def __init__(self, map_file, filename=None, region=None, map_hash=None, **options):
         super(Map, self).__init__(map_file, filename, **options)
 
         #: The unique hash used to identify this map on bnet's depots.
         self.hash = map_hash
 
-        #: The gateway this map was posted to. Maps must be posted individually to each gateway.
-        self.gateway = gateway
+        #: The region this map was posted to. Maps must be posted individually to each region.
+        self.region = region
 
         #: A URL reference to the location of this map on bnet's depots.
-        self.url = Map.get_url(gateway, map_hash)
+        self.url = Map.get_url(self.region, map_hash)
 
         #: The opened MPQArchive for this map
         self.archive = mpyq.MPQArchive(map_file)
@@ -672,12 +672,12 @@ def __init__(self, map_file, filename=None, gateway=None, map_hash=None, **optio
             self.dependencies.append(dependency_node.text)
 
     @classmethod
-    def get_url(cls, gateway, map_hash):
+    def get_url(cls, region, map_hash):
         """Builds a download URL for the map from its components."""
-        if gateway and map_hash:
+        if region and map_hash:
             # it seems like sea maps are stored on us depots.
-            gateway = 'us' if gateway == 'sea' else gateway
-            return cls.url_template.format(gateway, map_hash)
+            region = 'us' if region == 'sea' else region
+            return cls.url_template.format(region, map_hash)
         else:
             return None
 
@@ -837,8 +837,8 @@ def load_translations(self):
                     files.append(utils.DepotFile(file_hash))
             self.localization_urls[language] = files
 
-        # Grab the gateway from the one of the files
-        self.gateway = list(self.localization_urls.values())[0][0].server.lower()
+        # Grab the region from the one of the files
+        self.region = list(self.localization_urls.values())[0][0].server.lower()
 
         # Each of the localization urls points to an XML file with a set of
         # localization strings and their unique ids. After reading these mappings
@@ -1008,9 +1008,9 @@ def load_players(self):
             settings = self.player_settings[index]
             player.is_ai = not isinstance(struct[0][1], dict)
             if not player.is_ai:
-                player.gateway = self.gateway
+                player.region = self.region
                 player.subregion = struct[0][1][0][2]
-                player.region = REGIONS[player.gateway].get(player.subregion, 'Unknown')
+                player.region = REGIONS[player.region].get(player.subregion, 'Unknown')
                 player.bnetid = struct[0][1][0][3]
                 player.unknown1 = struct[0][1][0]
                 player.unknown2 = struct[0][1][1]

sc2reader/utils.py

@@ -328,7 +328,7 @@ def toDict(replay):
 
     # Consolidate replay metadata into dictionary
     return {
-        'gateway': getattr(replay, 'gateway', None),
+        'region': getattr(replay, 'region', None),
         'map_name': getattr(replay, 'map_name', None),
         'file_time': getattr(replay, 'file_time', None),
         'filehash': getattr(replay, 'filehash', None),