gerrit.plugins package

Submodules

gerrit.plugins.plugins module

class gerrit.plugins.plugins.GerritPlugin(id_: str, gerrit)

Bases: object

disable()

Disables a plugin on the Gerrit server.

Returns:

enable()

Enables a plugin on the Gerrit server.

Returns:

reload()

Reloads a plugin on the Gerrit server.

Returns:

class gerrit.plugins.plugins.GerritPlugins(gerrit)

Bases: object

get(id_)

Parameters:

id – plugin id

Returns:

install(id_, input_)

Installs a new plugin on the Gerrit server.

input_ = {
    "url": "file:///gerrit/plugins/delete-project/delete-project-2.8.jar"
}

plugin = client.plugins.install(input_)

Parameters:

• id – plugin id

• input – the PluginInput entity, https://gerrit-review.googlesource.com/Documentation/rest-api-plugins.html#plugin-input

Returns:

list(is_all: bool = False, limit: int = 25, skip: int = 0, pattern_dispatcher=None)

Lists the plugins installed on the Gerrit server.

Parameters:

• is_all – boolean value, if True then all plugins (including hidden ones) will be added to the results

• limit – Int value that allows to limit the number of plugins to be included in the output results

• skip – Int value that allows to skip the given number of plugins from the beginning of the list

• pattern_dispatcher – Dict of pattern type with respective pattern value: {(‘prefix’|’match’|’regex’) : value}

Returns:

Module contents