brewtils.resolvers package

Submodules

brewtils.resolvers.gridfs module

brewtils.resolvers.parameter module

class brewtils.resolvers.parameter.DownloadResolver(request, params_to_resolve, resolvers, *_)

Bases: brewtils.resolvers.parameter.ParameterResolver

resolve_parameters()

simple_resolve(value)

class brewtils.resolvers.parameter.ParameterResolver(request, params_to_resolve, resolvers)

Bases: object

Base class for parameter resolution.

This class is used under-the-hood for various plugin functions. Its purpose is to remove all the various cleanup and house keeping steps involved in resolving parameters. An example of an unresolved parameter is a dictionary which represents a bytes object. In this case, the user wants the open file descriptor, not the random dictionary that they don’t know how to process. The parameter resolver helps handle these scenarios by providing the following API:

with ParameterResolver(request, ["my_file"], resolvers) as resolved_params:
    file_bytes = resolved_params["my_file"].read()

This is intended for internal use for the plugin class.

cleanup()

pre_resolve()

resolve_parameters()

simple_resolve(value)

class brewtils.resolvers.parameter.UploadResolver(request, params_to_resolve, resolvers)

Bases: brewtils.resolvers.parameter.ParameterResolver

simple_resolve(value)

Module contents

class brewtils.resolvers.DownloadResolver(request, params_to_resolve, resolvers, *_)

Bases: brewtils.resolvers.parameter.ParameterResolver

resolve_parameters()

simple_resolve(value)

class brewtils.resolvers.FileResolver(client)

Bases: object

Resolvers are meant to be written for specific storage types. In this case, we are uploading and downloading file chunks.

This class is meant to be used transparently to Plugin developers. Resolvers respond to two methods:

• upload(value)
• download(bytes_parameter, writer)

client

A brewtils.EasyClient

download(file_id, *args)

Download the given bytes parameter.

Parameters:file_id – A BG generated file ID

upload(value, **kwargs)

Upload the given value to the server if necessary.

The value can be one of the following:

1. A string representation of a valid filename.
2. An open file descriptor.

Parameters:value – Value to upload. Returns:A valid beer garden assigned ID

class brewtils.resolvers.UploadResolver(request, params_to_resolve, resolvers)

Bases: brewtils.resolvers.parameter.ParameterResolver

simple_resolve(value)