Convert update-copyright.py to a more modular framework.

[update-copyright.git] / update_copyright / vcs / __init__.py

diff --git a/update_copyright/vcs/__init__.py b/update_copyright/vcs/__init__.py
new file mode 100644 (file)
index 0000000..bd9248b
--- /dev/null
+++ b/update_copyright/vcs/__init__.py
@@ -0,0 +1,48 @@
+# Copyright
+
+"""Backends for version control systems."""
+
+from . import utils as _utils
+
+
+class VCSBackend (object):
+    name = None
+
+    def __init__(self, author_hacks=None, year_hacks=None, aliases=None):
+        if author_hacks is None:
+            author_hacks = {}
+        self._author_hacks = author_hacks
+        if year_hacks is None:
+            year_hacks = {}
+        self._year_hacks = year_hacks
+        if aliases is None:
+            aliases = {}
+        self._aliases = aliases
+
+    def _years(self, filename=None):
+        raise NotImplementedError()
+
+    def original_year(self, filename=None):
+        years = self._years(filename=filename)
+        if filename is None:
+            years.update(self._year_hacks.values())
+        elif _utils.splitpath(filename) in self._year_hacks:
+            years.update(year_hacks[_utils.splitpath(filename)])
+        years = sorted(years)
+        return years[0]
+
+    def _authors(self, filename=None):
+        raise NotImplementedError()
+
+    def authors(self, filename=None, with_emails=True):
+        authors = self._authors(filename=filename)
+        if filename is None:
+            for path,authors in self._author_hacks.items():
+                authors.update(authors)
+        elif _utils.splitpath(filename) in self._author_hacks:
+            authors.update(self._author_hacks[_utils.splitpath(filename)])
+        return _utils.replace_aliases(
+            authors, with_email=False, aliases=self._aliases)
+
+    def is_versioned(self, filename=None):
+        raise NotImplementedError()