Type annotations for gates, quilatom, and quilbase modules (#999)

CHANGELOG.md

@@ -78,6 +78,8 @@ Changelog
     the `--runslow` option is specified for `pytest` (@kilimanjaro, gh-1001).
 -   `PauliSum` objects can now be constructed from strings via `from_compact_str()`
     and `PauliTerm.from_compact_str()` supports multi-qubit strings (@jlbosse, gh-984).
+-   Type hints have been added to the `pyquil.gates`, `pyquil.quilatom`, and `pyquil.quilbase`
+    modules (@appleby gh-999).
 
 ### Bugfixes
 

pyquil/_parser/PyQuilListener.py

@@ -279,7 +279,11 @@ def exitLogicalBinaryOp(self, ctx):
         if ctx.AND():
             self.result.append(ClassicalAnd(left, right))
         elif ctx.OR():
-            self.result.append(ClassicalOr(left, right))
+            if isinstance(right, MemoryReference):
+                self.result.append(ClassicalOr(left, right))
+            else:
+                raise RuntimeError("Right operand of deprecated OR instruction must be a"
+                                   f" MemoryReference, but found '{right}'")
         elif ctx.IOR():
             self.result.append(ClassicalInclusiveOr(left, right))
         elif ctx.XOR():

pyquil/api/_base_connection.py

@@ -367,7 +367,7 @@ def _qvm_run(self, quil_program, classical_addresses, trials,
         return ram
 
     @_record_call
-    def _qvm_get_version_info(self) -> dict:
+    def _qvm_get_version_info(self) -> str:
         """
         Return version information for the QVM.
 

pyquil/api/_quantum_computer.py

@@ -42,7 +42,7 @@
 from pyquil.quil import Program, validate_supported_quil
 
 
-Executable = Union[BinaryExecutableResponse, PyQuilExecutableResponse]
+ExecutableDesignator = Union[BinaryExecutableResponse, PyQuilExecutableResponse]
 
 
 class QuantumComputer:
@@ -107,7 +107,7 @@ def get_isa(self, oneq_type: str = 'Xhalves',
         return self.device.get_isa(oneq_type=oneq_type, twoq_type=twoq_type)
 
     @_record_call
-    def run(self, executable: Executable,
+    def run(self, executable: ExecutableDesignator,
             memory_map: Dict[str, List[Union[int, float]]] = None) -> np.ndarray:
         """
         Run a quil executable. If the executable contains declared parameters, then a memory
@@ -261,7 +261,7 @@ def compile(
             protoquil_positional: bool = None,
             *,
             protoquil: bool = None,
-    ) -> Union[BinaryExecutableResponse, PyQuilExecutableResponse]:
+    ) -> ExecutableDesignator:
         """
         A high-level interface to program compilation.
 

pyquil/api/_qvm.py

@@ -140,7 +140,7 @@ def get_version_info(self):
         """
         Return version information for the QVM.
 
-        :return: Dictionary with version information
+        :return: String with version information
         """
         return self._connection._qvm_get_version_info()
 
@@ -448,7 +448,7 @@ def get_version_info(self):
         """
         Return version information for the QVM.
 
-        :return: Dictionary with version information
+        :return: String with version information
         """
         return self.connection._qvm_get_version_info()