pyflyby 1.9.4__py3-none-any.whl

pyflyby-1.9.4.data/scripts/tidy-imports

@@ -0,0 +1,191 @@
+#!python
+"""
+tidy-imports *.py
+tidy-imports < foo.py
+
+Automatically improves python import statements.
+
+  - Adds missing imports and mandatory imports.
+  - Removes unused imports.
+  - Nicely formats imports (sorts, aligns, wraps).
+
+If filenames are given on the command line, rewrites them.  Otherwise, if
+stdin is not a tty, read from stdin and write to stdout.
+
+Only top-level import statements are touched.
+
+"""
+
+# pyflyby/tidy-imports
+# Copyright (C) 2011, 2012, 2014 Karl Chen.
+# License: MIT http://opensource.org/licenses/MIT
+
+
+from __future__ import print_function
+
+import os
+
+from   pyflyby._cmdline         import hfmt, parse_args, process_actions
+from   pyflyby._import_sorting  import sort_imports
+from   pyflyby._imports2s       import (canonicalize_imports,
+                                        fix_unused_and_missing_imports,
+                                        replace_star_imports,
+                                        transform_imports)
+from   pyflyby._parse           import PythonBlock
+
+import toml
+TOML_AVAIL = True
+
+
+def _get_pyproj_toml_config():
+    """
+    Try to find current project pyproject.toml
+    in cwd or parents directories.
+    """
+    if not TOML_AVAIL:
+        return None
+
+    from pathlib import Path
+
+
+    cwd = Path(os.getcwd())
+
+
+    for pth in [cwd] + list(cwd.parents):
+        pyproj_toml = pth /'pyproject.toml'
+        if pyproj_toml.exists() and pyproj_toml.is_file():
+            return pyproj_toml.read_text()
+
+    return None
+
+
+
+
+
+def _addopts(parser):
+    """
+    Callbacks to the parser to fill in extra options.
+    """
+    parser.add_option('--add-missing',
+                        default=True, action='store_true',
+                        help=hfmt('''
+                            (Default) Add missing imports.'''))
+    parser.add_option('--no-add-missing', dest='add_missing',
+                        default=True, action='store_false',
+                        help=hfmt('''
+                            Don't add missing imports.'''))
+    parser.add_option('--remove-unused',
+                        default="AUTOMATIC", action='store_true',
+                        help=hfmt('''
+                            Remove unused imports
+                            (default unless filename == __init__.py).'''))
+    parser.add_option('--no-remove-unused', dest='remove_unused',
+                        action='store_false',
+                        help=hfmt('''
+                            Don't remove unused imports
+                            (default if filename == __init__.py).'''))
+    parser.add_option('--add-mandatory',
+                        default=True, action='store_true',
+                        help=hfmt('''
+                            (Default) Add mandatory imports.'''))
+    parser.add_option('--no-add-mandatory', dest='add_mandatory',
+                        default=True, action='store_false',
+                        help=hfmt('''
+                            Don't add mandatory imports.'''))
+    parser.add_option('--replace-star-imports',
+                        default=False, action='store_true',
+                        help=hfmt('''
+                            Replace 'from foo.bar import *' with full list
+                            of imports before removing unused imports.'''))
+    parser.add_option('--no-replace-star-imports',
+                        dest='replace_star_imports',
+                        action='store_false',
+                        help=hfmt('''
+                            (Default) Don't replace 'from foo.bar import
+                            *'.'''))
+    parser.add_option('--canonicalize',
+                        default=True, action='store_true',
+                        help=hfmt('''
+                            (Default) Replace imports with canonical
+                            equivalent imports, according to database.'''))
+    parser.add_option('--experimental-sort-imports',
+                        default=False, action='store_true',
+                        help=hfmt('''
+                            experimental import sorting'''))
+    parser.add_option('--no-canonicalize', dest='canonicalize',
+                        default=True, action='store_false',
+                        help=hfmt('''
+                            Don't canonicalize imports.'''))
+
+
+    def transform_callback(option, opt_str, value, group):
+        k, v = value.split("=", 1)
+        group.values.transformations[k] = v
+    parser.add_option("--transform", action='callback',
+                        type="string", callback=transform_callback,
+                        metavar="OLD=NEW",
+                        dest="transformations", default={},
+                        help=hfmt('''
+                            Replace OLD with NEW in imports.
+                            May be specified multiple times.'''))
+    def no_add_callback(option, opt_str, value, group):
+        group.values.add_missing = False
+        group.values.add_mandatory = False
+    parser.add_option('--no-add', action='callback',
+                        callback=no_add_callback,
+                        help=hfmt('''
+                            Equivalent to --no-add-missing
+                            --no-add-mandatory.'''))
+def main() -> None:
+
+    config_text = _get_pyproj_toml_config()
+    if config_text:
+        default_config = toml.loads(config_text).get('tool', {}).get('pyflyby',{})
+    else:
+        default_config = {}
+
+    def _add_opts_and_defaults(parser):
+        _addopts(parser)
+        parser.set_defaults(**default_config)
+
+    options, args = parse_args(
+        _add_opts_and_defaults, import_format_params=True, modify_action_params=True, defaults=default_config)
+
+    def modify(block:PythonBlock) -> PythonBlock:
+        if options.transformations:
+            block = transform_imports(block, options.transformations,
+                                  params=options.params)
+        if options.replace_star_imports:
+            block = replace_star_imports(block, params=options.params)
+        block = fix_unused_and_missing_imports(
+            block, params=options.params,
+            add_missing=options.add_missing,
+            remove_unused=options.remove_unused,
+            add_mandatory=options.add_mandatory,
+            )
+        # TODO: disable sorting until we figure out #287
+        # https://github.com/deshaw/pyflyby/issues/287
+
+        # here we get a (single?) PythonBlock, we can access each statement with 
+        # >>> block.statements
+        # and each statement can have a:
+        # is_import
+        # or
+        # is_comment or blank
+        
+        # TODO: we do Python(str(...)) in order to unparse-reparse and get proper ast node numbers.
+        if options.experimental_sort_imports:
+            sorted_imports = PythonBlock(str(sort_imports(block)))
+        else:
+            sorted_imports = block
+        if options.canonicalize:
+            cannonical_imports = canonicalize_imports(sorted_imports, params=options.params)
+        else:
+            cannonical_imports = sorted_imports
+        return cannonical_imports
+
+    process_actions(args, options.actions, modify)
+
+
+if __name__ == '__main__':
+    main()

pyflyby-1.9.4.data/scripts/transform-imports

@@ -0,0 +1,47 @@
+#!python
+"""
+transform-imports --transform aa.bb=xx.yy *.py
+transform-imports --transform aa.bb=xx.yy < foo.py
+
+Transforms::
+  from aa.bb.cc import dd, ee
+  from aa import bb
+to::
+  from xx.yy.cc import dd, ee
+  from xx import yy as bb
+
+If filenames are given on the command line, rewrites them.  Otherwise, if
+stdin is not a tty, read from stdin and write to stdout.
+
+"""
+
+# pyflyby/transform-imports
+# Copyright (C) 2014 Karl Chen.
+# License: MIT http://opensource.org/licenses/MIT
+
+
+from   pyflyby._cmdline         import hfmt, parse_args, process_actions
+from   pyflyby._imports2s       import transform_imports
+
+
+def main():
+    transformations = {}
+    def addopts(parser):
+        def callback(option, opt_str, value, group):
+            k, v = value.split("=", 1)
+            transformations[k] = v
+        parser.add_option("--transform", action='callback',
+                          type="string", callback=callback,
+                          metavar="OLD=NEW",
+                          help=hfmt('''
+                                Replace OLD with NEW in imports.
+                                May be specified multiple times.'''))
+    options, args = parse_args(
+        addopts, import_format_params=True, modify_action_params=True)
+    def modify(x):
+        return transform_imports(x, transformations, params=options.params)
+    process_actions(args, options.actions, modify)
+
+
+if __name__ == '__main__':
+    main()

pyflyby-1.9.4.dist-info/LICENSE.txt

@@ -0,0 +1,23 @@
+Pyflyby: Copyright (c) 2011, 2012, 2013, 2014, 2015 Karl Chen
+
+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.
+
+
+Docxref.py includes code derived from Epydoc, which is also distributed under
+the same MIT license.