Added common logging, settings, translations and jsonRPC boilerplate #6

razzeee · 2017-01-18T22:10:24Z

This adds a bunch of boilerplate for plugins, services and scripts.
Only the service example will use something from this (logging).

This code is taken from my trakt script.
With the logging stuff taken from @tamland

Please review and let me know if there are things to improve @enen92 @phil65 @phate89

coveralls · 2017-01-18T22:12:24Z

Coverage remained the same at 100.0% when pulling 3c0a0692288186d9a30fdcbd3cf034afd5874a3a on common-boilerplate into 761f4d7 on master.

coveralls · 2017-01-18T22:12:25Z

Coverage remained the same at 100.0% when pulling 3c0a0692288186d9a30fdcbd3cf034afd5874a3a on common-boilerplate into 761f4d7 on master.

generators/app/templates/resources/lib/utilities.py

+if sys.version_info >= (2, 7):
+    import json as json
+else:
+    import simplejson as json


generators/app/templates/resources/lib/utilities.py

+    import simplejson as json
+
+# read settings
+__addon__ = xbmcaddon.Addon('<%= props.scriptid %>')


generators/app/templates/resources/lib/kodiLogging.py

+# 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/>.


generators/app/templates/addon.xml

-        <import addon="xbmc.python" version="<%= props.kodiVersion %>"/><% if (props.type == 'Plugin') { -%><import addon="script.module.routing" version="0.2.0"/><% } -%>
+        <import addon="xbmc.python" version="<%= props.kodiVersion %>"/>
+<%_ if (props.type == 'Plugin') { -%>        <import addon="script.module.routing" version="0.2.0"/><% } %>
+<%_ if (props.type == 'Plugin' || props.type == 'Script' || props.type == 'Service') { -%>        <import addon="script.module.simplejson" version="3.3.0"/><% } %>


generators/app/templates/plugin.py

 from xbmcgui import ListItem
 from xbmcplugin import addDirectoryItem, endOfDirectory

+
+logger = logging.getLogger(__name__)


generators/app/templates/service.py

 import time
 import xbmc

+
+kodiLogging.config()
+logger = logging.getLogger(__name__)


phate89 · 2017-01-18T23:04:39Z

Isn't better instead of adding it to ask tamland to create a module and add that dependency? It seems a very good logging other projects could use..

MartijnKaijser · 2017-01-18T23:26:54Z

Imo its plain stupid we even have to build a module around our Kodi python module to make it usable. That clearly shows it needs to get fixed and not build something around it.
Also most of this stuff is quite pointless as it's nearly duplication of what is already provided by the api

razzeee · 2017-01-19T00:05:14Z

@MartijnKaijser
while that would be the best approach, that won't help us know or with already released versions

coveralls · 2017-01-19T00:40:20Z

Coverage remained the same at 100.0% when pulling 805ec12 on common-boilerplate into 761f4d7 on master.

coveralls · 2017-01-20T23:32:31Z

Coverage remained the same at 100.0% when pulling 83c38e5 on common-boilerplate into 761f4d7 on master.

coveralls · 2017-01-20T23:36:35Z

Coverage remained the same at 100.0% when pulling 89c0a60 on common-boilerplate into 761f4d7 on master.

generators/app/templates/resources/lib/utilities.py

+<% } %>
+
+# read settings
+ADDON = xbmcaddon.Addon('<%= props.scriptid %>')


coveralls · 2017-01-21T00:17:18Z

Coverage remained the same at 100.0% when pulling 289e740 on common-boilerplate into 761f4d7 on master.

coveralls · 2017-01-21T00:17:18Z

Coverage remained the same at 100.0% when pulling 289e740 on common-boilerplate into 761f4d7 on master.

coveralls · 2017-01-21T00:22:24Z

Coverage remained the same at 100.0% when pulling a0479fd on common-boilerplate into 761f4d7 on master.

coveralls · 2017-01-21T00:22:24Z

Coverage remained the same at 100.0% when pulling a0479fd on common-boilerplate into 761f4d7 on master.

generators/app/templates/resources/lib/kodiLogging.py

+        if getSettingAsBool('debug'):
+            try:
+                xbmc.log(self.format(record), levels[record.levelno])
+            except UnicodeEncodeError:


generators/app/templates/resources/lib/utilities.py

+logger = logging.getLogger(__name__)
+
+def notification(header, message, time=5000, icon=ADDON.getAddonInfo('icon')):
+    xbmc.executebuiltin("XBMC.Notification(%s,%s,%i,%s)" % (header, message, time, icon))


generators/app/templates/resources/lib/utilities.py

+    data = json.dumps(params)
+    request = xbmc.executeJSONRPC(data)
+
+    try:


coveralls · 2017-01-22T14:58:20Z

Coverage remained the same at 100.0% when pulling 0657782 on common-boilerplate into 761f4d7 on master.

MartijnKaijser reviewed Jan 18, 2017

View reviewed changes

generators/app/templates/plugin.py

from xbmcgui import ListItem

from xbmcplugin import addDirectoryItem, endOfDirectory

logger = logging.getLogger(__name__)

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

MartijnKaijser reviewed Jan 18, 2017

View reviewed changes

generators/app/templates/service.py

import time

import xbmc

kodiLogging.config()

logger = logging.getLogger(__name__)

This comment was marked as spam.

Sign in to view

Added common logging, settings, translations and jsonRPC boilerplate

805ec12

razzeee force-pushed the common-boilerplate branch from 3c0a069 to 805ec12 Compare January 19, 2017 00:03

Only use simple json for Jarvis, newer versions won't need it

83c38e5

Removed license from logging boilerplate

89c0a60

enen92 reviewed Jan 20, 2017

View reviewed changes

generators/app/templates/resources/lib/utilities.py

<% } %>

# read settings

ADDON = xbmcaddon.Addon('<%= props.scriptid %>')

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

Improve addonid grabbing

289e740

Removed duplicate

a0479fd

phil65 reviewed Jan 21, 2017

View reviewed changes

generators/app/templates/resources/lib/utilities.py

data = json.dumps(params)

request = xbmc.executeJSONRPC(data)

try:

This comment was marked as spam.

Sign in to view

razzeee mentioned this pull request Jan 22, 2017

Use same python code style in every template #12

Closed

Use xbmcgui.Dialog().notification() instead of executebuiltin

0657782

razzeee mentioned this pull request Jan 22, 2017

Discussion try/except code smell? #13

Open

razzeee merged commit 3f4fb25 into master Jan 22, 2017

razzeee deleted the common-boilerplate branch January 22, 2017 18:18

razzeee mentioned this pull request Jan 22, 2017

Boilerplate for common code #3

Closed

Added common logging, settings, translations and jsonRPC boilerplate #6

Added common logging, settings, translations and jsonRPC boilerplate #6

Conversation

razzeee commented Jan 18, 2017

coveralls commented Jan 18, 2017

coveralls commented Jan 18, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

phate89 commented Jan 18, 2017

MartijnKaijser commented Jan 18, 2017 • edited Loading

razzeee commented Jan 19, 2017

coveralls commented Jan 19, 2017 • edited Loading

coveralls commented Jan 20, 2017

coveralls commented Jan 20, 2017 • edited Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Jan 21, 2017

coveralls commented Jan 21, 2017

coveralls commented Jan 21, 2017

coveralls commented Jan 21, 2017

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

coveralls commented Jan 22, 2017 • edited Loading

MartijnKaijser commented Jan 18, 2017 •

edited

Loading

coveralls commented Jan 19, 2017 •

edited

Loading

coveralls commented Jan 20, 2017 •

edited

Loading

coveralls commented Jan 22, 2017 •

edited

Loading