Merge lp:~flimm/quickly/better-new into lp:quickly

[David D Lowe]

Replaced New methods with __new__, it's more elegant.

[Rick Spencer (rick-rickspencer3)]

awesome ... we will need to make 'add dialog' work this way as well, but should be simple. next will be updating the docs.

review: Approve

=== modified file 'data/templates/ubuntu-application/project_root/bin/project_name'
--- data/templates/ubuntu-application/project_root/bin/project_name	2010-03-09 09:36:08 +0000
+++ data/templates/ubuntu-application/project_root/bin/project_name	2010-03-15 16:53:12 +0000
@@ -31,31 +31,41 @@
 
 from python_name import (
     Aboutcamel_case_nameDialog, Preferencescamel_case_nameDialog)
-from python_name.helpers import make_window
+from python_name.helpers import get_builder
 
 
 class camel_case_nameWindow(gtk.Window):
     __gtype_name__ = "camel_case_nameWindow"
-
-    def __init__(self):
-        """Construct a camel_case_nameWindow.
-
-        This function is typically not called directly. Creation a
-        camel_case_nameWindow requires rereading the associated ui file and
-        parsing the ui definition externally, and then calling
-        camel_case_nameWindow.finish_initializing().
-
-        Use the convenience function Newcamel_case_nameWindow to create
-        camel_case_nameWindow object.
+    
+    # To construct a new instance of this method, the following notable 
+    # methods are called in this order:
+    # __new__(cls)
+    # __init__(self)
+    # finish_initializing(self, builder)
+    # __init__(self)
+    #
+    # For this reason, it's recommended you leave __init__ empty and put
+    # your inialization code in finish_intializing
+    
+    def __new__(cls):
+        """Special static method that's automatically called by Python when 
+        constructing a new instance of this class.
+        
+        Returns a fully instantiated camel_case_nameWindow object.
         """
-        pass
+        builder = get_builder('camel_case_nameWindow')
+        new_object = builder.get_object("python_name_window")
+        new_object.finish_initializing(builder)
+        return new_object
 
     def finish_initializing(self, builder):
-        """Called after we've finished initializing.
+        """Called while initializing this instance in __new__
 
         finish_initalizing should be called after parsing the UI definition
         and creating a camel_case_nameWindow object with it in order to finish
         initializing the start of the new camel_case_nameWindow instance.
+        
+        Put your initilization code in here and leave __init__ undefined.
         """
         # Get a reference to the builder and set up the signals.
         self.builder = builder
@@ -80,13 +90,13 @@
 
     def about(self, widget, data=None):
         """Display the about box for project_name."""
-        about = Aboutcamel_case_nameDialog.NewAboutcamel_case_nameDialog()
+        about = Aboutcamel_case_nameDialog.Aboutcamel_case_nameDialog()
         response = about.run()
         about.destroy()
 
     def preferences(self, widget, data=None):
         """Display the preferences window for project_name."""
-        prefs = Preferencescamel_case_nameDialog.NewPreferencescamel_case_nameDialog()
+        prefs = Preferencescamel_case_nameDialog.Preferencescamel_case_nameDialog()
         response = prefs.run()
         if response == gtk.RESPONSE_OK:
             # Make any updates based on changed preferences here.
@@ -102,15 +112,6 @@
         # Clean up code for saving application state should be added here.
         gtk.main_quit()
 
-
-def Newcamel_case_nameWindow():
-    """Newcamel_case_nameWindow - returns a fully instantiated
-    camel_case_nameWindow object. Use this function rather than
-    creating a camel_case_nameWindow directly.
-    """
-    return make_window('camel_case_nameWindow', "python_name_window")
-
-
 if __name__ == "__main__":
     # Support for command line options.
     import logging
@@ -127,6 +128,6 @@
         logging.debug('logging enabled')
 
     # Run the application.
-    window = Newcamel_case_nameWindow()
+    window = camel_case_nameWindow()
     window.show()
     gtk.main()

=== modified file 'data/templates/ubuntu-application/project_root/python/Aboutcamel_case_nameDialog.py'
--- data/templates/ubuntu-application/project_root/python/Aboutcamel_case_nameDialog.py	2010-02-10 05:54:07 +0000
+++ data/templates/ubuntu-application/project_root/python/Aboutcamel_case_nameDialog.py	2010-03-15 16:53:12 +0000
@@ -5,7 +5,7 @@
 
 import gtk
 
-from python_name.helpers import make_window
+from python_name.helpers import get_builder
 
 import gettext
 from gettext import gettext as _
@@ -14,26 +14,26 @@
 class Aboutcamel_case_nameDialog(gtk.AboutDialog):
     __gtype_name__ = "Aboutcamel_case_nameDialog"
 
-    def __init__(self):
-        """Construct an Aboutcamel_case_nameDialog.
-
-        This function is typically not called directly. Creation of an
-        Aboutcamel_case_nameDialog requires redeading the associated UI file
-        and parsing the UI definition externally, and then calling
-        Aboutcamel_case_nameDialog.finish_initializing().
-
-        Use the convenience function NewAboutcamel_case_nameDialog to create
-        NewAboutcamel_case_nameDialog objects.
+    def __new__(cls):
+        """Special static method that's automatically called by Python when 
+        constructing a new instance of this class.
+        
+        Returns a fully instantiated Aboutcamel_case_nameDialog object.
         """
-        pass
+        builder = get_builder('Aboutcamel_case_nameDialog')
+        new_object = builder.get_object("about_python_name_dialog")
+        new_object.finish_initializing(builder)
+        return new_object
 
     def finish_initializing(self, builder):
-        """Called after we've finished initializing.
+        """Called while initializing this instance in __new__
 
         finish_initalizing should be called after parsing the ui definition
         and creating a Aboutcamel_case_nameDialog object with it in order to
         finish initializing the start of the new Aboutcamel_case_nameDialog
         instance.
+        
+        Put your initialization code in here and leave __init__ undefined.
         """
         # Get a reference to the builder and set up the signals.
         self.builder = builder
@@ -42,17 +42,7 @@
         # Code for other initialization actions should be added here.
 
 
-def NewAboutcamel_case_nameDialog():
-    """Returns a fully instantiated Aboutcamel_case_nameDialog object.
-
-    Use this function rather than creating a Aboutcamel_case_nameDialog
-    instance directly.
-    """
-    return make_window(
-        'Aboutcamel_case_nameDialog', "about_python_name_dialog")
-
-
 if __name__ == "__main__":
-    dialog = NewAboutcamel_case_nameDialog()
+    dialog = Aboutcamel_case_nameDialog()
     dialog.show()
     gtk.main()

=== modified file 'data/templates/ubuntu-application/project_root/python/Preferencescamel_case_nameDialog.py'
--- data/templates/ubuntu-application/project_root/python/Preferencescamel_case_nameDialog.py	2010-02-10 05:54:07 +0000
+++ data/templates/ubuntu-application/project_root/python/Preferencescamel_case_nameDialog.py	2010-03-15 16:53:12 +0000
@@ -7,7 +7,7 @@
 from desktopcouch.records.record import Record
 import gtk
 
-from python_name.helpers import make_window
+from python_name.helpers import get_builder
 
 import gettext
 from gettext import gettext as _
@@ -17,26 +17,26 @@
     __gtype_name__ = "Preferencescamel_case_nameDialog"
     preferences = {}
 
-    def __init__(self):
-        """Construct a Preferencescamel_case_nameDialog.
-
-        This function is typically not called directly. Creation of a
-        Preferencescamel_case_nameDialog requires rereading the associated UI
-        file and parsing the UI definition extrenally, and then calling
-        Preferencescamel_case_nameDialog.finish_initializing().
-
-        Use the convenience function NewPreferencescamel_case_nameDialog to
-        create NewAboutcamel_case_nameDialog objects.
+    def __new__(cls):
+        """Special static method that's automatically called by Python when 
+        constructing a new instance of this class.
+        
+        Returns a fully instantiated Preferencescamel_case_nameDialog object.
         """
-        pass
+        builder = get_builder('Preferencescamel_case_nameDialog')
+        new_object = builder.get_object("preferences_python_name_dialog")
+        new_object.finish_initializing(builder)
+        return new_object
 
     def finish_initializing(self, builder):
-        """Called after we've finished initializing.
+        """Called while initializing this instance in __new__
 
         finish_initalizing should be called after parsing the ui definition
-        and creating a Aboutcamel_case_nameDialog object with it in order to
-        finish initializing the start of the new Aboutcamel_case_nameDialog
+        and creating a Preferencescamel_case_nameDialog object with it in order to
+        finish initializing the start of the new Perferencescamel_case_nameDialog
         instance.
+        
+        Put your initialization code in here and leave __init__ undefined.
         """
 
         # Get a reference to the builder and set up the signals.
@@ -105,19 +105,7 @@
         # Restore any changes to self._preferences here.
         pass
 
-
-def NewPreferencescamel_case_nameDialog():
-    """Returns a fully instantiated Preferencescamel_case_nameDialog object.
-
-    Use this function rather than creating a Preferencescamel_case_nameDialog
-    instance directly.
-    """
-    return make_window(
-        'Preferencescamel_case_nameDialog',
-        "preferences_python_name_dialog")
-
-
 if __name__ == "__main__":
-    dialog = NewPreferencescamel_case_nameDialog()
+    dialog = Preferencescamel_case_nameDialog()
     dialog.show()
     gtk.main()

=== modified file 'data/templates/ubuntu-application/project_root/python/helpers.py'
--- data/templates/ubuntu-application/project_root/python/helpers.py	2010-03-03 14:27:09 +0000
+++ data/templates/ubuntu-application/project_root/python/helpers.py	2010-03-15 16:53:12 +0000
@@ -18,12 +18,12 @@
 from gettext import gettext as _
 gettext.textdomain('project_name')
 
-def make_window(builder_file_name, window_name):
-    """Return a fully-instantiated window or dialog.
-
+def get_builder(builder_file_name):
+    """Return a fully-instantiated gtk.Builder instance from specified ui 
+    file
+    
     :param builder_file_name: The name of the builder file, without extension.
         Assumed to be in the 'ui' directory under the data path.
-    :param window_name: The name of the window or dialog in the builder file.
     """
     # Look for the ui file that describes the user interface.
     ui_filename = get_data_file('ui', '%s.ui' % (builder_file_name,))
@@ -33,6 +33,4 @@
     builder = gtk.Builder()
     builder.set_translation_domain('project_name')
     builder.add_from_file(ui_filename)
-    dialog = builder.get_object(window_name)
-    dialog.finish_initializing(builder)
-    return dialog
+    return builder