https://github.com/musically-ut/decorated_options

Make long argument lists saner with decoration.
https://github.com/musically-ut/decorated_options

decorators python python-3 python-library

Last synced: 10 months ago
JSON representation

Make long argument lists saner with decoration.

• Host: GitHub
• URL: https://github.com/musically-ut/decorated_options
• Owner: musically-ut
• License: bsd-2-clause
• Created: 2016-07-24T20:51:11.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2018-03-15T19:35:54.000Z (about 8 years ago)
• Last Synced: 2024-12-15T11:05:00.542Z (over 1 year ago)
• Topics: decorators, python, python-3, python-library
• Language: Python
• Size: 16.6 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
========

Overview

========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - tests

      - |build|

    * - package

      - |version| |wheel| |supported-versions| |supported-implementations|

      

.. |build| image:: https://travis-ci.org/musically-ut/decorated_options.svg?branch=master

    :target: https://travis-ci.org/musically-ut/decorated_options

.. |docs| image:: https://readthedocs.org/projects/decorated_options/badge/?style=flat

    :target: https://readthedocs.org/projects/decorated_options

    :alt: Documentation Status

.. |version| image:: https://img.shields.io/pypi/v/decorated_options.svg?style=flat

    :alt: PyPI Package latest release

    :target: https://pypi.python.org/pypi/decorated_options

.. |wheel| image:: https://img.shields.io/pypi/wheel/decorated_options.svg?style=flat

    :alt: PyPI Wheel

    :target: https://pypi.python.org/pypi/decorated_options

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/decorated_options.svg?style=flat

    :alt: Supported versions

    :target: https://pypi.python.org/pypi/decorated_options

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/decorated_options.svg?style=flat

    :alt: Supported implementations

    :target: https://pypi.python.org/pypi/decorated_options

.. end-badges

Function decorator to make argument passing saner.

I often have to write a function which runs a simulation/learning task which I

need to run for several different parameters. This initially is manageable, but

then slowly configuration creep starts to happen: I keep adding more and more

parameters to the functions which run the simulations and keep making my old

code more and more fragile.

I wrote ``decorated_options`` to decouple the arguments for different set of experiments.

In brief,  ``decorated_options`` converts this:

.. code:: python

    def run(max_num_followers, num_segments, is_hawkes):

        # ...

        # ...

    # tmp = run_multiple_followers(max_num_followers=10, num_segments=10, is_hawkes=True)

    # tmp = run_multiple_followers(max_num_followers=100, num_segments=10, is_hawkes=False)

    # tmp = run_multiple_followers(max_num_followers=10, num_segments=50, is_hawkes=True)

    tmp = run_multiple_followers(max_num_followers=1000, num_segments=100, is_hawkes=False)

to:

.. code:: python

    from decorated_options import Options, optioned

    @optioned('opts')

    def run(max_num_followers, num_segments, is_hawkes):

        # ...

        # ...

    opts = Options(max_num_followers=10, num_segments=10, is_hawkes=True)

    # tmp = run_multiple_followers(opts=opts)

    # tmp = run_multiple_followers(max_num_followers=100, is_hawkes=False, opts=opts)

    # tmp = run_multiple_followers(num_segments=50, is_hawkes=False, opts=opts)

    tmp = run_multiple_followers(max_num_followers=1000, num_segments=100, is_hawkes=False)

* Benefits over ``**kwargs`` in receiving function:

  1. Early reporting of errors at call-time.

  2. No need to unpack the values.

  3. Default values do not have to be hard-coded.

  4. Allows progressive improvement, no need to change old code which uses positional arguments.

* Benefits over ``**dict`` while calling:

  1. Easier updating/overriding of values

  2. Positional arguments also work

  3. Guaranteed immutability (throws Exceptions on attempted violations.)

* Benefits over default values in receiving function:

  1. ``Options`` objects can save defaults for multiple settings.

  2. De-couples default values from the functions themselves.

Installation

============

.. code:: bash

    pip install decorated_options

Development

===========

To run the all tests run::

    tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::

    :widths: 10 90

    :stub-columns: 1

    - - Windows

      - ::

            set PYTEST_ADDOPTS=--cov-append

            tox

    - - Other

      - ::

            PYTEST_ADDOPTS=--cov-append tox