Updated docs for v0.5.1

Author: Maxusmusti

docs/index.html

@@ -114,18 +114,18 @@ <h1 class="title">Module <code>state_signals</code></h1>
 @dataclass
 class Signal:
     &#34;&#34;&#34;
-    Standard event signal protocol payload. All required fields, defaults, 
-    and type restrictions are defined in this dataclass. Also includes a 
+    Standard event signal protocol payload. All required fields, defaults,
+    and type restrictions are defined in this dataclass. Also includes a
     method for converting object data to json string.
 
     Fields:
 
-        - publisher_id: A unique id generated by the SignalExporter for identification  
-        - process_name: The name of the process that the state signals are describing  
-        - event: The current state of the process  
-        - runner_host: The host that the process is currently being run on  
-        - sample_no: The current sample number (if applicable, default -1)  
-        - tag: Any user-supplied string tag for the signal (default &#39;No tag specified&#39;)  
+        - publisher_id: A unique id generated by the SignalExporter for identification
+        - process_name: The name of the process that the state signals are describing
+        - event: The current state of the process
+        - runner_host: The host that the process is currently being run on
+        - sample_no: The current sample number (if applicable, default -1)
+        - tag: Any user-supplied string tag for the signal (default &#39;No tag specified&#39;)
         - metadata: Dictionary containing any additional necessary data (optional)
     &#34;&#34;&#34;
 
@@ -165,20 +165,20 @@ <h1 class="title">Module <code>state_signals</code></h1>
 @dataclass
 class Response:
     &#34;&#34;&#34;
-    Standard signal response protocol payload. All required fields, defaults, 
-    and type restrictions are defined in this dataclass. Also includes a 
+    Standard signal response protocol payload. All required fields, defaults,
+    and type restrictions are defined in this dataclass. Also includes a
     method for converting object data to json string.
 
     Fields:
 
-        - responder_id: A unique id generated by the SignalResponder for identification  
-        - publisher_id: The id of the publisher that is being responded to  
-        - event: The published state of the signal-publishing process  
-        - ras: Response Action Success code  
-            - Whether or not the responding process successfully processed/acted upon the signal  
-            - 1 = successful, 0 (or other) = unsuccessful  
+        - responder_id: A unique id generated by the SignalResponder for identification
+        - publisher_id: The id of the publisher that is being responded to
+        - event: The published state of the signal-publishing process
+        - ras: Response Action Success code
+            - Whether or not the responding process successfully processed/acted upon the signal
+            - 1 = successful, 0 (or other) = unsuccessful
             - Not needed when not subscribed or responding to initialization
-        - message: Optional string message for further detail 
+        - message: Optional string message for further detail
     &#34;&#34;&#34;
 
     responder_id: str
@@ -233,11 +233,11 @@ <h1 class="title">Module <code>state_signals</code></h1>
         init: Sets exporter object fields and generates unique publisher_id.
         Allows for specification of redis host/port. Will continue to attempt
         to connect to redis server for conn_timeout seconds. Also allows runner
-        hostname to be inputted manually (otherwise will default to 
-        platform.node() value). 
+        hostname to be inputted manually (otherwise will default to
+        platform.node() value).
         &#34;&#34;&#34;
         self.logger = _create_logger(&#34;SignalExporter&#34;, process_name, log_level)
-        self.subs = []
+        self.subs = set()
         self.proc_name = process_name
         self.runner_host = runner_host
         self.pub_id = process_name + &#34;-&#34; + str(uuid.uuid4())
@@ -314,7 +314,7 @@ <h1 class="title">Module <code>state_signals</code></h1>
                 and data[&#34;event&#34;] == &#34;initialization&#34;
                 and data[&#34;publisher_id&#34;] == self.pub_id
             ):
-                self.subs.append(data[&#34;responder_id&#34;])
+                self.subs.add(data[&#34;responder_id&#34;])
 
         subscriber.subscribe(**{&#34;event-signal-response&#34;: _init_handler})
         self.init_listener = subscriber.run_in_thread()
@@ -328,7 +328,7 @@ <h1 class="title">Module <code>state_signals</code></h1>
         if not self.subs:
             return None, [0], {}
 
-        to_check = set(self.subs)
+        to_check = self.subs.copy()
         subscriber = self.redis.pubsub(ignore_subscribe_messages=True)
         result_code_holder = [ResultCodes.ALL_SUBS_SUCCESS]
         msgs = {}
@@ -385,8 +385,8 @@ <h1 class="title">Module <code>state_signals</code></h1>
 
         Result Codes:
 
-           - ALL_SUBS_SUCCESS = 0 = all subs responded well 
-           - SUB_FAILED = 1 = one or more sub responded badly  
+           - ALL_SUBS_SUCCESS = 0 = all subs responded well
+           - SUB_FAILED = 1 = one or more sub responded badly
            - MISSING_RESPONSE = 2 = not all subs responded
         &#34;&#34;&#34;
         if not isinstance(timeout, int):
@@ -451,7 +451,7 @@ <h1 class="title">Module <code>state_signals</code></h1>
                     &#34;&#39;expected_hosts&#39; arg must be a list of string hostnames&#34;
                 )
             for resp in expected_resps:
-                self.subs.append(resp)
+                self.subs.add(resp)
 
         self.legal_events = legal_events
         sig = self._sig_builder(event=&#34;initialization&#34;, tag=tag)
@@ -505,7 +505,7 @@ <h1 class="title">Module <code>state_signals</code></h1>
         sig = self._sig_builder(event=&#34;shutdown&#34;, tag=tag)
         self.init_listener.stop()
         self.init_listener.join()
-        self.subs = []
+        self.subs = set()
         self.redis.publish(channel=&#34;event-signal-pubsub&#34;, message=sig.to_json_str())
         self.logger.debug(&#34;Shutdown successful!&#34;)
 
@@ -608,7 +608,7 @@ <h1 class="title">Module <code>state_signals</code></h1>
     ) -&gt; None:
         &#34;&#34;&#34;
         Publish a legal response to a certain publisher_id&#39;s event signal.
-        Also allows for optional ras code to be added on (required for 
+        Also allows for optional ras code to be added on (required for
         publisher acknowledgement, but not for initialization response),
         as well as an optional message.
         &#34;&#34;&#34;
@@ -620,7 +620,7 @@ <h1 class="title">Module <code>state_signals</code></h1>
         &#34;&#34;&#34;
         Publish a legal response to a given signal. Serves as a wrapper
         for the respond method. Also allows for optional ras code to be
-        added on (required for publisher acknowledgement, but not for 
+        added on (required for publisher acknowledgement, but not for
         initialization response), as well as an optional message.
         &#34;&#34;&#34;
         self.respond(signal.publisher_id, signal.event, ras, message)
@@ -677,18 +677,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 method for converting object data to json string.</p>
 <h2 id="fields">Fields</h2>
 <ul>
-<li>responder_id: A unique id generated by the SignalResponder for identification
-</li>
-<li>publisher_id: The id of the publisher that is being responded to
-</li>
-<li>event: The published state of the signal-publishing process
-</li>
-<li>ras: Response Action Success code
-<ul>
-<li>Whether or not the responding process successfully processed/acted upon the signal
-</li>
-<li>1 = successful, 0 (or other) = unsuccessful
-</li>
+<li>responder_id: A unique id generated by the SignalResponder for identification</li>
+<li>publisher_id: The id of the publisher that is being responded to</li>
+<li>event: The published state of the signal-publishing process</li>
+<li>ras: Response Action Success code<ul>
+<li>Whether or not the responding process successfully processed/acted upon the signal</li>
+<li>1 = successful, 0 (or other) = unsuccessful</li>
 <li>Not needed when not subscribed or responding to initialization</li>
 </ul>
 </li>
@@ -700,20 +694,20 @@ <h2 id="fields">Fields</h2>
 </summary>
 <pre><code class="python">class Response:
     &#34;&#34;&#34;
-    Standard signal response protocol payload. All required fields, defaults, 
-    and type restrictions are defined in this dataclass. Also includes a 
+    Standard signal response protocol payload. All required fields, defaults,
+    and type restrictions are defined in this dataclass. Also includes a
     method for converting object data to json string.
 
     Fields:
 
-        - responder_id: A unique id generated by the SignalResponder for identification  
-        - publisher_id: The id of the publisher that is being responded to  
-        - event: The published state of the signal-publishing process  
-        - ras: Response Action Success code  
-            - Whether or not the responding process successfully processed/acted upon the signal  
-            - 1 = successful, 0 (or other) = unsuccessful  
+        - responder_id: A unique id generated by the SignalResponder for identification
+        - publisher_id: The id of the publisher that is being responded to
+        - event: The published state of the signal-publishing process
+        - ras: Response Action Success code
+            - Whether or not the responding process successfully processed/acted upon the signal
+            - 1 = successful, 0 (or other) = unsuccessful
             - Not needed when not subscribed or responding to initialization
-        - message: Optional string message for further detail 
+        - message: Optional string message for further detail
     &#34;&#34;&#34;
 
     responder_id: str
@@ -848,18 +842,12 @@ <h3>Class variables</h3>
 method for converting object data to json string.</p>
 <h2 id="fields">Fields</h2>
 <ul>
-<li>publisher_id: A unique id generated by the SignalExporter for identification
-</li>
-<li>process_name: The name of the process that the state signals are describing
-</li>
-<li>event: The current state of the process
-</li>
-<li>runner_host: The host that the process is currently being run on
-</li>
-<li>sample_no: The current sample number (if applicable, default -1)
-</li>
-<li>tag: Any user-supplied string tag for the signal (default 'No tag specified')
-</li>
+<li>publisher_id: A unique id generated by the SignalExporter for identification</li>
+<li>process_name: The name of the process that the state signals are describing</li>
+<li>event: The current state of the process</li>
+<li>runner_host: The host that the process is currently being run on</li>
+<li>sample_no: The current sample number (if applicable, default -1)</li>
+<li>tag: Any user-supplied string tag for the signal (default 'No tag specified')</li>
 <li>metadata: Dictionary containing any additional necessary data (optional)</li>
 </ul></div>
 <details class="source">
@@ -868,18 +856,18 @@ <h2 id="fields">Fields</h2>
 </summary>
 <pre><code class="python">class Signal:
     &#34;&#34;&#34;
-    Standard event signal protocol payload. All required fields, defaults, 
-    and type restrictions are defined in this dataclass. Also includes a 
+    Standard event signal protocol payload. All required fields, defaults,
+    and type restrictions are defined in this dataclass. Also includes a
     method for converting object data to json string.
 
     Fields:
 
-        - publisher_id: A unique id generated by the SignalExporter for identification  
-        - process_name: The name of the process that the state signals are describing  
-        - event: The current state of the process  
-        - runner_host: The host that the process is currently being run on  
-        - sample_no: The current sample number (if applicable, default -1)  
-        - tag: Any user-supplied string tag for the signal (default &#39;No tag specified&#39;)  
+        - publisher_id: A unique id generated by the SignalExporter for identification
+        - process_name: The name of the process that the state signals are describing
+        - event: The current state of the process
+        - runner_host: The host that the process is currently being run on
+        - sample_no: The current sample number (if applicable, default -1)
+        - tag: Any user-supplied string tag for the signal (default &#39;No tag specified&#39;)
         - metadata: Dictionary containing any additional necessary data (optional)
     &#34;&#34;&#34;
 
@@ -1011,11 +999,11 @@ <h3>Methods</h3>
         init: Sets exporter object fields and generates unique publisher_id.
         Allows for specification of redis host/port. Will continue to attempt
         to connect to redis server for conn_timeout seconds. Also allows runner
-        hostname to be inputted manually (otherwise will default to 
-        platform.node() value). 
+        hostname to be inputted manually (otherwise will default to
+        platform.node() value).
         &#34;&#34;&#34;
         self.logger = _create_logger(&#34;SignalExporter&#34;, process_name, log_level)
-        self.subs = []
+        self.subs = set()
         self.proc_name = process_name
         self.runner_host = runner_host
         self.pub_id = process_name + &#34;-&#34; + str(uuid.uuid4())
@@ -1092,7 +1080,7 @@ <h3>Methods</h3>
                 and data[&#34;event&#34;] == &#34;initialization&#34;
                 and data[&#34;publisher_id&#34;] == self.pub_id
             ):
-                self.subs.append(data[&#34;responder_id&#34;])
+                self.subs.add(data[&#34;responder_id&#34;])
 
         subscriber.subscribe(**{&#34;event-signal-response&#34;: _init_handler})
         self.init_listener = subscriber.run_in_thread()
@@ -1106,7 +1094,7 @@ <h3>Methods</h3>
         if not self.subs:
             return None, [0], {}
 
-        to_check = set(self.subs)
+        to_check = self.subs.copy()
         subscriber = self.redis.pubsub(ignore_subscribe_messages=True)
         result_code_holder = [ResultCodes.ALL_SUBS_SUCCESS]
         msgs = {}
@@ -1163,8 +1151,8 @@ <h3>Methods</h3>
 
         Result Codes:
 
-           - ALL_SUBS_SUCCESS = 0 = all subs responded well 
-           - SUB_FAILED = 1 = one or more sub responded badly  
+           - ALL_SUBS_SUCCESS = 0 = all subs responded well
+           - SUB_FAILED = 1 = one or more sub responded badly
            - MISSING_RESPONSE = 2 = not all subs responded
         &#34;&#34;&#34;
         if not isinstance(timeout, int):
@@ -1229,7 +1217,7 @@ <h3>Methods</h3>
                     &#34;&#39;expected_hosts&#39; arg must be a list of string hostnames&#34;
                 )
             for resp in expected_resps:
-                self.subs.append(resp)
+                self.subs.add(resp)
 
         self.legal_events = legal_events
         sig = self._sig_builder(event=&#34;initialization&#34;, tag=tag)
@@ -1283,7 +1271,7 @@ <h3>Methods</h3>
         sig = self._sig_builder(event=&#34;shutdown&#34;, tag=tag)
         self.init_listener.stop()
         self.init_listener.join()
-        self.subs = []
+        self.subs = set()
         self.redis.publish(channel=&#34;event-signal-pubsub&#34;, message=sig.to_json_str())
         self.logger.debug(&#34;Shutdown successful!&#34;)</code></pre>
 </details>
@@ -1319,7 +1307,7 @@ <h3>Methods</h3>
                 &#34;&#39;expected_hosts&#39; arg must be a list of string hostnames&#34;
             )
         for resp in expected_resps:
-            self.subs.append(resp)
+            self.subs.add(resp)
 
     self.legal_events = legal_events
     sig = self._sig_builder(event=&#34;initialization&#34;, tag=tag)
@@ -1391,9 +1379,8 @@ <h3>Methods</h3>
 signal publish/response success, as well as any included response messages.</p>
 <p>Result Codes:</p>
 <ul>
-<li>ALL_SUBS_SUCCESS = 0 = all subs responded well </li>
-<li>SUB_FAILED = 1 = one or more sub responded badly
-</li>
+<li>ALL_SUBS_SUCCESS = 0 = all subs responded well</li>
+<li>SUB_FAILED = 1 = one or more sub responded badly</li>
 <li>MISSING_RESPONSE = 2 = not all subs responded</li>
 </ul></div>
 <details class="source">
@@ -1417,8 +1404,8 @@ <h3>Methods</h3>
 
     Result Codes:
 
-       - ALL_SUBS_SUCCESS = 0 = all subs responded well 
-       - SUB_FAILED = 1 = one or more sub responded badly  
+       - ALL_SUBS_SUCCESS = 0 = all subs responded well
+       - SUB_FAILED = 1 = one or more sub responded badly
        - MISSING_RESPONSE = 2 = not all subs responded
     &#34;&#34;&#34;
     if not isinstance(timeout, int):
@@ -1484,7 +1471,7 @@ <h3>Methods</h3>
     sig = self._sig_builder(event=&#34;shutdown&#34;, tag=tag)
     self.init_listener.stop()
     self.init_listener.join()
-    self.subs = []
+    self.subs = set()
     self.redis.publish(channel=&#34;event-signal-pubsub&#34;, message=sig.to_json_str())
     self.logger.debug(&#34;Shutdown successful!&#34;)</code></pre>
 </details>
@@ -1605,7 +1592,7 @@ <h3>Methods</h3>
     ) -&gt; None:
         &#34;&#34;&#34;
         Publish a legal response to a certain publisher_id&#39;s event signal.
-        Also allows for optional ras code to be added on (required for 
+        Also allows for optional ras code to be added on (required for
         publisher acknowledgement, but not for initialization response),
         as well as an optional message.
         &#34;&#34;&#34;
@@ -1617,7 +1604,7 @@ <h3>Methods</h3>
         &#34;&#34;&#34;
         Publish a legal response to a given signal. Serves as a wrapper
         for the respond method. Also allows for optional ras code to be
-        added on (required for publisher acknowledgement, but not for 
+        added on (required for publisher acknowledgement, but not for
         initialization response), as well as an optional message.
         &#34;&#34;&#34;
         self.respond(signal.publisher_id, signal.event, ras, message)
@@ -1737,7 +1724,7 @@ <h3>Methods</h3>
 ) -&gt; None:
     &#34;&#34;&#34;
     Publish a legal response to a certain publisher_id&#39;s event signal.
-    Also allows for optional ras code to be added on (required for 
+    Also allows for optional ras code to be added on (required for
     publisher acknowledgement, but not for initialization response),
     as well as an optional message.
     &#34;&#34;&#34;
@@ -1762,7 +1749,7 @@ <h3>Methods</h3>
     &#34;&#34;&#34;
     Publish a legal response to a given signal. Serves as a wrapper
     for the respond method. Also allows for optional ras code to be
-    added on (required for publisher acknowledgement, but not for 
+    added on (required for publisher acknowledgement, but not for
     initialization response), as well as an optional message.
     &#34;&#34;&#34;
     self.respond(signal.publisher_id, signal.event, ras, message)</code></pre>
@@ -1864,4 +1851,4 @@ <h4><code><a title="state_signals.SignalResponder" href="#state_signals.SignalRe
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "state-signals"
-version = "0.5.0"
+version = "0.5.1"
 description = "Package for easy management of state/event signal publishing, subscribing, and responding"
 
 license = "GPL-3.0-only"