mirror of
https://github.com/gsi-upm/senpy
synced 2025-09-17 12:02:21 +00:00
Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
37a098109f | ||
|
ff14925056 | ||
|
10f4782ad7 | ||
|
4351f76b60 | ||
|
86f45f8147 |
20
app.py
20
app.py
@@ -15,21 +15,29 @@
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""
|
||||
Simple Sentiment Analysis server for EUROSENTIMENT
|
||||
This is a helper for development. If you want to run Senpy use:
|
||||
|
||||
This class shows how to use the nif_server module to create custom services.
|
||||
python -m senpy
|
||||
"""
|
||||
from gevent.monkey import patch_all; patch_all()
|
||||
import gevent
|
||||
import config
|
||||
from flask import Flask
|
||||
from senpy.extensions import Senpy
|
||||
import logging
|
||||
import os
|
||||
from gevent.wsgi import WSGIServer
|
||||
|
||||
logging.basicConfig(level=logging.DEBUG)
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
sp = Senpy()
|
||||
sp.init_app(app)
|
||||
mypath = os.path.dirname(os.path.realpath(__file__))
|
||||
sp = Senpy(app, os.path.join(mypath, "plugins"))
|
||||
sp.activate_all()
|
||||
|
||||
if __name__ == '__main__':
|
||||
import logging
|
||||
logging.basicConfig(level=config.DEBUG)
|
||||
app.debug = config.DEBUG
|
||||
app.run(host="0.0.0.0", use_reloader=False)
|
||||
http_server = WSGIServer(('', config.SERVER_PORT), app)
|
||||
http_server.serve_forever()
|
||||
|
@@ -6,19 +6,6 @@ from senpy.models import Response, Opinion, Entry
|
||||
|
||||
|
||||
class Sentiment140Plugin(SentimentPlugin):
|
||||
EXTRA_PARAMS = {
|
||||
"language": {"aliases": ["language", "l"],
|
||||
"required": False,
|
||||
"options": ["es", "en", "auto"],
|
||||
}
|
||||
}
|
||||
|
||||
def __init__(self, **kwargs):
|
||||
super(Sentiment140Plugin, self).__init__(name="sentiment140",
|
||||
version="2.0",
|
||||
extraparams=self.EXTRA_PARAMS,
|
||||
**kwargs)
|
||||
|
||||
def analyse(self, **params):
|
||||
lang = params.get("language", "auto")
|
||||
res = requests.post("http://www.sentiment140.com/api/bulkClassifyJson",
|
||||
@@ -28,18 +15,19 @@ class Sentiment140Plugin(SentimentPlugin):
|
||||
)
|
||||
)
|
||||
|
||||
response = Response()
|
||||
response = Response(base=params.get("prefix", None))
|
||||
polarity_value = int(res.json()["data"][0]["polarity"]) * 25
|
||||
polarity = "marl:Neutral"
|
||||
if polarity_value > 50:
|
||||
polarity = "marl:Positive"
|
||||
elif polarity_value < 50:
|
||||
polarity = "marl:Negative"
|
||||
entry = Entry(text=params["input"])
|
||||
opinion = Opinion(hasPolarity=polarity, polarityValue=polarity_value)
|
||||
entry = Entry(id="Entry0", text=params["input"])
|
||||
opinion = Opinion(id="Opinion0",
|
||||
hasPolarity=polarity,
|
||||
polarityValue=polarity_value)
|
||||
opinion["prov:wasGeneratedBy"] = self.id
|
||||
entry.opinions.append(opinion)
|
||||
entry.language = lang
|
||||
response.entries.append(entry)
|
||||
return response
|
||||
|
||||
plugin = Sentiment140Plugin()
|
15
plugins/sentiment140/sentiment140.senpy
Normal file
15
plugins/sentiment140/sentiment140.senpy
Normal file
@@ -0,0 +1,15 @@
|
||||
{
|
||||
"name": "sentiment140",
|
||||
"module": "sentiment140",
|
||||
"description": "What my plugin broadly does",
|
||||
"author": "@balkian",
|
||||
"version": "0.1",
|
||||
"extra_params": {
|
||||
"language": {
|
||||
"aliases": ["language", "l"],
|
||||
"required": false,
|
||||
"options": ["es", "en", "auto"]
|
||||
}
|
||||
},
|
||||
"requirements": {}
|
||||
}
|
@@ -1,4 +1,6 @@
|
||||
Flask==0.10.1
|
||||
gunicorn==19.0.0
|
||||
requests==2.4.1
|
||||
GitPython==0.3.2.RC1
|
||||
GitPython==0.3.2.RC1
|
||||
Yapsy>=1.10.423
|
||||
gevent>=1.0.1
|
@@ -21,5 +21,3 @@ Sentiment analysis server in Python
|
||||
import extensions
|
||||
import blueprints
|
||||
import plugins
|
||||
|
||||
__version__ = "0.2.8"
|
||||
|
@@ -1,7 +1,73 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright 2014 J. Fernando Sánchez Rada - Grupo de Sistemas Inteligentes
|
||||
# DIT, UPM
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""
|
||||
Senpy is a modular sentiment analysis server. This script runs an instance of
|
||||
the server.
|
||||
|
||||
"""
|
||||
from gevent.monkey import patch_all; patch_all(thread=False)
|
||||
import gevent
|
||||
from flask import Flask
|
||||
from extensions import Senpy
|
||||
app = Flask(__name__)
|
||||
sp = Senpy()
|
||||
sp.init_app(app)
|
||||
app.debug = True
|
||||
app.run()
|
||||
from senpy.extensions import Senpy
|
||||
import logging
|
||||
import os
|
||||
from gevent.wsgi import WSGIServer
|
||||
import argparse
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser(description='Run a Senpy server')
|
||||
parser.add_argument('--level',
|
||||
"-l",
|
||||
metavar="logging_level",
|
||||
type=str,
|
||||
default="INFO",
|
||||
help='Logging level')
|
||||
parser.add_argument('--debug',
|
||||
"-d",
|
||||
metavar="debug",
|
||||
type=bool,
|
||||
default=False,
|
||||
help='Run the application in debug mode')
|
||||
parser.add_argument('--host',
|
||||
type=str,
|
||||
default = "127.0.0.1",
|
||||
help='Use 0.0.0.0 to accept requests from any host.')
|
||||
parser.add_argument('--port',
|
||||
'-p',
|
||||
type=int,
|
||||
default = 5000,
|
||||
help='Port to listen on.')
|
||||
parser.add_argument('--plugins-folder',
|
||||
'-f',
|
||||
type=str,
|
||||
default = "plugins",
|
||||
help='Where to look for plugins.')
|
||||
args = parser.parse_args()
|
||||
logging.basicConfig(level=getattr(logging,args.level))
|
||||
app = Flask(__name__)
|
||||
app.debug = args.debug
|
||||
sp = Senpy(app, args.plugins_folder)
|
||||
sp.activate_all()
|
||||
import logging
|
||||
http_server = WSGIServer((args.host, args.port), app)
|
||||
try:
|
||||
print "Server running on port %s:%d. Ctrl+C to quit" % (args.host,
|
||||
args.port)
|
||||
http_server.serve_forever()
|
||||
except KeyboardInterrupt:
|
||||
http_server.stop()
|
||||
print "Bye!"
|
||||
|
@@ -48,7 +48,7 @@ def get_params(req, params=BASIC_PARAMS):
|
||||
if alias in indict:
|
||||
outdict[param] = indict[alias]
|
||||
if param not in outdict:
|
||||
if options.get("required", False):
|
||||
if options.get("required", False) and "default" not in options:
|
||||
wrong_params[param] = params[param]
|
||||
else:
|
||||
if "default" in options:
|
||||
@@ -110,23 +110,22 @@ def default():
|
||||
@nif_blueprint.route('/plugins/<plugin>/<action>', methods=['POST', 'GET'])
|
||||
def plugins(plugin=None, action="list"):
|
||||
filt = {}
|
||||
sp = current_app.senpy
|
||||
if plugin:
|
||||
filt["name"] = plugin
|
||||
plugs = current_app.senpy.filter_plugins(**filt)
|
||||
plugs = sp.filter_plugins(**filt)
|
||||
if plugin and not plugs:
|
||||
return "Plugin not found", 400
|
||||
if action == "list":
|
||||
with_params = request.args.get("params", "") == "1"
|
||||
dic = {plug: plugs[plug].jsonable(with_params) for plug in plugs}
|
||||
if plugin:
|
||||
dic = plugs[plugin].jsonable(with_params)
|
||||
else:
|
||||
dic = {plug: plugs[plug].jsonable(with_params) for plug in plugs}
|
||||
return jsonify(dic)
|
||||
if action == "disable":
|
||||
current_app.senpy.disable_plugin(plugin)
|
||||
return "Ok"
|
||||
elif action == "enable":
|
||||
current_app.senpy.enable_plugin(plugin)
|
||||
return "Ok"
|
||||
elif action == "reload":
|
||||
current_app.senpy.reload_plugin(plugin)
|
||||
method = "{}_plugin".format(action)
|
||||
if(hasattr(sp, method)):
|
||||
getattr(sp, method)(plugin)
|
||||
return "Ok"
|
||||
else:
|
||||
return "action '{}' not allowed".format(action), 400
|
||||
|
@@ -34,6 +34,7 @@
|
||||
"@id": "dc:date",
|
||||
"@type": "xsd:dateTime"
|
||||
},
|
||||
"text": { "@id": "nif:isString" },
|
||||
"wnaffect": "http://www.gsi.dit.upm.es/ontologies/wnaffect#",
|
||||
"xsd": "http://www.w3.org/2001/XMLSchema#"
|
||||
}
|
||||
|
@@ -1,21 +1,21 @@
|
||||
"""
|
||||
"""
|
||||
import os
|
||||
import fnmatch
|
||||
import inspect
|
||||
import sys
|
||||
import imp
|
||||
import logging
|
||||
import gevent
|
||||
import json
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
from .plugins import SentimentPlugin, EmotionPlugin
|
||||
|
||||
try:
|
||||
from flask import _app_ctx_stack as stack
|
||||
except ImportError:
|
||||
from flask import _request_ctx_stack as stack
|
||||
from .plugins import SenpyPlugin, SentimentPlugin, EmotionPlugin
|
||||
|
||||
from .blueprints import nif_blueprint
|
||||
from git import Repo, InvalidGitRepositoryError
|
||||
from functools import partial
|
||||
|
||||
|
||||
class Senpy(object):
|
||||
@@ -50,11 +50,13 @@ class Senpy(object):
|
||||
app.register_blueprint(nif_blueprint)
|
||||
|
||||
def add_folder(self, folder):
|
||||
logger.debug("Adding folder: %s", folder)
|
||||
if os.path.isdir(folder):
|
||||
self._search_folders.add(folder)
|
||||
self._outdated = True
|
||||
return True
|
||||
else:
|
||||
logger.debug("Not a folder: %s", folder)
|
||||
return False
|
||||
|
||||
def analyse(self, **params):
|
||||
@@ -64,17 +66,20 @@ class Senpy(object):
|
||||
algo = params["algorithm"]
|
||||
elif self.plugins:
|
||||
algo = self.default_plugin
|
||||
if algo in self.plugins and self.plugins[algo].enabled:
|
||||
plug = self.plugins[algo]
|
||||
resp = plug.analyse(**params)
|
||||
resp.analysis.append(plug.jsonable())
|
||||
return resp
|
||||
if algo in self.plugins:
|
||||
if self.plugins[algo].is_activated:
|
||||
plug = self.plugins[algo]
|
||||
resp = plug.analyse(**params)
|
||||
resp.analysis.append(plug.jsonable())
|
||||
return resp
|
||||
logger.debug("Plugin not activated: {}".format(algo))
|
||||
else:
|
||||
logger.debug("The algorithm '{}' is not valid\nValid algorithms: {}".format(algo, self.plugins.keys()))
|
||||
return {"status": 400, "message": "The algorithm '{}' is not valid".format(algo)}
|
||||
|
||||
@property
|
||||
def default_plugin(self):
|
||||
candidates = self.filter_plugins(enabled=True)
|
||||
candidates = self.filter_plugins(is_activated=True)
|
||||
if len(candidates) > 0:
|
||||
candidate = candidates.keys()[0]
|
||||
logger.debug("Default: {}".format(candidate))
|
||||
@@ -85,11 +90,38 @@ class Senpy(object):
|
||||
def parameters(self, algo):
|
||||
return getattr(self.plugins.get(algo or self.default_plugin), "params", {})
|
||||
|
||||
def enable_plugin(self, plugin):
|
||||
self.plugins[plugin].enable()
|
||||
def activate_all(self, sync=False):
|
||||
ps = []
|
||||
for plug in self.plugins.keys():
|
||||
ps.append(self.activate_plugin(plug, sync=sync))
|
||||
return ps
|
||||
|
||||
def disable_plugin(self, plugin):
|
||||
self.plugins[plugin].disable()
|
||||
def deactivate_all(self, sync=False):
|
||||
ps = []
|
||||
for plug in self.plugins.keys():
|
||||
ps.append(self.deactivate_plugin(plug, sync=sync))
|
||||
return ps
|
||||
|
||||
def _set_active_plugin(self, plugin_name, active=True, *args, **kwargs):
|
||||
self.plugins[plugin_name].is_activated = active
|
||||
|
||||
def activate_plugin(self, plugin_name, sync=False):
|
||||
plugin = self.plugins[plugin_name]
|
||||
th = gevent.spawn(plugin.activate)
|
||||
th.link_value(partial(self._set_active_plugin, plugin_name, True))
|
||||
if sync:
|
||||
th.join()
|
||||
else:
|
||||
return th
|
||||
|
||||
def deactivate_plugin(self, plugin_name, sync=False):
|
||||
plugin = self.plugins[plugin_name]
|
||||
th = gevent.spawn(plugin.deactivate)
|
||||
th.link_value(partial(self._set_active_plugin, plugin_name, False))
|
||||
if sync:
|
||||
th.join()
|
||||
else:
|
||||
return th
|
||||
|
||||
def reload_plugin(self, plugin):
|
||||
logger.debug("Reloading {}".format(plugin))
|
||||
@@ -99,38 +131,47 @@ class Senpy(object):
|
||||
self.plugins[nplug.name] = nplug
|
||||
|
||||
@staticmethod
|
||||
def _load_plugin(plugin, search_folder, enabled=True):
|
||||
logger.debug("Loading plugins")
|
||||
sys.path.append(search_folder)
|
||||
(fp, pathname, desc) = imp.find_module(plugin)
|
||||
def _load_plugin(root, filename):
|
||||
logger.debug("Loading plugin: {}".format(filename))
|
||||
fpath = os.path.join(root, filename)
|
||||
with open(fpath,'r') as f:
|
||||
info = json.load(f)
|
||||
logger.debug("Info: {}".format(info))
|
||||
sys.path.append(root)
|
||||
module = info["module"]
|
||||
name = info["name"]
|
||||
(fp, pathname, desc) = imp.find_module(module, [root,])
|
||||
try:
|
||||
tmp = imp.load_module(plugin, fp, pathname, desc).plugin
|
||||
sys.path.remove(search_folder)
|
||||
tmp.path = search_folder
|
||||
tmp = imp.load_module(module, fp, pathname, desc)
|
||||
sys.path.remove(root)
|
||||
candidate = None
|
||||
for _, obj in inspect.getmembers(tmp):
|
||||
if inspect.isclass(obj) and inspect.getmodule(obj) == tmp:
|
||||
logger.debug("Found plugin class: {}@{}".format(obj, inspect.getmodule(obj)))
|
||||
candidate = obj
|
||||
break
|
||||
if not candidate:
|
||||
logger.debug("No valid plugin for: {}".format(filename))
|
||||
return
|
||||
module = candidate(info=info)
|
||||
try:
|
||||
repo_path = os.path.join(search_folder, plugin)
|
||||
tmp.repo = Repo(repo_path)
|
||||
repo_path = root
|
||||
module.repo = Repo(repo_path)
|
||||
except InvalidGitRepositoryError:
|
||||
tmp.repo = None
|
||||
if not hasattr(tmp, "enabled"):
|
||||
tmp.enabled = enabled
|
||||
tmp.module = plugin
|
||||
module.repo = None
|
||||
except Exception as ex:
|
||||
tmp = None
|
||||
logger.debug("Exception importing {}: {}".format(plugin, ex))
|
||||
return tmp
|
||||
logger.debug("Exception importing {}: {}".format(filename, ex))
|
||||
return None, None
|
||||
return name, module
|
||||
|
||||
def _load_plugins(self):
|
||||
plugins = {}
|
||||
for search_folder in self._search_folders:
|
||||
for item in os.listdir(search_folder):
|
||||
if os.path.isdir(os.path.join(search_folder, item)) \
|
||||
and os.path.exists(os.path.join(search_folder,
|
||||
item,
|
||||
"__init__.py")):
|
||||
plugin = self._load_plugin(item, search_folder)
|
||||
for root, dirnames, filenames in os.walk(search_folder):
|
||||
for filename in fnmatch.filter(filenames, '*.senpy'):
|
||||
name, plugin = self._load_plugin(root, filename)
|
||||
if plugin:
|
||||
plugins[plugin.name] = plugin
|
||||
plugins[name] = plugin
|
||||
|
||||
self._outdated = False
|
||||
return plugins
|
||||
@@ -138,18 +179,12 @@ class Senpy(object):
|
||||
def teardown(self, exception):
|
||||
pass
|
||||
|
||||
def enable_all(self):
|
||||
for plugin in self.plugins:
|
||||
self.enable_plugin(plugin)
|
||||
|
||||
@property
|
||||
def plugins(self):
|
||||
""" Return the plugins registered for a given application. """
|
||||
ctx = stack.top
|
||||
if ctx is not None:
|
||||
if not hasattr(ctx, 'senpy_plugins') or self._outdated:
|
||||
ctx.senpy_plugins = self._load_plugins()
|
||||
return ctx.senpy_plugins
|
||||
if not hasattr(self, 'senpy_plugins') or self._outdated:
|
||||
self.senpy_plugins = self._load_plugins()
|
||||
return self.senpy_plugins
|
||||
|
||||
def filter_plugins(self, **kwargs):
|
||||
""" Filter plugins by different criteria """
|
||||
|
@@ -4,22 +4,41 @@ from collections import defaultdict
|
||||
|
||||
|
||||
class Leaf(defaultdict):
|
||||
def __init__(self, context=None, ofclass=list):
|
||||
_prefix = None
|
||||
|
||||
def __init__(self, id=None, context=None, prefix=None, ofclass=list):
|
||||
super(Leaf, self).__init__(ofclass)
|
||||
if context:
|
||||
self.context = context
|
||||
if id:
|
||||
self.id = id
|
||||
self._prefix = prefix
|
||||
|
||||
def __getattr__(self, name):
|
||||
if name is not "context":
|
||||
return super(Leaf, self).__getitem__(name)
|
||||
return self["@context"]
|
||||
def __getattr__(self, key):
|
||||
return super(Leaf, self).__getitem__(self._get_key(key))
|
||||
|
||||
def __setattr__(self, name, value):
|
||||
name = "@context" if name is "context" else name
|
||||
self[name] = self.get_context(value)
|
||||
def __setattr__(self, key, value):
|
||||
try:
|
||||
object.__getattr__(self, key)
|
||||
object.__setattr__(self, key, value)
|
||||
except AttributeError:
|
||||
key = self._get_key(key)
|
||||
value = self.get_context(value) if key == "@context" else value
|
||||
if key[0] == "_":
|
||||
object.__setattr__(self, key, value)
|
||||
else:
|
||||
super(Leaf, self).__setitem__(key, value)
|
||||
|
||||
def __delattr__(self, name):
|
||||
return super(Leaf, self).__delitem__(name)
|
||||
def __delattr__(self, key):
|
||||
return super(Leaf, self).__delitem__(self._get_key(key))
|
||||
|
||||
def _get_key(self, key):
|
||||
if key in ["context", "id"]:
|
||||
return "@{}".format(key)
|
||||
elif self._prefix:
|
||||
return "{}:{}".format(self._prefix, key)
|
||||
else:
|
||||
return key
|
||||
|
||||
@staticmethod
|
||||
def get_context(context):
|
||||
@@ -39,11 +58,13 @@ class Leaf(defaultdict):
|
||||
|
||||
|
||||
class Response(Leaf):
|
||||
def __init__(self, context=None, *args, **kwargs):
|
||||
def __init__(self, context=None, base=None, *args, **kwargs):
|
||||
if context is None:
|
||||
context = "{}/context.jsonld".format(os.path.dirname(
|
||||
os.path.realpath(__file__)))
|
||||
super(Response, self).__init__(*args, context=context, **kwargs)
|
||||
if base:
|
||||
self.context["@base"] = base
|
||||
self["analysis"] = []
|
||||
self["entries"] = []
|
||||
|
||||
@@ -60,11 +81,9 @@ class Entry(Leaf):
|
||||
|
||||
|
||||
class Opinion(Leaf):
|
||||
opinionContext = {
|
||||
"@vocab": "http://www.gsi.dit.upm.es/ontologies/marl/ns#"
|
||||
}
|
||||
#opinionContext = {"@vocab": "http://www.gsi.dit.upm.es/ontologies/marl/ns#"}
|
||||
def __init__(self, polarityValue=None, hasPolarity=None, *args, **kwargs):
|
||||
super(Opinion, self).__init__(context=self.opinionContext,
|
||||
super(Opinion, self).__init__( prefix="marl",
|
||||
*args,
|
||||
**kwargs)
|
||||
if polarityValue is not None:
|
||||
@@ -74,13 +93,18 @@ class Opinion(Leaf):
|
||||
|
||||
|
||||
class EmotionSet(Leaf):
|
||||
emotionContext = {
|
||||
"@vocab": "http://www.gsi.dit.upm.es/ontologies/onyx/ns#"
|
||||
}
|
||||
emotionContext = {}
|
||||
def __init__(self, emotions=None, *args, **kwargs):
|
||||
if not emotions:
|
||||
emotions = []
|
||||
super(EmotionSet, self).__init__(context=self.emotionContext,
|
||||
super(EmotionSet, self).__init__(context=EmotionSet.emotionContext,
|
||||
*args,
|
||||
**kwargs)
|
||||
self.emotions = emotions or []
|
||||
|
||||
class Emotion(Leaf):
|
||||
emotionContext = {}
|
||||
def __init__(self, emotions=None, *args, **kwargs):
|
||||
super(EmotionSet, self).__init__(context=Emotion.emotionContext,
|
||||
*args,
|
||||
**kwargs)
|
||||
|
@@ -1,4 +1,5 @@
|
||||
import logging
|
||||
import ConfigParser
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
@@ -25,6 +26,10 @@ PARAMS = {"input": {"aliases": ["i", "input"],
|
||||
"required": False,
|
||||
"options": ["es", "en"],
|
||||
},
|
||||
"prefix": {"aliases": ["prefix", "p"],
|
||||
"required": True,
|
||||
"default": "",
|
||||
},
|
||||
"urischeme": {"aliases": ["urischeme", "u"],
|
||||
"required": False,
|
||||
"default": "RFC5147String",
|
||||
@@ -34,39 +39,44 @@ PARAMS = {"input": {"aliases": ["i", "input"],
|
||||
|
||||
|
||||
class SenpyPlugin(object):
|
||||
def __init__(self, name=None, version=None, extraparams=None, params=None):
|
||||
logger.debug("Initialising {}".format(name))
|
||||
self.name = name
|
||||
self.version = version
|
||||
if params:
|
||||
self.params = params
|
||||
else:
|
||||
self.params = PARAMS.copy()
|
||||
if extraparams:
|
||||
self.params.update(extraparams)
|
||||
self.extraparams = extraparams or {}
|
||||
self.enabled = True
|
||||
def __init__(self, info=None):
|
||||
if not info:
|
||||
raise ValueError("You need to provide configuration information for the plugin.")
|
||||
logger.debug("Initialising {}".format(info))
|
||||
self.name = info["name"]
|
||||
self.version = info["version"]
|
||||
self.params = info.get("params", PARAMS.copy())
|
||||
self.extra_params = info.get("extra_params", {})
|
||||
self.params.update(self.extra_params)
|
||||
self.is_activated = False
|
||||
self.info = info
|
||||
|
||||
def analyse(self, *args, **kwargs):
|
||||
logger.debug("Analysing with: {} {}".format(self.name, self.version))
|
||||
pass
|
||||
|
||||
def enable(self):
|
||||
self.enabled = True
|
||||
def activate(self):
|
||||
pass
|
||||
|
||||
def disable(self):
|
||||
self.enabled = False
|
||||
def deactivate(self):
|
||||
pass
|
||||
|
||||
|
||||
@property
|
||||
def id(self):
|
||||
return "{}_{}".format(self.name, self.version)
|
||||
|
||||
def jsonable(self, parameters=False):
|
||||
resp = {
|
||||
"@id": "{}_{}".format(self.name, self.version),
|
||||
"enabled": self.enabled,
|
||||
"is_activated": self.is_activated,
|
||||
}
|
||||
if hasattr(self, "repo") and self.repo:
|
||||
resp["repo"] = self.repo.remotes[0].url
|
||||
if parameters:
|
||||
resp["parameters"] = self.params
|
||||
elif self.extraparams:
|
||||
resp["extra_parameters"] = self.extraparams
|
||||
elif self.extra_params:
|
||||
resp["extra_parameters"] = self.extra_params
|
||||
return resp
|
||||
|
||||
|
||||
|
2
setup.py
2
setup.py
@@ -8,7 +8,7 @@ install_reqs = parse_requirements("requirements.txt")
|
||||
# e.g. ['django==1.5.1', 'mezzanine==1.4.6']
|
||||
reqs = [str(ir.req) for ir in install_reqs]
|
||||
|
||||
VERSION = "0.2.9"
|
||||
VERSION = "0.3.1"
|
||||
|
||||
print(reqs)
|
||||
|
||||
|
@@ -1 +0,0 @@
|
||||
|
||||
|
@@ -9,6 +9,7 @@ except ImportError:
|
||||
from senpy.extensions import Senpy
|
||||
from flask import Flask
|
||||
from flask.ext.testing import TestCase
|
||||
from gevent import sleep
|
||||
|
||||
|
||||
def check_dict(indic, template):
|
||||
@@ -22,6 +23,7 @@ class BlueprintsTest(TestCase):
|
||||
self.senpy.init_app(self.app)
|
||||
self.dir = os.path.join(os.path.dirname(__file__), "..")
|
||||
self.senpy.add_folder(self.dir)
|
||||
self.senpy.activate_plugin("Dummy", sync=True)
|
||||
return self.app
|
||||
|
||||
def test_home(self):
|
||||
@@ -36,3 +38,43 @@ class BlueprintsTest(TestCase):
|
||||
}
|
||||
assert check_dict(resp.json, atleast)
|
||||
|
||||
def test_analysis(self):
|
||||
""" The dummy plugin returns an empty response, it should contain the context """
|
||||
resp = self.client.get("/?i=My aloha mohame")
|
||||
self.assert200(resp)
|
||||
logging.debug(resp.json)
|
||||
assert "@context" in resp.json
|
||||
assert check_dict(resp.json["@context"], {"marl": "http://www.gsi.dit.upm.es/ontologies/marl/ns#"})
|
||||
assert "entries" in resp.json
|
||||
|
||||
def test_list(self):
|
||||
""" List the plugins """
|
||||
resp = self.client.get("/plugins/")
|
||||
self.assert200(resp)
|
||||
logging.debug(resp.json)
|
||||
assert "Dummy" in resp.json
|
||||
|
||||
def test_detail(self):
|
||||
""" Show only one plugin"""
|
||||
resp = self.client.get("/plugins/Dummy")
|
||||
self.assert200(resp)
|
||||
logging.debug(resp.json)
|
||||
assert "@id" in resp.json
|
||||
assert resp.json["@id"] == "Dummy_0.1"
|
||||
|
||||
def test_activate(self):
|
||||
""" Activate and deactivate one plugin """
|
||||
resp = self.client.get("/plugins/Dummy/deactivate")
|
||||
self.assert200(resp)
|
||||
sleep(0.5)
|
||||
resp = self.client.get("/plugins/Dummy")
|
||||
self.assert200(resp)
|
||||
assert "is_activated" in resp.json
|
||||
assert resp.json["is_activated"] == False
|
||||
resp = self.client.get("/plugins/Dummy/activate")
|
||||
self.assert200(resp)
|
||||
sleep(0.5)
|
||||
resp = self.client.get("/plugins/Dummy")
|
||||
self.assert200(resp)
|
||||
assert "is_activated" in resp.json
|
||||
assert resp.json["is_activated"] == True
|
||||
|
@@ -1,3 +0,0 @@
|
||||
from senpy.plugins import SenpyPlugin
|
||||
|
||||
plugin = SenpyPlugin("dummy")
|
8
tests/dummy_plugin/dummy.py
Normal file
8
tests/dummy_plugin/dummy.py
Normal file
@@ -0,0 +1,8 @@
|
||||
from senpy.plugins import SentimentPlugin
|
||||
from senpy.models import Response
|
||||
|
||||
class DummyPlugin(SentimentPlugin):
|
||||
pass
|
||||
|
||||
def analyse(self, *args, **kwargs):
|
||||
return Response()
|
7
tests/dummy_plugin/dummy.senpy
Normal file
7
tests/dummy_plugin/dummy.senpy
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"name": "Dummy",
|
||||
"module": "dummy",
|
||||
"description": "I am dummy",
|
||||
"author": "@balkian",
|
||||
"version": "0.1"
|
||||
}
|
@@ -13,10 +13,10 @@ from flask.ext.testing import TestCase
|
||||
class ExtensionsTest(TestCase):
|
||||
def create_app(self):
|
||||
self.app = Flask("test_extensions")
|
||||
self.senpy = Senpy()
|
||||
self.senpy.init_app(self.app)
|
||||
self.dir = os.path.join(os.path.dirname(__file__), "..")
|
||||
self.senpy.add_folder(self.dir)
|
||||
self.senpy = Senpy(plugin_folder=self.dir)
|
||||
self.senpy.init_app(self.app)
|
||||
self.senpy.activate_plugin("Dummy", sync=True)
|
||||
return self.app
|
||||
|
||||
def test_init(self):
|
||||
@@ -31,41 +31,42 @@ class ExtensionsTest(TestCase):
|
||||
# noinspection PyProtectedMember
|
||||
assert self.dir in self.senpy._search_folders
|
||||
print self.senpy.plugins
|
||||
assert "dummy" in self.senpy.plugins
|
||||
assert "Dummy" in self.senpy.plugins
|
||||
|
||||
def test_enabling(self):
|
||||
""" Enabling a plugin """
|
||||
self.senpy.enable_plugin("dummy")
|
||||
assert self.senpy.plugins["dummy"].enabled
|
||||
self.senpy.activate_all(sync=True)
|
||||
assert len(self.senpy.plugins) == 2
|
||||
assert self.senpy.plugins["Sleep"].is_activated
|
||||
|
||||
def test_disabling(self):
|
||||
""" Disabling a plugin """
|
||||
self.senpy.enable_plugin("dummy")
|
||||
self.senpy.disable_plugin("dummy")
|
||||
assert not self.senpy.plugins["dummy"].enabled
|
||||
self.senpy.deactivate_all(sync=True)
|
||||
assert self.senpy.plugins["Dummy"].is_activated == False
|
||||
assert self.senpy.plugins["Sleep"].is_activated == False
|
||||
|
||||
def test_default(self):
|
||||
""" Default plugin should be set """
|
||||
assert self.senpy.default_plugin
|
||||
assert self.senpy.default_plugin == "dummy"
|
||||
assert self.senpy.default_plugin == "Dummy"
|
||||
|
||||
def test_analyse(self):
|
||||
""" Using a plugin """
|
||||
with mock.patch.object(self.senpy.plugins["dummy"], "analyse") as mocked:
|
||||
self.senpy.analyse(algorithm="dummy", input="tupni", output="tuptuo")
|
||||
with mock.patch.object(self.senpy.plugins["Dummy"], "analyse") as mocked:
|
||||
self.senpy.analyse(algorithm="Dummy", input="tupni", output="tuptuo")
|
||||
self.senpy.analyse(input="tupni", output="tuptuo")
|
||||
mocked.assert_any_call(input="tupni", output="tuptuo", algorithm="dummy")
|
||||
mocked.assert_any_call(input="tupni", output="tuptuo", algorithm="Dummy")
|
||||
mocked.assert_any_call(input="tupni", output="tuptuo")
|
||||
for plug in self.senpy.plugins:
|
||||
self.senpy.disable_plugin(plug)
|
||||
self.senpy.deactivate_plugin(plug, sync=True)
|
||||
resp = self.senpy.analyse(input="tupni")
|
||||
logging.debug("Response: {}".format(resp))
|
||||
assert resp["status"] == 400
|
||||
|
||||
def test_filtering(self):
|
||||
""" Filtering plugins """
|
||||
assert len(self.senpy.filter_plugins(name="dummy")) > 0
|
||||
assert len(self.senpy.filter_plugins(name="Dummy")) > 0
|
||||
assert not len(self.senpy.filter_plugins(name="notdummy"))
|
||||
assert self.senpy.filter_plugins(name="dummy", enabled=True)
|
||||
self.senpy.disable_plugin("dummy")
|
||||
assert not len(self.senpy.filter_plugins(name="dummy", enabled=True))
|
||||
assert self.senpy.filter_plugins(name="Dummy", is_activated=True)
|
||||
self.senpy.deactivate_plugin("Dummy", sync=True)
|
||||
assert not len(self.senpy.filter_plugins(name="Dummy", is_activated=True))
|
||||
|
10
tests/sleep_plugin/sleep.py
Normal file
10
tests/sleep_plugin/sleep.py
Normal file
@@ -0,0 +1,10 @@
|
||||
from senpy.plugins import SenpyPlugin
|
||||
from time import sleep
|
||||
|
||||
class SleepPlugin(SenpyPlugin):
|
||||
def __init__(self, info, *args, **kwargs):
|
||||
super(SleepPlugin, self).__init__(info, *args, **kwargs)
|
||||
self.timeout = int(info["timeout"])
|
||||
|
||||
def activate(self, *args, **kwargs):
|
||||
sleep(self.timeout)
|
8
tests/sleep_plugin/sleep.senpy
Normal file
8
tests/sleep_plugin/sleep.senpy
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"name": "Sleep",
|
||||
"module": "sleep",
|
||||
"description": "I am dummy",
|
||||
"author": "@balkian",
|
||||
"version": "0.1",
|
||||
"timeout": "2"
|
||||
}
|
Reference in New Issue
Block a user