doc improvements, unicode support for IDs

Author: mhowes

docs/tm/services/dsf.rst

@@ -15,6 +15,19 @@ The following function is primarily a helper function which performs an API
 
 .. autofunction:: dyn.tm.services.dsf.get_all_dsf_monitors
 
+.. autofunction:: dyn.tm.services.dsf.get_all_notifiers
+
+.. autofunction:: dyn.tm.services.dsf.get_all_records
+
+.. autofunction:: dyn.tm.services.dsf.get_all_record_sets
+
+.. autofunction:: dyn.tm.services.dsf.get_all_failover_chains
+
+.. autofunction:: dyn.tm.services.dsf.get_all_response_pools
+
+.. autofunction:: dyn.tm.services.dsf.get_all_rulesets
+
+
 Classes
 -------
 .. toctree::

docs/tm/services/dsf/dsf.rst

@@ -804,7 +804,7 @@ dyn.tm System and how to edit some of the fields using the returned
     >>> #Now, lets create a Node object. This is used for attaching the service to a Node (or zone)
     >>> node = Node('example.com',fqdn = 'example.com.')
     >>>
-    >>> Finally, we pass all of this in. upon command execution the service will have been created.
+    >>> #Finally, we pass all of this in. upon command execution the service will have been created.
     >>>
     >>> dsf = TrafficDirector('Test_Service', rulesets=[ruleset], nodes=[node], notifiers=[notifier])
 
@@ -831,7 +831,7 @@ Traffic Director SDK Caveats
 *  Creating a fully populated service with prototypes leaves the prototypes unusable.
    CRUD capabilities can only be achieved   by accessing data within the
    :class:`TrafficDirector` object.
-   Accessors are `records`, `record_sets`, `failover_chains`, `response_pools`, `rulesets`
+   Accessors are :param:`records`, :mod:`record_sets`, `failover_chains`, `response_pools`, `rulesets`
 
 *  Accessors like in the previous bullet point only work if the object is fully linked to the service.
    In other words, you can have a full response_pool, but if it does not belong to a ruleset, then it will
@@ -843,13 +843,13 @@ Traffic Director SDK Caveats
    This is becasue these record trees are built from the ruleset, and if one response pool belongs to multiple
    Rulesets, then its children will appear as many times as is exists as a ruleset member.
 
-*  :param refresh(): is your friend. When modifying child objects from a parent sometimes the parent doesn't know about
+*  :param:`refresh()` is your friend. When modifying child objects from a parent sometimes the parent doesn't know about
    the changes. If you do a refresh() on the :class:`TrafficDirector` object it will pull down the latest data
    from the Dynect System.
 
-*  :param publish(): is run on the :class:`TrafficDirector` as a whole, even when run from a child object.
+*  :param:`publish()` is run on the :class:`TrafficDirector` as a whole, even when run from a child object.
 
-*  :param implicitPublish: is non cascading. It is locally bound to the specific object, or child object.
+*  :param:`implicitPublish` is non cascading. It is locally bound to the specific object, or child object.
 
 
 

dyn/tm/services/dsf.py

@@ -129,7 +129,7 @@ def get_all_dsf_monitors():
 def _checkType(service):
     if isinstance(service, TrafficDirector):
         _service_id = service.service_id
-    elif type(service) is str:
+    elif type(service) is str or type(service) is unicode:
         _service_id = service
     else:
         raise Exception('Value must be string, or TrafficDirector Object')
@@ -309,7 +309,7 @@ def add_to_record_set(self, record_set, service = None, publish = True):
         if isinstance(record_set, DSFRecordSet):
             _record_set_id = record_set._dsf_record_set_id
             _service_id = record_set._service_id
-        elif type(record_set) is str:
+        elif type(record_set) is str or type(record_set) is unicode:
             if service is None:
                 raise Exception('When record_set as a string, you must provide the service_id as service=')
             _record_set_id = record_set
@@ -1549,7 +1549,7 @@ def add_to_failover_chain(self, failover_chain, service=None, publish=True):
         if isinstance(failover_chain, DSFFailoverChain):
             _dsf_record_set_failover_chain_id = failover_chain._dsf_record_set_failover_chain_id
             _service_id = failover_chain._service_id
-        elif type(failover_chain) is str:
+        elif type(failover_chain) is str or type(failover_chain) is unicode:
             if service is None:
                 raise Exception('If passing failover_chain as a string, you must provide the service_id as service=')
             _dsf_record_set_failover_chain_id = failover_chain
@@ -1715,7 +1715,7 @@ def set_monitor(self, monitor):
         """
         if isinstance(monitor, DSFMonitor):
             _monitor_id = monitor._dsf_monitor_id
-        elif type(monitor) is str:
+        elif type(monitor) is str or type(monitor) is unicode:
             _monitor_id = monitor
         else:
             raise Exception('Could not make sense of Monitor Type')
@@ -1919,7 +1919,7 @@ def add_to_response_pool(self, response_pool, service=None, publish=True):
         if isinstance(response_pool, DSFResponsePool):
             _response_pool_id = response_pool._dsf_response_pool_id
             _service_id = response_pool._service_id
-        elif type(response_pool) is str:
+        elif type(response_pool) is str or type(response_pool) is unicode:
             if service is None:
                 raise Exception('If passing response_pool as a string, you must provide the service_id as service=')
             _response_pool_id = response_pool
@@ -2397,7 +2397,7 @@ def add_response_pool(self, response_pool, index=0, publish=True):
         """
         if isinstance(response_pool, DSFResponsePool):
             _response_pool_id = response_pool._dsf_response_pool_id
-        elif type(response_pool) is str:
+        elif type(response_pool) is str or type(response_pool) is unicode:
             _response_pool_id = response_pool
         else:
             raise Exception('Could not make sense of Response Pool Type')
@@ -2426,7 +2426,7 @@ def remove_response_pool(self, response_pool, publish=True):
         if isinstance(response_pool, DSFResponsePool):
             _response_pool_id = response_pool._dsf_response_pool_id
             _service_id = response_pool._service_id
-        elif type(response_pool) is str:
+        elif type(response_pool) is str or type(response_pool) is unicode:
             _response_pool_id = response_pool
         else:
             raise Exception('Could not make sense of Response Pool Type')
@@ -2471,7 +2471,7 @@ def order_response_pools(self, pool_list, publish=True):
         for list_item in pool_list:
             if isinstance(list_item, DSFResponsePool):
                 _pool_list.append(list_item._dsf_response_pool_id)
-            elif type(list_item) is str:
+            elif type(list_item) is str or type(list_item) is unicode:
                 _pool_list.append(list_item)
         api_args = dict()
         api_args['response_pools'] = list()