Merge lp:~frederik-elwert/python-distutils-extra/gsettings-support into lp:python-distutils-extra

[Frederik Elwert]

Add support for installing GSettings schema files (*.gsettings.xml)

[Martin Pitt (pitti)]

Thanks for this! This should go along with a test case in test/auto.py. Do you want to work on this? If not, I'll find some time to do that, but it might take a bit as I'm currently involved in the beta-1 release stuff.

[Frederik Elwert (frederik-elwert)]

Thanks for the reply!

I will try if I can add this. However, I have not much experience with tests. I’ll let you know if I have a test or if I don’t manage to add one.

[lp:~frederik-elwert/python-distutils-extra/gsettings-support]

277. By Frederik Elwert on 2012-02-28

Added test for GSettings schema files to test/auto.py

[Frederik Elwert (frederik-elwert)]

Okay, added a test case. I hope it is okay like this.

[Martin Pitt (pitti)]

Thanks, that looks like what I had in mind (and yes, it's mostly a copy&paste&adapt exercise :) ).

  self._mksrc('data/glib-2.0/schemas/org.test.myapp.gschema.xml')

I'm a bit sceptical that the source layout will really be like this. In other GNOME projects the "/glib-2.0/schemas/" is usually an implementation detail, and not required in the source layout. Usually developers would put these files into data/org.test.myapp.gschema.xml (e. g. gnome-settings-daemon), or even mymodule/org.test.myapp.gschema.xml.in (e. g. nautilus).

So perhaps you can change the test case to have both cases, and then it would make sure that it picks up the schemas from any directory and they still land in the right place?

Thanks!

[Frederik Elwert (frederik-elwert)]

sure, will change that. I used the layout that quickly introduced, but you're right, it probably doesn't make much sense.

[lp:~frederik-elwert/python-distutils-extra/gsettings-support]

278. By Frederik Elwert on 2012-03-01

Extended test for GSettings schema files in test/auto.py

[Frederik Elwert (frederik-elwert)]

Okay, extended the test to cover both cases.

[Martin Pitt (pitti)]

Thank you, nice work!

review: Approve

=== modified file 'DistUtilsExtra/auto.py'
--- DistUtilsExtra/auto.py	2011-11-08 15:38:45 +0000
+++ DistUtilsExtra/auto.py	2012-03-01 11:35:20 +0000
@@ -13,6 +13,7 @@
  * GtkBuilder and Qt4 user interfaces (*.ui) [installed into
    prefix/share/<projectname>/]
  * D-Bus (*.conf and *.service)
+ * GSettings schemas (*.gschema.xml)
  * polkit (*.policy.in)
  * Desktop files (*.desktop.in) [into prefix/share/applications, or
    prefix/share/autostart if they have "autostart" anywhere in the path]
@@ -85,6 +86,7 @@
     __packages(attrs, src)
     __provides(attrs, src)
     __dbus(attrs, src)
+    __gschema(attrs, src)
     __apport_hooks(attrs, src)
     __data(attrs, src)
     __scripts(attrs, src)
@@ -196,6 +198,17 @@
     if session_service:
         v.append(('share/dbus-1/services', session_service))
 
+def __gschema(attrs, src):
+    '''Install GSettings schema files'''
+    
+    v = attrs.setdefault('data_files', [])
+    schema_glob = '*.gschema.xml'
+    schemas = src_fileglob(src, schema_glob)
+    if schemas:
+        src_markglob(src, schema_glob)
+        src_markglob(src, '*gschemas.compiled')
+        v.append(('share/glib-2.0/schemas/', schemas))
+
 def __apport_hooks(attrs, src):      
     '''Apport hooks'''  
     v = attrs.setdefault('data_files', [])

=== modified file 'test/auto.py'
--- test/auto.py	2011-11-08 15:37:40 +0000
+++ test/auto.py	2012-03-01 11:35:20 +0000
@@ -158,6 +158,25 @@
         self.assertTrue('/usr/share/dbus-1/services/com.example.foo.gui.service' in f)
         self.assertFalse('super.service' in '\n'.join(f))
 
+    def test_gsettings(self):
+        '''GSettings schema files'''
+
+        # schema files in dedicated directory
+        self._mksrc('data/glib-2.0/schemas/org.test.myapp.gschema.xml')
+        self._mksrc('data/glib-2.0/schemas/gschemas.compiled')
+        # schema files in data directory
+        self._mksrc('data/org.test.myapp2.gschema.xml')
+        self._mksrc('data/gschemas.compiled')
+
+        (o, e, s) = self.do_install()
+        self.assertEqual(e, '')
+        self.assertEqual(s, 0)
+
+        f = self.installed_files()
+        self.assertEqual(len(f), 3) # 2 schema files plus .egg-info
+        self.assertTrue('/usr/share/glib-2.0/schemas/org.test.myapp.gschema.xml' in f)
+        self.assertFalse('gschemas.compiled' in '\n'.join(f))
+
     def test_apport_hook(self):
         '''Apport hooks'''