Add more documentation to the classes/methods
* add type annotations in-line with PEP484
* convert existing documentation to follow the
"Google Python Style Guide" format understood by
the sphinx.ext.napoleon' extension
* add much more documentation all over the code base
Change-Id: I6ac88e0662cf3c56ae32d86d50b18a8b4150571a
diff --git a/pySim/transport/calypso.py b/pySim/transport/calypso.py
index 7f99d21..467d5ee 100644
--- a/pySim/transport/calypso.py
+++ b/pySim/transport/calypso.py
@@ -1,9 +1,5 @@
# -*- coding: utf-8 -*-
-""" pySim: Transport Link for Calypso bases phones
-"""
-
-#
# Copyright (C) 2018 Vadim Yanitskiy <axilirator@gmail.com>
#
# This program is free software: you can redistribute it and/or modify
@@ -73,8 +69,9 @@
self.data += pdu
class CalypsoSimLink(LinkBase):
+ """Transport Link for Calypso based phones."""
- def __init__(self, sock_path = "/tmp/osmocom_l2"):
+ def __init__(self, sock_path:str = "/tmp/osmocom_l2"):
# Make sure that a given socket path exists
if not os.path.exists(sock_path):
raise ReaderError("There is no such ('%s') UNIX socket" % sock_path)
@@ -119,7 +116,6 @@
pass # Nothing to do really ...
def send_apdu_raw(self, pdu):
- """see LinkBase.send_apdu_raw"""
# Request FULL reset
req_msg = L1CTLMessageSIM(h2b(pdu))