Basic steps to allow multiple configurations in one module.

README.rst

@@ -51,19 +51,11 @@ By that time you already know that **uwsgiconf** is just another configuration m
 .. _Why: http://uwsgi-docs.readthedocs.io/en/latest/FAQ.html#why-do-you-support-multiple-methods-of-configuration
 
 
-Usage Strategies
-----------------
+Overview
+--------
 
-Two main strategies to use **uwsgiconf**:
-
-1. **Static:** create configuration ``.py`` and compile it when you like into classic uWSGI ``.ini`` using provided methods.
-2. **Dynamic:** create configuration .py, and give it directly to uWSGI with ``exec`` directive.
-
-**uwsgiconf** CLI has tools to streamline both of these.
-
-
-A taste of it
--------------
+Static configuration
+~~~~~~~~~~~~~~~~~~~~
 
 Let's make ``uwsgicfg.py``. There we configure it using nice ``PythonSection`` preset to run our web app.
 
@@ -80,29 +72,51 @@ Let's make ``uwsgicfg.py``. There we configure it using nice ``PythonSection`` p
         # Make app available on http://127.0.0.1:8000
         PythonSection.networking.sockets.http('127.0.0.1:8000'),
 
-    ).as_configuration()
+    )
 
-    configuration.print_ini()
-
-1. Now if you want to generate ``myconf.ini`` file and use it for uWSGI you can do it with:
+1. Now if you want to generate ``myconf.ini`` file and use it for uWSGI manually you can do it with:
 
     .. code-block:: bash
 
-        $ python uwsgicfg.py > myconf.ini
-        ; or just
         $ uwsgiconf compile > myconf.ini
-
         $ uwsgi myconf.ini
 
-2. Or for dynamic usage of .py:
+2. Or use ``uwsgiconf`` to automatically spawn uWSGI processes for configurations defined in your module:
 
     .. code-block:: bash
 
-        $ uwsgi --ini "exec://python uwsgicfg.py"
-        ; or just
         $ uwsgiconf run
 
 
+**Note:** ``uwsgiconf`` CLI requires ``click`` package available.
+
+
+Runtime configuration
+~~~~~~~~~~~~~~~~~~~~~
+
+**uwsgiconf** comes with ``runtime`` package which is similar to **uwsgidecorators** but offers different abstractions.
+
+These abstractions will also use a stub ``uwsgi`` module when if the real one is not available.
+
+A couple of examples:
+
+.. code-block:: python
+
+    from uwsgiconf.runtime.locking import lock
+    from uwsgiconf.runtime.scheduling import register_timer_rb
+
+    @register_timer_rb(10, repeat=2)
+    def repeat_twice():
+        """This function will be called twice with 10 seconds interval
+        (by default in in first available mule) using red-black tree based timer.
+
+        """
+        with lock():
+            # Code under this context manager will be locked using default (0) uWSGI lock.
+            do()
+
+
+
 Documentation
 -------------
 

demos/onefile.py

@@ -16,7 +16,7 @@ def application(env, start_response):
 
     from functools import partial
     import random
-    from uwsgiconf import uwsgi  # This will be available under uWSGI.
+    from uwsgiconf.runtime.environ import uwsgi_env
 
     start_response('200 OK', [('Content-Type','text/html')])
 
@@ -25,8 +25,8 @@ def application(env, start_response):
 
         '<div>Some random number for you: %s</div>' % random.randint(1, 99999),
 
-        '<div>uWSGI version: %s</div>' % uwsgi.version.decode('utf8'),
-        '<div>uWSGI request ID: %s</div>' % uwsgi.request_id(),
+        '<div>uWSGI version: %s</div>' % uwsgi_env.get_version(),
+        '<div>uWSGI request ID: %s</div>' % uwsgi_env.request.id,
     ]
 
     return map(partial(bytes, encoding='utf8'), data)
@@ -39,7 +39,7 @@ def configure():
 
     FILE = os.path.abspath(__file__)
 
-    PythonSection(
+    section = PythonSection(
         # Automatically reload uWSGI if this file is changed.
         touch_reload=FILE,
 
@@ -53,9 +53,9 @@ def configure():
     ).networking.register_socket(
         PythonSection.networking.sockets.http('127.0.0.1:8000'),
 
-    ).as_configuration().print_ini()
+    )
 
+    return section
 
-if __name__ == '__main__':
-    # It seems we're asked for a configuration file.
-    configure()
+
+configuration = configure()

docs/source/hints.rst

@@ -1,5 +1,5 @@
-Tips and hints
-==============
+FAQ
+===
 
 
 How to get through

docs/source/index_api_static.rst

@@ -1,5 +1,5 @@
-Configuration [Dynamic]
-=======================
+Configuration [Static]
+======================
 
 .. toctree::
     :maxdepth: 3

docs/source/quickstart.rst

@@ -1,30 +1,6 @@
 Quickstart
 ==========
 
-Usage Strategies
-----------------
-
-Two main strategies to use **uwsgiconf**:
-
-1. **Static:** create configuration .py and compile it on demand into classic uWSGI .ini using provided methods.
-
-    .. code-block:: bash
-
-        $ python uwsgicfg.py > myconf.ini
-        ; or just
-        $ uwsgiconf compile > myconf.ini
-
-        $ uwsgi myconf.ini
-
-2. **Dynamic:** create configuration .py, and give it directly to uWSGI with ``exec`` directive.
-
-    .. code-block:: bash
-
-        $ uwsgi --ini "exec://python uwsgicfg.py"
-        ; or just
-        $ uwsgiconf run
-
-
 Using a preset to run Python web application
 --------------------------------------------
 
@@ -56,12 +32,18 @@ Let's make ``uwsgicfg.py``. There we configure it using nice ``PythonSection`` p
         # Make app available at http://127.0.0.1:8000
         PythonSection.networking.sockets.http('127.0.0.1:8000'),
 
-    ).as_configuration()
+    )
 
-    configuration.print_ini()
 
+Now we are ready to use this configuration:
 
-Now we are ready to use this configuration dynamically (see ``Strategies`` paragraph above).
+.. code-block:: bash
+
+    $ uwsgiconf compile > myconf.ini
+    $ uwsgi myconf.ini
+
+    ; or instead just
+    $ uwsgiconf run
 
 
 Configuration with multiple sections
@@ -108,5 +90,3 @@ Let's configure uWSGI to use Emperor Broodlord mode as described here_.
             master_process.set_idle_params(timeout=30, exit=True)
 
     ])
-
-    configuration.print_ini()

tests/confs/dummy.py

@@ -8,9 +8,11 @@
 not_conf2 = [1, 2]
 
 configuration = [
+
     Configuration([
-        Section('conf1_1'),
+        Section(),
         Section('conf1_2').env('A', 'B')
-    ]),
-    Section('conf2_1'),
+    ], alias='uwsgicgf_test1'),
+
+    Section().env('D', 'E'),
 ]

tests/test_utils.py

@@ -88,20 +88,21 @@ def test_conf_module_compile():
 
     out = '\n'.join(out)
 
-    assert 'conf1_1' in out
-    assert 'conf1_2' in out
-    assert 'conf2_1' in out
+    assert '[uwsgi]' in out
+    assert '[conf1_2]' in out
+    assert 'D=E' in out
 
 
 def test_conf_module_run(monkeypatch):
     executed = []
-    monkeypatch.setattr(os, 'execvp', lambda *args: executed.append(True))
+    monkeypatch.setattr(os, 'spawnvp', lambda *args: executed.append(True))
 
     fpath = os.path.join(os.path.dirname(__file__), 'confs', 'dummy.py')
 
     module = ConfModule(fpath)
     module.spawn_uwsgi()
 
+    assert len(executed) == 2
     assert all(executed)
 
 

uwsgiconf/cli.py

@@ -34,13 +34,17 @@ def base():
 
 @base.command()
 @arg_conf
-def run(conf):
+@click.option('--only', help='Configuration alias from module to run uWSGI with.')
+def run(conf, only):
     """Runs uWSGI passing to it using the default or another `uwsgiconf` configuration module.
 
     """
     with errorprint():
         config = ConfModule(conf)
-        config.spawn_uwsgi()
+        spawned = config.spawn_uwsgi(only)
+
+        for alias, pid in spawned:
+            click.secho("Spawned uWSGI for '%s' configuration. PID %s" % (alias, pid), fg='green')
 
 
 @base.command()

uwsgiconf/runtime/environ.py

@@ -9,6 +9,8 @@ class _Environment(object):
 
     # todo slots
 
+    request = None  # type: _Request
+
     hostname = uwsgi.hostname  # type: str
     """Current host name."""
 

uwsgiconf/utils.py

@@ -15,6 +15,10 @@
 from .exceptions import ConfigurationError
 
 
+if False:  # pragma: nocover
+    from uwsgiconf.config import Configuration
+
+
 PY3 = sys.version_info[0] == 3
 
 if PY3:  # pragma: nocover
@@ -74,13 +78,28 @@ def __init__(self, fpath):
         self.fpath = fpath
         self._confs = None
 
-    def spawn_uwsgi(self):
-        """Spawns uWSGI process wich will use current configuration module.
+    def spawn_uwsgi(self, only=None):
+        """Spawns uWSGI process(es) which will use configuration(s) from the module.
+
+        Returns list of tuples:
+            (configuration_alias, uwsgi_process_id)
 
-        .. note:: uWSGI process will replace ``uwsgiconf`` process.
+        :param str|unicode only: Configuration alias to run from the module.
+            If not set uWSGI will be spawned for every configuration found in the module.
 
+        :rtype: list
         """
-        UwsgiRunner().spawn(self.fpath)
+        spawned = []
+
+        for config in self.configurations:  # type: Configuration
+            alias = config.alias
+
+            if only is None or alias == only:
+                filepath = config.tofile()
+                pid = UwsgiRunner().spawn(filepath)
+                spawned.append((alias, pid))
+
+        return spawned
 
     @property
     def configurations(self):
@@ -100,14 +119,14 @@ def configurations(self):
 
             if attr is None:
                 raise ConfigurationError(
-                    "'configuration' attribute not found [ %s ]" % fpath)
+                    "'configuration' attribute not found. File: %s" % fpath)
 
             if callable(attr):
                 attr = attr()
 
         if not attr:
             raise ConfigurationError(
-                "'configuration' attribute is empty [ %s ]" % fpath)
+                "'configuration' attribute is empty. File: %s" % fpath)
 
         if not isinstance(attr, (list, tuple)):
             attr = [attr]
@@ -125,7 +144,7 @@ def configurations(self):
 
         if not confs:
             raise ConfigurationError(
-                "'configuration' attribute must hold either 'Section' or 'Configuration' objects [ %s ]" % fpath)
+                "'configuration' attribute must hold either 'Section' or 'Configuration' objects. File: %s" % fpath)
 
         self._confs = confs
 
@@ -280,15 +299,20 @@ def prepare_env(cls):
 
         return os.path.basename(python_binary)
 
-    def spawn(self, module_path):
-        """Spawns uWSGI using the given configuration module.
-
-        .. note:: uWSGI process will replace ``uwsgiconf`` process.
+    def spawn(self, filepath):
+        """Spawns uWSGI using the given configuration file (python module or .ini file).
 
-        :param str|unicode module_path:
+        :param str|unicode filepath:
 
         """
-        os.execvp('uwsgi', ['uwsgi', '--ini', 'exec://%s %s' % (self.binary_python, module_path)])
+        if filepath.endswith('.ini'):
+            target = filepath
+
+        else:
+            # todo Use this to get more.
+            target = 'exec://%s %s' % (self.binary_python, filepath)
+
+        return os.spawnvp(os.P_NOWAIT, 'uwsgi', ['uwsgi', '--ini', target])
 
 
 def parse_command_plugins_output(out):