minor code refactoring

Author: miccoli

.gitignore

@@ -1,4 +1,5 @@
 *.py[cod]
+MANIFEST
 
 # C extensions
 *.so
@@ -29,8 +30,3 @@ nosetests.xml
 
 # Translations
 *.mo
-
-# Mr Developer
-.mr.developer.cfg
-.project
-.pydevproject

MANIFEST.in

@@ -0,0 +1 @@
+include README.md

README.md

@@ -1,6 +1,6 @@
 # pyownet, a pythonic interface to ownet
 
-pyownet is a pure python library that interfaces to an 
+pyownet is a pure python package that allows to access an 
 [owserver](http://owfs.org/index.php?page=owserver_protocol) via the 
 [owserver network protocol](http://owfs.org/index.php?page=owserver-protocol),
 in short _ownet_.
@@ -12,11 +12,9 @@ owserver is part of the [OWFS 1-Wire File System](http://owfs.org):
 > environment. You can write scripts to read temperature, flash lights, write
 > to an LCD, log and graph, ...
 
-This package is composed by modules.
-
-`pyownet.protocol` implements low-level intereaction via the owserver protocol.
-A proxy object is created, with methods corresponding to the possible ownet 
-messages:
+The `pyownet.protocol` module is a low-level implementation of the ownet
+protocol. Interaction with an owserver takes place via a proxy object whose
+methods correspond to ownet messages:
 
 ```
 >>> owproxy = OwnetProxy(host="owserver.example.com", port=4304)

pyownet/__init__.py

@@ -1,19 +1,18 @@
 """python ownet client"""
 
-"""
-Copyright 2013, 2014 Stefano Miccoli
-
-
-This python package is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program 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 General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""
+#
+# Copyright 2013, 2014 Stefano Miccoli
+# 
+# This python package is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#

pyownet/protocol.py

@@ -1,10 +1,10 @@
 """ownet protocol implementation
 
-This module provides classes to query an owserver via the ownet protocol. 
-It is a pure python implementation, with no external dependencies.
+This module is a pure python, low level implementation of the ownet 
+protocol.
 
-A proxy object is provided that implements methods for the protocol 
-commands.
+OwnetProxy instances are proxy objects whose methods correspond to ownet 
+protocol messages.
 
 >>> owproxy = OwnetProxy(host="owserver.example.com", port=4304)
 >>> owproxy.ping()
@@ -18,16 +18,33 @@
 >>> owproxy.dir()
 ['/sensA/', '/05.4AEC29CDBAAB/']
 
-The lowlevel OwnetConnection encapsulates all socket operations and 
-interactions with the server.
+The OwnetConnection class encapsulates all socket operations and 
+interactions with the server and is mean for internal use.
 
 """
 
+#
+# Copyright 2013, 2014 Stefano Miccoli
+#
+# This python package is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program 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 General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 from __future__ import print_function
 
 import struct
 import socket
-import collections
+#import collections
 
 # see msg_classification from ow_message.h
 MSG_ERROR = 0
@@ -86,12 +103,17 @@
 
 def str2bytez(s):
     "transform string to zero-terminated bytes"
-    return s.encode() + b'\x00'
+    return s.encode('ascii') + b'\x00'
 
-class _dummy(collections.Sequence):
-    # dummy list, every item is an empty string
-    __len__ = lambda self: 0
-    __getitem__ = lambda self, i: ''
+def bytes2str(b):
+    "transform bytes to string"
+    return b.decode('ascii')
+
+
+#class _dummy(collections.Sequence):
+#    # dummy list, every item is an empty string
+#    __len__ = lambda self: 0
+#    __getitem__ = lambda self, i: ''
 
 #
 # exceptions
@@ -329,10 +351,11 @@ def __init__(self, host='localhost', port=4304, flags=0,
         self.ping()
 
         #self.errmess = _dummy()
+
         # fetch errcodes array from owserver
         errcodes = '/settings/return_codes/text.ALL'
         assert self.present(errcodes)
-        self.errmess = self.read(errcodes).decode().split(',')
+        self.errmess = bytes2str(self.read(errcodes)).split(',')
 
     def sendmess(self, type, payload, flags=0, size=0, offset=0):
         """ retcode, data = sendmess(type, payload)
@@ -358,7 +381,7 @@ def ping(self):
             raise OwnetError(-ret, self.errmess[-ret])
 
     def present(self, path):
-        "returns True if there is an entity as path"
+        "returns True if there is an entity at path"
 
         ret, data = self.sendmess(MSG_PRESENCE, str2bytez(path))
         assert ret <= 0
@@ -384,7 +407,7 @@ def dir(self, path='/', slash=True, bus=False):
         if ret < 0:
             raise OwnetError(-ret, self.errmess[-ret], path)
         if data:
-            return data.decode().split(',')
+            return bytes2str(data).split(',')
         else:
             return []
 
@@ -413,19 +436,19 @@ def write(self, path, data):
         if ret < 0:
             raise OwnetError(-ret, self.errmess[-ret], path)
 
-def _test():
-    proxy = OwnetProxy()
-    proxy.ping()
-    assert not proxy.present('/nonexistent')
-    sensors = proxy.dir('/',bus=False)
-    for j,i in enumerate(sensors):
-        assert proxy.present(i), i
-        stype = proxy.read(i + 'type')
-        if proxy.present(i + 'temperature'):
-            temp = proxy.read(i + 'temperature')
-        else:
-            temp = ''
-        print(i, stype, temp)
+def _main():
+    # print sensors on localhost owserver
+    try:
+        proxy = OwnetProxy()
+    except ConnError:
+        print("No owserver on localhost")
+        return 1
+    print("owserver directory on localhost:")
+    print("id".center(17), "type".center(7))
+    for sensor in proxy.dir(slash=False, bus=False):
+        stype = proxy.read(sensor + '/type')
+        print(sensor.ljust(17), stype.ljust(7))
+    return 0
 
 if __name__ == '__main__':
-    _test()
+    _main()

setup.py

@@ -1,10 +1,16 @@
 from distutils.core import setup
 
 setup(name = 'pyownet',
-      version = '0.6.1',
+      version = '0.6.2.dev0',
+      packages = ['pyownet', ],
       description = 'python ownet client library',
       author = 'Stefano Miccoli',
       author_email = '[email protected]',
       url = 'https://github.com/miccoli/pyownet',
-      packages = ['pyownet', ],
+      classifiers = [
+          'Development Status :: 3 - Alpha',
+          'Environment :: Other Environment',
+          'Intended Audience :: Developers',
+          'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+          ]
      )

tests.py

@@ -0,0 +1,33 @@
+import unittest
+from pyownet import protocol
+
+class TestProtocolModule(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.proxy = protocol.OwnetProxy()
+  
+    def test_ping(self):
+        self.assertIsNone(self.proxy.ping())
+
+    def test_present(self):
+        self.assertIs(self.proxy.present('/'), True)
+        self.assertIs(self.proxy.present('/nonexistent'), False)
+
+    def test_dir(self):
+        for i in self.proxy.dir(bus=False):
+            self.assertTrue(self.proxy.present(i))
+            self.assertTrue(self.proxy.present(i + 'type'))
+            stype = self.proxy.read(i + 'type')
+            if self.proxy.present(i + 'temperature'):
+                temp = self.proxy.read(i + 'temperature')
+            else:
+                temp = ''
+
+    def test_exceptions(self):
+        self.assertRaises(protocol.OwnetError, self.proxy.dir, '/nonexistent')
+        self.assertRaises(protocol.OwnetError, self.proxy.read, '/')
+
+if __name__ == '__main__':
+    unittest.main()
+