query backends from installed packages #106

edoput · 2018-05-18T12:56:48Z

Hi all,

this will solve a problem that I had last summer during GSOC. Using entry_points in the definition
of setup.py we can query possible backends for use in netjsonconfig in other packages instead of having long-lived branches.

This is an example for a setup.py using the entry_points directive

from setuptools import setup, find_packages                                                                                                           
                                                                                                                                                      
setup(                                                                                                                                                
    name='airos',                                                                                                                                  
    version='0.0.0',                                                                                                                                  
    description='AirOS backend for netjsonconfig',                                                                                                                          
    packages=find_packages(),                                                                                                                         
    entry_points={                                                                                                                                    
        'netjsonconfig.backends': [                                                                                                                   
            'airos=netjsonconfig-airos.backend:AirOsBackend',                                                                                                    
        ]                                                                                                                                             
    }                                                                                                                                                 
)

coveralls · 2018-05-21T08:46:27Z

Coverage remained the same at 99.931% when pulling 2bf557c on edoput:master into 11cfed1 on openwisp:master.

coveralls · 2018-05-21T08:46:27Z

Coverage remained the same at 99.931% when pulling 1511fc1 on edoput:master into 11cfed1 on openwisp:master.

edoput · 2018-05-22T21:24:55Z

This is an example backend as an external package that when installed along with netjsonconfig will let the user choose the example backend directly when using netjsonconfig

redhog · 2018-05-23T14:48:42Z

I greatly support this patch as it's The Right Way To Do it :P Please merge :)

redhog · 2018-05-31T12:06:00Z

netjsonconfig/__init__.py

+        try:
+            default.update({entry_point.name.lower(): entry_point.load()})
+        except ImportError as e:
+            print("Error loading backend {}".format(entry_point.name.lower()), file=sys.stderr)


Shouldn't this rather use the python logging framework?

in the grand scheme of integrating with openwisp-contoller it should use whatever openwisp-config is using? I don't really know what is the correct way to log this but I didn't want crash to propagate to netjsonconfig when loading. Moreover loggin requires to choose a target (console, file, syslog, ...) and a level and I'm not sure which should they be,

django-netjsonconfig/utils.py:9 uses

import logging logger = logging.getLogger(__name__) logger.warning("Grrrrrr")

Ok I'll change this to be a logger on the console 👍

edoput · 2018-06-01T07:35:36Z

Let me know if there's anything else to do or I'll squash everything before merge

redhog

Looks good :)

this will use the entry_points feature of pkg_resources to query other installed packages for additional backends. - [doc] added page create_your_backend - prevent import errors from crashing the cli during load the module will be imported but if an ImportError is raised the cli crash. This will prevent the cli from crashing but will not expose the backend to the user. An error message will be logger to console - exclude except form from flake qa this form is the only one compatible between python2 and python3 but flake is also worried about the e variable which is not used

nemesifier

@edoput great job 👍, thank you!

redhog reviewed May 31, 2018

View reviewed changes

redhog approved these changes Jun 1, 2018

View reviewed changes

edoput force-pushed the master branch from 69552c5 to ecfb31c Compare June 1, 2018 08:08

edoput changed the title ~~WIP: query backends from installed packages~~ query backends from installed packages Jun 1, 2018

edoput force-pushed the master branch from 46b67a0 to ded88d2 Compare June 10, 2018 08:10

edoput force-pushed the master branch from ded88d2 to 2bf557c Compare June 10, 2018 08:14

nemesifier added this to To do (general) in OpenWISP Contributor's Board via automation Jun 11, 2018

nemesifier approved these changes Jun 11, 2018

View reviewed changes

nemesifier merged commit ec56134 into openwisp:master Jun 11, 2018

OpenWISP Contributor's Board automation moved this from To do (general) to Done Jun 11, 2018

edoput mentioned this pull request Jul 4, 2018

Add support for Airos in OpenWISP2 #91

Open

query backends from installed packages #106

query backends from installed packages #106

edoput commented May 18, 2018

coveralls commented May 21, 2018 •

edited

coveralls commented May 21, 2018

edoput commented May 22, 2018

redhog commented May 23, 2018

redhog May 31, 2018

edoput May 31, 2018 •

edited

redhog May 31, 2018 •

edited

edoput May 31, 2018

edoput commented Jun 1, 2018

redhog left a comment

nemesifier left a comment

query backends from installed packages #106

query backends from installed packages #106

Conversation

edoput commented May 18, 2018

coveralls commented May 21, 2018 • edited

coveralls commented May 21, 2018

edoput commented May 22, 2018

redhog commented May 23, 2018

redhog May 31, 2018

Choose a reason for hiding this comment

edoput May 31, 2018 • edited

Choose a reason for hiding this comment

redhog May 31, 2018 • edited

Choose a reason for hiding this comment

edoput May 31, 2018

Choose a reason for hiding this comment

edoput commented Jun 1, 2018

redhog left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

coveralls commented May 21, 2018 •

edited

edoput May 31, 2018 •

edited

redhog May 31, 2018 •

edited