Metadata-Version: 2.1
Name: pycompose
Version: 1.2.1
Summary: A simple way to inject composition through inheritance syntax.
Home-page: https://github.com/timfi/pycompose
Author: Tim Fischer
Author-email: me@timfi.dev
License: MIT
Description: # PyCompose
        _A simple way to inject composition through inheritance syntax._
        
        [![PyPI - Version](https://img.shields.io/pypi/v/pycompose)](https://pypi.org/project/pycompose)
        [![PyPI - Status](https://img.shields.io/pypi/status/pycompose)](https://pypi.org/project/pycompose)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pycompose)](https://pypi.org/project/pycompose)
        [![PyPI - License](https://img.shields.io/pypi/l/pycompose)](https://opensource.org/licenses/MIT)
        
        [![Build Status](https://img.shields.io/github/workflow/status/timfi/pycompose/Tests?logo=github)](https://github.com/timfi/pycompose/actions?query=workflow%3ATests)
        [![codecov](https://codecov.io/gh/timfi/pycompose/branch/master/graph/badge.svg)](https://codecov.io/gh/timfi/pycompose)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        ## Inspirations
        The following links served as inpiration during the writing of this, and as a in-depth explanation of what actually is composition and its benefits and drawbacks versus inheritance.
        * [Ariel Ortiz's 2019 PyCon talk](https://www.youtube.com/watch?v=YXiaWtc0cgE)
        * [forwardable](https://github.com/5long/forwardable)
        
        ## Explanation
        From the inspirations one can easily see that an older implementation of compositional forwarding exists ([forwardable](https://github.com/5long/forwardable)) so why would I do this to myself? In short, I didn't like the syntax introduced by it. I find the syntax provided by this implementation a bit easier to understand as I find adding things that related to properties of a class inside the brackets in the class statement the most logical.
        
        ## Usage
        ```python
        from pycompose import Compose
        
        
        class A:
            test1 = "123"
        
            def hello(self):
                print("A")
        
            def __repr__(self):
                return "<A>"
        
        
        class B:
            test2 = "456"
        
            def hello(self):
                print("B")
        
            def __repr__(self):
                return "<B>"
        
        
        class C(
            Compose(A, "test1", ("hello", "helloA")),
            Compose(B, "test2", ("hello", "helloB"), name="b_object"),
        ):
            ...
        
        
        c = C()
        print(c.test1 + c.test2)  # > 123456
        c.helloA()                # > A
        c.helloB()                # > B
        print(c._a, c.b_object)   # > <A> <B>
        ```
        
        ## Disclaimer
        Please do note that this project is but a small abstraction for something that can easily be achieved only a few more lines of hand written code. As such I am aware of the fact that this may seem pretty useless to some people.
        MIT License
        
        Copyright (c) 2020 Tim Fischer
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Code Generators
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
