Minor doc string changes. Called load_keysym_group() for miscellany and

calroc · calroc · commit b670842e6ba7 · 2005-09-06T19:18:19.000Z
latin1 keysyms, rather than importing the modules.
diff --git a/Xlib/XK.py b/Xlib/XK.py
@@ -1,4 +1,4 @@
-# $Id: XK.py,v 1.5 2005-02-06 02:32:34 calroc99 Exp $
+# $Id: XK.py,v 1.6 2005-09-06 19:18:19 calroc99 Exp $
 #
 # Xlib.XK -- X keysym defs
 #
@@ -17,17 +17,25 @@
 #    You should have received a copy of the GNU General Public License
 #    along with this program; if not, write to the Free Software
 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# This module defines some functions for working with X keysyms as well
+# as a modular keysym definition and loading mechanism. See the keysym
+# definition modules in the Xlib/keysymdef directory.
 
 from X import NoSymbol
 
-def string_to_keysym(str):
-    '''Given the name of a keysym as a string, return its numeric code.
-    Don't include the 'XK_' prefix. Just use the base, i.e. 'Delete'
+def string_to_keysym(keysym):
+    '''Return the (16 bit) numeric code of keysym.
+
+    Given the name of a keysym as a string, return its numeric code.
+    Don't include the 'XK_' prefix, just use the base, i.e. 'Delete'
     instead of 'XK_Delete'.'''
-    return globals().get('XK_' + str, NoSymbol)
+    return globals().get('XK_' + keysym, NoSymbol)
 
 def load_keysym_group(group):
-    '''Given a group name such as 'latin1' or 'katakana' load the keysyms
+    '''Load all the keysyms in group.
+
+    Given a group name such as 'latin1' or 'katakana' load the keysyms
     defined in module 'Xlib.keysymdef.group-name' into this XK module.'''
     if '.' in group:
 	raise ValueError('invalid keysym group name: %s' % group)
@@ -38,24 +46,33 @@ def load_keysym_group(group):
     mod = __import__('Xlib.keysymdef.%s' % group, G, locals(), [group])
 
     #Extract names of just the keysyms.
-    keysyms = [n for n in dir(mod) if n[:3] == 'XK_']
+    keysyms = [n for n in dir(mod) if n.startswith('XK_')]
 
     #Copy the named keysyms into XK.__dict__
     for keysym in keysyms:
         ## k = mod.__dict__[keysym]; assert k == int(k) #probably too much.
         G[keysym] = mod.__dict__[keysym]
 
+    #And get rid of the keysym module.
+    del mod
+
 def _load_keysyms_into_XK(mod):
     '''keysym definition modules need no longer call Xlib.XK._load_keysyms_into_XK().
     You should remove any calls to that function from your keysym modules.'''
     pass
 
 # Always import miscellany and latin1 keysyms
-import Xlib.keysymdef.miscellany
-import Xlib.keysymdef.latin1
+load_keysym_group('miscellany')
+load_keysym_group('latin1')
 
 
 def keysym_to_string(keysym):
+    '''Translate a keysym (16 bit number) into a python string.
+
+    This will pass 0 to 0xff as well as XK_BackSpace, XK_Tab, XK_Clear,
+    XK_Return, XK_Pause, XK_Scroll_Lock, XK_Escape, XK_Delete. For other
+    values it returns None.'''
+
     # ISO latin 1, LSB is the code
     if keysym & 0xff00 == 0:
 	return chr(keysym & 0xff)
