Files
deb-python-taskflow/taskflow/jobs/backends/__init__.py
Joshua Harlow 7277a73f8c Add persistence docs + adjustments
- Increase the level of docs around why the persistence
  objects exist and what they are used for and how an
  engine interacts with persistence objects to accomplish
  the wider goals.
- Pass backend conf as arg, not kwarg and to match with the
  other fetch/load functions allow for providing a kwargs
  which can be used for backend specific params.

Change-Id: Ia83e63196bcfcc966f68212f84f79a1e9f18e8bc
2014-04-20 11:58:35 -07:00

50 lines
1.7 KiB
Python

# -*- coding: utf-8 -*-
# Copyright (C) 2014 Yahoo! Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import logging
import six
from stevedore import driver
from taskflow import exceptions as exc
# NOTE(harlowja): this is the entrypoint namespace, not the module namespace.
BACKEND_NAMESPACE = 'taskflow.jobboards'
LOG = logging.getLogger(__name__)
def fetch(name, conf, namespace=BACKEND_NAMESPACE, **kwargs):
"""Fetch a jobboard backend with the given configuration (and any board
specific kwargs) in the given entrypoint namespace and create it with the
given name.
"""
# NOTE(harlowja): this allows simpler syntax.
if isinstance(conf, six.string_types):
conf = {'board': conf}
board = conf['board']
LOG.debug('Looking for %r jobboard driver in %r', board, namespace)
try:
mgr = driver.DriverManager(namespace, board,
invoke_on_load=True,
invoke_args=(name, conf),
invoke_kwds=kwargs)
return mgr.driver
except RuntimeError as e:
raise exc.NotFound("Could not find jobboard %s" % (board), e)