Moved to Python3/mypy/pylint/flake8

.flake8

+[flake8]
+ignore = E501,E225,C103
+max-line-length = 160

.gitignore

+*.pyc
+*,cover
+.coverage
+tests-coverage/output
+tests-coverage/smp2.asn
+tests-coverage/datatypessimulink.cat
+tests-coverage/datatypessimulink.pkg
+tests-coverage/Simulink_DataView_asn.m
+*swp

CHANGELOG

+# Change Log
+
+## 2.0.0
+
+- Moved to Python3
+- Added type annotations, checked via mypy
+- Added git commit hooks to check via flake8 AND pylint
+- Configuration files used to customize the checks for the project's
+  naming conventions.
+- Many bugs identified and fixed.
+
+## 1.2.3
+- ctypes backend: emit all ENUMERATED values in DV.py
+
+## 1.2.0
+- Not using SWIG anymore for the Python mappers
+
+## 1.1.2
+- pyside_b_mapper: added combo box for the asn1 value editor
+
+## 1.1.1
+- support empty SEQUENCEs (MyType ::= SEQUENCE {}) - except for Simulink

LICENSE.txt

+(C) Semantix Information Technologies.
+
+Semantix Information Technologies is licensing the code of the
+Data Modelling Tools (DMT) in the following dual-license mode:
+
+Commercial Developer License:
+      The DMT Commercial Developer License is the suggested version
+to use for the development of proprietary and/or commercial software.
+This version is for developers/companies who do not want to comply
+with the terms of the GNU Lesser General Public License version 2.1.
+
+GNU LGPL v. 2.1:
+      This version of DMT is the one to use for the development of
+applications, when you are willing to comply with the terms of the-
+GNU Lesser General Public License version 2.1.
+
+Note that in both cases, there are no charges (royalties) for the
+generated code.
+
+To purchase a commercial developer license (covering the entire
+DMT toolchain), please contact Semantix at: dmt@semantix.gr

Makefile

+PY_SRC:=$(wildcard dmt/asn2dataModel.py dmt/aadl2glueC.py dmt/smp2asn.py dmt/*mappers/[a-zA-Z]*py dmt/commonPy/[a-zA-Z]*py)
+PY_SRC:=$(filter-out dmt/B_mappers/antlr.main.py dmt/A_mappers/Stubs.py, ${PY_SRC})
+
+all:	flake8 pylint mypy
+
+flake8:
+	@echo Performing syntax checks via flake8...
+	@flake8 ${PY_SRC} || exit 1
+
+pylint:
+	@echo Performing static analysis via pylint...
+	@pylint --disable=I --rcfile=pylint.cfg ${PY_SRC}  | sed -n '/^Report/q;p'
+
+mypy:
+	@echo Performing type analysis via mypy...
+	@mypy --check-untyped-defs ${PY_SRC} || exit 1
+
+.PHONY:	flake8 pylint mypy

README.md

+TASTE Data Modelling Technologies
+=================================
+
+These are all the tools used by the [TASTE toolchain](https://taste.tuxfamily.org/)
+to automate handling of the Data Modelling challenges. They include more than two
+dozen codegenerators that create the 'glue' ; that is, the code allowing code
+generated by modelling tools (Simulink, SCADE, OpenGeode, etc) to "speak" to
+one another via ASN.1 marshalling. For the encoders and decoders of the messages
+themselves, we use [ASN1SCC](https://github.com/ttsiodras/asn1scc) - an ASN.1
+compiler geared for safety-critical environments.
+
+For more details, visit the [TASTE site](https://taste.tuxfamily.org/).
+
+Installation
+------------
+
+    $ sudo apt-get install libxslt-dev libxml2-dev python3-pip
+    $ pip3 install --user -r requirements.txt
+    $ make flake8  # optional, check for pep8 compliance
+    $ make pylint  # optional, static analysis with pylint
+    $ make mypy  # optional, type analysis with mypy
+    $ pip3 install --user --upgrade .
+
+Contents
+--------
+
+- **commonPy** (*library*)
+
+    Contains the basic API for parsing ASN.1 (via invocation of 
+    [ASN1SCC](https://github.com/ttsiodras/asn1scc) and simplification
+    of the generated XML AST representation to the Python classes
+    inside `asnAST.py`.
+
+- **asn2aadlPlus** (*utility*)
+
+    Converts the type declarations inside ASN.1 grammars to AADL
+    declarations (used by the Ellidiss tools to design the final systems)
+
+- **asn2dataModel** (*utility*)
+
+    Reads the ASN.1 specification of the exchanged messages, and generates
+    the semantically equivalent Modeling tool/Modeling language declarations
+    (e.g.  SCADE/Lustre, Matlab/Simulink statements, etc). 
+
+    The actual mapping logic exists in plugins, called *A mappers*
+    (`simulink_A_mapper.py` handles Simulink/RTW, `scade6_A_mapper.py`
+    handles SCADE5, `ada_A_mapper.py` generates Ada types,
+    `sqlalchemy_A_mapper.py`, generates SQL definitions via SQLAlchemy, etc)
+
+- **aadl2glueC** (*utility*)
+
+    Reads the AADL specification of the system, and then generates the runtime
+    bridge-code that will map the message data structures from those generated
+    by [ASN1SCC](https://github.com/ttsiodras/asn1scc) to/from those generated
+    by the modeling tool used to functionally model the subsystem (e.g. SCADE,
+    ObjectGeode, Matlab/Simulink, C, Ada, etc).
+
+Contact
+-------
+
+For bug reports, please use the Issue Tracker; for any other communication,
+contact me at:
+
+    Thanassis Tsiodras
+    Real-time Embedded Software Engineer 
+    System, Software and Technology Department
+    European Space Agency
+
+    ESTEC
+    Keplerlaan 1, PO Box 299
+    NL-2200 AG Noordwijk, The Netherlands
+    Athanasios.Tsiodras@esa.int | www.esa.int
+    T +31 71 565 5332

dmt/A_mappers/Stubs.py

+#
+# (C) Semantix Information Technologies.
+#
+# Semantix Information Technologies is licensing the code of the
+# Data Modelling Tools (DMT) in the following dual-license mode:
+#
+# Commercial Developer License:
+#       The DMT Commercial Developer License is the suggested version
+# to use for the development of proprietary and/or commercial software.
+# This version is for developers/companies who do not want to comply
+# with the terms of the GNU Lesser General Public License version 2.1.
+#
+# GNU LGPL v. 2.1:
+#       This version of DMT is the one to use for the development of
+# applications, when you are willing to comply with the terms of the
+# GNU Lesser General Public License version 2.1.
+#
+# Note that in both cases, there are no charges (royalties) for the
+# generated code.
+#
+import os
+import re
+import copy
+import DV_Types  # pylint: disable=import-error
+from ctypes import (
+    cdll, c_void_p, c_ubyte, c_double, c_uint,
+    c_longlong, c_bool, c_int, c_long
+)
+
+# load the *getset.so in this folder
+script_path = os.path.dirname(os.path.realpath(__file__))
+soFileNames = [
+    filename
+    for filename in os.listdir(script_path)
+    if filename.endswith("_getset.so")
+]
+if len(soFileNames) != 1:
+    raise Exception("Failed to locate a single _getset.so under " + script_path)
+
+JMP = cdll.LoadLibrary(os.path.join(script_path, soFileNames[0]))
+
+# BitStream constructor
+CreateStream = JMP.CreateStream
+CreateStream.restype = c_void_p
+# BitStream destructor
+DestroyStream = JMP.DestroyStream
+# BitStream reset
+ResetStream = JMP.ResetStream
+# Get number of bytes in encoded stream
+GetStreamCurrentLength = JMP.GetStreamCurrentLength
+GetStreamCurrentLength.restype = c_uint
+
+# Access BitStream buffer
+GetBitstreamBuffer = JMP.GetBitstreamBuffer
+GetBitstreamBuffer.restype = c_void_p
+# Read from buffer
+GetBufferByte = JMP.GetBufferByte
+GetBufferByte.restype = c_ubyte
+# Write to buffer
+SetBufferByte = JMP.SetBufferByte
+
+# Create pErr space for Encoders - i.e. sizeof(int)
+CreateInstanceOf_int = JMP.CreateInstanceOf_int
+CreateInstanceOf_int.restype = c_void_p
+# Release pErr space for Encoders
+DestroyInstanceOf_int = JMP.DestroyInstanceOf_int
+
+
+class AsnCoderError(Exception):
+    pass
+
+
+def CleanNameAsPythonWants(name):
+    """ASN.1 ids have minuses... turn non-ID chars to '_'"""
+    return re.sub(r'[^a-zA-Z0-9_]', '_', name)
+Clean = CleanNameAsPythonWants
+
+
+def myassert(b):
+    """assert that shows the call stack when it fails"""
+    if not b:
+        raise AsnCoderError("Assertion failed...")
+
+
+class DataStream(object):
+    """ASN1SCC BitStream equivalent"""
+    def __init__(self, bufferSize):
+        """bufferSize: use the DV.TYPENAME_REQUIRED_BYTES_FOR_ENCODING"""
+        myassert(isinstance(bufferSize, int))
+        self._bs = c_void_p(CreateStream(bufferSize))
+        self._bufferSize = bufferSize
+
+    def __del__(self):
+        """Releases the encoded data and the bitstream structure pointing to them"""
+        DestroyStream(self._bs)
+
+    def Reset(self):
+        """Rewinds the currentByte and currentBit to the start"""
+        ResetStream(self._bs)
+
+    def GetPyString(self):
+        # print "Reading",
+        msg = ""
+        pData = c_void_p(GetBitstreamBuffer(self._bs))
+        for i in range(0, GetStreamCurrentLength(self._bs)):
+            b = GetBufferByte(pData, i)
+            msg += chr(b)
+            # print b, ",",
+        # print "EOF"
+        return msg
+
+    def SetFromPyString(self, data):
+        strLength = len(data)
+        assert self._bufferSize >= strLength
+        self._bs.count = strLength
+        pData = c_void_p(GetBitstreamBuffer(self._bs))
+        # print "Writing",
+        for i in range(0, strLength):
+            b = ord(data[i])
+            # print b, ",",
+            SetBufferByte(pData, i, b)
+        # print "EOF"
+
+
+class COMMON(object):
+    """This class is used to implement ALL the Python "proxy" classes for
+ASN1SCC types.
+
+It uses the __getattr__ call to hook into all the accesses that Python
+considers "unexpected". Therefore, when the script does this...
+
+    a = T_SEQUENCE()
+    print a.x.Get()
+    a.x.Set(12)
+
+... __getattr__ is called to ask us how to provide a ".x" member.
+We do two things to cope:
+
+(1) we form the equivalent path to the C getter/setter function
+    (in self._Caccessor)
+(2) we form a list of params, which is basically the indexes of
+    whatever arrays we meet in the access path
+
+So if the script does...
+
+    a.x.y[0].z.k[2].w.Get()
+
+then the params list carries [0,2], to pass it as an argument to the
+C getter when it is called (in response to the "Get" method call).
+
+Some key points:
+    When the chain ends (in a .Get, .Set, .GetLength or .SetLength
+call), we have to reset the "paths" we have formed, so that the
+next chain will restart from the beginning. That's what the Reset
+method does.
+However, we also have some helper functions for OCTET STRINGs:
+GetPyString and SetFromPyString. These have to do a per-byte loop,
+and if they used the "Get" and "Set" as they originally were,
+the path would be reset after accessing the [0] element...
+So we added a keyword boolean param called "reset", which disables
+this Reset when it is used from within GetPyString and
+SetFromPyString.
+    Another keyword param is postfix: it is simply used to allow
+re-use of the Get and Set code for the GetLength and SetLength
+members of SEQUENCEOF/SETOFs and OCTETSTRINGs:
+
+An example for SetLength:
+
+  T_SEQUENCE ::= SEQUENCE { y SEQUENCE (SIZE(4)) OF INTEGER }
+
+    a = T_SEQUENCE()
+    a.y.SetLength(4)
+    a.y[0].Set(1)
+    a.y[1].Set(4)
+    a.y[2].Set(9)
+    a.y[3].Set(16)
+"""
+
+    allowed = ["_nodeTypeName", "_ptr", "_pErr", "_Caccessor", "_accessPath",
+               "_params", "_new_ptr"]
+# , "Get", "GetLength", "Set", "SetLength", "Reset", "Encode", "Decode", "SetFromPyString", "GetPyString", "allowed"]
+
+    def __init__(self, nodeTypeName, ptr=None):
+        myassert(isinstance(nodeTypeName, str))
+        self._nodeTypeName = nodeTypeName
+        self._new_ptr = ptr is None
+        constructor = getattr(JMP, "CreateInstanceOf_" + Clean(nodeTypeName))
+        constructor.restype = c_void_p
+        self._ptr = ptr or constructor()
+        self._ptr = c_void_p(self._ptr)
+        self._pErr = c_void_p(CreateInstanceOf_int())
+        self._Caccessor = ""
+        self._params = []
+        self._accessPath = ""
+
+    def Reset(self, state=None):
+        if state is None:
+            self._Caccessor = ""
+            self._params = []
+            self._accessPath = ""
+        else:
+            self._Caccessor, self._params, self._accessPath = state[0][:], copy.deepcopy(state[1]), state[2][:]
+
+    def GetState(self):
+        return self._Caccessor[:], copy.deepcopy(self._params), self._accessPath[:]
+
+    def SetData(self, src):
+        bridgeFct = getattr(JMP, "SetDataFor_" + Clean(self._nodeTypeName))
+        bridgeFct(self._ptr, src)
+
+    def __del__(self):
+        ''' Destructor: free memory only if it was allocated at creation '''
+        DestroyInstanceOf_int(self._pErr)
+        if self._new_ptr:
+            destructor = getattr(JMP, "DestroyInstanceOf_" + Clean(self._nodeTypeName))
+            destructor(self._ptr)
+
+    def __str__(self):
+        return "Choose the information you want - whole-structure or sequence dump not supported."
+
+    def __getattr__(self, x):
+        self._Caccessor += "_" + Clean(x)
+        self._accessPath += "." + x
+        return self
+
+    def __setattr__(self, name, value):
+        if name not in COMMON.allowed:
+            self.Reset()
+            raise AsnCoderError("You can only use .Set(XYZ) and .SetLength(XYZ) to assign values, don't use '='")
+        object.__setattr__(self, name, value)
+
+    def __getitem__(self, idx):
+        self._Caccessor += "_iDx"
+        self._params.append(idx)
+        self._accessPath += "[" + str(idx) + "]"
+        return self
+
+    def Get(self, **args):  # postfix="", reset=True
+        try:
+            bridgeFuncName = Clean(self._nodeTypeName) + "_" + self._Caccessor + "_Get" + args.get("postfix", "")
+            if bridgeFuncName not in DV_Types.funcTypeLookup:
+                raise AsnCoderError("Function %s not found in lookup - contact support." % bridgeFuncName)
+            resType = DV_Types.funcTypeLookup[bridgeFuncName]
+            if resType.endswith('*'):
+                cTypesResultType = c_void_p
+            else:
+                cTypesResultType = {
+                    'asn1SccSint': c_longlong,
+                    'byte': c_ubyte,
+                    'double': c_double,
+                    'flag': c_bool,
+                    'int': c_int,
+                    'long': c_long
+                }.get(resType, None)
+                if cTypesResultType is None:
+                    raise AsnCoderError("Result type of %s not yet supported in the Python mapper - contact support." % resType)
+            bridgeFunc = getattr(JMP, bridgeFuncName)
+            bridgeFunc.restype = cTypesResultType
+            retVal = bridgeFunc(self._ptr, *self._params)
+        except:
+            oldAP = self._accessPath
+            if args.get("reset", True):
+                self.Reset()
+            raise AsnCoderError("The access path you used (%s) is not valid." % oldAP)
+        if args.get("reset", True):
+            self.Reset()
+        return retVal
+
+    def Set(self, value, **args):  # postfix="", reset=True
+        try:
+            # print Clean(self._nodeTypeName) + "_" + self._Caccessor + "_Set"+postfix
+            bridgeFunc = getattr(JMP, Clean(self._nodeTypeName) + "_" + self._Caccessor + "_Set" + args.get("postfix", ""))
+            if isinstance(value, float):
+                ctypesValue = c_double(value)
+            elif isinstance(value, int):
+                ctypesValue = c_longlong(value)
+            else:
+                ctypesValue = value
+            self._params.append(ctypesValue)
+            bridgeFunc(self._ptr, *self._params)
+            self._params.pop()
+        except Exception as e:
+            oldAP = self._accessPath
+            if args.get("reset", True):
+                self.Reset()
+            raise AsnCoderError(
+                "The access path you used (%s) or the value you tried to assign (%s) is not valid. %s" % (
+                    oldAP, str(value), str(e)))
+        if args.get("reset", True):
+            self.Reset()
+
+    def GetLength(self, reset=True):
+        return self.Get(postfix="Length", reset=reset)
+
+    def SetLength(self, value, reset=True):
+        self.Set(value, postfix="Length", reset=reset)
+
+    @staticmethod
+    def getErrCode(pErr):
+        errCode = 0
+        for i in range(4):
+            errCode = (errCode << 8) | GetBufferByte(pErr, (3 - i))
+        return errCode
+
+    def Encode(self, bitstream, bACN=False):
+        """Returns (booleanSuccess, ASN1SCC iErrorCode)
+grep for the errorcode value inside ASN1SCC generated headers."""
+        myassert(isinstance(bitstream, DataStream))
+        bitstream.Reset()
+        suffix = "_ACN_Encode" if bACN else "_Encode"
+        EncodeFuncName = Clean(self._nodeTypeName) + suffix
+        EncodeFunc = getattr(JMP, EncodeFuncName)
+        success = EncodeFunc(self._ptr, bitstream._bs, self._pErr, True)
+        if not success:
+            raise AsnCoderError("Error in %s, code: %d" % (EncodeFuncName,
+                                                           COMMON.getErrCode(self._pErr)))
+
+    def Decode(self, bitstream, bACN=False):
+        """Returns (booleanSuccess, ASN1SCC iErrorCode)
+grep for the errorcode value inside ASN1SCC generated headers."""
+        myassert(isinstance(bitstream, DataStream))
+        suffix = "_ACN_Decode" if bACN else "_Decode"
+        DecodeFuncName = Clean(self._nodeTypeName) + suffix
+        DecodeFunc = getattr(JMP, DecodeFuncName)
+        success = DecodeFunc(self._ptr, bitstream._bs, self._pErr)
+        if not success:
+            raise AsnCoderError("Error in %s, code: %d" % (DecodeFuncName,
+                                                           COMMON.getErrCode(self._pErr)))
+
+    def EncodeACN(self, bitstream):
+        self.Encode(bitstream, True)
+
+    def DecodeACN(self, bitstream):
+        self.Decode(bitstream, True)
+
+    def IsConstraintValid(self):
+        # Allocate temp space to store error code (avoid race condition that _pErr would cause)
+        pErr = c_void_p(CreateInstanceOf_int())
+        validatorFunc = getattr(JMP, Clean(self._nodeTypeName) + "_IsConstraintValid")
+        isValid = validatorFunc(self._ptr, pErr)
+        errorCode = COMMON.getErrCode(pErr)
+        DestroyInstanceOf_int(pErr)
+        return isValid, errorCode
+
+# Type-specific helpers...
+
+# OCTET STRING
+
+    def SetFromPyString(self, src):
+        strLength = len(src)
+        self.SetLength(strLength, False)
+        self._Caccessor += "_iDx"
+        accessPath = self._accessPath
+        for idx in range(0, strLength):
+            self._params.append(idx)
+            self._accessPath = accessPath + "[" + str(idx) + "]"
+            self.Set(ord(src[idx]), reset=False)
+            self._params.pop()
+        self.Reset()
+
+    def GetPyString(self):
+        retval = ""
+        strLength = self.GetLength(False)
+        self._Caccessor += "_iDx"
+        accessPath = self._accessPath
+        for idx in range(0, strLength):
+            self._params.append(idx)
+            self._accessPath = accessPath + "[" + str(idx) + "]"
+            retval += chr(self.Get(reset=False))
+            self._params.pop()
+        self.Reset()
+        return retval

dmt/A_mappers/__init__.py

+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+   asn2dataModel converts ASN.1 modules to a variety of target languages
+"""
+
+from ..commonPy import __version__

dmt/A_mappers/ada_A_mapper.py

+#
+# (C) Semantix Information Technologies.
+#
+# Semantix Information Technologies is licensing the code of the
+# Data Modelling Tools (DMT) in the following dual-license mode:
+#
+# Commercial Developer License:
+#       The DMT Commercial Developer License is the suggested version
+# to use for the development of proprietary and/or commercial software.
+# This version is for developers/companies who do not want to comply
+# with the terms of the GNU Lesser General Public License version 2.1.
+#
+# GNU LGPL v. 2.1:
+#       This version of DMT is the one to use for the development of
+# applications, when you are willing to comply with the terms of the
+# GNU Lesser General Public License version 2.1.
+#
+# Note that in both cases, there are no charges (royalties) for the
+# generated code.
+#
+'''This contains the implementation of model level mapping
+of ASN.1 constructs to C. It is used as a backend of Semantix's
+code generator A.'''
+
+import os
+import sys
+import distutils.spawn as spawn
+
+from ..commonPy.utility import panic
+
+
+def Version():
+    print("Code generator: " + "$Id: ada_A_mapper.py 2382 2012-06-22 08:35:33Z ttsiodras $")  # pragma: no cover
+
+
+# Especially for the C mapper, since we need to pass the complete ASN.1 files list to ASN1SCC,
+# the second param is not asnFile, it is asnFiles
+
+
+def OnStartup(unused_modelingLanguage, asnFiles, outputDir, unused_badTypes):
+    # print "Use ASN1SCC to generate the structures for '%s'" % asnFile
+    asn1SccPath = spawn.find_executable('asn1.exe')
+    if not asn1SccPath:
+        panic("ASN1SCC seems to be missing from your system (asn1.exe not found in PATH).\n")  # pragma: no cover
+    os.system(
+        ("mono " if sys.argv[0].endswith('.py') and sys.platform.startswith('linux') else "") +
+        "\"{}\" -wordSize 8 -typePrefix asn1Scc -Ada -uPER -o \"".format(asn1SccPath) +
+        outputDir + "\" \"" + "\" \"".join(asnFiles) + "\"")
+    os.system("rm -f \"" + outputDir + "\"/*.adb")
+
+
+def OnBasic(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnSequence(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnSet(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnEnumerated(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnSequenceOf(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnSetOf(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnChoice(unused_nodeTypename, unused_node, unused_leafTypeDict):
+    pass  # pragma: no cover
+
+
+def OnShutdown(unused_badTypes):
+    pass  # pragma: no cover

dmt/A_mappers/c_A_mapper.py

+#
+# (C) Semantix Information Technologies.