Skip to main content

Pretty dir printing with joy

Project description

:warning: pdir2 will soon switch to a codebase that only supports Python 3.5+, because I want to add type hints and apply those cool toolings like mypy. The Python 2 compatible version will exist in the 0.3.x branch, and will still be receiving bug fixes. All new features will be developed on master therefore is Python 3.5+ exclusive.

In short, if you're still using pdir2 for Python <3.5, install via pip install "pdir2>=0.3,<0.4".

pdir2: Pretty dir() printing with joy

Build Status Supported Python versions PyPI Version

Have you ever dreamed of a better output of dir()? I do. So I created this.

Features

  • Attributes are grouped by types/functionalities, with beautiful colors.

  • Support color customization, here's how.

  • Support all platforms including Windows(Thanks to colorama).

  • Support ipython, ptpython, bpython and Jupyter Notebook! See wiki for details.

  • The return value of pdir() can still be used as a list of names.

  • ✨ Attribute searching

    You can search for certain names with .s() or .search():

    Search is case-insensitive by default.
    search(name, case_sensitive=True) does case sensitive searching.

  • :star2: Attribute filtering

    properties: Find properties/variables defined in the inspected object.

    methods: Find methods/functions defined in the inspected object.

    public: Find public attributes.

    own: Find attributes that are not inherited from parent classes.

    These filters can be chained! Order does NOT matter.

    For example, use pdir(obj).public.own.methods to find all public own methods.

    You can also call search on the returned results.

    See a complete example.

Install

Generic

pip install pdir2

About the name. I wanted to call it "pdir", but there's already one with this name on pypi. Mine is better, of course.

Fedora

dnf install python3-pdir2
--or--
dnf install python2-pdir2

Automatic Import

As a better alternative of dir(), it's more convenient to automatically import pdir2 when launching REPL. Luckily, Python provides a way to do this. In you .bashrc(or .zshrc), add this line:

export PYTHONSTARTUP=$HOME/.pythonstartup

Then, create .pythonstartup in your home folder. Add one line:

import pdir

Next time you launch REPL, pdir() is already there, Hooray!

Testing

Simply run pytest, or use tox if you like.

Release History

0.3.1(2018-10-25)

  • Add support for __slots__ (#44, #45)
  • Seperate @staticmethod with other descriptors(#38, #42)
  • Add __post_init__ support

Special thanks to @liwt31 for his great contribution.

0.3.0(2018-02-10)

  • Add support for various filters (#37)

0.2.0(2017-04-04)

  • Add support for color customization. (#14)

0.1.0(2017-03-16)

  • Add support for ipython, ptpython and bpython (#4)

0.0.2(2017-03-11)

API Changes (Backward-Compatible)

  • Added a case_sensitive parameter into the search function (#5)

Bugfixes

  • Error calling pdir(pandas.DataFrame) (#1)
  • Methods are now considered functions (#6)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pdir2, version 0.3.1.post2
Filename, size File type Python version Upload date Hashes
Filename, size pdir2-0.3.1.post2-py2.py3-none-any.whl (13.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pdir2-0.3.1.post2.tar.gz (13.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page