######### Pyflyby #########

.. image:: https://badge.fury.io/py/pyflyby.svg :target: https://pypi.org/project/pyflyby/

.. image:: https://travis-ci.org/deshaw/pyflyby.png?branch=master :target: https://travis-ci.org/deshaw/pyflyby

Pyflyby is a set of Python programming productivity tools for Python 3.8+.

For command-line interaction:

• py: command-line multitool

For IPython interaction:

• autoimporter: automatically imports symbols when needed.

For editing python source code:

• tidy-imports: adds missing 'import's, removes unused 'import's, and also reformats import blocks.
• find-import: prints to stdout how to import a particular symbol.
• reformat-imports: reformats import blocks
• collect-imports: prints out all the imports in a given set of files.
• collect-exports: prints out definitions in a given set of modules, in the form of import statements.
• transform-imports: renames imported modules/functions.

Installation

.. code:: bash

$ pip install pyflyby

This creates an alias for your ipython named py which runs the pyflyby plug internally. pyflyby has a dependency on ipython, if it isn't already installed do install it with:

.. code:: bash

$ pip install ipython

Quick start: Autoimporter + IPython

.. code:: bash

$ py In [1]: re.search("[a-z]+", "....hello...").group(0) [PYFLYBY] import re Out[1]: 'hello'

In [2]: chisqprob(arange(5), 2) [PYFLYBY] from numpy import arange [PYFLYBY] from scipy.stats import chisqprob Out[2]: [ 1. 0.6065 0.3679 0.2231 0.1353]

To load pyflyby into an existing IPython session as a 1-off:

.. code:: bash

$ ipython In [1]: %load_ext pyflyby

To configure IPython/Jupyter Notebook to load pyflyby automatically:

.. code:: bash

$ py pyflyby.install_in_ipython_config_file

or

.. code:: bash

$ echo 'c.InteractiveShellApp.extensions.append("pyflyby")' \

~/.ipython/profile_default/ipython_config.py

$ ipython In [1]: b64decode('aGVsbG8=') [PYFLYBY] from base64 import b64decode Out[1]: 'hello'

Auto importer lazy variables

It is possible to use the autoimporter to lazily define variables.

To use, put the following in your IPython startup files (~/.ipython/profile_default/startup/autoimp.py), or in your IPython configuration file:

.. code:: python

from pyflyby import add_import

add_import("foo", "foo = 1")

add_import(
    "df, data as dd",
    '''
    import pandas as pd
    data = [1,2,3]
    df =  pd.DataFrame(data)
''')

You can add the keyword strict=False to not fail if not in IPython or of the pyflyby extensions is not loaded.

Quick start: py command-line multi-tool

.. code:: bash

$ py b64decode aGVsbG8= [PYFLYBY] from base64 import b64decode [PYFLYBY] b64decode('aGVsbG8=', altchars=None) 'hello'

$ py log2 sys.maxint [PYFLYBY] from numpy import log2 [PYFLYBY] import sys [PYFLYBY] log2(9223372036854775807) 63.0

$ py 'plot(cos(arange(30)))' [PYFLYBY] from numpy import arange [PYFLYBY] from numpy import cos [PYFLYBY] from matplotlib.pyplot import plot [PYFLYBY] plot(cos(arange(30)))