Merge pull request #44 from Contraz/settings-cleanup

Simplify a ridiculous way of generating a settings file

Author: einarf

demosys/conf/__init__.py

@@ -4,7 +4,7 @@
 import importlib
 import os
 
-from demosys.conf import default_settings
+from demosys.conf import default
 from demosys.core.exceptions import ImproperlyConfigured
 
 ENVIRONMENT_VARIABLE = "DEMOSYS_SETTINGS_MODULE"
@@ -13,10 +13,11 @@
 
 
 class Settings:
+    SETTINGS_MODULE = None
     SHADER_DIRS = []
     TEXTURE_DIRS = []
     DATA_DIRS = []
-    SETTINGS_MODULE = None
+    SCENE_DIRS = []
 
     def __init__(self):
         settings_module = os.environ.get(ENVIRONMENT_VARIABLE)
@@ -27,9 +28,9 @@ def __init__(self):
             )
 
         # Update this dict from global settings
-        for setting in dir(default_settings):
+        for setting in dir(default):
             if setting.isupper():
-                setattr(self, setting, getattr(default_settings, setting))
+                setattr(self, setting, getattr(default, setting))
 
         # Read the supplied settings module
         self.SETTINGS_MODULE = settings_module

demosys/conf/default_settings.py renamed to demosys/conf/default.py

@@ -1,40 +1,16 @@
-"""
-Default settings for demosys. Override using a settings module.
-"""
-
-# What attributes should be used when generating a settings file
-__ORDER__ = (
-    'DEBUG',
-    'SCREENSHOT_PATH',
-    'OPENGL',
-    'WINDOW',
-    'MUSIC',
-    'TIMER',
-    'ROCKET',
-    'EFFECTS',
-    'EFFECT_MANAGER',
-    'SHADER_DIRS',
-    'SHADER_FINDERS',
-    'TEXTURE_DIRS',
-    'TEXTURE_FINDERS',
-    'SCENE_DIRS',
-    'SCENE_FINDERS',
-    'SCENE_LOADERS',
-    'DATA_DIRS',
-    'DATA_FINDERS',
-)
+import os
 
-DEBUG = False
+PROJECT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 
-SCREENSHOT_PATH = None
+SCREENSHOT_PATH = os.path.join(PROJECT_DIR, 'screenshots')
 
 # OpenGL context configuration
 # version: (MAJOR, MINOR)
 OPENGL = {
     "version": (3, 3),
 }
 
-# Window size
+# Window / context properties
 WINDOW = {
     "class": "demosys.context.glfw.GLFW_Window",
     "size": (1280, 720),
@@ -63,7 +39,7 @@
 
 EFFECT_MANAGER = 'demosys.effects.managers.SingleEffectManager'
 
-# Raise errors when uniforms are assigned with incorrect type
+# Raise errors when shader uniforms are assigned incorrectly
 # Otherwise just print the errors to terminal
 SHADER_STRICT_VALIDATION = False
 
@@ -73,23 +49,22 @@
     'geometry_shader_suffix': ('geom', '_gs.glsl', '.glslg'),
 }
 
-# Additional directories shaders can be found
 SHADER_DIRS = ()
 
-# Finder
 SHADER_FINDERS = (
     'demosys.core.shaderfiles.finders.FileSystemFinder',
     'demosys.core.shaderfiles.finders.EffectDirectoriesFinder'
 )
 
-# Additonal directories textures can be found
 TEXTURE_DIRS = ()
+
 TEXTURE_FINDERS = (
     'demosys.core.texturefiles.finders.FileSystemFinder',
     'demosys.core.texturefiles.finders.EffectDirectoriesFinder'
 )
 
 SCENE_DIRS = ()
+
 SCENE_FINDERS = (
     "demosys.core.scenefiles.finders.FileSystemFinder",
     "demosys.core.scenefiles.finders.EffectDirectoriesFinder",
@@ -101,6 +76,7 @@
 )
 
 DATA_DIRS = ()
+
 DATA_FINDERS = (
     "demosys.core.datafiles.finders.FileSystemFinder",
     "demosys.core.datafiles.finders.EffectDirectoriesFinder",

demosys/conf/settingsfile.py

@@ -1,45 +1,19 @@
+import os
 
 
-def create(settings):
+def create(**kwargs):
     """
-    Return a string representation of the settings.
-    This is an extremely ugly way of doing this, but it works for now!
+    Return a string representing a new default settings file for a project
     """
-    # FIXME: Use a template system for generating settings file
-    data = "# Auto generated settings file\n" \
-           "import os\n" \
-           "PROJECT_DIR = os.path.dirname(os.path.abspath(__file__))\n\n"
-
-    for name in settings.__ORDER__:
-        value = getattr(settings, name)
-
-        if isinstance(value, dict):
-            value = ",\n".join('    "{}": {}'.format(k, to_s(v)) for k, v in value.items())
-
-            # Add comma after the last dict entry
-            if value:
-                value += ','
-
-            data += "%s = {\n%s\n}\n\n" % (name, value)
-
-        elif isinstance(value, tuple):
-            value = ",\n".join("    {}".format(to_s(v)) for v in value)
-
-            # Add comma after the last tuple entry
-            if value:
-                value += ","
-
-            data += "{} = (\n{}\n)\n\n".format(name, value)
-
-        elif value is None:
-            data += "{} = {}\n\n".format(name, value)
-
-    # Return config excluding last newline
-    return data[:-1]
-
-
-def to_s(var):
-    if isinstance(var, str):
-        return '"{}"'.format(var)
-    else:
-        return str(var)
+    template_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'default.py')
+    data = ""
+    with open(template_file, 'r') as fd:
+        data = fd.read()
+
+    header = (
+        '"""\n'
+        'Auto generated settings file for project {}\n'
+        '"""\n'
+    ).format(kwargs.get('name'))
+
+    return header + data

demosys/core/management/commands/createproject.py

@@ -1,61 +1,60 @@
-import os
-from demosys.core.management.base import CreateCommand
-
-
-class Command(CreateCommand):
-    help = "Create a project"
-
-    def add_arguments(self, parser):
-        parser.add_argument("name", help="Name of the project")
-
-    def handle(self, *args, **options):
-        name = options['name']
-
-        # Check for python module collision
-        self.try_import(name)
-
-        # Is the name a valid identifier?
-        self.validate_name(name)
-
-        # Make sure we don't mess with existing directories
-        if os.path.exists(name):
-            print("Directory {} already exist. Aborting.".format(name))
-            return
-
-        manage_file = 'manage.py'
-        if os.path.exists(manage_file):
-            print("A manage.py file already exist in the current directory. Aborting.")
-            return
-
-        # Create the project directory
-        os.makedirs(name)
-
-        # Use the default settings file
-        os.environ['DEMOSYS_SETTINGS_MODULE'] = 'demosys.conf.default_settings'
-        from demosys.conf import settings
-        from demosys.conf import settingsfile
-
-        with open(os.path.join(name, 'settings.py'), 'w') as fd:
-            fd.write(settingsfile.create(settings))
-
-        with open(manage_file, 'w') as fd:
-            fd.write(gen_manage_py(name))
-
-        os.chmod(manage_file, 0o777)
-
-
-def gen_manage_py(project_name):
-    lines = [
-        '#!/usr/bin/env python3',
-        'import os',
-        'import sys',
-        '',
-        'if __name__ == "__main__":',
-        '    os.environ.setdefault("DEMOSYS_SETTINGS_MODULE", "{}.settings")'.format(project_name),
-        '',
-        '    from demosys.core.management import execute_from_command_line',
-        '',
-        '    execute_from_command_line(sys.argv)',
-        '',
-    ]
-    return "\n".join(lines)
+import os
+from demosys.core.management.base import CreateCommand
+
+
+class Command(CreateCommand):
+    help = "Create a project"
+
+    def add_arguments(self, parser):
+        parser.add_argument("name", help="Name of the project")
+
+    def handle(self, *args, **options):
+        name = options['name']
+
+        # Check for python module collision
+        self.try_import(name)
+
+        # Is the name a valid identifier?
+        self.validate_name(name)
+
+        # Make sure we don't mess with existing directories
+        if os.path.exists(name):
+            print("Directory {} already exist. Aborting.".format(name))
+            return
+
+        manage_file = 'manage.py'
+        if os.path.exists(manage_file):
+            print("A manage.py file already exist in the current directory. Aborting.")
+            return
+
+        # Create the project directory
+        os.makedirs(name)
+
+        # Use the default settings file
+        os.environ['DEMOSYS_SETTINGS_MODULE'] = 'demosys.conf.default'
+        from demosys.conf import settingsfile
+
+        with open(os.path.join(name, 'settings.py'), 'w') as fd:
+            fd.write(settingsfile.create(name=name))
+
+        with open(manage_file, 'w') as fd:
+            fd.write(gen_manage_py(name))
+
+        os.chmod(manage_file, 0o777)
+
+
+def gen_manage_py(project_name):
+    lines = [
+        '#!/usr/bin/env python3',
+        'import os',
+        'import sys',
+        '',
+        'if __name__ == "__main__":',
+        '    os.environ.setdefault("DEMOSYS_SETTINGS_MODULE", "{}.settings")'.format(project_name),
+        '',
+        '    from demosys.core.management import execute_from_command_line',
+        '',
+        '    execute_from_command_line(sys.argv)',
+        '',
+    ]
+    return "\n".join(lines)