Add support for license override config file in YAML, fix bug with wayward u character in output file

initialed85 · initialed85 · commit b5f7a6af44a8 · 2018-05-07T13:03:10.000+08:00
diff --git a/README.md b/README.md
@@ -48,11 +48,11 @@ Two different pip "requirements" files, two different Python paths (Virtualenvs)
         -p ~/.virtualenvs/backend_py/bin/python \
         -r requirements-pypy.txt \
         -p ~/.virtualenvs/backend_pypy/bin/python \
-        --skip-prefix ims-
+        -s ims-
 
 Please note that pip "requirements" files and Python executable paths are paired together in the order they're specified.
 
-Three different pip "requirements" files, two different Python paths (Virtualenvs), a GPL exception and a custom output file:
+Three different pip "requirements" files, two different Python paths (need to repeat), a GPL exception and a custom output file:
 
     python -m third_party_license_file_generator \
         -r requirements.txt \
@@ -61,8 +61,26 @@ Three different pip "requirements" files, two different Python paths (Virtualenv
         -p ~/.virtualenvs/api_pypy/bin/python \
         -r cpython_requirements.txt \
         -p ~/.virtualenvs/api_py/bin/python \
-        --gpl-exception uwsgi
-        --output-file ThirdPartyLicenses.txt
+        -x uWSGI \ 
+        -o ThirdPartyLicenses.txt
+
+Three different pip "requirements" files, two different Python paths (need to repeat), a GPL exception, a custom output file and a license override file:
+
+    # contents of license_override_file.yml
+    uWSGI: 
+        license_name: GPL-2.0 w/ linking exception
+        license_file: https://raw.githubusercontent.com/unbit/uwsgi/master/LICENSE
+
+    python -m third_party_license_file_generator \
+        -r requirements.txt \
+        -p ~/.virtualenvs/api_pypy/bin/python \
+        -r pypy_requirements.txt \
+        -p ~/.virtualenvs/api_pypy/bin/python \
+        -r cpython_requirements.txt \
+        -p ~/.virtualenvs/api_py/bin/python \
+        -x uWSGI \ 
+        -o ThirdPartyLicenses.txt \
+        -l license_override_file.yml
 
 An example of the structure of the generated third party license file is as follows:
 
diff --git a/THIRDPARTYLICENSES b/THIRDPARTYLICENSES
@@ -1,4 +1,24 @@
-Start of 'THIRDPARTYLICENSES' generated by Python third_party_license_generator at 2018-04-19 13:34:09.628303u
+Start of 'THIRDPARTYLICENSES' generated by Python third_party_license_generator at 2018-05-07 12:57:58.761181
+
+----------------------------------------
+
+Package: PyYAML
+License: MIT
+Requires: n/a
+Author: Kirill Simonov <xi@resolvent.net>
+Home page: http://pyyaml.org/wiki/PyYAML
+
+NOTE: This module was missing a license file (despite listing a license name) so one has been auto-generated
+
+The MIT License
+
+Copyright 2018 Kirill Simonov <xi@resolvent.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ----------------------------------------
 
@@ -28,7 +48,7 @@ v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain
 one at http://mozilla.org/MPL/2.0/.
 
 ***** END LICENSE BLOCK *****
-@(#) $RCSfile: certdata.txt,v $ $Revision: 1.80 $ $Date: 2011/11/03 15:11:58 $u
+@(#) $RCSfile: certdata.txt,v $ $Revision: 1.80 $ $Date: 2011/11/03 15:11:58 $
 
 ----------------------------------------
 
@@ -539,7 +559,7 @@ necessary.  Here is a sample; alter the names:
   <signature of Ty Coon>, 1 April 1990
   Ty Coon, President of Vice
 
-That's all there is to it!u
+That's all there is to it!
 
 ----------------------------------------
 
@@ -563,7 +583,7 @@ Redistribution and use in source and binary forms, with or without modification,
 
 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.u
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ----------------------------------------
 
@@ -659,7 +679,7 @@ To apply the Apache License to your work, attach the following boilerplate notic
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.u
+   limitations under the License.
 
 ----------------------------------------
 
@@ -679,8 +699,8 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.u
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 ----------------------------------------
 
-End of 'THIRDPARTYLICENSES' generated by Python third_party_license_generator at 2018-04-19 13:34:09.628385
+End of 'THIRDPARTYLICENSES' generated by Python third_party_license_generator at 2018-05-07 12:57:58.761237
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,2 @@
 requests==2.18.4
+PyYAML==3.12
diff --git a/setup.py b/setup.py
@@ -24,7 +24,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='2018.5',
+    version='2018.6',
 
     description='The Python third_party_license_file_generator is aimed at distilling down the appropriate license for one or many pip "requirements" files into a single file; it supports Python2.7 and Python3.',
     long_description=long_description,
diff --git a/third_party_license_file_generator/__main__.py b/third_party_license_file_generator/__main__.py
@@ -6,6 +6,8 @@
 import os
 import sys
 
+import requests
+import yaml
 from third_party_license_file_generator.site_packages import SitePackages
 
 # for Python2.7
@@ -104,9 +106,54 @@
     )
 )
 
+parser.add_argument(
+    '-l',
+    '--license-override-file',
+    type=str,
+    required=False,
+    default=None,
+    help='the location of a YAML file that describes a dict {"(some case-sensitive package name)": {"license_name": "(some license name)", "license_file": "(URL or system file path to license file"}} (but as YAML)'
+)
+
+
 if __name__ == '__main__':
     args = parser.parse_args()
 
+    license_overrides = {}
+    if args.license_override_file is not None:
+        with codecs.open(args.license_override_file, 'r', 'utf-8') as f:
+            license_overrides = yaml.load(f.read())
+
+        for module_name, license_override in license_overrides.items():
+            license_name = license_override.get('license_name')
+            license_file = license_override.get('license_file')
+            if None in [license_name, license_file]:
+                print(
+                    'ERROR: license_name or license_file for license override of {0} missing or empty'.format(
+                        repr(module_name)
+                    )
+                )
+                sys.exit(1)
+
+            actual_license_file = None
+            if license_file.lower().startswith('http'):
+                r = requests.get(license_file, timeout=5)
+                actual_license_file = r.text.strip()
+            else:
+                with codecs.open(license_file, 'r', 'utf-8') as f:
+                    actual_license_file = f.read().strip()
+
+            if actual_license_file is None:
+                print(
+                    'ERROR: attempt to get license_file for license override of {0} from {1} returned empty file'.format(
+                        repr(module_name),
+                        repr(license_file)
+                    )
+                )
+                sys.exit(1)
+
+            license_override['license_file'] = actual_license_file
+
     pairs = tuple(
         zip(
             [x.strip() for x in args.requirements_path if x.strip() != ''],
@@ -137,6 +184,7 @@
                 python_path=python_path,
                 skip_prefixes=args.skip_prefix,
                 use_internet=not args.no_internet_lookups,
+                license_overrides=license_overrides,
             )
         ]
 
@@ -156,7 +204,7 @@
         module_output = ''
         module_names = []
         for module in modules:
-            module_names += [module.name.lower()]
+            module_names += [module.name]
             module_output += '\t{0} by {1} ({2})\n'.format(
                 repr(module.name),
                 repr(module.author),
@@ -165,7 +213,7 @@
 
         warning = ''
         if not args.permit_gpl and license_name.startswith('GPL') and not all(
-                [x.lower() in args.gpl_exception for x in module_names]):
+                [x in args.gpl_exception for x in module_names]):
             warning = gpl_warning
             gpl_triggered = True
         elif not args.permit_commercial and license_name in ['Commercial', 'Unknown (assumed commercial)']:
@@ -217,7 +265,7 @@
 
     separator = u'-' * 40
 
-    data = 'u\n\n{0}\n\n'.format(separator).join(third_party_licenses)
+    data = u'\n\n{0}\n\n'.format(separator).join(third_party_licenses)
 
     with codecs.open(args.output_file, 'w', 'utf-8') as f:
         f.write(data.strip() + '\n')
diff --git a/third_party_license_file_generator/site_packages.py b/third_party_license_file_generator/site_packages.py
@@ -78,11 +78,13 @@ class LicenseError(Exception):
 
 
 class SitePackages(object):
-    def __init__(self, requirements_path, python_path=None, skip_prefixes=None, autorun=True, use_internet=True):
+    def __init__(self, requirements_path, python_path=None, skip_prefixes=None,
+                 autorun=True, use_internet=True, license_overrides=None):
         self._requirements_path = requirements_path
         self._python_path = python_path if python_path is not None else distutils.spawn.find_executable('python3')
         self._skip_prefixes = skip_prefixes
         self._use_internet = use_internet
+        self._license_overrides = license_overrides if license_overrides is not None else {}
 
         self._root_module_names = set()
         self._required_module_names = set()
@@ -271,60 +273,73 @@ def _read_site_packages(self):
 
             author = metadata['author']
             home_page = metadata['home_page']
-            original_license_name = metadata['license_name']
-            license_file = self._module_licenses_by_module_name.get(module_name)
 
-            # print('details are', [author, home_page, original_license_name])
+            overriden_license_name = None
+            overriden_license_file = None
 
-            license_name = parse_license(original_license_name)
-            # if license_name is not None:
-            #     print('got license_name', repr(license_name))
+            license_override = self._license_overrides.get(module_name)
+            if module_name in self._license_overrides:
+                overriden_license_name = license_override.get('license_name')
+                overriden_license_file = license_override.get('license_file')
 
-            # if license_file is not None:
-            #     print('got license_file from module folder')
-
-            github_license_file = None
-            if original_license_name not in ['Commercial']:
-                if license_name is None and self._use_internet:
-                    pypi_license_name = get_license_from_pypi_license_scrape(module_name)
-                    license_name = parse_license(pypi_license_name)
-                    # if license_name is not None:
-                    #     print('got license_name from PyPI', repr(license_name))
-
-                    if license_name is None:
-                        if home_page is not None and 'github' in home_page and self._use_internet:
-                            github_license_file = get_license_from_github_home_page_scrape(home_page)
-                            license_name = parse_license(github_license_file)
-                            # if license_name is not None:
-                            #     print('got license_name from Github repo', repr(license_name))
-
-                            if license_file is None:
-                                license_file = github_license_file
-
-                                # if license_file is not None:
-                                #     print('got license_file from Github repo')
+            if None not in [overriden_license_name, overriden_license_file]:
+                license_name = overriden_license_name
+                license_file = overriden_license_file
+            else:
+                original_license_name = metadata['license_name']
+                license_file = self._module_licenses_by_module_name.get(module_name)
 
-            if license_file is None:
-                if github_license_file is None and self._use_internet:
-                    github_license_file = get_license_from_github_home_page_scrape(home_page)
+                # print('details are', [author, home_page, original_license_name])
 
-                license_file = github_license_file
-                # if license_file is not None:
-                #     print('got license_file from Github repo')
+                license_name = parse_license(original_license_name)
+                # if license_name is not None:
+                #     print('got license_name', repr(license_name))
 
-            if license_file is None and license_name is not None:
-                license_file = build_license_file_for_author(author, license_name)
                 # if license_file is not None:
-                #     print('built license_file from local store')
-
-            # if license_name is None:
-            #     print('warning: all attempts to get license_name failed')
-            # elif license_file is None:
-            #     print('warning: all attempts to get license_file failed')
-
-            if license_name is None:
-                license_name = 'Unknown (assumed commercial)'
-                license_file = build_license_file_for_author(author, 'Commercial')
+                #     print('got license_file from module folder')
+
+                github_license_file = None
+                if original_license_name not in ['Commercial']:
+                    if license_name is None and self._use_internet:
+                        pypi_license_name = get_license_from_pypi_license_scrape(module_name)
+                        license_name = parse_license(pypi_license_name)
+                        # if license_name is not None:
+                        #     print('got license_name from PyPI', repr(license_name))
+
+                        if license_name is None:
+                            if home_page is not None and 'github' in home_page and self._use_internet:
+                                github_license_file = get_license_from_github_home_page_scrape(home_page)
+                                license_name = parse_license(github_license_file)
+                                # if license_name is not None:
+                                #     print('got license_name from Github repo', repr(license_name))
+
+                                if license_file is None:
+                                    license_file = github_license_file
+
+                                    # if license_file is not None:
+                                    #     print('got license_file from Github repo')
+
+                if license_file is None:
+                    if github_license_file is None and self._use_internet:
+                        github_license_file = get_license_from_github_home_page_scrape(home_page)
+
+                    license_file = github_license_file
+                    # if license_file is not None:
+                    #     print('got license_file from Github repo')
+
+                if license_file is None and license_name is not None:
+                    license_file = build_license_file_for_author(author, license_name)
+                    # if license_file is not None:
+                    #     print('built license_file from local store')
+
+                # if license_name is None:
+                #     print('warning: all attempts to get license_name failed')
+                # elif license_file is None:
+                #     print('warning: all attempts to get license_file failed')
+
+                if license_name is None:
+                    license_name = 'Unknown (assumed commercial)'
+                    license_file = build_license_file_for_author(author, 'Commercial')
 
             module = Module(
                 name=module_name,
