Merge pull request #30 from Contraz/textwriter

Basic textwriter + improved resource features

Author: einarf

demosys/conf/__init__.py

@@ -9,8 +9,15 @@
 
 ENVIRONMENT_VARIABLE = "DEMOSYS_SETTINGS_MODULE"
 
+# pylint: disable=C0103
+
 
 class Settings:
+    SHADER_DIRS = []
+    TEXTURE_DIRS = []
+    DATA_DIRS = []
+    SETTINGS_MODULE = None
+
     def __init__(self):
         settings_module = os.environ.get(ENVIRONMENT_VARIABLE)
         if not settings_module:
@@ -58,5 +65,17 @@ def add_shader_dir(self, dir):
         dirs.append(dir)
         self.SHADER_DIRS = dirs
 
+    def add_texture_dir(self, directory):
+        """Hack in texture directory"""
+        dirs = list(self.TEXTURE_DIRS)
+        dirs.append(directory)
+        self.TEXTURE_DIRS = dirs
+
+    def add_data_dir(self, directory):
+        """Hack in a data directory"""
+        dirs = list(self.DATA_DIRS)
+        dirs.append(directory)
+        self.DATA_DIRS = dirs
+
 
 settings = Settings()

demosys/conf/default_settings.py

@@ -20,6 +20,8 @@
     'SCENE_DIRS',
     'SCENE_FINDERS',
     'SCENE_LOADERS',
+    'DATA_DIRS',
+    'DATA_FINDERS',
 )
 
 DEBUG = False
@@ -98,3 +100,9 @@
     'demosys.scene.loaders.gltf.GLTF2',
     'demosys.scene.loaders.wavefront.ObjLoader',
 )
+
+DATA_DIRS = ()
+DATA_FINDERS = (
+    "demosys.core.datafiles.finders.FileSystemFinder",
+    "demosys.core.datafiles.finders.EffectDirectoriesFinder",
+)

demosys/core/__init__.py

@@ -0,0 +1,37 @@
+import functools
+
+from demosys.core import finders
+from demosys.conf import settings
+from demosys.core.exceptions import ImproperlyConfigured
+from demosys.utils.module_loading import import_string
+
+
+class FileSystemFinder(finders.BaseFileSystemFinder):
+    """Find data in ``DATA_DIRS``"""
+    settings_attr = 'DATA_DIRS'
+
+
+class EffectDirectoriesFinder(finders.BaseEffectDirectoriesFinder):
+    """Finds data in the registered effects"""
+    directory = 'data'
+
+
+def get_finders():
+    for finder in settings.DATA_FINDERS:
+        yield get_finder(finder)
+
+
+@functools.lru_cache(maxsize=None)
+def get_finder(import_path):
+    """
+    Get a finder class from an import path.
+    Raises ``demosys.core.exceptions.ImproperlyConfigured`` if the finder is not found.
+    This function uses an lru cache.
+
+    :param import_path: string representing an import path
+    :return: An instance of the finder
+    """
+    Finder = import_string(import_path)
+    if not issubclass(Finder, finders.BaseFileSystemFinder):
+        raise ImproperlyConfigured('Finder {} is not a subclass of core.finders.FileSystemFinder'.format(import_path))
+    return Finder()

demosys/core/datafiles/finders.py

@@ -3,14 +3,24 @@
 """
 import os
 from collections import namedtuple
+from demosys.conf import settings
+from demosys.core.exceptions import ImproperlyConfigured
 
 FinderEntry = namedtuple('FinderEntry', ['path', 'abspath', 'exists'])
 
 
-class FileSystemFinder:
-    """Find files in the local file system"""
-    def __init__(self, paths):
-        self.paths = paths
+class BaseFileSystemFinder:
+    """Base class for searching directory lists"""
+    settings_attr = None
+
+    def __init__(self):
+        if not hasattr(settings, self.settings_attr):
+            raise ImproperlyConfigured(
+                "Settings module don't define TEXTURE_DIRS."
+                "This is required when using a FileSystemFinder."
+            )
+        self.paths = getattr(settings, self.settings_attr)
+
         self._cache = {}
 
     def find(self, path):
@@ -30,8 +40,8 @@ def _find(self, path):
         :param path: The path to find
         :return: The absolute path to the file or None if not found
         """
-        for p in self.paths:
-            abspath = os.path.join(p, path)
+        for entry in self.paths:
+            abspath = os.path.join(entry, path)
             if os.path.exists(abspath):
                 self.cache(abspath, abspath)
                 return abspath
@@ -48,9 +58,11 @@ def find_cached(self, path):
         :param path: The path to the file
         :return: The absolute path to the file or None
         """
-        e = self._cache.get(path)
-        if e.exists:
-            return e.abspath
+        entry = self._cache.get(path)
+
+        if entry.exists:
+            return entry.abspath
+
         return None
 
     def cache(self, path, abspath, exists=True):
@@ -63,3 +75,16 @@ def cache(self, path, abspath, exists=True):
         :param exists: Did the file exist? (bool)
         """
         self._cache[path] = FinderEntry(path=path, abspath=abspath, exists=exists)
+
+
+class BaseEffectDirectoriesFinder(BaseFileSystemFinder):
+    """Base class for searching effect directories"""
+    directory = None
+
+    def __init__(self):
+        from demosys.effects.registry import effects
+        self.paths = list(effects.get_dirs())
+        self._cache = {}
+
+    def find(self, path):
+        return self._find(os.path.join(self.directory, path))

demosys/core/finders.py

@@ -1,38 +1,19 @@
 import functools
-import os
+
 from demosys.core import finders
 from demosys.conf import settings
 from demosys.core.exceptions import ImproperlyConfigured
 from demosys.utils.module_loading import import_string
 
-SCENE_DIR = 'scenes'
-
 
-class FileSystemFinder(finders.FileSystemFinder):
+class FileSystemFinder(finders.BaseFileSystemFinder):
     """Find textures in ``SCENE_DIRS``"""
-    def __init__(self):
-        if not hasattr(settings, 'SCENE_DIRS'):
-            raise ImproperlyConfigured(
-                "Settings module don't define SCENE_DIRS."
-                "This is required when using a FileSystemFinder."
-            )
-        super().__init__(settings.TEXTURE_DIRS)
+    settings_attr = 'SCENE_DIRS'
 
-    # TODO: Use values from settings to filter files
-    # def find(self, path):
-    #     pass
 
-
-class EffectDirectoriesFinder(finders.FileSystemFinder):
+class EffectDirectoriesFinder(finders.BaseEffectDirectoriesFinder):
     """Finds textures in the registered effects"""
-    def __init__(self):
-        from demosys.effects.registry import effects
-        dirs = list(effects.get_dirs())
-        super().__init__(dirs)
-
-    # TODO: Use values from settings to filter texture files
-    def find(self, path):
-        return self._find(os.path.join(SCENE_DIR, path))
+    directory = 'scenes'
 
 
 def get_finders():
@@ -51,6 +32,6 @@ def get_finder(import_path):
     :return: An instance of the finder
     """
     Finder = import_string(import_path)
-    if not issubclass(Finder, finders.FileSystemFinder):
+    if not issubclass(Finder, finders.BaseFileSystemFinder):
         raise ImproperlyConfigured('Finder {} is not a subclass of core.finders.FileSystemFinder'.format(import_path))
     return Finder()

demosys/core/scenefiles/finders.py

@@ -1,34 +1,19 @@
 import functools
-import os
+
 from demosys.core import finders
 from demosys.conf import settings
 from demosys.core.exceptions import ImproperlyConfigured
 from demosys.utils.module_loading import import_string
 
-SHADER_DIR = 'shaders'
-
 
-class FileSystemFinder(finders.FileSystemFinder):
+class FileSystemFinder(finders.BaseFileSystemFinder):
     """Find shaders in ``SHADER_DIRS``"""
-    def __init__(self):
-        if not hasattr(settings, 'SHADER_DIRS'):
-            raise ImproperlyConfigured(
-                "Settings module don't define SHADER_DIRS."
-                "This is required when using a FileSystemFinder."
-            )
-        super().__init__(settings.SHADER_DIRS)
+    settings_attr = 'SHADER_DIRS'
 
 
-class EffectDirectoriesFinder(finders.FileSystemFinder):
+class EffectDirectoriesFinder(finders.BaseEffectDirectoriesFinder):
     """Finds shaders in the registered effects"""
-    def __init__(self):
-        from demosys.effects.registry import effects
-        dirs = list(effects.get_dirs())
-        super().__init__(dirs)
-
-    # TODO: Use values from settings to filter shader files
-    def find(self, path):
-        return self._find(os.path.join(SHADER_DIR, path))
+    directory = 'shaders'
 
 
 def get_finders():
@@ -47,6 +32,6 @@ def get_finder(import_path):
     :return: An instance of the finder
     """
     Finder = import_string(import_path)
-    if not issubclass(Finder, finders.FileSystemFinder):
+    if not issubclass(Finder, finders.BaseFileSystemFinder):
         raise ImproperlyConfigured('Finder {} is not a subclass of core.finders.FileSystemFinder'.format(import_path))
     return Finder()

demosys/core/shaderfiles/__init__.py

@@ -1,38 +1,19 @@
 import functools
-import os
+
 from demosys.core import finders
 from demosys.conf import settings
 from demosys.core.exceptions import ImproperlyConfigured
 from demosys.utils.module_loading import import_string
 
-TEXTURE_DIR = 'textures'
-
 
-class FileSystemFinder(finders.FileSystemFinder):
+class FileSystemFinder(finders.BaseFileSystemFinder):
     """Find textures in ``TEXTURE_DIRS``"""
-    def __init__(self):
-        if not hasattr(settings, 'TEXTURE_DIRS'):
-            raise ImproperlyConfigured(
-                "Settings module don't define TEXTURE_DIRS."
-                "This is required when using a FileSystemFinder."
-            )
-        super().__init__(settings.TEXTURE_DIRS)
+    settings_attr = 'TEXTURE_DIRS'
 
-    # TODO: Use values from settings to filter texture files
-    # def find(self, path):
-    #     pass
 
-
-class EffectDirectoriesFinder(finders.FileSystemFinder):
+class EffectDirectoriesFinder(finders.BaseEffectDirectoriesFinder):
     """Finds textures in the registered effects"""
-    def __init__(self):
-        from demosys.effects.registry import effects
-        dirs = list(effects.get_dirs())
-        super().__init__(dirs)
-
-    # TODO: Use values from settings to filter texture files
-    def find(self, path):
-        return self._find(os.path.join(TEXTURE_DIR, path))
+    directory = 'textures'
 
 
 def get_finders():
@@ -51,6 +32,6 @@ def get_finder(import_path):
     :return: An instance of the finder
     """
     Finder = import_string(import_path)
-    if not issubclass(Finder, finders.FileSystemFinder):
+    if not issubclass(Finder, finders.BaseFileSystemFinder):
         raise ImproperlyConfigured('Finder {} is not a subclass of core.finders.FileSystemFinder'.format(import_path))
     return Finder()