Moved weapons.manager._Weapon to new weapons.instance module and made the class public.

Made listeners.tick.delays._Delay public and added a 'cancel' method to more easily cancel an instance.

Removed '__all__' declaration from listeners.tick.delays and listeners.tick.repeat as the objects are exposed via listeners.tick.__init__

Author: satoon101

Diff for: addons/source-python/packages/source-python/listeners/tick/__init__.py

@@ -8,6 +8,7 @@
 # Source.Python Imports
 #   Listeners
 from listeners import listeners_logger
+from listeners.tick.delays import Delay
 from listeners.tick.delays import tick_delays
 from listeners.tick.repeat import TickRepeat
 from listeners.tick.repeat import TickRepeatStatus
@@ -16,7 +17,8 @@
 # =============================================================================
 # >> ALL DECLARATION
 # =============================================================================
-__all__ = ('TickRepeat',
+__all__ = ('Delay',
+           'TickRepeat',
            'TickRepeatStatus',
            'tick_delays',
            )

Diff for: addons/source-python/packages/source-python/listeners/tick/delays.py

@@ -17,13 +17,6 @@
 from listeners import listeners_logger
 
 
-# =============================================================================
-# >> ALL DECLARATION
-# =============================================================================
-__all__ = ('tick_delays',
-           )
-
-
 # =============================================================================
 # >> GLOBAL VARIABLES
 # =============================================================================
@@ -34,19 +27,19 @@
 # =============================================================================
 # >> CLASSES
 # =============================================================================
-class _Delay(object):
+class Delay(object):
 
     """Stores a callback to be called at a later time."""
 
     def __init__(self, seconds, callback, *args, **kwargs):
         """Called when an instance is instantiated."""
         # Log the init message
         listeners_tick_delays_logger.log_info(
-            '_Delay.__init__ <{0}> <{1}> <{2}> <{3}>'.format(
+            'Delay.__init__ <{0}> <{1}> <{2}> <{3}>'.format(
                 seconds, callback, args, kwargs))
 
         # Store the time to execute the callback
-        self.exec_time = time.time() + seconds
+        self._exec_time = time.time() + seconds
 
         # Store the callback, arguments, and keywords
         self.callback = callback
@@ -57,7 +50,7 @@ def __call__(self):
         """Call the delay with the proper arguments and keywords."""
         # Log the call message
         listeners_tick_delays_logger.log_info(
-            '_Delay.__call__ - Try to call - <{0}> <{1}> <{2}>'.format(
+            'Delay.__call__ - Try to call - <{0}> <{1}> <{2}>'.format(
                 self.callback, self.args, self.kwargs))
 
         # Use try/except in case an error is encountered
@@ -72,6 +65,15 @@ def __call__(self):
             # Print the exception to the console
             except_hooks.print_exception()
 
+    @property
+    def exec_time(self):
+        """Return the time to execute the delayed function."""
+        return self._exec_time
+
+    def cancel(self):
+        """Cancel the delay."""
+        tick_delays.cancel_delay(self)
+
 
 class _Times(list):
 
@@ -157,11 +159,11 @@ def __delitem__(self, item):
 
     def delay(self, seconds, callback, *args, **kwargs):
         """Create a delay."""
-        # Get the _Delay instance for the given arguments
-        delay_object = _Delay(seconds, callback, *args, **kwargs)
+        # Get the Delay instance for the given arguments
+        delay_object = Delay(seconds, callback, *args, **kwargs)
 
-        # Add the _Delay instance to the dictionary using its execution time
-        self[delay_object.exec_time].append(delay_object)
+        # Add the Delay instance to the dictionary using its execution time
+        self[delay_object._exec_time].append(delay_object)
 
         # Return the object
         return delay_object
@@ -199,37 +201,37 @@ def cancel_delay(self, delay_object):
         listeners_tick_delays_logger.log_info(
             'tick_delays.cancel_delay <{0}>'.format(delay_object))
 
-        # Is the given argument a _Delay object?
-        if not isinstance(delay_object, _Delay):
+        # Is the given argument a Delay object?
+        if not isinstance(delay_object, Delay):
 
             # If not, raise an error
             raise TypeError(
-                'tick_delays.cancel_delay requires a _Delay instance.')
+                'tick_delays.cancel_delay requires a Delay instance.')
 
-        # Is the given _Delay object's time no longer in the dictionary?
-        if delay_object.exec_time not in self:
+        # Is the given Delay object's time no longer in the dictionary?
+        if delay_object._exec_time not in self:
 
             # If not, raise an error
             raise KeyError('Object is no longer registered.')
 
         # Log the removing from list message
         listeners_tick_delays_logger.log_info(
             'tick_delays.cancel_delay - Removing from '
-            '<{0}>'.format(delay_object.exec_time))
+            '<{0}>'.format(delay_object._exec_time))
 
         # Remove the delay from its time
-        self[delay_object.exec_time].remove(delay_object)
+        self[delay_object._exec_time].remove(delay_object)
 
         # Does the delay's time have any remaining objects?
-        if not self[delay_object.exec_time]:
+        if not self[delay_object._exec_time]:
 
             # Log the deletion of the time from the dictionary message
             listeners_tick_delays_logger.log_info(
                 'tick_delays.cancel_delay - Removing <{0}> '
-                'from dictionary'.format(delay_object.exec_time))
+                'from dictionary'.format(delay_object._exec_time))
 
             # If not, remove the delay's time from the dictionary
-            del self[delay_object.exec_time]
+            del self[delay_object._exec_time]
 
         # Are there any remaining delays?
         if not self:

Diff for: addons/source-python/packages/source-python/listeners/tick/repeat.py

@@ -19,14 +19,6 @@
 from listeners.tick import listeners_logger
 
 
-# =============================================================================
-# >> ALL DECLARATION
-# =============================================================================
-__all__ = ('TickRepeat',
-           'TickRepeatStatus',
-           )
-
-
 # =============================================================================
 # >> GLOBAL VARIABLES
 # =============================================================================

Diff for: addons/source-python/packages/source-python/weapons/instance.py

@@ -0,0 +1,90 @@
+# ../weapons/instance.py
+
+"""Provides a class to store information specific to each weapon."""
+
+# =============================================================================
+# >> IMPORTS
+# =============================================================================
+# Source.Python Imports
+#   Cvars
+from cvars import ConVar
+
+
+# =============================================================================
+# >> ALL DECLARATION
+# =============================================================================
+__all__ = ('Weapon',
+           )
+
+
+# =============================================================================
+# >> CLASSES
+# =============================================================================
+class Weapon(object):
+
+    """Class used to store information specific to the given weapon."""
+
+    def __init__(self, name, basename, properties):
+        """Store the base attributes for the weapon."""
+        # Store the weapon's full name
+        self._name = name
+
+        # Store the weapon's base name
+        self._basename = basename
+
+        # Store the weapon's slot number
+        self._slot = properties.get('slot', None)
+
+        # Store the weapon's max ammo amount
+        self._maxammo = properties.get('maxammo', None)
+
+        # Store the weapon's ammo property
+        self._ammoprop = properties.get('ammoprop', None)
+
+        # Store the weapon's clip amount
+        self._clip = properties.get('clip', 0)
+
+        # Store the weapon's tags
+        self._tags = properties.get('tags', 'all').split(',')
+
+    @property
+    def name(self):
+        """Return the classname of the weapon."""
+        return self._name
+
+    @property
+    def basename(self):
+        """Return the basename of the weapon."""
+        return self._basename
+
+    @property
+    def slot(self):
+        """Return the slot of the weapon."""
+        return self._slot
+
+    @property
+    def maxammo(self):
+        """Return the maxammo amount for the weapon."""
+        # Is the stored maxammo an integer?
+        if isinstance(self._maxammo, int):
+
+            # Return the value
+            return self._maxammo
+
+        # Get the cvar value of the maxammo
+        return ConVar(self._maxammo).get_int()
+
+    @property
+    def ammoprop(self):
+        """Return the ammoprop of the weapon."""
+        return self._ammoprop
+
+    @property
+    def clip(self):
+        """Return the clip value of the weapon."""
+        return self._clip
+
+    @property
+    def tags(self):
+        """Return the tags of the weapon."""
+        return self._tags

Diff for: addons/source-python/packages/source-python/weapons/manager.py

@@ -12,12 +12,11 @@
 # Source.Python Imports
 #   Core
 from core import GAME_NAME
-#   Cvars
-from cvars import ConVar
 #   Paths
 from paths import SP_DATA_PATH
 #   Weapons
 from weapons.default import NoWeaponManager
+from weapons.instance import Weapon
 
 
 # =============================================================================
@@ -74,13 +73,13 @@ def __init__(self, ini_file):
             name = self._format_name(basename)
 
             # Add the weapon to the dictionary
-            self[name] = _Weapon(name, basename, ini['weapons'][basename])
+            self[name] = Weapon(name, basename, ini['weapons'][basename])
 
             # Add the weapon's tags to the set of tags
             self._tags.update(self[name].tags)
 
     def __getitem__(self, item):
-        """Format the given name."""
+        """Return the Weapon instance for the given weapon."""
         # Format the weapon's name
         name = self._format_name(item)
 
@@ -151,76 +150,6 @@ def tags(self):
         """Return the weapon tags for the server."""
         return self._tags
 
-
-class _Weapon(object):
-
-    """Class used to store information specific to the given weapon."""
-
-    def __init__(self, name, basename, properties):
-        """Store the base attributes for the weapon."""
-        # Store the weapon's full name
-        self._name = name
-
-        # Store the weapon's base name
-        self._basename = basename
-
-        # Store the weapon's slot number
-        self._slot = properties.get('slot', None)
-
-        # Store the weapon's max ammo amount
-        self._maxammo = properties.get('maxammo', None)
-
-        # Store the weapon's ammo property
-        self._ammoprop = properties.get('ammoprop', None)
-
-        # Store the weapon's clip amount
-        self._clip = properties.get('clip', 0)
-
-        # Store the weapon's tags
-        self._tags = properties.get('tags', 'all').split(',')
-
-    @property
-    def name(self):
-        """Return the classname of the weapon."""
-        return self._name
-
-    @property
-    def basename(self):
-        """Return the basename of the weapon."""
-        return self._basename
-
-    @property
-    def slot(self):
-        """Return the slot of the weapon."""
-        return self._slot
-
-    @property
-    def maxammo(self):
-        """Return the maxammo amount for the weapon."""
-        # Is the stored maxammo an integer?
-        if isinstance(self._maxammo, int):
-
-            # Return the value
-            return self._maxammo
-
-        # Get the cvar value of the maxammo
-        return ConVar(self._maxammo).get_int()
-
-    @property
-    def ammoprop(self):
-        """Return the ammoprop of the weapon."""
-        return self._ammoprop
-
-    @property
-    def clip(self):
-        """Return the clip value of the weapon."""
-        return self._clip
-
-    @property
-    def tags(self):
-        """Return the tags of the weapon."""
-        return self._tags
-
 # Does the current game have an ini file?
 if _gamepath.isfile():