<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/23590">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Add type annotations to card_data.py<br><br>Change-Id: Ia09b3ecaa582d62a97c3adac2650686dc19d5ec1<br>---<br>M pySim/card_data.py<br>1 file changed, 30 insertions(+), 26 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/90/23590/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/pySim/card_data.py b/pySim/card_data.py</span><br><span>index ebc63a6..c6820c1 100644</span><br><span>--- a/pySim/card_data.py</span><br><span>+++ b/pySim/card_data.py</span><br><span>@@ -1,35 +1,36 @@</span><br><span> # coding=utf-8</span><br><span style="color: hsl(0, 100%, 40%);">-"""Abstraction of card data that can be queried from external source</span><br><span style="color: hsl(120, 100%, 40%);">+"""Abstraction of card related data that can be queried from external source."""</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-(C) 2021 by Sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(0, 100%, 40%);">-All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+# (C) 2021 by Sysmocom s.f.m.c. GmbH</span><br><span style="color: hsl(120, 100%, 40%);">+# All Rights Reserved</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# Author: Philipp Maier</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is free software: you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+# it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+# the Free Software Foundation, either version 2 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+# (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+# but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+# GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+# along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-Author: Philipp Maier</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-This program is free software: you can redistribute it and/or modify</span><br><span style="color: hsl(0, 100%, 40%);">-it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(0, 100%, 40%);">-the Free Software Foundation, either version 2 of the License, or</span><br><span style="color: hsl(0, 100%, 40%);">-(at your option) any later version.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(0, 100%, 40%);">-but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(0, 100%, 40%);">-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(0, 100%, 40%);">-GNU General Public License for more details.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(0, 100%, 40%);">-along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(0, 100%, 40%);">-"""</span><br><span style="color: hsl(120, 100%, 40%);">+from typing import List, Dict, Optional</span><br><span> </span><br><span> import csv</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-card_data_provider = []</span><br><span style="color: hsl(120, 100%, 40%);">+card_data_provider = List[CardData]</span><br><span> </span><br><span> class CardData(object):</span><br><span> </span><br><span> VALID_FIELD_NAMES = ['ICCID', 'ADM1', 'IMSI', 'PIN1', 'PIN2', 'PUK1', 'PUK2']</span><br><span> </span><br><span> # check input parameters, but do nothing concrete yet</span><br><span style="color: hsl(0, 100%, 40%);">- def get_data(self, fields=[], key='ICCID', value=""):</span><br><span style="color: hsl(120, 100%, 40%);">+ def get_data(self, fields:List[str]=[], key:str='ICCID', value:str="") -> Dict[str,str]:</span><br><span> """abstract implementation of get_data that only verifies the function parameters"""</span><br><span> </span><br><span> for f in fields:</span><br><span>@@ -43,25 +44,28 @@</span><br><span> </span><br><span> return {}</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- def get_field(self, field, key='ICCID', value=""):</span><br><span style="color: hsl(120, 100%, 40%);">+ def get_field(self, field:str, key:str='ICCID', value:str="") -> Optional[str]:</span><br><span> """get a single field from CSV file using a specified key/value pair"""</span><br><span> fields = [field]</span><br><span> result = self.get(fields, key, value)</span><br><span> return result.get(field)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ def get(self, fields:List[str], key:str, value:str) -> Dict[str,str]:</span><br><span style="color: hsl(120, 100%, 40%);">+ """get fields from CSV file using a specified key/value pair"""</span><br><span style="color: hsl(120, 100%, 40%);">+ pass</span><br><span> </span><br><span> class CardDataCsv(CardData):</span><br><span> """card data class that allows the user to query against a specified CSV file"""</span><br><span> csv_file = None</span><br><span> filename = None</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- def __init__(self, filename):</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, filename:str):</span><br><span> self.csv_file = open(filename, 'r')</span><br><span> if not self.csv_file:</span><br><span> raise RuntimeError("Could not open CSV-File '%s'" % filename)</span><br><span> self.filename = filename</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- def get(self, fields, key, value):</span><br><span style="color: hsl(120, 100%, 40%);">+ def get(self, fields:List[str], key:str, value:str) -> Dict[str,str]:</span><br><span> """get fields from CSV file using a specified key/value pair"""</span><br><span> super().get_data(fields, key, value)</span><br><span> </span><br><span>@@ -83,14 +87,14 @@</span><br><span> return rc</span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-def card_data_register(provider, provider_list=card_data_provider):</span><br><span style="color: hsl(120, 100%, 40%);">+def card_data_register(provider:CardData, provider_list=card_data_provider):</span><br><span> """Register a new card data provider"""</span><br><span> if not isinstance(provider, CardData):</span><br><span> raise ValueError("provider is not a card data provier")</span><br><span> provider_list.append(provider)</span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-def card_data_get(fields, key, value, provider_list=card_data_provider):</span><br><span style="color: hsl(120, 100%, 40%);">+def card_data_get(fields, key:str, value:str, provider_list=card_data_provider) -> Dict[str,str]:</span><br><span> """Query all registered card data providers"""</span><br><span> for p in provider_list:</span><br><span> if not isinstance(p, CardData):</span><br><span>@@ -101,7 +105,7 @@</span><br><span> return {}</span><br><span> </span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-def card_data_get_field(field, key, value, provider_list=card_data_provider):</span><br><span style="color: hsl(120, 100%, 40%);">+def card_data_get_field(field:str, key:str, value:str, provider_list=card_data_provider) -> Optional[str]:</span><br><span> """Query all registered card data providers for a single field"""</span><br><span> for p in provider_list:</span><br><span> if not isinstance(p, CardData):</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/23590">change 23590</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/pysim/+/23590"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: pysim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ia09b3ecaa582d62a97c3adac2650686dc19d5ec1 </div>
<div style="display:none"> Gerrit-Change-Number: 23590 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>