Re-order definitions

[pinch] / pinch.py

diff --git a/pinch.py b/pinch.py
index ad493344a65d7d07e05c92b882f49dc8f01f7a0a..a8af6a67aa6f50b2f6a3dbfba53b45a166d5b71d 100644 (file)
--- a/pinch.py
+++ b/pinch.py
@@ -25,29 +25,17 @@ from typing import (
     Tuple,
 )
 
     Tuple,
 )
 

-Digest16 = NewType('Digest16', str)
-Digest32 = NewType('Digest32', str)
+# Use xdg module when it's less painful to have as a dependency

 
 
 
 

-class ChannelTableEntry(types.SimpleNamespace):
-    absolute_url: str
-    digest: Digest16
-    file: str
-    size: int
-    url: str
+class XDG(types.SimpleNamespace):
+    XDG_CACHE_HOME: str

 
 
 
 

-class Channel(types.SimpleNamespace):
-    alias_of: str
-    channel_html: bytes
-    channel_url: str
-    forwarded_url: str
-    git_ref: str
-    git_repo: str
-    git_revision: str
-    old_git_revision: str
-    release_name: str
-    table: Dict[str, ChannelTableEntry]
+xdg = XDG(
+    XDG_CACHE_HOME=os.getenv(
+        'XDG_CACHE_HOME',
+        os.path.expanduser('~/.cache')))

 
 
 class VerificationError(Exception):
 
 
 class VerificationError(Exception):


@@ -70,7 +58,7 @@ class Verification:
     def result(self, r: bool) -> None:
         message, color = {True: ('OK ', 92), False: ('FAIL', 91)}[r]
         length = len(message)
     def result(self, r: bool) -> None:
         message, color = {True: ('OK ', 92), False: ('FAIL', 91)}[r]
         length = len(message)

-        cols = shutil.get_terminal_size().columns
+        cols = shutil.get_terminal_size().columns or 80

         pad = (cols - (self.line_length + length)) % cols
         print(' ' * pad + self._color(message, color), file=sys.stderr)
         self.line_length = 0
         pad = (cols - (self.line_length + length)) % cols
         print(' ' * pad + self._color(message, color), file=sys.stderr)
         self.line_length = 0


@@ -85,6 +73,34 @@ class Verification:
         self.result(True)
 
 
         self.result(True)
 
 

+Digest16 = NewType('Digest16', str)
+Digest32 = NewType('Digest32', str)
+
+
+class ChannelTableEntry(types.SimpleNamespace):
+    absolute_url: str
+    digest: Digest16
+    file: str
+    size: int
+    url: str
+
+
+class SearchPath(types.SimpleNamespace):
+    release_name: str
+
+
+class Channel(SearchPath):
+    alias_of: str
+    channel_html: bytes
+    channel_url: str
+    forwarded_url: str
+    git_ref: str
+    git_repo: str
+    git_revision: str
+    old_git_revision: str
+    table: Dict[str, ChannelTableEntry]
+
+

 def compare(a: str, b: str) -> Tuple[List[str], List[str], List[str]]:
 
     def throw(error: OSError) -> None:
 def compare(a: str, b: str) -> Tuple[List[str], List[str], List[str]]:
 
     def throw(error: OSError) -> None:


@@ -118,7 +134,7 @@ def fetch(v: Verification, channel: Channel) -> None:
     request = urllib.request.urlopen(channel.channel_url, timeout=10)
     channel.channel_html = request.read()
     channel.forwarded_url = request.geturl()
     request = urllib.request.urlopen(channel.channel_url, timeout=10)
     channel.channel_html = request.read()
     channel.forwarded_url = request.geturl()

-    v.result(request.status == 200)
+    v.result(request.status == 200)  # type: ignore  # (for old mypy)

     v.check('Got forwarded', channel.channel_url != channel.forwarded_url)
 
 
     v.check('Got forwarded', channel.channel_url != channel.forwarded_url)
 
 


@@ -171,7 +187,7 @@ def digest_file(filename: str) -> Digest16:
 def to_Digest16(v: Verification, digest32: Digest32) -> Digest16:
     v.status('Converting digest to base16')
     process = subprocess.run(
 def to_Digest16(v: Verification, digest32: Digest32) -> Digest16:
     v.status('Converting digest to base16')
     process = subprocess.run(

-        ['nix', 'to-base16', '--type', 'sha256', digest32], capture_output=True)
+        ['nix', 'to-base16', '--type', 'sha256', digest32], stdout=subprocess.PIPE)

     v.result(process.returncode == 0)
     return Digest16(process.stdout.decode().strip())
 
     v.result(process.returncode == 0)
     return Digest16(process.stdout.decode().strip())
 


@@ -179,7 +195,7 @@ def to_Digest16(v: Verification, digest32: Digest32) -> Digest16:
 def to_Digest32(v: Verification, digest16: Digest16) -> Digest32:
     v.status('Converting digest to base32')
     process = subprocess.run(
 def to_Digest32(v: Verification, digest16: Digest16) -> Digest32:
     v.status('Converting digest to base32')
     process = subprocess.run(

-        ['nix', 'to-base32', '--type', 'sha256', digest16], capture_output=True)
+        ['nix', 'to-base32', '--type', 'sha256', digest16], stdout=subprocess.PIPE)

     v.result(process.returncode == 0)
     return Digest32(process.stdout.decode().strip())
 
     v.result(process.returncode == 0)
     return Digest32(process.stdout.decode().strip())
 


@@ -190,7 +206,7 @@ def fetch_with_nix_prefetch_url(
         digest: Digest16) -> str:
     v.status('Fetching %s' % url)
     process = subprocess.run(
         digest: Digest16) -> str:
     v.status('Fetching %s' % url)
     process = subprocess.run(

-        ['nix-prefetch-url', '--print-path', url, digest], capture_output=True)
+        ['nix-prefetch-url', '--print-path', url, digest], stdout=subprocess.PIPE)

     v.result(process.returncode == 0)
     prefetch_digest, path, empty = process.stdout.decode().split('\n')
     assert empty == ''
     v.result(process.returncode == 0)
     prefetch_digest, path, empty = process.stdout.decode().split('\n')
     assert empty == ''


@@ -199,7 +215,7 @@ def fetch_with_nix_prefetch_url(
     v.status("Verifying file digest")
     file_digest = digest_file(path)
     v.result(file_digest == digest)
     v.status("Verifying file digest")
     file_digest = digest_file(path)
     v.result(file_digest == digest)

-    return path
+    return path  # type: ignore  # (for old mypy)

 
 
 def fetch_resources(v: Verification, channel: Channel) -> None:
 
 
 def fetch_resources(v: Verification, channel: Channel) -> None:


@@ -216,11 +232,20 @@ def fetch_resources(v: Verification, channel: Channel) -> None:
 
 
 def git_cachedir(git_repo: str) -> str:
 
 
 def git_cachedir(git_repo: str) -> str:

-    # TODO: Consider using pyxdg to find this path.
-    return os.path.expanduser(
-        '~/.cache/pinch/git/%s' %
-        digest_string(
-            git_repo.encode()))
+    return os.path.join(
+        xdg.XDG_CACHE_HOME,
+        'pinch/git',
+        digest_string(git_repo.encode()))
+
+
+def tarball_cache_file(channel: Channel) -> str:
+    return os.path.join(
+        xdg.XDG_CACHE_HOME,
+        'pinch/git-tarball',
+        '%s-%s-%s' %
+        (digest_string(channel.git_repo.encode()),
+         channel.git_revision,
+         channel.release_name))

 
 
 def verify_git_ancestry(v: Verification, channel: Channel) -> None:
 
 
 def verify_git_ancestry(v: Verification, channel: Channel) -> None:


@@ -360,13 +385,20 @@ def git_checkout(v: Verification, channel: Channel, dest: str) -> None:
                            stdout=subprocess.PIPE)
     tar = subprocess.Popen(
         ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout)
                            stdout=subprocess.PIPE)
     tar = subprocess.Popen(
         ['tar', 'x', '-C', dest, '-f', '-'], stdin=git.stdout)

-    git.stdout.close()
+    if git.stdout:
+        git.stdout.close()

     tar.wait()
     git.wait()
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 
 def git_get_tarball(v: Verification, channel: Channel) -> str:
     tar.wait()
     git.wait()
     v.result(git.returncode == 0 and tar.returncode == 0)
 
 
 def git_get_tarball(v: Verification, channel: Channel) -> str:

+    cache_file = tarball_cache_file(channel)
+    if os.path.exists(cache_file):
+        cached_tarball = open(cache_file).read(9999)
+        if os.path.exists(cached_tarball):
+            return cached_tarball
+

     with tempfile.TemporaryDirectory() as output_dir:
         output_filename = os.path.join(
             output_dir, channel.release_name + '.tar.xz')
     with tempfile.TemporaryDirectory() as output_dir:
         output_filename = os.path.join(
             output_dir, channel.release_name + '.tar.xz')


@@ -388,9 +420,13 @@ def git_get_tarball(v: Verification, channel: Channel) -> str:
 
         v.status('Putting tarball in Nix store')
         process = subprocess.run(
 
         v.status('Putting tarball in Nix store')
         process = subprocess.run(

-            ['nix-store', '--add', output_filename], capture_output=True)
+            ['nix-store', '--add', output_filename], stdout=subprocess.PIPE)

         v.result(process.returncode == 0)
         v.result(process.returncode == 0)

-        return process.stdout.decode().strip()
+        store_tarball = process.stdout.decode().strip()
+
+        os.makedirs(os.path.dirname(cache_file), exist_ok=True)
+        open(cache_file, 'w').write(store_tarball)
+        return store_tarball  # type: ignore  # (for old mypy)

 
 
 def check_channel_metadata(
 
 
 def check_channel_metadata(


@@ -445,17 +481,22 @@ def git_revision_name(v: Verification, channel: Channel) -> str:
     process = subprocess.run(['git',
                               '-C',
                               git_cachedir(channel.git_repo),
     process = subprocess.run(['git',
                               '-C',
                               git_cachedir(channel.git_repo),

-                              'lo',
+                              'log',

                               '-n1',
                               '--format=%ct-%h',
                               '--abbrev=11',
                               '-n1',
                               '--format=%ct-%h',
                               '--abbrev=11',

+                              '--no-show-signature',

                               channel.git_revision],
                               channel.git_revision],

-                             capture_output=True)
-    v.result(process.returncode == 0 and process.stdout != '')
+                             stdout=subprocess.PIPE)
+    v.result(process.returncode == 0 and process.stdout != b'')

     return '%s-%s' % (os.path.basename(channel.git_repo),
                       process.stdout.decode().strip())
 
 
     return '%s-%s' % (os.path.basename(channel.git_repo),
                       process.stdout.decode().strip())
 
 

+def read_search_path(conf: configparser.SectionProxy) -> Channel:
+    return Channel(**dict(conf.items()))
+
+

 def read_config(filename: str) -> configparser.ConfigParser:
     config = configparser.ConfigParser()
     config.read_file(open(filename), filename)
 def read_config(filename: str) -> configparser.ConfigParser:
     config = configparser.ConfigParser()
     config.read_file(open(filename), filename)


@@ -469,7 +510,7 @@ def pin(args: argparse.Namespace) -> None:
         if args.channels and section not in args.channels:
             continue
 
         if args.channels and section not in args.channels:
             continue
 

-        channel = Channel(**dict(config[section].items()))
+        channel = read_search_path(config[section])

 
         if hasattr(channel, 'alias_of'):
             assert not hasattr(channel, 'git_repo')
 
         if hasattr(channel, 'alias_of'):
             assert not hasattr(channel, 'git_repo')


@@ -493,6 +534,25 @@ def pin(args: argparse.Namespace) -> None:
         config.write(configfile)
 
 
         config.write(configfile)
 
 

+def fetch_channel(
+        v: Verification,
+        section: str,
+        conf: configparser.SectionProxy) -> str:
+    if 'git_repo' not in conf or 'release_name' not in conf:
+        raise Exception(
+            'Cannot update unpinned channel "%s" (Run "pin" before "update")' %
+            section)
+
+    if 'channel_url' in conf:
+        return fetch_with_nix_prefetch_url(
+            v, conf['tarball_url'], Digest16(
+                conf['tarball_sha256']))
+
+    channel = read_search_path(conf)
+    ensure_git_rev_available(v, channel)
+    return git_get_tarball(v, channel)
+
+

 def update(args: argparse.Namespace) -> None:
     v = Verification()
     config = configparser.ConfigParser()
 def update(args: argparse.Namespace) -> None:
     v = Verification()
     config = configparser.ConfigParser()


@@ -500,20 +560,10 @@ def update(args: argparse.Namespace) -> None:
     configs = [read_config(filename) for filename in args.channels_file]
     for config in configs:
         for section in config.sections():
     configs = [read_config(filename) for filename in args.channels_file]
     for config in configs:
         for section in config.sections():

-

             if 'alias_of' in config[section]:
                 assert 'git_repo' not in config[section]
                 continue
             if 'alias_of' in config[section]:
                 assert 'git_repo' not in config[section]
                 continue

-
-            if 'channel_url' in config[section]:
-                tarball = fetch_with_nix_prefetch_url(
-                    v, config[section]['tarball_url'], Digest16(
-                        config[section]['tarball_sha256']))
-            else:
-                channel = Channel(**dict(config[section].items()))
-                ensure_git_rev_available(v, channel)
-                tarball = git_get_tarball(v, channel)
-
+            tarball = fetch_channel(v, section, config[section])

             if section in exprs:
                 raise Exception('Duplicate channel "%s"' % section)
             exprs[section] = (
             if section in exprs:
                 raise Exception('Duplicate channel "%s"' % section)
             exprs[section] = (


@@ -560,4 +610,5 @@ def main() -> None:
     args.func(args)
 
 
     args.func(args)
 
 

-main()
+if __name__ == '__main__':
+    main()