EPAVin subclass to fetch data from epa's fueleconomy.gov

README.rst

@@ -194,3 +194,4 @@ References
  * http://www.nisrinc.com/include/common/VIN.html
  * http://vpic.nhtsa.dot.gov
  * http://vpic.nhtsa.dot.gov/mid/
+ * http://gm.oemdtc.com/2772/vehicle-identification-number-vin-information-1960-2017

libvin/decoding.py

@@ -4,7 +4,7 @@
 (c) Copyright 2016 Dan Kegel <[email protected]>
 """
 
-from libvin.static import *
+from static import *
 
 class Vin(object):
     def __init__(self, vin):
@@ -42,38 +42,66 @@ def is_pre_2010(self):
         """
         return self.vin[6].isdigit()
 
-    @property
-    def is_valid(self):
+    def calculate_checkdigit(self, v):
         """
-        Returns True if a VIN is valid, otherwise returns False.
+        Returns calculated check digit of the given VIN string.
+        """
+        products = [VIN_WEIGHT[i] * VIN_TRANSLATION[j] for i, j in enumerate(v)]
+        check_digit = sum(products) % 11
+        if check_digit == 10:
+            check_digit = 'X'
+        return str(check_digit)
+
+    def seqnumlen(self):
+        """
+        Return length of the sequential number field for this vendor
         """
-        if len(self.vin) != 17:
+        if self.less_than_500_built_per_year:
+            return 3
+        elif self.wmi == 'SCC':
+            # SCC Lotus https://vpic.nhtsa.dot.gov/mid/home/displayfile/32155
+            # SCC Lotus 2008 ftp://ftp.nhtsa.dot.gov/mfrmail/ORG3319.pdf
+            return 4
+        elif self.wmi == "SCF" or self.wmi == "SAJ":
+            # SCF Aston-Martin https://vpic.nhtsa.dot.gov/mid/home/displayfile/1742
+            # SAJ Jaguar https://vpic.nhtsa.dot.gov/mid/home/displayfile/28722
+            return 5
+        else:
+            return 6
+
+    def anonvin(self):
+        """
+        Return an anonymized VIN, where the sequential number has been replaced with zeroes.
+        """
+        v = self.vin[0:17 - self.seqnumlen()] + '0' * self.seqnumlen()
+        return v[0:8]+ self.calculate_checkdigit(v) + v[9:17]
+
+    def __is_valid(self, v):
+        """
+        Returns True if the given VIN is valid, otherwise returns False.
+        """
+        if len(v) != 17:
             """
             For model years 1981 to present, the VIN is composed of 17 
             alphanumeric values
             """
             return False
 
-        if any(x in 'IOQ' for x in self.vin):
+        if any(x in 'IOQ' for x in v):
             """ 
             The letters I,O, Q are prohibited from any VIN position 
             """
             return False
 
-        if self.vin[9] in 'UZ0':
+        if v[9] in 'UZ0':
             """
             The tenth position of the VIN represents the Model Year and 
             does not permit the use of the characters U and Z, as well 
             as the numeric zero (0)
             """
             return False
 
-        products = [VIN_WEIGHT[i] * VIN_TRANSLATION[j] for i, j in enumerate(self.vin)]
-        check_digit = sum(products) % 11
-        if check_digit == 10:
-            check_digit = 'X'
-
-        if self.vin[8] != str(check_digit):
+        if v[8] != self.calculate_checkdigit(v):
             """
             The ninth position of the VIN is a calculated value based on 
             the other 16 alphanumeric values, it's called the 
@@ -84,6 +112,13 @@ def is_valid(self):
 
         return True
 
+    @property
+    def is_valid(self):
+        """
+        Returns True if a VIN is valid, otherwise returns False.
+        """
+        return self.__is_valid(self.vin)
+
     @property
     def less_than_500_built_per_year(self):
         """
@@ -123,10 +158,7 @@ def vsn(self):
         """
         Returns the Vehicle Sequential Number
         """
-        if self.less_than_500_built_per_year:
-            return self.vin[-3:]
-        else:
-            return self.vin[-6:]
+        return self.vin[-self.seqnumlen():]
 
     @property
     def wmi(self):
@@ -154,44 +186,119 @@ def make(self):
         '''
         man = self.manufacturer
         for suffix in [
+           'Argentina',
+           'Australia',
            'Canada',
            'Cars',
+           'China',
            'France',
+           'Germany',
            'Hungary',
            'Mexico',
            'Motor Company',
+           'Spain',
+           'Thailand',
            'Truck USA',
            'Turkey',
+           'UK',
            'USA',
            'USA - trucks',
+           'USA (AutoAlliance International)',
            ]:
              if man.endswith(suffix):
                 man = man.replace(" %s" % suffix, "")
+
+        if self.vin[0:5] == '3MYDL':
+            # Mazda builds Yaris for Toyota, see https://vpic.nhtsa.dot.gov/mid/home/displayfile/32354
+            # 3MYDLBZV4GY112482 is 2016 Scion still
+            if self.vin.startswith('3MYDLBZV'):
+               return 'Scion'
+            return 'Toyota'
+
         if man == "General Motors":
             return "GMC"
-        make = man
-        # 2012 and later: first 3 positions became overloaded, some 'make' aka brand info moved further in; see
-        # https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/Chrysler/VIN_Codes
-        # http://www.allpar.com/mopar/vin-decoder.html
-        if self.year > 2011:
-            if man == 'Chrysler':
+        if man == 'Chrysler' or man == 'Dodge':
+            # 3C4FY48B62T305332 is a 2002 Chrysler PT Cruiser
+            if self.year > 2001 and self.year <= 2011:
+                brandcode = self.vin[1]
+                if brandcode == 'B':
+                    return 'Dodge'
+                elif brandcode == 'C':
+                    return 'Chrysler'
+        if man == 'Chrysler' or man == 'FCA' or man == 'Fiat':
+            # 2012 and later: first 3 positions became overloaded, some 'make' aka brand info moved further in; see
+            # https://en.wikibooks.org/wiki/Vehicle_Identification_Numbers_(VIN_codes)/Chrysler/VIN_Codes
+            # http://www.allpar.com/mopar/vin-decoder.html
+            # https://vpic.nhtsa.dot.gov/mid/home/displayfile/32250
+            if self.year > 2011:
                 brandcode = self.vin[4]
                 if brandcode == 'D':
-                    make = 'Dodge'
+                    return 'Dodge'
                 if brandcode == 'F':
-                    make = 'Fiat'
+                    return 'Fiat'
                 if brandcode == 'J':
-                    make = 'Jeep'
+                    return 'Jeep'
+                if brandcode == 'R':
+                    return 'Ram'
+        if man == 'Hyundai':
+            brandcode = self.vin[3]
+            if self.year > 2016 and brandcode == 'G':
+                return 'Genesis'
+        if man == 'Kia':
+            # WTF?
+            if self.year > 2011:
+                brandcode = self.vin[3]
+                if brandcode == 'Z':
+                    return 'Hyundai'
+        if "FUJI HEAVY INDUSTRIES" in man.upper():
+            brandcode = self.vin[4]
+            if brandcode == 'N':
+                if self.year > 2016:
+                    return 'Toyota'
+                return 'Scion'
+            return 'Subaru'
+        if man == 'Toyota':
+            if self.vin.startswith('JTNJJXB0'):
+                # 2012-2014 Scion iQ
+                return 'Scion'
+            if self.year == 2016:
+                # JTNKARJEXGJ522381 is 2016 Scion iM still, as far as EPA is concerned
+                if self.vin.startswith('JTNKARJE'):
+                   return 'Scion'
+
         if man == 'Nissan':
-            # FIXME: this was gathered from just four test cases, probably needs updating
-            brandcode = self.vin[3:5]
-            if brandcode == 'CV':
-                make = 'Infiniti'
-            if brandcode == 'BS':
-                make = 'Infiniti'
-            if brandcode == 'CS':
-                make = 'Infiniti'
-        return make
+            # Sources, by model year:
+            # MY05 https://vpic.nhtsa.dot.gov/mid/home/displayfile/28822
+            # MY11 ftp://safercar.gov/MfrMail/ORG6337.pdf
+            # MY12 ftp://safercar.gov/MfrMail/ORG7377.pdf
+            # MY13 ftp://ftp.nhtsa.dot.gov/mfrmail/ORG7846.pdf
+            # MY16 https://vpic.nhtsa.dot.gov/mid/home/displayfile/29173
+            # MY16 https://vpic.nhtsa.dot.gov/mid/home/displayfile/31784
+            # 01234567
+            # 1N4AZ0CP3EC336448 is 2014 nissan leaf
+            # 5N1AZ2MG1GN146218 is 2016 Nissan Murano
+            # 5N1BV28U17N100517 is 2007 Nissan Quest
+            # 5N1DL0MNXHC508030 is 2017 Infiniti QX60
+            # JN1FV7AP1GM421263 is 2016 Infiniti Q50
+            # JN8AZ2NE0D9060764 is 2013 infiniti qx56
+            # JNRAS08UX3X101869 is 2003 Infiniti fx35
+            v46 = self.vin[4:6]
+            v47 = self.vin[4:7]
+            if (
+               v46 == 'J0' or      # 2016 Infiniti QX60, 2011 Infiniti EX35
+               v46 == 'L0' or      #
+               v46 == 'S1' or      #
+               v46 == 'V6' or      # 2011 Infiniti G37, G25
+               v46 == 'V7' or      # 2016 Infiniti Q50
+               v46 == 'Y1' or      # 2011 Infiniti M56, M37
+               v47 == 'Z2N'):      # 2011 Infiniti QX56
+                 return 'Infiniti'
+        if man == 'Renault Samsung':
+            # FIXME: they build other makes, too
+            return 'Nissan'
+        if man == 'Subaru-Isuzu Automotive':
+            return 'Subaru'
+        return man
 
     @property
     def year(self):
@@ -207,3 +314,15 @@ def year(self):
 def decode(vin):
     v = Vin(vin)
     return v.decode()
+
+import sys
+
+def main():
+    if sys.argv[1] == "squish":
+        for line in sys.stdin:
+            vin = line.strip()
+            v = Vin(vin)
+            print v.anonvin()
+
+if __name__ == "__main__":
+    main()