https://github.com/asottile/classify-imports

Utilities for refactoring imports in python-like syntax.
https://github.com/asottile/classify-imports

imports isort python refactoring

Last synced: 13 days ago
JSON representation

Utilities for refactoring imports in python-like syntax.

• Host: GitHub
• URL: https://github.com/asottile/classify-imports
• Owner: asottile
• License: mit
• Created: 2014-06-27T23:40:30.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T01:22:16.000Z (15 days ago)
• Last Synced: 2024-10-30T00:38:10.023Z (14 days ago)
• Topics: imports, isort, python, refactoring
• Language: Python
• Size: 323 KB
• Stars: 23
• Watchers: 4
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![build status](https://github.com/asottile/classify-imports/actions/workflows/main.yml/badge.svg)](https://github.com/asottile/classify-imports/actions/workflows/main.yml)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/asottile/classify-imports/main.svg)](https://results.pre-commit.ci/latest/github/asottile/classify-imports/main)

classify-imports

================

Utilities for refactoring imports in python-like syntax.

## installation

```bash

pip install classify-imports

```

## examples

### splitting an import object

```pycon

>>> from classify_imports import import_obj_from_str

>>> obj = import_obj_from_str('import foo, bar, baz')

>>> [str(i) for i in obj.split()]

['import foo\n', 'import bar\n', 'import baz\n']

```

### sorting import objects

```pycon

# Or to partition into blocks (even with mixed imports)

>>> import pprint

>>> from classify_imports import import_obj_from_str, sort

>>> partitioned = sort(

    [

        import_obj_from_str('from classify_imports import sort'),

        import_obj_from_str('import sys'),

        import_obj_from_str('from pyramid.view import view_config'),

        import_obj_from_str('import cached_property'),

    ],

)

>>> pprint.pprint(partitioned)

(

    (import_obj_from_str('import sys\n'),),

    (

        import_obj_from_str('import cached_property\n'),

        import_obj_from_str('from pyramid.view import view_config\n'),

    ),

    (import_obj_from_str('from classify_imports import sort\n'),),

)

```

### classify a module

```pycon

>>> from classify_imports import classify_base, import_obj_from_str, Classified

>>> classify_base('__future__')

'FUTURE'

>>> classify_base('classify_imports')

'APPLICATION'

>>> classify_base('pyramid')

'THIRD_PARTY'

>>> classify_base('os')

'BUILTIN'

>>> classify_base(import_obj_from_str('import os.path').module_base)

'BUILTIN'

>>> Classified.APPLICATION

'APPLICATION'

>>> Classified.order

('FUTURE', 'BUILTIN', 'THIRD_PARTY', 'APPLICATION')

```