diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2016-11-10 21:05:57 -0500 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2016-11-10 21:05:57 -0500 |
| commit | 003bbda05ba729bda00351d846d12920646f4c81 (patch) | |
| tree | b5c18e46fafe201973c3f8c0c03519e0487d70b7 /admin | |
| parent | cef17583553ad294b6bbd3b61790afb3407b71c3 (diff) | |
| download | passlib-003bbda05ba729bda00351d846d12920646f4c81.tar.gz | |
hash: fix PyCharm autocompletion of passlib.hash
Issue for a while has been that IDEs such as PyCharm can't detect
autocompletion in 'passlib.hash', because the module is replaced
w/ a lazy-loading object, that breaks it's source inspection.
As workaround, that module now contains a block listing all the imports
explicitly. This block is trapped in a "if False:" block so it will do nothing,
but that seems sufficient for PyCharm to autocomplete with.
Script "admin/regen.py" can be used to autogenerate this list when registry.py changes.
Diffstat (limited to 'admin')
| -rw-r--r-- | admin/regen.py | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/admin/regen.py b/admin/regen.py new file mode 100644 index 0000000..dc4b2fb --- /dev/null +++ b/admin/regen.py @@ -0,0 +1,106 @@ +""" +helper script which rebuilds all autogenerated bits of code w/in passlib. +""" +#============================================================================= +# imports +#============================================================================= +# core +from __future__ import absolute_import, division, print_function +import datetime +import re +import os +# all +__all__ = [ + "main", + "replace_section", +] + +#============================================================================= +# helpers +#============================================================================= + +now = datetime.datetime.now().strftime("%Y-%m-%d") + +def replace_section(data, ident, content): + """ + helper to replace autogenerated section of content. + + :param data: + existing file contents + + :param ident: + identifying string for section start and end. + will look for "begin <ident>" section marker, + and "end <ident>" section marker. + + :param content: + replacement content to replace whatever's present + between section start & end. + + :returns: + modified data + """ + m = re.match(r"""(?ixms) + (?P<head>.*?\n) + \#[-=]{10,}\n + \# \s begin \s* %(ident)s .* \n + \#[-=]{10,}\n + .*? + \#[-=]{10,}\n + \# \s end \s* %(ident)s \s* \n + \#[-=]{10,}\n + (?P<tail>.*) + """ % dict(ident=re.escape(ident).replace("\\ ", "\\s+"),), + data.replace("\r\n", "\n")) + assert m, "%r section not found" % (ident,) + + begin_row = "# begin " + ident + " (autogenerated " + now + ")\n" + + head, tail = m.group("head", "tail") + divline = "#" + "-" * max(40, len(begin_row) - 1) + "\n" + return "".join([ + head, + divline, + begin_row, + divline, + content, + divline, + "# end ", ident, "\n", + divline, + tail, + ]) + +#============================================================================= +# main +#============================================================================= + +from passlib.hash import sha256_crypt + +source_dir = os.path.abspath(os.path.join(__file__, *[".."]*2)) + +def main(): + """rebuild autogenerated sections in passlib""" + + #------------------------------------------------ + # rebuild autocomplete helper in passlib/hash.py + #------------------------------------------------ + content = "if False:\n" + from passlib.registry import _locations + modules = {} + for name, path in _locations.items(): + modules.setdefault(path, []).append(name) + for path, names in sorted(modules.items()): + row = " from %s import %s\n" % (path, ", ".join(sorted(names))) + content += row + + hash_path = os.path.join(source_dir, "passlib", "hash.py") + data = open(hash_path).read() + data = replace_section(data, "autocomplete hack", content) + open(hash_path, "w").write(data) + +if __name__ == "__main__": + main() + +#============================================================================= +# eof +#============================================================================= |