├── .gitignore ├── LICENSE ├── Makefile ├── README.rst ├── setup.py └── src └── piplint └── __init__.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[co] 2 | 3 | # Packages 4 | *.egg 5 | *.egg-info 6 | dist 7 | build 8 | eggs 9 | parts 10 | bin 11 | var 12 | sdist 13 | develop-eggs 14 | .installed.cfg 15 | 16 | # Installer logs 17 | pip-log.txt 18 | 19 | # Unit test / coverage reports 20 | .coverage 21 | .tox 22 | 23 | #Translations 24 | *.mo 25 | 26 | #Mr Developer 27 | .mr.developer.cfg 28 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2012 DISQUS 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | develop: 2 | pip install -e . 3 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | piplint 2 | ======= 3 | 4 | Piplint validates your current environment with the requirements files you've specified. It will 5 | ensure that any requirement listed exists within the environment, and within the bounds of the versions specified. 6 | 7 | :: 8 | 9 | source env/bin/activate 10 | piplint requirements/*.txt 11 | 12 | You can also pass ``--strict`` if you want to enfoce things like case sensitivity on package names. -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | from setuptools import setup 4 | 5 | setup( 6 | name="piplint", 7 | license='Apache License 2.0', 8 | version="0.2.0", 9 | description="Checks packages in your active environment against pip requirements files", 10 | author="David Cramer", 11 | author_email="dcramer@gmail.com", 12 | url="https://github.com/dcramer/piplint", 13 | packages=["piplint"], 14 | package_dir={'': 'src'}, 15 | entry_points={ 16 | 'console_scripts': [ 17 | 'piplint = piplint:main', 18 | ], 19 | }, 20 | classifiers=[ 21 | "Environment :: Console", 22 | "Intended Audience :: Developers", 23 | "Programming Language :: Python", 24 | "Topic :: Software Development", 25 | "Topic :: Utilities", 26 | ]) 27 | -------------------------------------------------------------------------------- /src/piplint/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | piplint 3 | ~~~~~~~ 4 | 5 | :copyright: 2012 DISQUS. 6 | :license: Apache License 2.0, see LICENSE for more details. 7 | """ 8 | from __future__ import absolute_import, print_function, unicode_literals 9 | 10 | import argparse 11 | import os 12 | import re 13 | import sys 14 | 15 | from pkg_resources import parse_version 16 | from subprocess import Popen, PIPE 17 | 18 | 19 | class TextColours: 20 | def __init__(self, enabled=False): 21 | if enabled: 22 | self.enable() 23 | else: 24 | self.disable() 25 | 26 | def enable(self): 27 | self.OKGREEN = u'\033[92m' 28 | self.WARNING = u'\033[93m' 29 | self.FAIL = u'\033[91m' 30 | self.ENDC = u'\033[0m' 31 | 32 | def disable(self): 33 | self.OKGREEN = u'' 34 | self.WARNING = u'' 35 | self.FAIL = u'' 36 | self.ENDC = u'' 37 | 38 | 39 | def check_requirements(requirement_files, strict=False, error_on_extras=False, verbose=False, 40 | venv=None, do_colour=False): 41 | """ 42 | Given a list of requirements files, checks them against the installed 43 | packages in the currentl environment. If any are missing, or do not fit 44 | within the version bounds, exits with a code of 1 and outputs information 45 | about the missing dependency. 46 | """ 47 | colour = TextColours(do_colour) 48 | 49 | version_re = re.compile(r'^([^<>=\s#]+)\s*(>=|>|<|<=|==|===)?\s*([^<>=\s#]+)?(?:\s*#.*)?$') 50 | 51 | def parse_package_line(line): 52 | try: 53 | if line.startswith('-e'): 54 | return parse_checkout_line(line) 55 | package, compare, version = version_re.split(line)[1:-1] 56 | except ValueError: 57 | raise ValueError("Unknown package line format: %r" % line) 58 | return (package, compare or None, parse_version(version) if version else None, line) 59 | 60 | def parse_checkout_line(whole_line): 61 | """ 62 | parse a line that starts with '-e' 63 | 64 | e.g., 65 | -e git://github.com/jcrocholl/pep8.git@bb20999aefc394fb826371764146bf61d8e572e2#egg=pep8-dev 66 | """ 67 | # Snip off the '-e' and any leading whitespace 68 | line = whole_line[2:].lstrip() 69 | 70 | # Check if there is a revision specified 71 | if '@' in line: 72 | url, last_bit = line.rsplit('@', 1) 73 | rev, eggname = last_bit.split('#', 1) 74 | return (url, '==', rev, line) 75 | else: 76 | (url, eggname) = line.split('#') 77 | return (url, None, None, line) 78 | 79 | def is_requirements_line(line): 80 | """ 81 | line is a valid requirement in requirements file or pip freeze output 82 | """ 83 | if not line: 84 | return False 85 | if line.startswith('#'): 86 | return False 87 | if line.endswith(' # optional'): 88 | return False 89 | if line.startswith('-e'): 90 | return True 91 | if line.startswith('-'): 92 | return False 93 | if line.startswith('http://') or line.startswith('https://'): 94 | return False 95 | return True 96 | 97 | def valid_version(version, compare, r_version): 98 | if not all([compare, version]): 99 | return True 100 | if compare in ('==', '==='): 101 | return version == r_version 102 | elif compare == '<=': 103 | return version <= r_version 104 | elif compare == '>=': 105 | return version >= r_version 106 | elif compare == '<': 107 | return version < r_version 108 | elif compare == '>': 109 | return version > r_version 110 | raise ValueError("Unknown comparison operator: %r" % compare) 111 | 112 | frozen_reqs = [] 113 | unknown_reqs = set() 114 | listed_reqs = [] 115 | args = 'pip freeze' 116 | if venv is not None: 117 | args = venv + "/bin/" + args 118 | freeze = Popen([args], stdout=PIPE, shell=True) 119 | for line in freeze.communicate()[0].splitlines(): 120 | line = line.strip() 121 | if not is_requirements_line(line): 122 | unknown_reqs.add(line) 123 | continue 124 | frozen_reqs.append(parse_package_line(line)) 125 | 126 | # Requirements files may include other requirements files; 127 | # if so, add to list. 128 | included_files = [] 129 | for file in requirement_files: 130 | path = os.path.dirname(file) 131 | args = "grep '^\-r' %s" % file 132 | grep = Popen([args], stdout=PIPE, shell=True) 133 | for line in grep.communicate()[0].splitlines(): 134 | included_files.append(os.path.join(path, line[2:].lstrip())) 135 | requirement_files.extend(included_files) 136 | 137 | for fname in requirement_files: 138 | with open(fname) as fp: 139 | for line in fp: 140 | line = line.strip() 141 | if not is_requirements_line(line): 142 | continue 143 | 144 | listed_reqs.append(parse_package_line(line)) 145 | 146 | unknown_reqs.update(set(r[0] for r in frozen_reqs).difference(set(r[0] for r in listed_reqs))) 147 | 148 | errors = [] 149 | 150 | for r_package, r_compare, r_version, r_line in listed_reqs: 151 | r_package_lower = r_package.lower() 152 | found = False 153 | 154 | for package, _, version, line in frozen_reqs: 155 | if package.lower() == r_package_lower: 156 | found = True 157 | if strict and package != r_package: 158 | unknown_reqs.remove(package) 159 | errors.append( 160 | "%sUnexpected capitalization found: %r is required but %r is installed.%s" 161 | % (colour.WARNING, r_package, package, colour.ENDC) 162 | ) 163 | elif valid_version(version, r_compare, r_version): 164 | unknown_reqs.discard(package) 165 | if verbose: 166 | print("%sRequirement is installed correctly: %s%s" 167 | % (colour.OKGREEN, r_line, colour.ENDC)) 168 | else: 169 | errors.append( 170 | "%sUnexpected version of %r found: %r is required but %r is installed.%s" 171 | % (colour.WARNING, r_package, r_line, line, colour.ENDC) 172 | ) 173 | break 174 | 175 | if not found: 176 | errors.append("%sRequirement %r not installed in virtualenv.%s" 177 | % (colour.FAIL, r_package, colour.ENDC)) 178 | 179 | code = 0 180 | if unknown_reqs: 181 | print("\nFor debugging purposes, the following packages are installed but not in the requirements file(s):") 182 | unknown_reqs_with_versions = [] 183 | for unknown_req in unknown_reqs: 184 | for req in frozen_reqs: 185 | if unknown_req == req[0]: 186 | unknown_reqs_with_versions.append(req[3]) 187 | break 188 | print("%s%s%s\n" % (colour.WARNING, 189 | "\n".join(sorted(unknown_reqs_with_versions)), 190 | colour.ENDC)) 191 | if error_on_extras: 192 | code = 2 193 | 194 | if errors: 195 | print("Errors found:") 196 | print('\n'.join(errors)) 197 | print("You must correct your environment before committing (and running tests).\n") 198 | code = 1 199 | 200 | if not errors and not unknown_reqs: 201 | print("%sNo errors found; all packages accounted for!%s" 202 | % (colour.OKGREEN, colour.ENDC)) 203 | 204 | return code 205 | 206 | 207 | def main(): 208 | 209 | cli_parser = argparse.ArgumentParser() 210 | cli_parser.add_argument('-c', '--colour', '--color', action='store_true', 211 | help='coloured output') 212 | cli_parser.add_argument('-E', '--environment', dest='venv', metavar='DIR', 213 | default=None, 214 | help='virtualenv to check against') 215 | cli_parser.add_argument('-s', '--strict', action='store_true', 216 | default=False, 217 | help='strict matching of package names') 218 | cli_parser.add_argument('-x', '--error-on-extras', action='store_true', 219 | default=False, 220 | help='return error if extra packages are installed in virtualenv') 221 | cli_parser.add_argument('-v', '--verbose', action='store_true', 222 | default=False, help='show status of all packages') 223 | cli_parser.add_argument('file', nargs='+', 224 | help='requirements file(s), use `-` for stdin') 225 | cli_args = cli_parser.parse_args() 226 | 227 | # call the main function to kick off the real work 228 | code = check_requirements(cli_args.file, strict=cli_args.strict, 229 | error_on_extras=cli_args.error_on_extras, 230 | verbose=cli_args.verbose, venv=cli_args.venv, 231 | do_colour=cli_args.colour,) 232 | sys.exit(code) 233 | 234 | 235 | if __name__ == '__main__': 236 | main() 237 | --------------------------------------------------------------------------------