a Ev@s@ddlmZddlmZmZGdddeZGdddeZdS) )errors) CollectionModelc@sreZdZdZddZeddZeddZedd Zd d Z d d Z dddZ ddZ dddZ dddZdS)Pluginz! A plugin on the server. cCsd|jj|jfS)Nz <%s: '%s'>) __class____name__nameselfr 9/usr/lib/python3.9/site-packages/docker/models/plugins.py__repr__ szPlugin.__repr__cCs |jdS)z$ The plugin's name. Nameattrsgetr r r r r sz Plugin.namecCs |jdS)z0 Whether the plugin is enabled. ZEnabledrr r r r enabledszPlugin.enabledcCs |jdS)zG A dictionary representing the plugin's configuration. ZSettingsrr r r r settingsszPlugin.settingscCs|jj|j||dS)a Update the plugin's settings. Args: options (dict): A key-value mapping of options. Raises: :py:class:`docker.errors.APIError` If the server returns an error. N)clientapiZconfigure_pluginr reload)r optionsr r r configure!s zPlugin.configurecCs|jj|j|dS)z Disable the plugin. Raises: :py:class:`docker.errors.APIError` If the server returns an error. N)rrZdisable_pluginr rr r r r disable/s zPlugin.disablecCs|jj|j||dS)z Enable the plugin. Args: timeout (int): Timeout in seconds. Default: 0 Raises: :py:class:`docker.errors.APIError` If the server returns an error. N)rrZ enable_pluginr r)r timeoutr r r enable;s z Plugin.enablecCs|jj|jS)a Push the plugin to a remote registry. Returns: A dict iterator streaming the status of the upload. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )rrZ push_pluginr r r r r pushIs z Plugin.pushFcCs|jjj|j|dS)a. Remove the plugin from the server. Args: force (bool): Remove even if the plugin is enabled. Default: False Raises: :py:class:`docker.errors.APIError` If the server returns an error. )force)rrZ remove_pluginr )r rr r r removeVs z Plugin.removeNccsX|jrtd|dur|j}|jj|}|jj|j||D] }|Vq@|dS)aR Upgrade the plugin. Args: remote (string): Remote reference to upgrade to. The ``:latest`` tag is optional and is the default if omitted. Default: this plugin's name. Returns: A generator streaming the decoded API logs z)Plugin must be disabled before upgrading.N) rrZ DockerErrorr rrplugin_privilegesZupgrade_pluginr)r Zremote privilegesdr r r upgradeds zPlugin.upgrade)r)F)N)r __module__ __qualname____doc__rpropertyr rrrrrrr r$r r r r rs     rc@s4eZdZeZd ddZddZd ddZd d ZdS) PluginCollectionFcCs|jj|||||S)aC Create a new plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. plugin_data_dir (string): Path to the plugin data directory. Plugin data directory must contain the ``config.json`` manifest file and the ``rootfs`` directory. gzip (bool): Compress the context using gzip. Default: False Returns: (:py:class:`Plugin`): The newly created plugin. )rrZ create_pluginr)r r Zplugin_data_dirgzipr r r createszPluginCollection.createcCs||jj|S)ah Gets a plugin. Args: name (str): The name of the plugin. Returns: (:py:class:`Plugin`): The plugin. Raises: :py:class:`docker.errors.NotFound` If the plugin does not exist. :py:class:`docker.errors.APIError` If the server returns an error. ) prepare_modelrrZinspect_plugin)r r r r r rszPluginCollection.getNcCs8|jj|}|jj|||}|D]}q$||p4|S)a Pull and install a plugin. Args: remote_name (string): Remote reference for the plugin to install. The ``:latest`` tag is optional, and is the default if omitted. local_name (string): Local name for the pulled plugin. The ``:latest`` tag is optional, and is the default if omitted. Optional. Returns: (:py:class:`Plugin`): The installed plugin Raises: :py:class:`docker.errors.APIError` If the server returns an error. )rrr!Z pull_pluginr)r Z remote_nameZ local_namer"itdatar r r installs zPluginCollection.installcsjj}fdd|DS)z List plugins installed on the server. Returns: (list of :py:class:`Plugin`): The plugins. Raises: :py:class:`docker.errors.APIError` If the server returns an error. csg|]}|qSr )r,).0rr r r z)PluginCollection.list..)rrZplugins)r Zrespr r r lists zPluginCollection.list)F)N) rr%r&rZmodelr+rr/r4r r r r r)}s   r)N)rresourcerrrr)r r r r s x