Deprecated add_data_qubit to add_qubit [unitaryhack] (#138)

* change

* final-change

* deprecate-warning

* some-html-changes

* Updating-suggested-changes

Author: divshacker

docs/components/host.html

@@ -468,8 +468,8 @@ <h1>Host<a class="headerlink" href="#host" title="Permalink to this headline">¶
 </dd></dl>
 
 <dl class="method">
-<dt id="qunetsim.components.host.Host.add_data_qubit">
-<code class="sig-name descname">add_data_qubit</code><span class="sig-paren">(</span><em class="sig-param">host_id</em>, <em class="sig-param">qubit</em>, <em class="sig-param">q_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#qunetsim.components.host.Host.add_data_qubit" title="Permalink to this definition">¶</a></dt>
+<dt id="qunetsim.components.host.Host.add_qubit">
+<code class="sig-name descname">add_data_qubit</code><span class="sig-paren">(</span><em class="sig-param">host_id</em>, <em class="sig-param">qubit</em>, <em class="sig-param">q_id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#qunetsim.components.host.Host.add_qubit" title="Permalink to this definition">¶</a></dt>
 <dd><p>Adds the data qubit to the data qubit store of a host. If the qubit has an ID, adds the qubit with it,
 otherwise generates an ID for the qubit and adds the qubit with that ID.</p>
 <dl class="field-list simple">
@@ -1616,4 +1616,4 @@ <h1>Host<a class="headerlink" href="#host" title="Permalink to this headline">¶
 
 
 </body>
-</html>
+</html>

docs/genindex.html

@@ -357,7 +357,7 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="components/host.html#qunetsim.components.host.Host.add_connections">add_connections() (qunetsim.components.host.Host method)</a>
 </li>
-      <li><a href="components/host.html#qunetsim.components.host.Host.add_data_qubit">add_data_qubit() (qunetsim.components.host.Host method)</a>
+      <li><a href="components/host.html#qunetsim.components.host.Host.add_qubit">add_qubit() (qunetsim.components.host.Host method)</a>
 </li>
       <li><a href="components/host.html#qunetsim.components.host.Host.add_epr">add_epr() (qunetsim.components.host.Host method)</a>
 </li>
@@ -941,4 +941,4 @@ <h2 id="Z">Z</h2>
 
 
 </body>
-</html>
+</html>

integration_tests/test_host.py

@@ -27,10 +27,10 @@ def test_get_qubits_by_id(self):
         q4 = Qubit(host2)
 
         host.add_epr('B', q1)
-        host.add_data_qubit('C', q2)
+        host.add_qubit('C', q2)
         host.add_ghz_qubit('D', q3)
 
-        host2.add_data_qubit('A', q4)
+        host2.add_qubit('A', q4)
 
         # Test all types of qubits
         self.assertEqual(q1, host.get_qubit_by_id(q1.id))
@@ -48,7 +48,7 @@ def test_get_data_qubit(self):
             host = Host('A')
             q1 = Qubit(host)
 
-            host.add_data_qubit('A', q1)
+            host.add_qubit('A', q1)
 
             qs = host.get_data_qubit('A')
             self.assertIsInstance(qs, Qubit)
@@ -57,7 +57,7 @@ def test_get_qubit(self):
         host = Host('A')
         q1 = Qubit(host)
 
-        host.add_data_qubit('A', q1)
+        host.add_qubit('A', q1)
 
         qs = host.get_qubit('A')
         self.assertIsInstance(qs, Qubit)
@@ -69,13 +69,13 @@ def test_get_data_qubits(self):
             q2 = Qubit(host)
             q3 = Qubit(host)
 
-            host.add_data_qubit('B', q1)
+            host.add_qubit('B', q1)
 
             qs = host.get_data_qubits('B')
             self.assertEqual(len(qs), 1)
 
-            host.add_data_qubit('B', q2)
-            host.add_data_qubit('B', q3)
+            host.add_qubit('B', q2)
+            host.add_qubit('B', q3)
 
             qs = host.get_data_qubits('B')
             self.assertEqual(len(qs), 3)
@@ -92,13 +92,13 @@ def test_get_qubits(self):
         q2 = Qubit(host)
         q3 = Qubit(host)
 
-        host.add_data_qubit('B', q1)
+        host.add_qubit('B', q1)
 
         qs = host.get_qubits('B')
         self.assertEqual(len(qs), 1)
 
-        host.add_data_qubit('B', q2)
-        host.add_data_qubit('B', q3)
+        host.add_qubit('B', q2)
+        host.add_qubit('B', q3)
 
         qs = host.get_qubits('B')
         self.assertEqual(len(qs), 3)
@@ -116,7 +116,7 @@ def test_resetting_qubits(self):
         q3 = Qubit(host)
 
         host.add_epr('B', q1)
-        host.add_data_qubit('B', q2)
+        host.add_qubit('B', q2)
         host.add_ghz_qubit('B', q3)
 
         qs = host.get_qubits('B')

qunetsim/components/host.py

@@ -1341,6 +1341,31 @@ def add_data_qubit(self, host_id, qubit, q_id=None):
         Returns:
             (str): The qubit ID
         """
+        warnings.warn(
+            "The 'add_data_qubit' function has been renamed to"
+            " 'add_qubit'. The 'add_data_qubit' function will be removed in QuNetStim 1.0.",
+            DeprecationWarning,
+            stacklevel=3,
+        )
+        if q_id is not None:
+            qubit.id = q_id
+
+        self._qubit_storage.add_qubit_from_host(qubit, Qubit.DATA_QUBIT, host_id)
+        return qubit.id
+    
+    def add_qubit(self, host_id, qubit, q_id=None):
+        """
+        Adds the data qubit to the data qubit store of a host. If the qubit has an ID, adds the qubit with it,
+        otherwise generates an ID for the qubit and adds the qubit with that ID.
+
+        Args:
+            host_id (str): The ID of the host to pair the qubit
+            qubit (Qubit): The data Qubit to be added.
+            q_id (str): the ID to set the qubit ID to
+        Returns:
+            (str): The qubit ID
+        """
+        )
         if q_id is not None:
             qubit.id = q_id
 

qunetsim/components/protocols.py

@@ -173,7 +173,7 @@ def _rec_qubit(packet):
     receiver = packet.receiver
     qubit = packet.payload
     receiver = network.get_host(receiver)
-    receiver.add_data_qubit(from_host, qubit)
+    receiver.add_qubit(from_host, qubit)
 
     Logger.get_instance().log(
         packet.receiver + ' received qubit ' + packet.payload.id + ' from ' + packet.sender)
@@ -276,7 +276,7 @@ def _rec_teleport(packet):
         host_receiver.add_epr(epr_host, q)
 
     elif payload['type'] == Constants.DATA:
-        host_receiver.add_data_qubit(epr_host, q, q_id=q_id)
+        host_receiver.add_qubit(epr_host, q, q_id=q_id)
 
     # Always send ACK!
     if 'o_seq_num' in payload and 'ack' in payload: