Merge pull request #24 from mshenfield/issue-22-add-hash-information-…

…to-requirements

Add hash and hash_name fragment

requirements/fragment.py

@@ -1,3 +1,8 @@
+# Copied from pip
+# https://github.com/pypa/pip/blob/281eb61b09d87765d7c2b92f6982b3fe76ccb0af/pip/index.py#L947
+HASH_ALGORITHMS = set(['sha1', 'sha224', 'sha384', 'sha256', 'sha512', 'md5'])
+
+
 def parse_fragment(fragment_string):
     """Takes a fragment string nd returns a dict of the components"""
     fragment_string = fragment_string.lstrip('#')
@@ -13,3 +18,12 @@ def parse_fragment(fragment_string):
                 fragment_string=fragment_string
             )
         )
+
+
+def get_hash_info(d):
+    """Returns the first matching hashlib name and value from a dict"""
+    for key in d.keys():
+        if key.lower() in HASH_ALGORITHMS:
+            return key, d[key]
+
+    return None, None

requirements/requirement.py

@@ -2,7 +2,7 @@
 import re
 from pkg_resources import Requirement as Req
 
-from .fragment import parse_fragment
+from .fragment import get_hash_info, parse_fragment
 from .vcs import VCS, VCS_SCHEMES
 
 
@@ -50,6 +50,8 @@ class Requirement(object):
     * ``name`` - the name of the requirement
     * ``uri`` - the URI if this requirement was specified by URI
     * ``path`` - the local path to the requirement
+    * ``hash_name`` - the type of hashing algorithm indicated in the line
+    * ``hash`` - the hash value indicated by the requirement line
     * ``extras`` - a list of extras for this requirement
       (eg. "mymodule[extra1, extra2]")
     * ``specs`` - a list of specs for this requirement
@@ -67,6 +69,8 @@ def __init__(self, line):
         self.uri = None
         self.path = None
         self.revision = None
+        self.hash_name = None
+        self.hash = None
         self.extras = []
         self.specs = []
 
@@ -104,6 +108,7 @@ def parse_editable(cls, line):
             if groups['fragment']:
                 fragment = parse_fragment(groups['fragment'])
                 req.name = fragment.get('egg')
+                req.hash_name, req.hash = get_hash_info(fragment)
             for vcs in VCS:
                 if req.uri.startswith(vcs):
                     req.vcs = vcs
@@ -114,6 +119,7 @@ def parse_editable(cls, line):
             if groups['fragment']:
                 fragment = parse_fragment(groups['fragment'])
                 req.name = fragment.get('egg')
+                req.hash_name, req.hash = get_hash_info(fragment)
             req.path = groups['path']
 
         return req
@@ -143,6 +149,7 @@ def parse_line(cls, line):
             if groups['fragment']:
                 fragment = parse_fragment(groups['fragment'])
                 req.name = fragment.get('egg')
+                req.hash_name, req.hash = get_hash_info(fragment)
             for vcs in VCS:
                 if req.uri.startswith(vcs):
                     req.vcs = vcs
@@ -152,6 +159,7 @@ def parse_line(cls, line):
             if groups['fragment']:
                 fragment = parse_fragment(groups['fragment'])
                 req.name = fragment.get('egg')
+                req.hash_name, req.hash = get_hash_info(fragment)
             if groups['scheme'] == 'file':
                 req.local_file = True
         elif '#egg=' in line:
@@ -162,6 +170,7 @@ def parse_line(cls, line):
             if groups['fragment']:
                 fragment = parse_fragment(groups['fragment'])
                 req.name = fragment.get('egg')
+                req.hash_name, req.hash = get_hash_info(fragment)
             req.path = groups['path']
         else:
             # This is a requirement specifier.

tests/reqfiles/comment_2.expected

@@ -1,20 +1,22 @@
 [
  {
-  "specifier": true, 
-  "local_file": false, 
-  "name": "req", 
-  "editable": false, 
-  "uri": null, 
-  "extras": [], 
-  "vcs": null, 
-  "path": null, 
-  "line": "req==1.0    # comment", 
+  "specifier": true,
+  "local_file": false,
+  "name": "req",
+  "editable": false,
+  "uri": null,
+  "extras": [],
+  "vcs": null,
+  "path": null,
+  "line":  "req==1.0    # comment",
+  "hash_name": null,
+  "hash": null,
   "specs": [
    [
-    "==", 
+    "==",
     "1.0"
    ]
-  ], 
+  ],
   "revision": null
  }
-]
+]