Sync back with upstream

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Please read, before you post!
+
+This is a _**BUG REPORT for issues in the existing code**_. 
+
+If you have general questions, code handling problems or ideas, please use the:
+
+Discussionsboard: https://github.com/FreeOpcUa/python-opcua/discussions <br/> or <br />
+Gitter-Channel: https://gitter.im/FreeOpcUa/python-opcua
+
+---
+
+
+To save some time, please provide us following informations, if possible:
+
+
+**Describe the bug** <br />
+A clear and concise description of what the bug is.
+
+**To Reproduce**<br />
+Steps to reproduce the behavior incl code. <br />
+If you post code, please use the "insert Code" (which is the "< >" symbol) format for a better readability.
+
+**Expected behavior**<br />
+A clear and concise description of what you expected to happen.
+
+**Screenshots**<br />
+If applicable, add screenshots to help explain your problem. <br />
+You can post Screenshots directly to github, please don't use 3rd Party webpages
+
+**Version**<br />
+Python-Version:<br />
+python-opcua Version (e.g. master branch, 0.9):

.gitignore

@@ -1,3 +1,4 @@
+tmp_test_*
 build*
 MANIFEST
 .idea*
@@ -21,3 +22,10 @@ examples/history.db
 /.project
 /.pydevproject
 /.settings/
+
+# DS_Store
+.DS_Store
+
+*.der
+*.pem
+venv/

.travis.yml

@@ -1,11 +1,15 @@
 language: python
 python:
   - "2.7"
-  - "3.4"
-  - "pypy"  
+  - "3.6"
+  - "pypy"
+  - "pypy3"
 # command to install dependencies
 install:
   - pip install python-dateutil
+  - pip install datetime
+  - pip install pytz
+  - pip install lxml
   - if [[ $TRAVIS_PYTHON_VERSION == '3.4' ]]; then pip install cryptography ; fi
   - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install futures ; fi
   - if [[ $TRAVIS_PYTHON_VERSION == '2.7' ]]; then pip install cryptography ; fi

Dockerfile

@@ -0,0 +1,5 @@
+FROM python:3.6
+
+RUN pip install opcua
+
+CMD uaserver

README.md

@@ -1,4 +1,4 @@
-Pure Python OPC UA / IEC 62541 Client and Server Python 2, 3 and pypy .
+Pure Python OPC UA / IEC 62541 Client and Server Python 2, 3 and pypy.
 http://freeopcua.github.io/, https://github.com/FreeOpcUa/python-opcua
 
 [![Build Status](https://travis-ci.org/FreeOpcUa/python-opcua.svg?branch=master)](https://travis-ci.org/FreeOpcUa/python-opcua)
@@ -7,17 +7,43 @@ http://freeopcua.github.io/, https://github.com/FreeOpcUa/python-opcua
 [![Codacy Badge](https://api.codacy.com/project/badge/grade/f7f9a138ee7c4541b3b794b86e61e929)](https://www.codacy.com/app/olivier-roulet/python-opcua)
 [![Code Climate](https://codeclimate.com/github/FreeOpcUa/python-opcua/badges/gpa.svg)](https://codeclimate.com/github/FreeOpcUa/python-opcua)
 
-[![PyPI Oackage](https://badge.fury.io/py/freeopcua.svg)](https://badge.fury.io/py/freeopcua)
+[![PyPI Package](https://badge.fury.io/py/opcua.svg)](https://badge.fury.io/py/opcua)
+
+# The library is deprecated. 
+# Please switch to : [opcua-asyncio](https://github.com/FreeOpcUa/opcua-asyncio) which also has a [sync-wrapper](https://github.com/FreeOpcUa/opcua-asyncio/blob/master/asyncua/sync.py), with very few changes in API**
+
+**PR to fix bugs to python-opcua are welcome, but if you want to write new fancy features or architectural changes, please look at opcua-asyncio**
+
+**Why asyncio? because it makes code easier to read and safer(read: less chances for bugs) and since python is monoprocess it might even be faster. It is also a good timing to remove all Python2 code**
+
 
 OPC UA binary protocol implementation is quasi complete and has been tested against many different OPC UA stacks. API offers both a low level interface to send and receive all UA defined structures and high level classes allowing to write a server or a client in a few lines. It is easy to mix high level objects and low level UA calls in one application.
 
-Most low level code is autogenerated from xml specification, thus adding missing functionnality to client or server is often trivial.
+Most low level code is autogenerated from xml specification, thus adding missing functionality to client or server is often trivial.
+
+coverage.py reports a test coverage of over 95 % of code, most of non-tested code is autogenerated code that is not used yet.
+
+
+# Installation
+
+With pip (note: the package was ealier called freeopcua)
+
+    pip install opcua
+
+Ubuntu:
 
-Using Python > 3.4 the dependencies are cryptography and dateutil. If using python 2.7 or pypy < 3 you also need to install enum34, trollius(asyncio), and futures(concurrent.futures), with pip for example.
+    apt install python-opcua        # Library
+    apt install python-opcua-tools  # Command-line tools
 
-coveryage.py reports a test coverage of over 90% of code, most of non-tested code is autogenerate code that is not used yet.
+Dependencies:
+* Python > 3.4: `cryptography`, `dateutil`, `lxml` and `pytz`. 
+* Python 2.7 or pypy < 3: you also need to install `enum34`, `trollius` (`asyncio`), and `futures` (`concurrent.futures`),
+  with pip for example.
 
-Some documentation is available at http://python-opcua.readthedocs.org/en/latest/
+
+# Documentation
+
+Some documentation is available on [ReadTheDocs](http://python-opcua.readthedocs.org/en/latest/).
 
 A simple GUI client is available: https://github.com/FreeOpcUa/opcua-client-gui
 
@@ -27,23 +53,26 @@ Minimal client example: https://github.com/FreeOpcUa/python-opcua/blob/master/ex
 Minimal server example: https://github.com/FreeOpcUa/python-opcua/blob/master/examples/server-minimal.py
 
 A set of command line tools also available: https://github.com/FreeOpcUa/python-opcua/tree/master/tools
-* uadiscover (find_servers, get_endpoints and find_servers_on_network calls)
-* uals (list children of a node)
-* uahistoryread
-* uaread (read attribute of a node)
-* uawrite (write attribute of a node)
-* uacall (call method of a node)
-* uasubscribe (subscribe to a node and print datachange events)
-* uaclient (connect to server and start python shell)
-* uaserver (starts a demo OPC UA server)
+* `uadiscover `(find_servers, get_endpoints and find_servers_on_network calls)
+* `uals `(list children of a node)
+* `uahistoryread`
+* `uaread `(read attribute of a node)
+* `uawrite `(write attribute of a node)
+* `uacall `(call method of a node)
+* `uasubscribe `(subscribe to a node and print datachange events)
+* `uaclient `(connect to server and start python shell)
+* `uaserver `(starts a demo OPC UA server)  
+  `tools/uaserver --populate --certificate cert.pem --private_key pk.pem`
+
+How to generate certificate: https://github.com/FreeOpcUa/python-opcua/tree/master/examples/generate_certificate.sh
 
-    tools/uaserver --populate --certificate cert.pem --private_key pk.pem
+## Client
 
+What works:
 
-Client: what works:
 * connection to server, opening channel, session
 * browsing and reading attributes value
-* gettings nodes by path and nodeids
+* getting nodes by path and nodeids
 * creating subscriptions
 * subscribing to items for data change
 * subscribing to events
@@ -55,19 +84,24 @@ Client: what works:
 * communication encryption
 * removing nodes
 
-Tested servers: freeopcua C++, freeopcua Python, prosys, kepware, beckoff
+Tested servers: freeopcua C++, freeopcua Python, prosys, kepware, beckhoff, winCC, B&R, …
+
+Not implemented yet:
 
-Client: what is not implemented yet
 * localized text feature
-* adding some missing modify methods
 * XML protocol
+* UDP
+* maybe automatic reconnection...
+
 
+## Server
+
+What works:
 
-Server: what works:
 * creating channel and sessions
 * read/set attributes and browse
-* gettings nodes by path and nodeids
-* autogenerate addres space from spec
+* getting nodes by path and nodeids
+* autogenerate address space from spec
 * adding nodes to address space
 * datachange events
 * events
@@ -80,43 +114,55 @@ Server: what works:
 
 Tested clients: freeopcua C++, freeopcua Python, uaexpert, prosys, quickopc
 
-Server: what is not implemented
+Not yet implemented:
+
+* more high level solution to create custom structures
+* UDP
+* session restore
 * alarms
 * XML protocol
 * views
 * localized text features
-* better securty model with users and password
-* adding some missing modify methods
+* better security model with users and password
+
 
-Server: Running on a Raspberry Pi
+### Running a server on a Raspberry Pi
+
+Setting up the standard address-space from XML is the most time-consuming step of the startup process which may lead to
+long startup times on less powerful devices like a Raspberry Pi. By passing a path to a cache-file to the server constructor,
+a shelve holding the address space will be created during the first startup. All following startups will make use of the
+cache-file which leads to significantly better startup performance (~3.5 vs 125 seconds on a Raspberry Pi Model B).
 
-Setting up the standard address-space from XML is the most time-consuming step of the startup process which may lead to long startup times on less powerful devices like a Raspberry Pi. By passing a path to a cache-file to the server constructor, a shelve holding the address space will be created during the first startup. All following startups will make use of the cache-file which leads to significantly better startup performance (~3.5 vs 125 seconds on a Raspbery Pi Model B).
 
 # Development
 
-Code follows PEP8 apart for line lengths which should be max 120 characters and OPC UA structures that keep camel case from XML definition.
+Code follows PEP8 apart for line lengths which should be max 120 characters and OPC UA structures that keep camel case
+from XML definition.
 
 All protocol code is under opcua directory
 
-- opcua/ua contains all UA structures from specification, most are autogenerated
-- opcua/common contains high level objects and methods used both in server and client
-- opcua/client contains client specific code
-- opcua/server contains server specific code
-- opcua/utils contains some utilities function and classes
-- opcua/tools contains code for command lines tools
-- schemas contains the XML and text files from specification and the python scripts used to autogenerate code
-- tests contains tests
-- docs contains files to auto generate documentation from doc strings
-- examples contains many example files
-- tools contains python scripts that can be used to run command line tools from repository without installing
+- `opcua/ua` contains all UA structures from specification, most are autogenerated
+- `opcua/common` contains high level objects and methods used both in server and client
+- `opcua/client` contains client specific code
+- `opcua/server` contains server specific code
+- `opcua/utils` contains some utilities function and classes
+- `opcua/tools` contains code for command lines tools
+- `schemas` contains the XML and text files from specification and the python scripts used to autogenerate code
+- `tests` contains tests
+- `docs` contains files to auto generate documentation from doc strings
+- `examples` contains many example files
+- `tools` contains python scripts that can be used to run command line tools from repository without installing
 
 ## Running tests:
 
-python tests.py
+```
+./run-tests.sh
+```
 
 ## Coverage
 
+```
 coverage run tests.py
 coverage html
 firefox htmlcov/index.html
-
+```

docs/index.rst

@@ -20,8 +20,8 @@ A simple GUI client is available: https://github.com/FreeOpcUa/opcua-client-gui
 
 Examples: https://github.com/FreeOpcUa/python-opcua/tree/master/examples
 
-Minimal client example: https://github.com/FreeOpcUa/python-opcua/tree/master/examples/minimal-client.py
-Minimal server example: https://github.com/FreeOpcUa/python-opcua/tree/master/examples/minimal-server.py
+Minimal client example: https://github.com/FreeOpcUa/python-opcua/blob/master/examples/client-minimal.py
+Minimal server example: https://github.com/FreeOpcUa/python-opcua/blob/master/examples/server-minimal.py
 
 
 Contents:

examples/client-example.py

@@ -44,6 +44,7 @@ def event_notification(self, event):
     # client = Client("opc.tcp://admin@localhost:4840/freeopcua/server/") #connect using a user
     try:
         client.connect()
+        client.load_type_definitions()  # load definition of server specific structures/extension objects
 
         # Client has a few methods to get proxy to UA nodes that should always be in address space such as Root or Objects
         root = client.get_root_node()
@@ -57,15 +58,20 @@ def event_notification(self, event):
         # get a specific node knowing its node id
         #var = client.get_node(ua.NodeId(1002, 2))
         #var = client.get_node("ns=3;i=2002")
+        #var = client.get_node("ns=2;g=1be5ba38-d004-46bd-aa3a-b5b87940c698")
         #print(var)
         #var.get_data_value() # get value of node as a DataValue object
         #var.get_value() # get value of node as a python builtin
         #var.set_value(ua.Variant([23], ua.VariantType.Int64)) #set node value using explicit data type
         #var.set_value(3.9) # set node value using implicit data type
 
+        # gettting our namespace idx
+        uri = "http://examples.freeopcua.github.io"
+        idx = client.get_namespace_index(uri)
+
         # Now getting a variable node using its browse path
-        myvar = root.get_child(["0:Objects", "2:MyObject", "2:MyVariable"])
-        obj = root.get_child(["0:Objects", "2:MyObject"])
+        myvar = root.get_child(["0:Objects", "{}:MyObject".format(idx), "{}:MyVariable".format(idx)])
+        obj = root.get_child(["0:Objects", "{}:MyObject".format(idx)])
         print("myvar is: ", myvar)
 
         # subscribing to a variable node
@@ -80,7 +86,7 @@ def event_notification(self, event):
         # sub.delete()
 
         # calling a method on server
-        res = obj.call_method("2:multiply", 3, "klk")
+        res = obj.call_method("{}:multiply".format(idx), 3, "klk")
         print("method result is: ", res)
 
         embed()

examples/client-minimal.py

@@ -32,6 +32,10 @@
         myvar = root.get_child(["0:Objects", "2:MyObject", "2:MyVariable"])
         obj = root.get_child(["0:Objects", "2:MyObject"])
         print("myvar is: ", myvar)
+        print("myobj is: ", obj)
+
+        # Stacked myvar access
+        # print("myvar is: ", root.get_children()[0].get_children()[1].get_variables()[0].get_value())
 
     finally:
         client.disconnect()

examples/client-with-encryption.py

@@ -0,0 +1,26 @@
+import sys
+sys.path.insert(0, "..")
+import logging
+
+from IPython import embed
+
+from opcua import Client
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.WARNING)
+    client = Client("opc.tcp://localhost:4840/freeopcua/server/")
+    #client = Client("opc.tcp://localhost:53530/OPCUA/SimulationServer/")
+    client.set_security_string("Basic256Sha256,SignAndEncrypt,certificate-example.der,private-key-example.pem")
+    client.application_uri = "urn:example.org:FreeOpcUa:python-opcua"
+    client.secure_channel_timeout = 10000
+    client.session_timeout = 10000
+    try:
+        client.connect()
+        root = client.get_root_node()
+        objects = client.get_objects_node()
+        print("childs og objects are: ", objects.get_children())
+
+        embed()
+    finally:
+        client.disconnect()