Mercurial > hg
view contrib/check-py3-compat.py @ 31793:69d8fcf20014
help: document bundle specifications
I softly formalized the concept of a "bundle specification" a while
ago when I was working on clone bundles and stream clone bundles and
wanted a more robust way to define what exactly is in a bundle file.
The concept has existed for a while. Since it is part of the clone
bundles feature and exposed to the user via the "-t" argument to
`hg bundle`, it is something we need to support for the long haul.
After the 4.1 release, I heard a few people comment that they didn't
realize you could generate zstd bundles with `hg bundle`. I'm
partially to blame for not documenting it in bundle's docstring.
Additionally, I added a hacky, experimental feature for controlling
the compression level of bundles in 76104a4899ad. As the commit
message says, I went with a quick and dirty solution out of time
constraints. Furthermore, I wanted to eventually store this
configuration in the "bundlespec" so it could be made more flexible.
Given:
a) bundlespecs are here to stay
b) we don't have great documentation over what they are, despite being
a user-facing feature
c) the list of available compression engines and their behavior isn't
exposed
d) we need an extensible place to modify behavior of compression
engines
I want to move forward with formalizing bundlespecs as a user-facing
feature. This commit does that by introducing a "bundlespec" help
page. Leaning on the just-added compression engine documentation
and API, the topic also conveniently lists available compression
engines and details about them. This makes features like zstd
bundle compression more discoverable. e.g. you can now
`hg help -k zstd` and it lists the "bundlespec" topic.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Sat, 01 Apr 2017 13:42:06 -0700 |
parents | b85fa6bf298b |
children | 65cd7e705ff6 |
line wrap: on
line source
#!/usr/bin/env python # # check-py3-compat - check Python 3 compatibility of Mercurial files # # Copyright 2015 Gregory Szorc <gregory.szorc@gmail.com> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. from __future__ import absolute_import, print_function import ast import os import sys import traceback def check_compat_py2(f): """Check Python 3 compatibility for a file with Python 2""" with open(f, 'rb') as fh: content = fh.read() root = ast.parse(content) # Ignore empty files. if not root.body: return futures = set() haveprint = False for node in ast.walk(root): if isinstance(node, ast.ImportFrom): if node.module == '__future__': futures |= set(n.name for n in node.names) elif isinstance(node, ast.Print): haveprint = True if 'absolute_import' not in futures: print('%s not using absolute_import' % f) if haveprint and 'print_function' not in futures: print('%s requires print_function' % f) def check_compat_py3(f): """Check Python 3 compatibility of a file with Python 3.""" import importlib # not available on Python 2.6 with open(f, 'rb') as fh: content = fh.read() try: ast.parse(content) except SyntaxError as e: print('%s: invalid syntax: %s' % (f, e)) return # Try to import the module. # For now we only support mercurial.* and hgext.* modules because figuring # out module paths for things not in a package can be confusing. if f.startswith(('hgext/', 'mercurial/')) and not f.endswith('__init__.py'): assert f.endswith('.py') name = f.replace('/', '.')[:-3].replace('.pure.', '.') try: importlib.import_module(name) except Exception as e: exc_type, exc_value, tb = sys.exc_info() # We walk the stack and ignore frames from our custom importer, # import mechanisms, and stdlib modules. This kinda/sorta # emulates CPython behavior in import.c while also attempting # to pin blame on a Mercurial file. for frame in reversed(traceback.extract_tb(tb)): if frame.name == '_call_with_frames_removed': continue if 'importlib' in frame.filename: continue if 'mercurial/__init__.py' in frame.filename: continue if frame.filename.startswith(sys.prefix): continue break if frame.filename: filename = os.path.basename(frame.filename) print('%s: error importing: <%s> %s (error at %s:%d)' % ( f, type(e).__name__, e, filename, frame.lineno)) else: print('%s: error importing module: <%s> %s (line %d)' % ( f, type(e).__name__, e, frame.lineno)) if __name__ == '__main__': if sys.version_info[0] == 2: fn = check_compat_py2 else: fn = check_compat_py3 for f in sys.argv[1:]: fn(f) sys.exit(0)