<p>laforge has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/pysim/+/23709">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">filesystem: Introduce 'construct' support<br><br>This allows for pure declarative encoders/decoders for linear fixed<br>and transparent EFs.<br><br>Change-Id: Id0765ec3ddb8c044838ce47d0ff8740720a32b15<br>---<br>M pySim/construct.py<br>M pySim/filesystem.py<br>2 files changed, 36 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/pysim refs/changes/09/23709/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/pySim/construct.py b/pySim/construct.py</span><br><span>index 03d284e..839497c 100644</span><br><span>--- a/pySim/construct.py</span><br><span>+++ b/pySim/construct.py</span><br><span>@@ -1,5 +1,5 @@</span><br><span> from construct import *</span><br><span style="color: hsl(0, 100%, 40%);">-from pySim.utils import b2h, h2b</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.utils import b2h, h2b, swap_nibbles</span><br><span> </span><br><span> """Utility code related to the integration of the 'construct' declarative parser."""</span><br><span> </span><br><span>@@ -26,6 +26,13 @@</span><br><span> def _encode(self, obj, context, path):</span><br><span> return h2b(obj)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+class BcdAdapter(Adapter):</span><br><span style="color: hsl(120, 100%, 40%);">+ """convert a bytes() type to a string of BCD nibbles."""</span><br><span style="color: hsl(120, 100%, 40%);">+ def _decode(self, obj, context, path):</span><br><span style="color: hsl(120, 100%, 40%);">+ return swap_nibbles(b2h(obj))</span><br><span style="color: hsl(120, 100%, 40%);">+ def _encode(self, obj, context, path):</span><br><span style="color: hsl(120, 100%, 40%);">+ return h2b(swap_nibbles(obj))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> def filter_dict(d, exclude_prefix='_'):</span><br><span> """filter the input dict to ensure no keys starting with 'exclude_prefix' remain."""</span><br><span> res = {}</span><br><span>diff --git a/pySim/filesystem.py b/pySim/filesystem.py</span><br><span>index e771f3c..49520c3 100644</span><br><span>--- a/pySim/filesystem.py</span><br><span>+++ b/pySim/filesystem.py</span><br><span>@@ -35,6 +35,7 @@</span><br><span> from typing import cast, Optional, Iterable, List, Any, Dict, Tuple</span><br><span> </span><br><span> from pySim.utils import sw_match, h2b, b2h, is_hex</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.construct import filter_dict</span><br><span> from pySim.exceptions import *</span><br><span> from pySim.jsonpath import js_path_find, js_path_modify</span><br><span> </span><br><span>@@ -466,6 +467,7 @@</span><br><span> size : tuple of (minimum_size, recommended_size)</span><br><span> """</span><br><span> super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent)</span><br><span style="color: hsl(120, 100%, 40%);">+ self._construct = None</span><br><span> self.size = size</span><br><span> self.shell_commands = [self.ShellCommands()]</span><br><span> </span><br><span>@@ -487,6 +489,8 @@</span><br><span> method = getattr(self, '_decode_hex', None)</span><br><span> if callable(method):</span><br><span> return method(b2h(raw_bin_data))</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.parse(raw_bin_data, total_len=len(raw_bin_data)))</span><br><span> return {'raw': raw_bin_data.hex()}</span><br><span> </span><br><span> def decode_hex(self, raw_hex_data:str) -> dict:</span><br><span>@@ -508,6 +512,8 @@</span><br><span> method = getattr(self, '_decode_bin', None)</span><br><span> if callable(method):</span><br><span> return method(raw_bin_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.parse(raw_bin_data, total_len=len(raw_bin_data)))</span><br><span> return {'raw': raw_bin_data.hex()}</span><br><span> </span><br><span> def encode_bin(self, abstract_data:dict) -> bytearray:</span><br><span>@@ -528,6 +534,8 @@</span><br><span> method = getattr(self, '_encode_hex', None)</span><br><span> if callable(method):</span><br><span> return h2b(method(abstract_data))</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._construct.build(abstract_data)</span><br><span> raise NotImplementedError</span><br><span> </span><br><span> def encode_hex(self, abstract_data:dict) -> str:</span><br><span>@@ -549,6 +557,8 @@</span><br><span> if callable(method):</span><br><span> raw_bin_data = method(abstract_data)</span><br><span> return b2h(raw_bin_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return b2h(self._construct.build(abstract_data))</span><br><span> raise NotImplementedError</span><br><span> </span><br><span> </span><br><span>@@ -683,6 +693,7 @@</span><br><span> super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent)</span><br><span> self.rec_len = rec_len</span><br><span> self.shell_commands = [self.ShellCommands()]</span><br><span style="color: hsl(120, 100%, 40%);">+ self._construct = None</span><br><span> </span><br><span> def decode_record_hex(self, raw_hex_data:str) -> dict:</span><br><span> """Decode raw (hex string) data into abstract representation.</span><br><span>@@ -703,6 +714,8 @@</span><br><span> method = getattr(self, '_decode_record_bin', None)</span><br><span> if callable(method):</span><br><span> return method(raw_bin_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.parse(raw_bin_data, total_len=len(raw_bin_data)))</span><br><span> return {'raw': raw_bin_data.hex()}</span><br><span> </span><br><span> def decode_record_bin(self, raw_bin_data:bytearray) -> dict:</span><br><span>@@ -724,6 +737,8 @@</span><br><span> method = getattr(self, '_decode_record_hex', None)</span><br><span> if callable(method):</span><br><span> return method(raw_hex_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.parse(raw_bin_data, total_len=len(raw_bin_data)))</span><br><span> return {'raw': raw_hex_data}</span><br><span> </span><br><span> def encode_record_hex(self, abstract_data:dict) -> str:</span><br><span>@@ -745,6 +760,8 @@</span><br><span> if callable(method):</span><br><span> raw_bin_data = method(abstract_data)</span><br><span> return b2h(raw_bin_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return b2h(self._construct.build(abstract_data))</span><br><span> raise NotImplementedError</span><br><span> </span><br><span> def encode_record_bin(self, abstract_data:dict) -> bytearray:</span><br><span>@@ -765,6 +782,8 @@</span><br><span> method = getattr(self, '_encode_record_hex', None)</span><br><span> if callable(method):</span><br><span> return h2b(method(abstract_data))</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return self._construct.build(abstract_data)</span><br><span> raise NotImplementedError</span><br><span> </span><br><span> class CyclicEF(LinFixedEF):</span><br><span>@@ -813,10 +832,12 @@</span><br><span> method = getattr(self, '_decode_record_hex', None)</span><br><span> if callable(method):</span><br><span> return method(raw_hex_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ raw_bin_data = h2b(raw_hex_data)</span><br><span> method = getattr(self, '_decode_record_bin', None)</span><br><span> if callable(method):</span><br><span style="color: hsl(0, 100%, 40%);">- raw_bin_data = h2b(raw_hex_data)</span><br><span> return method(raw_bin_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.parse(raw_bin_data, total_len=len(raw_bin_data)))</span><br><span> return {'raw': raw_hex_data}</span><br><span> </span><br><span> def decode_record_bin(self, raw_bin_data:bytearray) -> dict:</span><br><span>@@ -838,6 +859,8 @@</span><br><span> method = getattr(self, '_decode_record_hex', None)</span><br><span> if callable(method):</span><br><span> return method(raw_hex_data)</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.parse(raw_bin_data, total_len=len(raw_bin_data)))</span><br><span> return {'raw': raw_hex_data}</span><br><span> </span><br><span> def encode_record_hex(self, abstract_data:dict) -> str:</span><br><span>@@ -858,6 +881,8 @@</span><br><span> method = getattr(self, '_encode_record_bin', None)</span><br><span> if callable(method):</span><br><span> return b2h(method(abstract_data))</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return b2h(filter_dict(self._construct.build(abstract_data)))</span><br><span> raise NotImplementedError</span><br><span> </span><br><span> def encode_record_bin(self, abstract_data:dict) -> bytearray:</span><br><span>@@ -878,6 +903,8 @@</span><br><span> method = getattr(self, '_encode_record_hex', None)</span><br><span> if callable(method):</span><br><span> return h2b(method(abstract_data))</span><br><span style="color: hsl(120, 100%, 40%);">+ if self._construct:</span><br><span style="color: hsl(120, 100%, 40%);">+ return filter_dict(self._construct.build(abstract_data))</span><br><span> raise NotImplementedError</span><br><span> </span><br><span> def _decode_bin(self, raw_bin_data:bytearray):</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/pysim/+/23709">change 23709</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/+/23709"/><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: Id0765ec3ddb8c044838ce47d0ff8740720a32b15 </div>
<div style="display:none"> Gerrit-Change-Number: 23709 </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>