{"id":13468429,"url":"https://github.com/deshaw/pyflyby","last_synced_at":"2025-05-14T23:07:50.844Z","repository":{"id":37795332,"uuid":"151776282","full_name":"deshaw/pyflyby","owner":"deshaw","description":"A set of productivity tools for Python","archived":false,"fork":false,"pushed_at":"2025-01-29T14:26:56.000Z","size":7639,"stargazers_count":375,"open_issues_count":56,"forks_count":54,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-14T23:07:39.755Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://deshaw.github.io/pyflyby/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deshaw.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-05T20:46:28.000Z","updated_at":"2025-05-14T17:57:35.000Z","dependencies_parsed_at":"2023-11-21T14:27:10.844Z","dependency_job_id":"7d01238d-17b1-4b23-aa90-981d1f398ec9","html_url":"https://github.com/deshaw/pyflyby","commit_stats":{"total_commits":1218,"total_committers":33,"mean_commits":36.90909090909091,"dds":0.6707717569786535,"last_synced_commit":"55cb843d25ff322f0bfdcd10a104cdff37050fb7"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deshaw%2Fpyflyby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deshaw%2Fpyflyby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deshaw%2Fpyflyby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deshaw%2Fpyflyby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deshaw","download_url":"https://codeload.github.com/deshaw/pyflyby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254243363,"owners_count":22038046,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-07-31T15:01:10.627Z","updated_at":"2025-05-14T23:07:45.834Z","avatar_url":"https://github.com/deshaw.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"#########\n Pyflyby\n#########\n\n.. image:: https://badge.fury.io/py/pyflyby.svg\n   :target: https://pypi.org/project/pyflyby/\n\n.. image:: https://travis-ci.org/deshaw/pyflyby.png?branch=master\n   :target: https://travis-ci.org/deshaw/pyflyby\n\nPyflyby is a set of Python programming productivity tools for Python 3.8+.\n\nFor command-line interaction:\n  * ``py``: command-line multitool\n\nFor IPython interaction:\n  * ``autoimporter``: automatically imports symbols when needed.\n\nFor editing python source code:\n  * ``tidy-imports``: adds missing 'import's, removes unused 'import's,\n    and also reformats import blocks.\n  * ``find-import``: prints to stdout how to import a particular symbol.\n  * ``reformat-imports``: reformats ``import`` blocks\n  * ``collect-imports``: prints out all the imports in a given set of files.\n  * ``collect-exports``: prints out definitions in a given set of modules,\n    in the form of import statements.\n  * ``transform-imports``: renames imported modules/functions.\n\nInstallation\n============\n\n.. code:: bash\n\n    $ pip install pyflyby\n\nThis creates an alias for your `ipython` named `py` which runs the `pyflyby` plug internally.\n `pyflyby` has a dependency on `ipython`, if it isn't already installed do install it with:\n\n.. code:: bash\n\n    $ pip install ipython\n\n\nQuick start: Autoimporter + IPython\n===================================\n\n.. code:: bash\n\n   $ py\n   In [1]: re.search(\"[a-z]+\", \"....hello...\").group(0)\n   [PYFLYBY] import re\n   Out[1]: 'hello'\n\n   In [2]: chisqprob(arange(5), 2)\n   [PYFLYBY] from numpy import arange\n   [PYFLYBY] from scipy.stats import chisqprob\n   Out[2]: [ 1.      0.6065  0.3679  0.2231  0.1353]\n\nTo load pyflyby into an existing IPython session as a 1-off:\n\n.. code:: bash\n\n   $ ipython\n   In [1]: %load_ext pyflyby\n\nTo configure IPython/Jupyter Notebook to load pyflyby automatically:\n\n.. code:: bash\n\n   $ py pyflyby.install_in_ipython_config_file\n\nor\n\n.. code:: bash\n\n   $ echo 'c.InteractiveShellApp.extensions.append(\"pyflyby\")' \\\n     \u003e\u003e ~/.ipython/profile_default/ipython_config.py\n\n   $ ipython\n   In [1]: b64decode('aGVsbG8=')\n   [PYFLYBY] from base64 import b64decode\n   Out[1]: 'hello'\n\nAuto importer lazy variables\n----------------------------\n\nIt is possible to use the autoimporter to lazily define variables.\n\nTo use, put the following in your IPython startup files\n(``~/.ipython/profile_default/startup/autoimp.py``), or in your IPython\nconfiguration file:\n\n.. code:: python\n\n\n    from pyflyby import add_import\n\n    add_import(\"foo\", \"foo = 1\")\n\n    add_import(\n        \"df, data as dd\",\n        '''\n        import pandas as pd\n        data = [1,2,3]\n        df =  pd.DataFrame(data)\n    ''')\n\n\nYou can add the keyword ``strict=False`` to not fail if not in IPython or of the\npyflyby extensions is not loaded.\n\n\n\n\nQuick start: ``py`` command-line multi-tool\n===========================================\n\n.. code:: bash\n\n  $ py b64decode aGVsbG8=\n  [PYFLYBY] from base64 import b64decode\n  [PYFLYBY] b64decode('aGVsbG8=', altchars=None)\n  'hello'\n\n  $ py log2 sys.maxint\n  [PYFLYBY] from numpy import log2\n  [PYFLYBY] import sys\n  [PYFLYBY] log2(9223372036854775807)\n  63.0\n\n  $ py 'plot(cos(arange(30)))'\n  [PYFLYBY] from numpy import arange\n  [PYFLYBY] from numpy import cos\n  [PYFLYBY] from matplotlib.pyplot import plot\n  [PYFLYBY] plot(cos(arange(30)))\n  \u003cplot\u003e\n\n  $ py 38497631 / 13951446\n  2.7594007818257693\n\n  $ py foo.py\n\nQuick start: ``tidy-imports``\n=============================\n\nTo use ``tidy-imports``, just specify the filename(s) to tidy.\n\nFor example:\n\n.. code::\n\n   $ echo 're.search(\"[a-z]+\", \"....hello...\"), chisqprob(arange(5), 2)' \u003e foo.py\n\n   $ tidy-imports foo.py\n   --- /tmp/foo.py\n   +++ /tmp/foo.py\n   @@ -1 +1,9 @@\n   +from __future__ import absolute_import, division, with_statement\n   +\n   +from   numpy                    import arange\n   +from   scipy.stats              import chisqprob\n   +import re\n   +\n    re.search(\"[a-z]+\", \"....hello...\"), chisqprob(arange(5), 2)\n\n   Replace /tmp/foo.py? [y/N]\n\n\nQuick start: import libraries\n=============================\n\nCreate a file named .pyflyby with lines such as\n\n.. code:: python\n\n   from mypackage.mymodule import MyClass, my_function\n   import anotherpackage.anothermodule\n\nYou can put this file in your home directory or in the same directory as your\n``*.py`` files.\n\n\nDetails: automatic imports\n==========================\n\nAUTOMATIC IMPORTS - never type \"import\" again!\n\nThis module allows your \"known imports\" to work automatically in your IPython\ninteractive session without having to type the 'import' statements (and also\nwithout having to slow down your Python startup with imports you only use\noccasionally).\n\nExample::\n\n  In [1]: re.search(\"[a-z]+\", \"....hello...\").group(0)\n  [PYFLYBY] import re\n  Out[1]: 'hello'\n\n  In [2]: chisqprob(arange(5), 2)\n  [PYFLYBY] from numpy import arange\n  [PYFLYBY] from scipy.stats import chisqprob\n  Out[2]: [ 1.      0.6065  0.3679  0.2231  0.1353]\n\n  In [3]: np.sin(arandom(5))\n  [PYFLYBY] from numpy.random import random as arandom\n  [PYFLYBY] import numpy as np\n  Out[3]: [ 0.0282  0.0603  0.4653  0.8371  0.3347]\n\n  In [4]: isinstance(42, Number)\n  [PYFLYBY] from numbers import Number\n  Out[4]: True\n\n\nIt just works\n-------------\n\nTab completion works, even on modules that are not yet imported.  In the\nfollowing example, notice that numpy is imported when we need to know its\nmembers, and only then::\n\n  $ ipython\n  In [1]: nump\u003cTAB\u003e\n  In [1]: numpy\n  In [1]: numpy.arang\u003cTAB\u003e\n  [PYFLYBY] import numpy\n  In [1]: numpy.arange\n\n\nThe IPython \"?\" magic help (pinfo/pinfo2) automatically imports symbols first\nif necessary::\n\n  $ ipython\n  In [1]: arange?\n  [PYFLYBY] from numpy import arange\n  ... Docstring: arange([start,] stop[, step,], dtype=None) ...\n\nOther IPython magic commands work as well::\n\n  $ ipython\n  In [1]: %timeit np.cos(pi)\n  [PYFLYBY] import numpy as np\n  [PYFLYBY] from numpy import pi\n  100000 loops, best of 3: 2.51 us per loop\n\n  $ echo 'print arange(4)' \u003e foo.py\n  $ ipython\n  In [1]: %run foo.py\n  [PYFLYBY] from numpy import arange\n  [0 1 2 3]\n\n\nImplementation details\n----------------------\n\nThe automatic importing happens at parse time, before code is executed.  The\nnamespace never contains entries for names that are not yet imported.\n\nThis method of importing at parse time contrasts with previous implementations\nof automatic importing that use proxy objects.  Those implementations using\nproxy objects don't work as well, because it is impossible to make proxy\nobjects behave perfectly.  For example, instance(x, T) will return the wrong\nanswer if either x or T is a proxy object.\n\n\nCompatibility\n-------------\n\nTested with:\n  - Python 3.8, 3.9, 3.10\n  - IPython 0.10, 0.11, 0.12, 0.13, 1.0, 1.2, 2.0, 2.1, 2.2, 2.3, 2.4, 3.0,\n    3.1, 3.2, 4.0., 7.11 (latest)\n  - IPython (text console), IPython Notebook, Spyder\n\n\nDetails: import libraries\n=========================\n\nPyflyby uses \"import libraries\" that tell how to import a given symbol.\n\nAn import library file is simply a python source file containing 'import' (or\n'from ... import ...') lines.  These can be generated automatically with\n``collect-imports`` and ``collect-exports``.\n\nKnown imports\n-------------\n\nFind-imports, ``tidy-imports``, and autoimport consult the database of known\nimports to figure out where to get an import.  For example, if the\nimports database contains::\n\n    from numpy import arange, NaN\n\nthen when you type the following in IPython::\n\n    print(arange(10))\n\nthe autoimporter would automatically execute ``from numpy import arange``.\n\nThe database can be one file or multiple files.  This makes it easy to have\nproject-specific known_imports along with global and per-user defaults.\n\nThe ``PYFLYBY_PATH`` environment variable specifies which files to read.\nThis is a colon-separated list of filenames or directory names.  The default\nis::\n\n  PYFLYBY_PATH=/etc/pyflyby:~/.pyflyby:.../.pyflyby\n\nIf you set::\n\n  PYFLYBY_PATH=/foo1/bar1:/foo2/bar2\n\nthen this replaces the default.\n\nYou can use a hyphen to include the default in the path.  If you set::\n\n  PYFLYBY_PATH=/foo1/bar1:-:/foo2/bar2\n\nthen this reads ``/foo1/bar1``, then the default locations, then ``/foo2/bar2``.\n\nIn ``$PYFLYBY_PATH``, ``.../.pyflyby`` (with _three_ dots) means that all ancestor\ndirectories are searched for a member named \".pyflyby\".\n\nFor example, suppose the following files exist::\n\n  /etc/pyflyby/stuff.py\n  /u/quarl/.pyflyby/blah1.py\n  /u/quarl/.pyflyby/more/blah2.py\n  /proj/share/mypythonstuff/.pyflyby\n  /proj/share/mypythonstuff/foo/bar/.pyflyby/baz.py\n  /.pyflyby\n\nFurther, suppose:\n\n  * ``/proj`` is on a separate file system from ``/``.\n  * ``$HOME=/u/quarl``\n\nThen ``tidy-imports /proj/share/mypythonstuff/foo/bar/quux/zot.py`` will by\ndefault use the following::\n\n  /etc/pyflyby/stuff.py\n  /u/quarl/.pyflyby/blah1.py\n  /u/quarl/.pyflyby/more/blah2.py\n  /proj/share/mypythonstuff/foo/bar/.pyflyby/baz.py\n  /proj/share/mypythonstuff/.pyflyby (a file)\n\n.. note::\n\n  * ``/.pyflyby`` is not included, because traversal stops at file system\n    boundaries, and in this example, ``/proj`` is on a different file system than\n    ``/``.\n  * ``.pyflyby`` (in ``$HOME`` or near the target file) can be a file or a directory.\n    If it is a directory, then it is recursively searched for ``*.py`` files.\n  * The order usually doesn't matter, but if there are \"forget\" instructions\n    (see below), then the order matters.  In the default ``$PYFLYBY_PATH``,\n    .../.pyflyby is placed last so that per-directory configuration can\n    override per-user configuration, which can override systemwide\n    configuration.\n\n\nForgetting imports\n------------------\n\nOccasionally you may have reason to tell pyflyby to \"forget\" entries from the\ndatabase of known imports.\n\nYou can put the following in any file reachable from ``$PYFLYBY_PATH``::\n\n  __forget_imports__ = [\"from numpy import NaN\"]\n\nThis is useful if you want to use a set of imports maintained by someone else\nexcept for a few particular imports.\n\nEntries in ``$PYFLYBY_PATH`` are processed left-to-right in the order specified,\nso put the files containing these at the end of your ``$PYFLYBY_PATH``.  By\ndefault, ``tidy-imports`` and friends process ``/etc/pyflyby``, then ``~/.pyflyby``,\nthen the per-directory ``.pyflyby``.\n\n\nMandatory imports\n-----------------\n\nWithin a certain project you may have a policy to always include certain\nimports.  For example, maybe you always want to do ``from __future__ import\ndivision`` in all files.\n\nYou can put the following in any file reachable from ``$PYFLYBY_PATH``::\n\n  __mandatory_imports__ = [\"from __future__ import division\"]\n\nTo undo mandatory imports inherited from other ``.pyflyby`` files, use\n``__forget_imports__`` (see above).\n\n\nCanonicalize imports\n--------------------\n\nSometimes you want every run of ``tidy-imports`` to automatically rename an import\nto a new name.\n\nYou can put the following in any file reachable from ``$PYFLYBY_PATH``::\n\n  __canonical_imports__ = {\"oldmodule.oldfunction\": \"newmodule.newfunction\"}\n\nThis is equivalent to running::\n\n  tidy-imports --transform=oldmodule.oldfunction=newmodule.newfunction\n\n\nSoapbox: avoid \"star\" imports\n=============================\n\nWhen programming in Python, a good software engineering practice is to avoid\nusing ``from foopackage import *`` in production code.\n\nThis style is a maintenance nightmare:\n\n  * It becomes difficult to figure out where various symbols\n    (functions/classes/etc) come from.\n\n  * It's hard to tell what gets shadowed by what.\n\n  * When the package changes in trivial ways, your code will be affected.\n    Consider the following example: Suppose ``foopackage.py`` contains ``import\n    sys``, and ``myprogram.py`` contains ``from foopackage import *; if\n    some_condition: sys.exit(0)``.  If ``foopackage.py`` changes so that ``import\n    sys`` is removed, ``myprogram.py`` is now broken because it's missing ``import\n    sys``.\n\nTo fix such code, you can run ``tidy-imports --replace-star-imports`` to\nautomatically replace star imports with the specific needed imports.\n\nPer-Project configuration of tidy-imports\n=========================================\n\nYou can configure Pyflyby on a per-repository basis by using the\n`[tool.pyflyby]` section of `pyproject.toml` files. Pyflyby will look in current\nworking directory and all it's parent until it find a `pyproject.toml` file from\nwhich it will load the defaults.\n\n\nMost of the long command line flags default values can be configured in this\nsection. Simply use the long form option name by replacing dashes `-` by\nunderscore `_`. For long option that have the form `--xxx` and `--no-xxx`, you\ncan assign a boolean to `xxx`. For example::\n\n    [tool.pyflyby]\n    add_missing=true\n    from_spaces=7\n    remove_unused=false\n\n\nEmacs support\n=============\n\n* To get a ``M-x tidy-imports`` command in GNU Emacs, add to your ``~/.emacs``::\n\n    (load \"/path/to/pyflyby/lib/emacs/pyflyby.el\")\n\n\n- Pyflyby.el doesn't yet work with XEmacs; patches welcome.\n\n\nsaveframe: A utility for debugging / reproducing an issue\n=========================================================\n\nPyFlyBy provides a utility named **saveframe** which can be used to save\ninformation for debugging / reproducing an issue.\n\n**Usage**: If you have a piece of code or a script that is failing due an issue\noriginating from upstream code, and you cannot share your private code as a reproducer,\nuse this utility to save relevant information to a file. Share the generated file with\nthe upstream team, enabling them to reproduce and diagnose the issue independently.\n\n**Information saved in the file**: This utility captures and saves *error stack frames*\nto a file. It includes the values of local variables from each stack frame, as well\nas metadata about each frame and the exception raised by your code.\n\nThis utility comes with 2 interfaces:\n\n1. **A function**: For interactive usages such as IPython, Jupyter Notebook, or a\n   debugger (pdb/ipdb), use **pyflyby.saveframe** function. To know how to use this\n   function, checkout it's documentation:\n\n.. code::\n\n   In [1]: saveframe?\n\n2. **A script**: For cli usages (like a failing script), use **pyflyby/bin/saveframe**\n   script. To know how to use this script, checkout its documentation:\n\n.. code::\n\n   $ saveframe --help\n\nAuthorship\n==========\n\nThis plugin was contributed back to the community by the `D. E. Shaw group\n\u003chttps://www.deshaw.com/\u003e`_.\n\n.. image:: https://www.deshaw.com/assets/logos/blue_logo_417x125.png\n   :target: https://www.deshaw.com\n   :height: 75 px\n\nPyflyby is written by Karl Chen \u003cquarl@8166.clguba.z.quarl.org\u003e\n\nWe love contributions! Before you can contribute, please sign and submit this\n`Contributor License Agreement (CLA) \u003chttps://www.deshaw.com/oss/cla\u003e`_.\nThis CLA is in place to protect all users of this project.\n\nLicense\n=======\n\nPyflyby is released under a very permissive license, the MIT/X11 license; see\nLICENSE.txt.\n\n\nRelease\n=======\n\n1. Check version number in `lib/python/pyflyby/_version.py`, maybe increase it.\n2. Commit and tag if necessary, and push tags/commits.\n3. Optional: Set SOURCE_DATE_EPOCH for reproducible build::\n\n    export SOURCE_DATE_EPOCH=$(git show -s --format=%ct HEAD)\n\n4. Build the SDIST::\n\n    python setup.py sdist\n\n5. Optional Repack the Sdist to make sure the ZIP only contain SOURCE_DATE_EPOCH\n   date using IPython tools::\n\n    python ~/dev/ipython/tools/retar.py dist/pyflyby-1.7.8.tar.gz\n    shasum -a 256 dist/*\n\n6. Optional, redo 4 \u0026 5 to verify checksum is unchanged.\n7. Upload using twine::\n\n    twine upload dist/*\n\n8. Check/update https://github.com/conda-forge/pyflyby-feedstock for new pyflyby\n   release on conda-forge\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeshaw%2Fpyflyby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeshaw%2Fpyflyby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeshaw%2Fpyflyby/lists"}