aboutsummaryrefslogtreecommitdiff
path: root/pyecsca/sca/target/binary.py
diff options
context:
space:
mode:
Diffstat (limited to 'pyecsca/sca/target/binary.py')
-rw-r--r--pyecsca/sca/target/binary.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/pyecsca/sca/target/binary.py b/pyecsca/sca/target/binary.py
index 0455c75..3e2877b 100644
--- a/pyecsca/sca/target/binary.py
+++ b/pyecsca/sca/target/binary.py
@@ -1,3 +1,6 @@
+"""
+This module provides a binary target class which represents a target that is a runnable binary on the host.
+"""
import subprocess
from subprocess import Popen
from typing import Optional, Union, List
@@ -9,6 +12,7 @@ from .serial import SerialTarget
@public
class BinaryTarget(SerialTarget):
+ """A binary target that is runnable on the host and communicates using the stdin/stdout streams."""
binary: List[str]
process: Optional[Popen] = None
debug_output: bool
@@ -26,7 +30,7 @@ class BinaryTarget(SerialTarget):
self.process = Popen(self.binary, stdin=subprocess.PIPE, stdout=subprocess.PIPE,
text=True, bufsize=1)
- def write(self, data: bytes):
+ def write(self, data: bytes) -> None:
if self.process is None:
raise ValueError
if self.debug_output: