|build status|

accrocchio
==========

Accrocchio is a library to mark and being notified of smelly code
(a.k.a, "accrocchio").

Example
-------

.. code:: python

    from accrocchio.badgeofshame import accrocchio
    from accrocchio import observers


    class AClassThatSmells(metaclass=accrocchio):
        pass

    @accrocchio
    def a_function_that_smells():
        pass


    accrocchio.how_many()     # here we have 1, as you have declared a smelly class
    AClassThatSmells()
    accrocchio.how_many()     # here we have 2, as you have created an instance of a smelly class
    a_function_that_smells()
    accrocchio.how_many()     # here we have 3, as you have invoked a smelly function

    accrocchio.reset()
    accrocchio.how_many()     # here we have 0

    # You can also be notified of smelly code execution, such as:

    class MyAccrocchioObserver(observers.AccrocchioObserver):
        def on_accrocchio(self):
            print('Another accrocchio!')

        def reset(self):
            print('Reset accrocchi')
    accrocchio.add_observer(MyAccrocchioObserver())
    a_function_that_smells()   # prints 'Another accrocchio!'
    accrocchio.reset()         # prints 'Reset accrocchi'

It is also possible to decorate the entire class. Both the declaration
and the instantiation of such classes increase the accrocchio counters.

.. code:: python

    from accrocchio.badgeofshame import accrocchio
    from accrocchio import observers


    @accrocchio
    class AClassThatSmells:
        pass


    accrocchio.how_many()     # here we have 1, as you have declared a smelly class
    AClassThatSmells()
    accrocchio.how_many()     # here we have 2, as you have created an instance of a smelly class

You might declare an accrocchio using type hinting, as follows:

.. code:: python

    from accrocchio.badgeofshame import accrocchio, detonator


    def f(a: detonator[int]):
        pass

    accrocchio.how_many()     # here we have 1, as you have declared a smelly parameter
    detonator.how_many()     # here we have 1, as you have declared a smelly parameter

    f(1)
    accrocchio.how_many()     # here we still have 1
    detonator.how_many()     # here we still have 1

The library also implements `Michael Duell's resign
patterns <http://nishitalab.org/user/paulo/files/resign-patterns.txt>`__.

.. code:: python

    from accrocchio.badgeofshame import accrocchio, detonator


    @accrocchio
    def accrocchio_fun():
        pass


    @detonator
    def detonator_fun():
        pass


    accrocchio_fun()
    accrocchio.how_many()     # here we have 1, as you have invoked an accrocchio function
    detonator.how_many()      # here we have 0, as you have never invoked a detonator function
    detonator_fun()
    detonator.how_many()      # here we have 1, as you have invoked a detonator function
    accrocchio.how_many()     # here we have 2, as you have invoked a detonator function, which is an accrocchio

You may mark arbitrary code as an accrocchio:

.. code:: python

    from accrocchio.badgeofshame import detonator, epoxy, this_is_a, this_is_an

    this_is_an(epoxy)
    this_is_a(detonator)
    detonator.how_many()  # this will be 1
    epoxy.how_many()  # this will be 1

If you need to have to mark a specific portion of your code as an
accrocchio, you can use it as a context manager, as follows:

.. code:: python

    from accrocchio.badgeofshame import detonator, epoxy

    with detonator:
        ...

    with epoxy:
        ...

    detonator.how_many()  # this will be 1
    epoxy.how_many()  # this will be 1

For a full list of the implemented accrocchio resign patterns, please
consult `Michael Duell's resign
patterns <http://nishitalab.org/user/paulo/files/resign-patterns.txt>`__.

Some final notes:

1. This library is useful only if a small part of the software is an
   accrocchio
2. We intentionally left out Python versions before 3.5, as we think
   they are a complete accrocchio.
3. We intentionally did not pass the accrocchio to the 'on\_accrocchio'
   observer function, as you should treat all the accrocchioes the same
   way
4. The plural for accrocchio is accrocchioes
5. If you are using this library, you are deliberately brutalizing The
   Zen of Python; thus it has been replaced with a more appropriate one.
   Just do ``import this`` after ``import accrocchio``.

.. |build status| image:: https://img.shields.io/travis/fcracker79/accrocchio/master.svg?style=flat-square
   :target: https://travis-ci.org/fcracker79/accrocchio
