AadamZ5 / py-controller-model

A simple controller-model implementation for arbitrary or unique API setups

py-controller-model

Simplifies arbitrary API creation by leaving definition and binding in-code.

Goals:

• Bind a controller to a model
• Register using decorators
• Unit testing
• GH Actions automated testing
• Code coverage
• Easy documentation (and basic introspection?)
• push to pypi.org

Installation

Install this repository directly with pip install git+https://github.com/AadamZ5/py-controller-model/

Alternatively, clone this repository, then when inside of the directory, install with pip install .

Example usage

Usage of the generic implementation

import controllermodel as cm

# This is our data model class of some sort.
class A:
    def __init__(self):
        self.a = "A variable"

    @cm.GenericController.register_action(action="action") # The "action" and "description" keywords can be used to override 
    def myaction(self):                                    # the name and description (usually gathered fromthe funciton 
        print(self.a)                                      # name and docstring, respectively).

a = A()
gc = cm.GenericController(a)

# Now wire in `gc` to an API endpoint class such as a websocket to easily and quickly map API calls.

Noticing how a derived class behaves

import controllermodel as cm


# Here we define our specific controller. It can have special logic and methods and algorithms for our arbitrary API.
class SpecificController(cm.GenericController):
    def __init__(self, instance_of_class):
        super().__init__(instance_of_class)

    def special_method(self):
        print(self._registered_classes)

# Here we use our SpecificController to tell it what methods to expect.
@SpecificController.register_model
class A:
    def __init__(self):
        self.a = "A variable"

    # More specifically, when we decorate, we tell our controller to expect this function on the instance we supply.
    @SpecificController.register_action
    def myaction(self):
        print(self.a)



print(cm.GenericController._registered_classes)     # Although this variable isn't to be used by you,
print(SpecificController._registered_classes)       # it is worth noting that these will be the same value.

a = A()
sc = SpecificController(a)
gc = cm.GenericController(a)    # <<-- This will raise an Exception! We have not registered any
                                #       functions of class A to `GenericController`

sc.special_method()
sc.execute_action('myaction')

Notes

GenericController is designed to be inherited from in your own controller. The important function to consider is GenericController.execute_action which is the function that looks up the corresponding model function to call.

Flask already exists, why should I use this?

You're right. Flask does already exist, but this library actually goes one level of abstraction lower than Flask does. Flask is a fully-featured HTTP REST API, while this is simply a controller routing middle-man. If you think Flask solves all of your problems, then you probably don't need this library. If you need more specific control than what Flask offers, then you may benefit from your own implementation using this as a backbone.

Contributing

Please feel free to open an issue or pull request with your ideas and intentions! Any help is greatly appreciated!