Simplifying python code with named constants #21

Author: lexus2k

examples/python/hdlc_send_receive.py

@@ -18,6 +18,7 @@
 #
 
 import tinyproto
+import tinyproto.options
 
 p = tinyproto.Hdlc()
 def on_read(a):
@@ -29,9 +30,12 @@ def on_send(a):
 # setup protocol
 p.on_read = on_read
 p.on_send = on_send
+p.crc = tinyproto.options.HDLC_CRC_16
 p.begin()
 
 # provide rx bytes to the protocol
+# For serial port communication you need to read the bytes from the serial port
+# and pass them to rx() method then.
 p.rx( bytearray([ 0x7E, 0xFF, 0x3F, 0xF3, 0x39, 0x7E  ]) )
 
 # Let's try to send single byte frame 0x65

python/__init__.py

@@ -0,0 +1,22 @@
+"""
+    Copyright 2021 (C) Alexey Dynda
+
+    This file is part of Tiny Protocol Library.
+
+    Protocol Library is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Protocol Library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with Protocol Library.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+import tinyproto_
+Hdlc = tinyproto_.Hdlc
+Fd = tinyproto_.Fd

python/main.cpp

@@ -35,10 +35,10 @@ static PyObject *pants(PyObject *self, PyObject *args)
 static PyMethodDef tinyproto_methods[] = {{"pants", pants, METH_VARARGS, "Returns a square of an integer."},
                                           {NULL, NULL, 0, NULL}};
 
-static struct PyModuleDef tinyproto_definition = {PyModuleDef_HEAD_INIT, "tinyproto", "A Python tiny protocol module",
+static struct PyModuleDef tinyproto_definition = {PyModuleDef_HEAD_INIT, "tinyproto_", "A Python tiny protocol module",
                                                   -1, tinyproto_methods};
 
-PyMODINIT_FUNC PyInit_tinyproto(void)
+PyMODINIT_FUNC PyInit_tinyproto_(void)
 {
     Py_Initialize();
     PyObject *m = PyModule_Create(&tinyproto_definition);

python/options/__init__.py

@@ -0,0 +1,25 @@
+"""
+    Copyright 2021 (C) Alexey Dynda
+
+    This file is part of Tiny Protocol Library.
+
+    Protocol Library is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Protocol Library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with Protocol Library.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+HDLC_CRC_DEFAULT = 0
+HDLC_CRC_8       = 8
+HDLC_CRC_16      = 16
+HDLC_CRC_32      = 32
+HDLC_CRC_OFF     = 0xFF
+

setup.py

@@ -24,7 +24,7 @@
 source_files.extend( glob.glob('./python/**/*.cpp', recursive=True ) )
 
 tinyproto_module = Extension(
-    'tinyproto',
+    'tinyproto_',
     sources=source_files,
     include_dirs=['./src','./python'],
     define_macros=[("MYDEF", None), ("TINY_FD_DEBUG", 0), ("TINY_LOG_LEVEL_DEFAULT", 0)],
@@ -44,7 +44,8 @@
     version='0.12.1',
     description='tinyproto module wrapper',
     package_dir = { "tinyproto": "./python" },
-    packages = ['tinyproto.wrappers'],
+    packages = ['tinyproto', 'tinyproto.wrappers', 'tinyproto.options'],
+    # py_modules = ['tinyproto.options'],
     ext_modules=[tinyproto_module],
 )