pyxcp 0.21.11__tar.gz → 0.22.1__tar.gz

{pyxcp-0.21.11 → pyxcp-0.22.1}/PKG-INFO

@@ -1,29 +1,43 @@
 Metadata-Version: 2.1
 Name: pyxcp
-Version: 0.21.11
+Version: 0.22.1
 Summary: Universal Calibration Protocol for Python
+Home-page: https://github.com/christoph2/pyxcp
+License: LGPLv3
 Keywords: automotive,ecu,xcp,asam,autosar
 Author: Christoph Schueler
-Author-email: cpu12.gems@googlemail.com
-Requires-Python: >=3.7
+Author-email: cpu.gems@googlemail.com
+Requires-Python: >=3.8.1,<4.0.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development
-Provides-Extra: doc
-Project-URL: homepage, https://github.com/christoph2/pyxcp
+Requires-Dist: bandit (>=1.7.8,<2.0.0)
+Requires-Dist: chardet (>=5.2.0,<6.0.0)
+Requires-Dist: construct (>=2.10.68,<3.0.0)
+Requires-Dist: line-profiler-pycharm (>=1.1.0,<2.0.0)
+Requires-Dist: mako (>=1.2.4,<2.0.0)
+Requires-Dist: pyserial (>=3.5,<4.0)
+Requires-Dist: python-can (>=4.2.2,<5.0.0)
+Requires-Dist: pytz (>=2024.1,<2025.0)
+Requires-Dist: pyusb (>=1.2.1,<2.0.0)
+Requires-Dist: rich (>=13.6.0,<14.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: tomlkit (>=0.12.5,<0.13.0)
+Requires-Dist: traitlets (<=5.11.2)
+Requires-Dist: uptime (>=3.0.1,<4.0.0)
 Description-Content-Type: text/markdown
 
-
-pyXCP
-=====
+# pyXCP
 
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/85f774708b2542d98d02df55c743d24a)](https://app.codacy.com/app/christoph2/pyxcp?utm_source=github.com&utm_medium=referral&utm_content=christoph2/pyxcp&utm_campaign=Badge_Grade_Settings)
 [![Maintainability](https://api.codeclimate.com/v1/badges/4c639f3695f2725e392a/maintainability)](https://codeclimate.com/github/christoph2/pyxcp/maintainability)
@@ -47,17 +61,20 @@ XCP also replaces the older CCP (CAN Calibration Protocol).
 pyXCP is hosted on Github, get the latest release: [https://github.com/christoph2/pyxcp](https://github.com/christoph2/pyxcp)
 
 You can install pyxcp from source:
+
 ```
 pip install -r requirements.txt
 python setup.py install
 ```
 
 Alternatively, you can install pyxcp from source with pip:
+
 ```
 pip install git+https://github.com/christoph2/pyxcp.git
 ```
 
 Alternatively, get pyxcp from [PyPI](https://pypi.org/project/pyxcp/):
+
 ```
 pip install pyxcp
 ```

{pyxcp-0.21.11 → pyxcp-0.22.1}/README.md

@@ -1,6 +1,4 @@
-
-pyXCP
-=====
+# pyXCP
 
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/85f774708b2542d98d02df55c743d24a)](https://app.codacy.com/app/christoph2/pyxcp?utm_source=github.com&utm_medium=referral&utm_content=christoph2/pyxcp&utm_campaign=Badge_Grade_Settings)
 [![Maintainability](https://api.codeclimate.com/v1/badges/4c639f3695f2725e392a/maintainability)](https://codeclimate.com/github/christoph2/pyxcp/maintainability)
@@ -24,17 +22,20 @@ XCP also replaces the older CCP (CAN Calibration Protocol).
 pyXCP is hosted on Github, get the latest release: [https://github.com/christoph2/pyxcp](https://github.com/christoph2/pyxcp)
 
 You can install pyxcp from source:
+
 ```
 pip install -r requirements.txt
 python setup.py install
 ```
 
 Alternatively, you can install pyxcp from source with pip:
+
 ```
 pip install git+https://github.com/christoph2/pyxcp.git
 ```
 
 Alternatively, get pyxcp from [PyPI](https://pypi.org/project/pyxcp/):
+
 ```
 pip install pyxcp
 ```

pyxcp-0.22.1/build_ext.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python
+
+import multiprocessing as mp
+import os
+import platform
+import re
+import subprocess  # nosec
+import sys
+from pathlib import Path
+from tempfile import TemporaryDirectory
+
+
+TOP_DIR = Path(__file__).parent
+
+print("Platform", platform.system())
+uname = platform.uname()
+if uname.system == "Darwin":
+    os.environ["MACOSX_DEPLOYMENT_TARGET"] = "11.0"
+
+
+def banner(msg: str) -> None:
+    print("=" * 80)
+    print(str.center(msg, 80))
+    print("=" * 80)
+
+
+def build_extension(debug: bool = False, use_temp_dir: bool = False) -> None:
+    print("CMakeBuild::build_extension()")
+
+    debug = bool(os.environ.get("DEBUG", 0)) or debug
+    cfg = "Debug" if debug else "Release"
+    print(f" BUILD-TYPE: {cfg!r}")
+    cmake_args = [
+        f"-DPYTHON_EXECUTABLE={sys.executable}",
+        f"-DCMAKE_BUILD_TYPE={cfg}",  # not used on MSVC, but no harm
+    ]
+    build_args = ["--config Release", "--verbose"]
+    # cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=1 /path/to/src
+
+    if sys.platform.startswith("darwin"):
+        # Cross-compile support for macOS - respect ARCHFLAGS if set
+        archs = re.findall(r"-arch (\S+)", os.environ.get("ARCHFLAGS", ""))
+        if archs:
+            cmake_args += ["-DCMAKE_OSX_ARCHITECTURES={}".format(";".join(archs))]
+
+    if use_temp_dir:
+        build_temp = Path(TemporaryDirectory(suffix=".build-temp").name) / "extension_it_in"
+    else:
+        build_temp = Path(".")
+    # print("cwd:", os.getcwd(), "build-dir:", build_temp, "top:", str(TOP_DIR))
+    if not build_temp.exists():
+        build_temp.mkdir(parents=True)
+
+    banner("Step #1: Configure")
+    # cmake_args += ["--debug-output"]
+    subprocess.run(["cmake", str(TOP_DIR), *cmake_args], cwd=build_temp, check=True)  # nosec
+
+    cmake_args += [f"--parallel {mp.cpu_count()}"]
+
+    banner("Step #2: Build")
+    # build_args += ["-DCMAKE_VERBOSE_MAKEFILE:BOOL=ON"]
+    subprocess.run(["cmake", "--build", build_temp, *build_args], cwd=TOP_DIR, check=True)  # nosec
+
+    banner("Step #3: Install")
+    # subprocess.run(["cmake", "--install", "."], cwd=build_temp, check=True)  # nosec
+    subprocess.run(["cmake", "--install", build_temp], cwd=TOP_DIR, check=True)  # nosec
+
+
+if __name__ == "__main__":
+    includes = subprocess.getoutput("pybind11-config --cmakedir")  # nosec
+    os.environ["pybind11_DIR"] = includes
+    build_extension(False)

pyxcp-0.22.1/pyproject.toml

@@ -0,0 +1,187 @@
+
+[build-system]
+requires = ["poetry-core>=1.0.0", "setuptools>=68.0.0", "pybind11>=2.12.0",  "pybind11[global]>=2.12.0"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.poetry.dev-dependencies]
+Pygments = ">=2.10.0"
+bandit = ">=1.7.4"
+black = ">=21.10b0"
+coverage = {extras = ["toml"], version = ">=6.2"}
+darglint = ">=1.8.1"
+flake8 = ">=4.0.1"
+flake8-docstrings = ">=1.6.0"
+flake8-rst-docstrings = ">=0.2.5"
+furo = ">=2021.11.12"
+isort = ">=5.10.1"
+mypy = ">=0.930"
+pep8-naming = ">=0.12.1"
+pre-commit = ">=2.16.0"
+pre-commit-hooks = ">=4.1.0"
+pytest = ">=6.2.5"
+pyupgrade = ">=2.29.1"
+safety = ">=1.10.3"
+sphinx = ">=4.3.2"
+sphinx-autobuild = ">=2021.3.14"
+sphinx-click = ">=3.0.2"
+typeguard = ">=2.13.3"
+xdoctest = {extras = ["colors"], version = ">=0.15.10"}
+myst-parser = {version = ">=0.16.1"}
+
+[project]
+name = "pyxcp"
+dynamic = ["license", "readme", "authors", "requires-python", "description", "classifiers", "scripts", "dependencies", "optional-dependencies"]
+
+[tool.poetry]
+authors = ["Christoph Schueler <cpu.gems@googlemail.com>"]
+name = "pyxcp"
+version = "0.22.1"
+readme = "README.md"
+description = "Universal Calibration Protocol for Python"
+keywords = ["automotive", "ecu", "xcp", "asam", "autosar"]
+homepage = "https://github.com/christoph2/pyxcp"
+license = "LGPLv3"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers", "Topic :: Software Development",
+    "Topic :: Scientific/Engineering",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+	"Programming Language :: Python :: 3.13"
+]
+build = "build_ext.py"
+include = [
+    { path = "pyxcp/cpp_ext/*.so", format = "wheel" },
+    { path = "pyxcp/cpp_ext/*.pyd", format = "wheel" },
+    { path = "pyxcp/daq_stim/*.so", format = "wheel" },
+    { path = "pyxcp/daq_stim/*.pyd", format = "wheel" },
+    { path = "pyxcp/recorder/*.so", format = "wheel" },
+    { path = "pyxcp/recorder/*.pyd", format = "wheel" },
+    { path = "pyxcp/*.exe", format = "wheel" },
+    { path = "CMakeLists.txt", format = "wheel" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.8.1"
+construct = "^2.10.68"
+mako = "^1.2.4"
+pyserial = "^3.5"
+pyusb = "^1.2.1"
+python-can = "^4.2.2"
+uptime = "^3.0.1"
+rich = "^13.6.0"
+chardet = "^5.2.0"
+traitlets = "<=5.11.2"
+line-profiler-pycharm = "^1.1.0"
+
+toml = "^0.10.2"
+bandit = "^1.7.8"
+tomlkit = "^0.12.5"
+pytz = "^2024.1"
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.1.0"
+
+pre-commit-hooks = "^4.6.0"
+darglint = "^1.8.1"
+[tool.poetry.scripts]
+pyxcp-probe-can-drivers = "pyxcp.scripts.pyxcp_probe_can_drivers:main"
+xcp-id-scanner = "pyxcp.scripts.xcp_id_scanner:main"
+xcp-fetch-a2l = "pyxcp.scripts.xcp_fetch_a2l:main"
+xcp-info = "pyxcp.scripts.xcp_info:main"
+xcp-profile = "pyxcp.scripts.xcp_profile:main"
+
+[tool.pytest]
+addopts = "--verbose --tb=short --junitxml=result.xml -o junit_family=xunit2"
+testpaths = "pyxcp/tests"
+
+[tool.isort]
+profile = "black"
+force_single_line = false
+lines_after_imports = 2
+
+[tool.mypy]
+strict = false
+warn_unreachable = true
+pretty = true
+show_column_numbers = true
+show_error_context = true
+
+[tool.flake8]
+ignore = ["F403", "D203", "E203", "E266", "E501", "W503", "E501", "F401", "BLK100"]
+exclude = '''
+/(
+    \.git
+    | __pycache__
+    | __pypackages__
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | \.eggs
+    | _build
+    | build
+    | docs
+    | dist
+    | experimental
+)/
+'''
+max-complexity = 10
+count = true
+statistics = true
+show-source = true
+max-line-length = 132
+select = ["B","C","E","F","W","T4","B9"]
+extend-select = "B950"
+extend-ignore = ["E203", "E501", "E701"]
+
+[tool.ruff]
+line-length = 132
+
+[tool.black]
+line-length=132
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | build
+    | docs
+    | experimental
+    | __pycache__
+    | __pypackages__
+    | dist
+)/
+'''
+
+[tool.cibuildwheel]
+build-verbosity = 3
+#test-command = "pytest {package}/tests"
+#test-command = "pytest -svv pyxcp/tests"
+build = "cp3{8,9,10,11,12,13}-*"
+skip = ["*-manylinux_i686", "*-musllinux_x86_64", "*-musllinux_i686"] # Skip Linux 32bit and MUSL builds.
+build-frontend = "pip"
+
+[tool.pyright]
+include = ["pyxcp", "build_ext.py"]
+ignore = ["pyxcp/conf_test.py", "pyxcp/config_new.py", "pyxcp/config_tr.py", "pyxcp/examples/memxfer.py",
+	"pyxcp/examples/ts_tester.py", "pyxcp/recorder/converter/**", "pyxcp/transport/candriver/**", "pyxcp/recorder/simdjson/**",
+	"pyxcp/recorder/mio/**", "pyxcp/recorder/lz4/**"]
+#defineConstant = { DEBUG = true }
+#stubPath = "src/stubs"
+
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+#executionEnvironments = [
+#  { root = "src/web", pythonVersion = "3.5", pythonPlatform = "Windows", extraPaths = [ "src/service_libs" ] },
+#  { root = "src/sdk", pythonVersion = "3.0", extraPaths = [ "src/backend" ] },
+#  { root = "src/tests", extraPaths = ["src/tests/e2e", "src/sdk" ]},
+#  { root = "src" }
+#]

pyxcp-0.22.1/pyxcp/__init__.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python
+"""Universal Calibration Protocol for Python."""
+
+from rich import pretty
+from rich.console import Console
+from rich.traceback import install as tb_install
+
+
+pretty.install()
+
+from .master import Master  # noqa: F401, E402
+from .transport import Can, Eth, SxI, Usb  # noqa: F401, E402
+
+
+console = Console()
+tb_install(show_locals=True, max_frames=3)  # Install custom exception handler.
+
+# if you update this manually, do not forget to update
+# .bumpversion.cfg and pyproject.toml.
+__version__ = "0.22.1"

pyxcp-0.22.1/pyxcp/aml/EtasCANMonitoring.a2l

@@ -0,0 +1,82 @@
+ASAP2_VERSION 1 30
+/begin PROJECT
+  aProjectName
+  "description of project"
+
+  /begin HEADER
+     "project"
+     VERSION "1.0"
+     PROJECT_NO "1.0"
+  /end HEADER
+
+  /begin MODULE
+     aModuleName
+     "description of module"
+
+     /begin MOD_PAR
+        ""
+     /end MOD_PAR
+
+     /begin IF_DATA CAN_MONITORING
+        /begin  TP_BLOB
+           500
+       /end  TP_BLOB
+     /end IF_DATA
+
+     /begin MEASUREMENT
+        aMeasurementName
+        "description of measurement"
+        ULONG
+        aConversionName
+        0
+        0.0
+        0
+        1000
+        /begin IF_DATA CAN_MONITORING
+           /begin KP_BLOB
+              0x0 32
+           /end KP_BLOB
+        /end IF_DATA
+        FORMAT ""
+        BYTE_ORDER MSB_LAST
+        BIT_MASK 0xFFFFFFFF
+     /end MEASUREMENT
+
+     /begin COMPU_METHOD
+        aConversionName
+        "description of conversion"
+        RAT_FUNC
+        "%f5.2"
+        ""
+        COEFFS 0 1.0 0.0 0 0 1
+     /end COMPU_METHOD
+
+
+
+
+
+
+
+
+    /begin FRAME
+        aFrameName
+        "description of frame"
+        0
+        0
+        /begin IF_DATA CAN_MONITORING
+           QP_BLOB 0x0200 0 8
+        /end IF_DATA
+        FRAME_MEASUREMENT aMeasurementName
+     /end FRAME
+
+     /begin FUNCTION
+        aFunctionName
+        "description of function"
+        /begin OUT_MEASUREMENT
+           aMeasurementName
+        /end OUT_MEASUREMENT
+     /end FUNCTION
+
+  /end MODULE
+
+/end PROJECT

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/XCP_Common.aml

@@ -406,4 +406,3 @@ taggedstruct Common_Parameters {
     block "PGM" struct Pgm;
     block "DAQ_EVENT" taggedunion Daq_Event;
 }; /******************** end of Common Parameters *****************************/
-

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/XCPonUSB.aml

@@ -103,4 +103,4 @@ struct USB_Parameters {
     }; /* end of optional */
 };
 /************************* end of USB ***********************************/
-/end A2ML
+/end A2ML

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/ifdata_CAN.a2l

@@ -18,4 +18,3 @@ begin XCP_ON_CAN
         FIXED 0x330
     /end DAQ_LIST_CAN_ID
 /end XCP_ON_CAN
-

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/ifdata_Eth.a2l

@@ -9,4 +9,3 @@
 0x5555 /* PORT */
 "127.0.0.1" /* ADDRESS */
 /end XCP_ON_UDP_IP
-

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/ifdata_Flx.a2l

@@ -92,4 +92,3 @@ STIM VARIABLE
 /end XCP_PACKET
 /end POOL_BUFFER
 /end XCP_ON_FLX
-

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/ifdata_SxI.a2l

@@ -11,4 +11,3 @@
     HEADER_LEN_CTR_WORD
     NO_CHECKSUM
 /end XCP_ON_SxI
-

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/aml/ifdata_USB.a2l

@@ -79,4 +79,3 @@
         FIXED_OUT 0x02 /* uses Endpoint 2 OUT. */
     /end DAQ_LIST_USB_ENDPOINT
 /end XCP_ON_USB
-

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/asam/types.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 import struct
 
+
 INTEL = "<"
 MOTOROLA = ">"
 
@@ -15,7 +15,7 @@ MOTOROLA = ">"
 """
 
 
-class AsamBaseType(object):
+class AsamBaseType:
     """Base class for ASAM codecs.
 
     Note
@@ -51,7 +51,7 @@ class AsamBaseType(object):
         bytes
           Encoded value.
         """
-        return struct.pack("{}{}".format(self.byteorder, self.FMT), value)
+        return struct.pack(f"{self.byteorder}{self.FMT}", value)
 
     def decode(self, value):
         """Decode a value.
@@ -68,7 +68,7 @@ class AsamBaseType(object):
         data-type
           data-type is determined by derived class.
         """
-        return struct.unpack("{}{}".format(self.byteorder, self.FMT), bytes(value))[0]
+        return struct.unpack(f"{self.byteorder}{self.FMT}", bytes(value))[0]
 
 
 class A_Uint8(AsamBaseType):

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/asamkeydll.c

@@ -110,7 +110,6 @@ int main(int argc, char ** argv)
     }
 
     res = GetKey((char *)&dllname, privilege, seedlen, (BYTE *)&seedBuffer, &keylen, (BYTE *)&keyBuffer);
-    printf("%lu\n", res);
     if (res == 0) {
         hexlify(keyBuffer, keylen);
     }

{pyxcp-0.21.11 → pyxcp-0.22.1}/pyxcp/checksum.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*-
 """Checksum calculation for memory ranges
 
 .. [1] XCP Specification, BUILD_CHECKSUM service.

pyxcp-0.22.1/pyxcp/cmdline.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python
+"""
+Parse (transport-layer specific) command line parameters
+and create a XCP master instance.
+"""
+
+import warnings
+from dataclasses import dataclass
+from typing import List
+
+from pyxcp.config import create_application
+from pyxcp.master import Master
+
+
+warnings.simplefilter("always")
+
+
+@dataclass
+class Option:
+    short_opt: str
+    long_opt: str = ""
+    dest: str = ""
+    help: str = ""
+    type: str = ""
+    default: str = ""
+
+
+class FakeParser:
+
+    options: List[Option] = []
+
+    def add_argument(self, short_opt: str, long_opt: str = "", dest: str = "", help: str = "", type: str = "", default: str = ""):
+        warnings.warn("Argument parser extension is currently not supported.", DeprecationWarning, 2)
+        self.options.append(Option(short_opt, long_opt, dest, help, type, default))
+
+
+class ArgumentParser:
+    def __init__(self, callout=None, *args, **kws):
+        self._parser = FakeParser()
+        if callout is not None:
+            warnings.warn("callout  argument is currently not supported.", DeprecationWarning, 2)
+
+    def run(self, policy=None, transport_layer_interface=None):
+        application = create_application(self.parser.options)
+        master = Master(
+            application.transport.layer, config=application, policy=policy, transport_layer_interface=transport_layer_interface
+        )
+        return master
+
+    @property
+    def parser(self):
+        return self._parser