Localization

.gitignore

@@ -10,3 +10,6 @@ build
 *.swo
 *.pyc
 .repos
+
+.mypy_cache
+mypy.ini

.travis.yml

@@ -4,7 +4,7 @@ python:
   - 3.6
 
 install:
-  - pip install coveralls pycodestyle
+  - pip install coveralls pycodestyle pyyaml
   - python setup.py install
 
 script:

src/blameandshame/components.py

@@ -0,0 +1,33 @@
+class Component(object):
+
+    def __init__(self):
+        raise NotImplementedError
+
+
+class File_C(Component):
+
+    def __init__(self,
+                 filename: str = "") -> None:
+        self.filename = filename
+
+
+class Line_C(Component):
+
+    def __init__(self,
+                 filename: str = "",
+                 lineno: int = 0) -> None:
+        self.filename = filename
+        self.lineno = lineno
+
+
+class Function_C(Component):
+
+    def __init__(self,
+                 funcname: str = "",
+                 filename: File_C = None,
+                 line_start: int = 0,
+                 line_end: int = 0) -> None:
+        self.funcname = funcname
+        self.filename = filename
+        self.line_start = line_start
+        self.line_end = line_end

src/blameandshame/localization.py

@@ -0,0 +1,55 @@
+from typing import Dict, List, Type, TypeVar
+from blameandshame.components import Component
+import yaml
+
+VERSION = "1.0"
+G = TypeVar('G', bound=Component)
+S = TypeVar('S', bound=Component)
+
+
+class Localization (object):
+
+    @staticmethod
+    def from_file(filename: str) -> 'Localization':
+        """
+        Builds a Localization object from a file
+        """
+        with open(filename) as f:
+            try:
+                loc = yaml.load(f)
+            except KeyError as err:
+                print('Error when importing', filename, '.', err)
+                raise IOError
+        return loc
+
+    def to_file(self, filename: str) -> None:
+        """
+        Stores its internal data in a file
+        """
+        with open(filename, "w") as f:
+            yaml.dump(self, f)
+
+    def __init__(self,
+                 mapping: Dict,
+                 scope: List[S],
+                 granularity: Type[G],
+                 version: str = VERSION) -> None:
+
+        self.mapping = mapping
+        self.scope = scope
+        self.__version = version
+        self.__granularity = granularity
+
+    @property
+    def version(self) -> str:
+        """
+        The version number of this localization object.
+        """
+        return self.__version
+
+    @property
+    def granularity(self) -> Type[G]:
+        """
+        The granularity of this object
+        """
+        return self.__granularity

tests/localization_test.py

@@ -0,0 +1,65 @@
+#!/usr/bin/env python3
+import tempfile
+import textwrap
+from typing import Dict, List, Type
+import unittest
+from blameandshame.localization import Localization
+from blameandshame.components import Component, File_C, Function_C, Line_C
+
+
+class LocalizationTestCase(unittest.TestCase):
+
+    def test_from_file(self):
+        """
+        Tests the from_file function by creating a YAML file from a string
+        and using from_file to import it.
+        """
+        def check_one(yaml_string: str,
+                      granularity: Type[Component],
+                      version: str,
+                      mapping: Dict,
+                      scope: List[Component]) -> None:
+            f = tempfile.NamedTemporaryFile()
+            f.write(yaml_string.encode())
+            f.seek(0)
+            l = Localization.from_file(f.name)
+            f.close()
+            self.assertEqual(l.granularity, granularity)
+            self.assertEqual(l.version, version)
+            self.assertEqual(l.mapping, mapping)
+            self.assertEqual(l.scope, scope)
+
+        simple_localization = textwrap.dedent(
+            """
+            !!python/object:blameandshame.localization.Localization
+            _Localization__granularity: !!python/name:blameandshame.components.File_C
+            _Localization__version: '0.0'
+            mapping: {}
+            scope: []
+            """
+        )
+        check_one(simple_localization, File_C, "0.0", {}, [])
+        simple_localization = textwrap.dedent(
+            """
+            !!python/object:blameandshame.localization.Localization
+            _Localization__granularity: !!python/name:blameandshame.components.Function_C
+            _Localization__version: '0.0'
+            mapping: {}
+            scope: []
+            """
+        )
+        check_one(simple_localization, Function_C, "0.0", {}, [])
+        simple_localization = textwrap.dedent(
+            """
+            !!python/object:blameandshame.localization.Localization
+            _Localization__granularity: !!python/name:blameandshame.components.Line_C
+            _Localization__version: '0.0'
+            mapping: {}
+            scope: []
+            """
+        )
+        check_one(simple_localization, Line_C, "0.0", {}, [])
+
+
+if __name__ == '__main__':
+    unittest.main()