Add-on unicode paths: Difference between revisions
m (→smart_unicode and smart_utf8: <syntaxhighlight>) |
m (<syntaxhighlight enclose="div" lang="python">) |
||
Line 23: | Line 23: | ||
==== Conclusion ==== | ==== Conclusion ==== | ||
Since your add-on should work with all supported OS, use the following approach: | Since your add-on should work with all supported OS, use the following approach: | ||
< | <syntaxhighlight enclose="div" lang="python"> | ||
if sys.platform.startswith('win'): | if sys.platform.startswith('win'): | ||
file function with unicodes | file function with unicodes | ||
else: | else: | ||
file function with utf-8 encoded strings | file function with utf-8 encoded strings | ||
</ | </syntaxhighlight> | ||
Line 34: | Line 34: | ||
=== Addon path === | === Addon path === | ||
The first path an add-on has to deal with is it's own add-on path: | The first path an add-on has to deal with is it's own add-on path: | ||
<syntaxhighlight enclose="div" lang="python"> | |||
path = addon.getAddonInfo('path').decode('utf-8') | path = addon.getAddonInfo('path').decode('utf-8') | ||
</syntaxhighlight> | |||
XBMC's getAddonInfo returns an UTF-8 encoded string and we decode it an unicode. | XBMC's getAddonInfo returns an UTF-8 encoded string and we decode it an unicode. | ||
=== Browse dialog === | === Browse dialog === | ||
<syntaxhighlight enclose="div" lang="python"> | |||
dialog = xbmcgui.Dialog() | dialog = xbmcgui.Dialog() | ||
directory = dialog.browse(0, 'Title' , 'pictures').decode('utf-8') | directory = dialog.browse(0, 'Title' , 'pictures').decode('utf-8') | ||
</syntaxhighlight> | |||
dialog.browse() returns an UTF-8 encoded string which perhaps contains some non latin characters. Therefore decode it to unicode! | dialog.browse() returns an UTF-8 encoded string which perhaps contains some non latin characters. Therefore decode it to unicode! | ||
=== Path joins === | === Path joins === | ||
<syntaxhighlight enclose="div" lang="python"> | |||
os.path.join(path, filename) | os.path.join(path, filename) | ||
</syntaxhighlight> | |||
If path and filename are unicodes then everthing will work as expected. | If path and filename are unicodes then everthing will work as expected. | ||
But what will happen if filename is an UTF-8 encoded string which contains "öäü.jpg"? | But what will happen if filename is an UTF-8 encoded string which contains "öäü.jpg"? | ||
Python always uses unicodes to join a string with an unicode. Therefore Python will decode the string with it's default encoding (ascii). | Python always uses unicodes to join a string with an unicode. Therefore Python will decode the string with it's default encoding (ascii). | ||
<syntaxhighlight enclose="div" lang="python"> | |||
os.path.join(path, filename.decode('ascii')) | os.path.join(path, filename.decode('ascii')) | ||
</syntaxhighlight> | |||
Due to the missing öäü within the ASCII codepage you'll get an unicode exception! That's the reason why you must explicitly convert the string to unicode! | Due to the missing öäü within the ASCII codepage you'll get an unicode exception! That's the reason why you must explicitly convert the string to unicode! | ||
<syntaxhighlight enclose="div" lang="python"> | |||
os.path.join(path, filename.decode('utf-8')) | os.path.join(path, filename.decode('utf-8')) | ||
</syntaxhighlight> | |||
=== Logging === | === Logging === | ||
"print" and xbmc.log does not support unicode. Always encode unicode strings to utf-8. | "print" and xbmc.log does not support unicode. Always encode unicode strings to utf-8. | ||
< | <syntaxhighlight enclose="div" lang="python"> | ||
print message.encode('utf-8') | print message.encode('utf-8') | ||
</ | </syntaxhighlight> | ||
Alternatively, the following function can be used, where msg can be everything from string to unicode to class: | Alternatively, the following function can be used, where msg can be everything from string to unicode to class: | ||
< | <syntaxhighlight enclose="div" lang="python"> | ||
def log(msg, level=xbmc.LOGDEBUG): | def log(msg, level=xbmc.LOGDEBUG): | ||
plugin = "My nice plugin" | plugin = "My nice plugin" | ||
Line 67: | Line 77: | ||
xbmc.log("[%s] %s" % (plugin, msg.__str__()), level) | xbmc.log("[%s] %s" % (plugin, msg.__str__()), level) | ||
</ | </syntaxhighlight> | ||
However, it's highly recommender to never mix byte strings and unicode strings in your program, in which case the 'if isinstanceof' is unnecessary. | However, it's highly recommender to never mix byte strings and unicode strings in your program, in which case the 'if isinstanceof' is unnecessary. | ||
Line 105: | Line 115: | ||
=== Notification === | === Notification === | ||
< | <syntaxhighlight enclose="div" lang="python"> | ||
def show_notification(title, message, timeout=2000, image=""): | def show_notification(title, message, timeout=2000, image=""): | ||
if image == "": | if image == "": | ||
Line 112: | Line 122: | ||
command = 'Notification(%s,%s,%s,%s)' % (smart_utf8(title), smart_utf8(message), timeout, smart_utf8(image)) | command = 'Notification(%s,%s,%s,%s)' % (smart_utf8(title), smart_utf8(message), timeout, smart_utf8(image)) | ||
xbmc.executebuiltin(command) | xbmc.executebuiltin(command) | ||
</ | </syntaxhighlight> | ||
The show_notification function uses the smart_utf8 function to ensure that every string parameter passed to XBMC is an UTF-8 encoded string. Therefore you can call show_notification with strings or unicodes! | The show_notification function uses the smart_utf8 function to ensure that every string parameter passed to XBMC is an UTF-8 encoded string. Therefore you can call show_notification with strings or unicodes! | ||
Revision as of 11:37, 18 September 2014
Add-on development | Add-on unicode paths |
This page describes how to prevent common problems with non latin characters in XBMC or Add-on paths.
Unicode paths
If you want to write an add-on which is able to work with paths like 'd:\apps\éîäß\' or 'opt/xbmc/àí' at first you should read http://docs.python.org/2/howto/unicode.html#python-2-x-s-unicode-support
After reading you know: "Software (Python) should only work with unicode strings internally, converting to a particular encoding on output. (or input)". XBMC outputs UTF-8 encoded strings. Input can be unicode or UTF-8 encoded, but there are rumors that some functions don't work with unicode input parameters.
Therefore the simplest way to deal with non-ASCII characters is to pass every parameter as UTF-8 encoded string to XBMC and to convert XBMC's UTF-8 output back to unicode.
File functions in Python
Windows
Windows' NTFS is unicode aware but Windows still uses codepages like cp-850 for Western Europe.
If you use Python file functions with string parameters then internally the strings will be converted to the Windows codepage which means that you cannot access a file with greek characters from an english Windows. But if you pass unicodes to the file functions then everything will work as expected!
Linux
When locale is set to C or POSIX Python will assume file system is ascii only and try to encode all unicode inputs to ascii. In reality file system does not have a specific encoding and utf-8 is a much better guess. Because of this you must not pass unicode to Python file functions!
Instead always use UTF-8 encoded strings.
Conclusion
Since your add-on should work with all supported OS, use the following approach:
if sys.platform.startswith('win'): file function with unicodes else: file function with utf-8 encoded strings
Examples
Addon path
The first path an add-on has to deal with is it's own add-on path:
path = addon.getAddonInfo('path').decode('utf-8')
XBMC's getAddonInfo returns an UTF-8 encoded string and we decode it an unicode.
Browse dialog
dialog = xbmcgui.Dialog() directory = dialog.browse(0, 'Title' , 'pictures').decode('utf-8')
dialog.browse() returns an UTF-8 encoded string which perhaps contains some non latin characters. Therefore decode it to unicode!
Path joins
os.path.join(path, filename)
If path and filename are unicodes then everthing will work as expected. But what will happen if filename is an UTF-8 encoded string which contains "öäü.jpg"?
Python always uses unicodes to join a string with an unicode. Therefore Python will decode the string with it's default encoding (ascii).
os.path.join(path, filename.decode('ascii'))
Due to the missing öäü within the ASCII codepage you'll get an unicode exception! That's the reason why you must explicitly convert the string to unicode!
os.path.join(path, filename.decode('utf-8'))
Logging
"print" and xbmc.log does not support unicode. Always encode unicode strings to utf-8.
print message.encode('utf-8')
Alternatively, the following function can be used, where msg can be everything from string to unicode to class:
def log(msg, level=xbmc.LOGDEBUG): plugin = "My nice plugin" if isinstanceof(msg, unicode): msg = msg.encode('utf-8') xbmc.log("[%s] %s" % (plugin, msg.__str__()), level)
However, it's highly recommender to never mix byte strings and unicode strings in your program, in which case the 'if isinstanceof' is unnecessary.
Useful functions
smart_unicode and smart_utf8
Because you cannot decode an unicode or encode a string it makes sense to have a function which works with unicodes and strings:
def smart_unicode(s): """credit : sfaxman""" if not s: return '' try: if not isinstance(s, basestring): if hasattr(s, '__unicode__'): s = unicode(s) else: s = unicode(str(s), 'UTF-8') elif not isinstance(s, unicode): s = unicode(s, 'UTF-8') except: if not isinstance(s, basestring): if hasattr(s, '__unicode__'): s = unicode(s) else: s = unicode(str(s), 'ISO-8859-1') elif not isinstance(s, unicode): s = unicode(s, 'ISO-8859-1') return s
You can use smart_unicode to ensure that the return type is an unicode!
def smart_utf8(s): return smart_unicode(s).encode('utf-8')
And smart_utf8 to pass parameters to XBMC.
Notification
def show_notification(title, message, timeout=2000, image=""): if image == "": command = 'Notification(%s,%s,%s)' % (smart_utf8(title), smart_utf8(message), timeout) else: command = 'Notification(%s,%s,%s,%s)' % (smart_utf8(title), smart_utf8(message), timeout, smart_utf8(image)) xbmc.executebuiltin(command)
The show_notification function uses the smart_utf8 function to ensure that every string parameter passed to XBMC is an UTF-8 encoded string. Therefore you can call show_notification with strings or unicodes!
See also
Development: