.. image:: https://travis-ci.org/MacHu-GWU/inspect_mate-project.svg?branch=master :target: https://travis-ci.org/MacHu-GWU/inspect_mate-project?branch=master

.. image:: https://codecov.io/gh/MacHu-GWU/inspect_mate-project/branch/master/graph/badge.svg :target: https://codecov.io/gh/MacHu-GWU/inspect_mate-project

.. image:: https://img.shields.io/pypi/v/inspect_mate.svg :target: https://pypi.python.org/pypi/inspect_mate

.. image:: https://img.shields.io/pypi/l/inspect_mate.svg :target: https://pypi.python.org/pypi/inspect_mate

.. image:: https://img.shields.io/pypi/pyversions/inspect_mate.svg :target: https://pypi.python.org/pypi/inspect_mate

.. image:: https://img.shields.io/badge/Star_Me_on_GitHub!--None.svg?style=social :target: https://github.com/MacHu-GWU/inspect_mate-project

Forked from https://github.com/MacHu-GWU/inspect_mate-project to keep up to date with Python versions

Welcome to inspect_mate Documentation

inspect_mate can easily separate:

1. regular attribute.
2. property attribute.
3. regular method.
4. static method.
5. class method.
6. all attributes, include regular attribute and property attribute.
7. all methods, include regular method, static method and class method.

Quick Links

• .. image:: https://img.shields.io/badge/Link-Document-red.svg :target: https://inspect_mate.readthedocs.io/index.html

• .. image:: https://img.shields.io/badge/Link-API_Reference_and_Source_Code-red.svg :target: https://inspect_mate.readthedocs.io/py-modindex.html

• .. image:: https://img.shields.io/badge/Link-Install-red.svg :target: install_

• .. image:: https://img.shields.io/badge/Link-GitHub-blue.svg :target: https://github.com/MacHu-GWU/inspect_mate-project

• .. image:: https://img.shields.io/badge/Link-Submit_Issue_and_Feature_Request-blue.svg :target: https://github.com/MacHu-GWU/inspect_mate-project/issues

• .. image:: https://img.shields.io/badge/Link-Download-blue.svg :target: https://pypi.python.org/pypi/inspect_mate#downloads

Example

import:

.. code-block:: python

from inspect_mate import (
    is_attribute,
    is_property_method,
    is_regular_method,
    is_static_method,
    is_class_method,
    get_attributes,
    get_property_methods,
    get_regular_methods,
    get_static_methods,
    get_class_methods,
    get_all_attributes,
    get_all_methods,
)

define a class:

.. code-block:: python

class Base(object):
    attribute = "attribute"

    def __init__(self):
        self.initiated_attribute = "initiated_attribute"

    @property
    def property_method(self):
        return "property_method"

    def regular_method(self):
        return "regular_method"

    @staticmethod
    def static_method():
        return "static_method"

    @classmethod
    def class_method(cls):
        return "class_method"


class Klass(Base):
    pass


instance = Klass()

usage:

.. code-block:: python

# tester_function(klass_or_instance, "attribute_name")
>>> is_attribute(Klass, "attribute")
True
>>> is_property_method(Klass, "property_attribute")
True
>>> is_regular_method(Klass, "regular_method")
True
>>> is_static_method(Klass, "static_method")
True
>>> is_class_method(Klass, "class_method")
True

>>> is_attribute(instance, "attribute")
True
>>> is_attribute(instance, "initiated_attribute")
True
>>> is_property_method(instance, "property_attribute")
True
>>> is_regular_method(instance, "regular_method")
True
>>> is_static_method(instance, "static_method")
True
>>> is_class_method(instance, "class_method")
True

# getter_function(klass_or_instance), yield (attr, value)
>>> get_attributes(Klass)
[("attribute", "attribute")]

>>> get_property_methods(Klass)
[("property_attribute", "property_attribute")]

>>> get_regular_methods(Klass)
[("regular_method", Klass.regular_method)]

>>> get_static_methods(Klass)
[("static_method", "Klass.static_method")]

>>> get_class_methods(Klass)
[("class_method", "Klass.class_method")]

>>> get_all_attributes(Klass)
[("attribute", "attribute"), ("property_attribute", "property_attribute")]

>>> get_all_methods(Klass)
[("regular_method", Klass.regular_method), ("static_method", "Klass.static_method"), ("class_method", "Klass.class_method")]

.. _install:

Install

inspect_mate is released on PyPI, so all you need is:

.. code-block:: console

$ pip install inspect_mate

To upgrade to latest version:

.. code-block:: console

$ pip install --upgrade inspect_mate