File manager - Edit - /home/newsbmcs.com/public_html/static/img/logo/docker.tar
Back
auth.py 0000644 00000031261 15027665106 0006072 0 ustar 00 import base64 import json import logging from . import credentials, errors from .utils import config INDEX_NAME = 'docker.io' INDEX_URL = f'https://index.{INDEX_NAME}/v1/' TOKEN_USERNAME = '<token>' log = logging.getLogger(__name__) def resolve_repository_name(repo_name): if '://' in repo_name: raise errors.InvalidRepository( f'Repository name cannot contain a scheme ({repo_name})' ) index_name, remote_name = split_repo_name(repo_name) if index_name[0] == '-' or index_name[-1] == '-': raise errors.InvalidRepository( f'Invalid index name ({index_name}). ' 'Cannot begin or end with a hyphen.' ) return resolve_index_name(index_name), remote_name def resolve_index_name(index_name): index_name = convert_to_hostname(index_name) if index_name == f"index.{INDEX_NAME}": index_name = INDEX_NAME return index_name def get_config_header(client, registry): log.debug('Looking for auth config') if not client._auth_configs or client._auth_configs.is_empty: log.debug( "No auth config in memory - loading from filesystem" ) client._auth_configs = load_config(credstore_env=client.credstore_env) authcfg = resolve_authconfig( client._auth_configs, registry, credstore_env=client.credstore_env ) # Do not fail here if no authentication exists for this # specific registry as we can have a readonly pull. Just # put the header if we can. if authcfg: log.debug('Found auth config') # auth_config needs to be a dict in the format used by # auth.py username , password, serveraddress, email return encode_header(authcfg) log.debug('No auth config found') return None def split_repo_name(repo_name): parts = repo_name.split('/', 1) if len(parts) == 1 or ( '.' not in parts[0] and ':' not in parts[0] and parts[0] != 'localhost' ): # This is a docker index repo (ex: username/foobar or ubuntu) return INDEX_NAME, repo_name return tuple(parts) def get_credential_store(authconfig, registry): if not isinstance(authconfig, AuthConfig): authconfig = AuthConfig(authconfig) return authconfig.get_credential_store(registry) class AuthConfig(dict): def __init__(self, dct, credstore_env=None): if 'auths' not in dct: dct['auths'] = {} self.update(dct) self._credstore_env = credstore_env self._stores = {} @classmethod def parse_auth(cls, entries, raise_on_error=False): """ Parses authentication entries Args: entries: Dict of authentication entries. raise_on_error: If set to true, an invalid format will raise InvalidConfigFile Returns: Authentication registry. """ conf = {} for registry, entry in entries.items(): if not isinstance(entry, dict): log.debug( f'Config entry for key {registry} is not auth config' ) # We sometimes fall back to parsing the whole config as if it # was the auth config by itself, for legacy purposes. In that # case, we fail silently and return an empty conf if any of the # keys is not formatted properly. if raise_on_error: raise errors.InvalidConfigFile( f'Invalid configuration for registry {registry}' ) return {} if 'identitytoken' in entry: log.debug(f'Found an IdentityToken entry for registry {registry}') conf[registry] = { 'IdentityToken': entry['identitytoken'] } continue # Other values are irrelevant if we have a token if 'auth' not in entry: # Starting with engine v1.11 (API 1.23), an empty dictionary is # a valid value in the auths config. # https://github.com/docker/compose/issues/3265 log.debug( f'Auth data for {registry} is absent. ' f'Client might be using a credentials store instead.' ) conf[registry] = {} continue username, password = decode_auth(entry['auth']) log.debug( f'Found entry (registry={registry!r}, username={username!r})' ) conf[registry] = { 'username': username, 'password': password, 'email': entry.get('email'), 'serveraddress': registry, } return conf @classmethod def load_config(cls, config_path, config_dict, credstore_env=None): """ Loads authentication data from a Docker configuration file in the given root directory or if config_path is passed use given path. Lookup priority: explicit config_path parameter > DOCKER_CONFIG environment variable > ~/.docker/config.json > ~/.dockercfg """ if not config_dict: config_file = config.find_config_file(config_path) if not config_file: return cls({}, credstore_env) try: with open(config_file) as f: config_dict = json.load(f) except (OSError, KeyError, ValueError) as e: # Likely missing new Docker config file or it's in an # unknown format, continue to attempt to read old location # and format. log.debug(e) return cls(_load_legacy_config(config_file), credstore_env) res = {} if config_dict.get('auths'): log.debug("Found 'auths' section") res.update({ 'auths': cls.parse_auth( config_dict.pop('auths'), raise_on_error=True ) }) if config_dict.get('credsStore'): log.debug("Found 'credsStore' section") res.update({'credsStore': config_dict.pop('credsStore')}) if config_dict.get('credHelpers'): log.debug("Found 'credHelpers' section") res.update({'credHelpers': config_dict.pop('credHelpers')}) if res: return cls(res, credstore_env) log.debug( "Couldn't find auth-related section ; attempting to interpret " "as auth-only file" ) return cls({'auths': cls.parse_auth(config_dict)}, credstore_env) @property def auths(self): return self.get('auths', {}) @property def creds_store(self): return self.get('credsStore', None) @property def cred_helpers(self): return self.get('credHelpers', {}) @property def is_empty(self): return ( not self.auths and not self.creds_store and not self.cred_helpers ) def resolve_authconfig(self, registry=None): """ Returns the authentication data from the given auth configuration for a specific registry. As with the Docker client, legacy entries in the config with full URLs are stripped down to hostnames before checking for a match. Returns None if no match was found. """ if self.creds_store or self.cred_helpers: store_name = self.get_credential_store(registry) if store_name is not None: log.debug( f'Using credentials store "{store_name}"' ) cfg = self._resolve_authconfig_credstore(registry, store_name) if cfg is not None: return cfg log.debug('No entry in credstore - fetching from auth dict') # Default to the public index server registry = resolve_index_name(registry) if registry else INDEX_NAME log.debug(f"Looking for auth entry for {repr(registry)}") if registry in self.auths: log.debug(f"Found {repr(registry)}") return self.auths[registry] for key, conf in self.auths.items(): if resolve_index_name(key) == registry: log.debug(f"Found {repr(key)}") return conf log.debug("No entry found") return None def _resolve_authconfig_credstore(self, registry, credstore_name): if not registry or registry == INDEX_NAME: # The ecosystem is a little schizophrenic with index.docker.io VS # docker.io - in that case, it seems the full URL is necessary. registry = INDEX_URL log.debug(f"Looking for auth entry for {repr(registry)}") store = self._get_store_instance(credstore_name) try: data = store.get(registry) res = { 'ServerAddress': registry, } if data['Username'] == TOKEN_USERNAME: res['IdentityToken'] = data['Secret'] else: res.update({ 'Username': data['Username'], 'Password': data['Secret'], }) return res except credentials.CredentialsNotFound: log.debug('No entry found') return None except credentials.StoreError as e: raise errors.DockerException( f'Credentials store error: {repr(e)}' ) from e def _get_store_instance(self, name): if name not in self._stores: self._stores[name] = credentials.Store( name, environment=self._credstore_env ) return self._stores[name] def get_credential_store(self, registry): if not registry or registry == INDEX_NAME: registry = INDEX_URL return self.cred_helpers.get(registry) or self.creds_store def get_all_credentials(self): auth_data = self.auths.copy() if self.creds_store: # Retrieve all credentials from the default store store = self._get_store_instance(self.creds_store) for k in store.list().keys(): auth_data[k] = self._resolve_authconfig_credstore( k, self.creds_store ) auth_data[convert_to_hostname(k)] = auth_data[k] # credHelpers entries take priority over all others for reg, store_name in self.cred_helpers.items(): auth_data[reg] = self._resolve_authconfig_credstore( reg, store_name ) auth_data[convert_to_hostname(reg)] = auth_data[reg] return auth_data def add_auth(self, reg, data): self['auths'][reg] = data def resolve_authconfig(authconfig, registry=None, credstore_env=None): if not isinstance(authconfig, AuthConfig): authconfig = AuthConfig(authconfig, credstore_env) return authconfig.resolve_authconfig(registry) def convert_to_hostname(url): return url.replace('http://', '').replace('https://', '').split('/', 1)[0] def decode_auth(auth): if isinstance(auth, str): auth = auth.encode('ascii') s = base64.b64decode(auth) login, pwd = s.split(b':', 1) return login.decode('utf8'), pwd.decode('utf8') def encode_header(auth): auth_json = json.dumps(auth).encode('ascii') return base64.urlsafe_b64encode(auth_json) def parse_auth(entries, raise_on_error=False): """ Parses authentication entries Args: entries: Dict of authentication entries. raise_on_error: If set to true, an invalid format will raise InvalidConfigFile Returns: Authentication registry. """ return AuthConfig.parse_auth(entries, raise_on_error) def load_config(config_path=None, config_dict=None, credstore_env=None): return AuthConfig.load_config(config_path, config_dict, credstore_env) def _load_legacy_config(config_file): log.debug("Attempting to parse legacy auth file format") try: data = [] with open(config_file) as f: for line in f.readlines(): data.append(line.strip().split(' = ')[1]) if len(data) < 2: # Not enough data raise errors.InvalidConfigFile( 'Invalid or empty configuration file!' ) username, password = decode_auth(data[0]) return {'auths': { INDEX_NAME: { 'username': username, 'password': password, 'email': data[1], 'serveraddress': INDEX_URL, } }} except Exception as e: log.debug(e) log.debug("All parsing attempts failed - returning empty config") return {} constants.py 0000644 00000002253 15027665106 0007144 0 ustar 00 import sys from .version import __version__ DEFAULT_DOCKER_API_VERSION = '1.44' MINIMUM_DOCKER_API_VERSION = '1.24' DEFAULT_TIMEOUT_SECONDS = 60 STREAM_HEADER_SIZE_BYTES = 8 CONTAINER_LIMITS_KEYS = [ 'memory', 'memswap', 'cpushares', 'cpusetcpus' ] DEFAULT_HTTP_HOST = "127.0.0.1" DEFAULT_UNIX_SOCKET = "http+unix:///var/run/docker.sock" DEFAULT_NPIPE = 'npipe:////./pipe/docker_engine' BYTE_UNITS = { 'b': 1, 'k': 1024, 'm': 1024 * 1024, 'g': 1024 * 1024 * 1024 } INSECURE_REGISTRY_DEPRECATION_WARNING = \ 'The `insecure_registry` argument to {} ' \ 'is deprecated and non-functional. Please remove it.' IS_WINDOWS_PLATFORM = (sys.platform == 'win32') WINDOWS_LONGPATH_PREFIX = '\\\\?\\' DEFAULT_USER_AGENT = f"docker-sdk-python/{__version__}" DEFAULT_NUM_POOLS = 25 # The OpenSSH server default value for MaxSessions is 10 which means we can # use up to 9, leaving the final session for the underlying SSH connection. # For more details see: https://github.com/docker/docker-py/issues/2246 DEFAULT_NUM_POOLS_SSH = 9 DEFAULT_MAX_POOL_SIZE = 10 DEFAULT_DATA_CHUNK_SIZE = 1024 * 2048 DEFAULT_SWARM_ADDR_POOL = ['10.0.0.0/8'] DEFAULT_SWARM_SUBNET_SIZE = 24 __pycache__/version.cpython-310.pyc 0000644 00000000615 15027665106 0013154 0 ustar 00 o �h� � @ s^ z d dl mZ W dS ey. ddlmZmZ zed�ZW Y dS ey- dZY Y dS w w )� )� __version__� )�PackageNotFoundError�version�dockerz0.0.0N)�_versionr � ImportError�importlib.metadatar r � r r �D/usr/local/CyberPanel/lib/python3.10/site-packages/docker/version.py�<module> s �� __pycache__/__init__.cpython-310.pyc 0000644 00000000652 15027665106 0013227 0 ustar 00 o �h� � @ sL d dl mZ d dlmZmZ d dlmZmZ d dlm Z d dl m Z dZ dS )� )� APIClient)� DockerClient�from_env)�Context� ContextAPI)� TLSConfig)� __version__�dockerN) �apir �clientr r �contextr r �tlsr �versionr � __title__� r r �E/usr/local/CyberPanel/lib/python3.10/site-packages/docker/__init__.py�<module> s __pycache__/client.cpython-310.pyc 0000644 00000020303 15027665106 0012741 0 ustar 00 o �h � @ s� d dl mZ d dlmZmZ d dlmZ d dlmZ d dl m Z d dl m Z d dl mZ d dlmZ d d lmZ d d lmZ d d lmZ d d lmZ d d lmZ G dd� d�Zej Z dS )� )� APIClient)�DEFAULT_MAX_POOL_SIZE�DEFAULT_TIMEOUT_SECONDS��ConfigCollection��ContainerCollection��ImageCollection��NetworkCollection��NodeCollection��PluginCollection��SecretCollection��ServiceCollection��Swarm��VolumeCollection)�kwargs_from_envc @ s" e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Z ed d � �Z ed d � �Z edd� �Z edd� �Z edd� �Zedd� �Zedd� �Zedd� �Zdd� Zejje_d d � Zejje_d d � Zejje_d d!� Zejje_d"d#� Zejje_d$d%� Zejje_d&d'� Zejje_d(d)� Zd*S )+� DockerClienta� A client for communicating with a Docker server. Example: >>> import docker >>> client = docker.DockerClient(base_url='unix://var/run/docker.sock') Args: base_url (str): URL to the Docker server. For example, ``unix:///var/run/docker.sock`` or ``tcp://127.0.0.1:1234``. version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``1.35`` timeout (int): Default timeout for API calls, in seconds. tls (bool or :py:class:`~docker.tls.TLSConfig`): Enable TLS. Pass ``True`` to enable it with default options, or pass a :py:class:`~docker.tls.TLSConfig` object to use custom configuration. user_agent (str): Set a custom user agent for requests to the server. credstore_env (dict): Override environment variables when calling the credential store process. use_ssh_client (bool): If set to `True`, an ssh connection is made via shelling out to the ssh client. Ensure the ssh client is installed and configured on the host. max_pool_size (int): The maximum number of connections to save in the pool. c O s t |i |��| _d S �N)r �api��self�args�kwargs� r! �C/usr/local/CyberPanel/lib/python3.10/site-packages/docker/client.py�__init__, s zDockerClient.__init__c K sR |� dt�}|� dt�}|� dd�}|� dd�}| d||||d�tdi |����S ) a� Return a client configured from environment variables. The environment variables used are the same as those used by the Docker command-line client. They are: .. envvar:: DOCKER_HOST The URL to the Docker host. .. envvar:: DOCKER_TLS_VERIFY Verify the host against a CA certificate. .. envvar:: DOCKER_CERT_PATH A path to a directory containing TLS certificates to use when connecting to the Docker host. Args: version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``auto`` timeout (int): Default timeout for API calls, in seconds. max_pool_size (int): The maximum number of connections to save in the pool. environment (dict): The environment to read environment variables from. Default: the value of ``os.environ`` credstore_env (dict): Override environment variables when calling the credential store process. use_ssh_client (bool): If set to `True`, an ssh connection is made via shelling out to the ssh client. Ensure the ssh client is installed and configured on the host. Example: >>> import docker >>> client = docker.from_env() .. _`SSL version`: https://docs.python.org/3.5/library/ssl.html#ssl.PROTOCOL_TLSv1 �timeout� max_pool_size�versionN�use_ssh_clientF)r$ r% r& r' r! )�popr r r )�clsr r$ r% r& r' r! r! r" �from_env/ s + � �zDockerClient.from_envc C � t | d�S )z� An object for managing configs on the server. See the :doc:`configs documentation <configs>` for full details. ��clientr �r r! r! r" �configsg � zDockerClient.configsc C r+ )z� An object for managing containers on the server. See the :doc:`containers documentation <containers>` for full details. r, r r. r! r! r" � containerso r0 zDockerClient.containersc C r+ )z� An object for managing images on the server. See the :doc:`images documentation <images>` for full details. r, r r. r! r! r" �imagesw r0 zDockerClient.imagesc C r+ )z� An object for managing networks on the server. See the :doc:`networks documentation <networks>` for full details. r, r r. r! r! r" �networks r0 zDockerClient.networksc C r+ )z� An object for managing nodes on the server. See the :doc:`nodes documentation <nodes>` for full details. r, r r. r! r! r" �nodes� r0 zDockerClient.nodesc C r+ )z� An object for managing plugins on the server. See the :doc:`plugins documentation <plugins>` for full details. r, r r. r! r! r" �plugins� r0 zDockerClient.pluginsc C r+ )z� An object for managing secrets on the server. See the :doc:`secrets documentation <secrets>` for full details. r, r r. r! r! r" �secrets� r0 zDockerClient.secretsc C r+ )z� An object for managing services on the server. See the :doc:`services documentation <services>` for full details. r, r r. r! r! r" �services� r0 zDockerClient.servicesc C r+ )z� An object for managing a swarm on the server. See the :doc:`swarm documentation <swarm>` for full details. r, r r. r! r! r" �swarm� r0 zDockerClient.swarmc C r+ )z� An object for managing volumes on the server. See the :doc:`volumes documentation <volumes>` for full details. r, r r. r! r! r" �volumes� r0 zDockerClient.volumesc O � | j j|i |��S r )r �eventsr r! r! r" r; � � zDockerClient.eventsc C � | j �� S r )r �dfr. r! r! r" r> � � zDockerClient.dfc O r: r )r �infor r! r! r" r@ � r< zDockerClient.infoc O r: r )r �loginr r! r! r" rA � r< zDockerClient.loginc O r: r )r �pingr r! r! r" rB � r< zDockerClient.pingc O r: r )r r& r r! r! r" r& � r< zDockerClient.versionc C r= r )r �closer. r! r! r" rC � r? zDockerClient.closec C s0 d|� d�g}t t|�r|�d� td�|���)Nz('DockerClient' object has no attribute '�'z�In Docker SDK for Python 2.0, this method is now on the object APIClient. See the low-level API section of the documentation for more details.� )�hasattrr �append�AttributeError�join)r �name�sr! r! r" � __getattr__� s zDockerClient.__getattr__N)�__name__� __module__� __qualname__�__doc__r# � classmethodr* �propertyr/ r1 r2 r3 r4 r5 r6 r7 r8 r9 r; r r> r@ rA rB r& rC rL r! r! r! r" r sP 7 r N) � api.clientr � constantsr r �models.configsr �models.containersr � models.imagesr �models.networksr � models.nodesr �models.pluginsr �models.secretsr �models.servicesr � models.swarmr �models.volumesr �utilsr r r* r! r! r! r" �<module> s O __pycache__/tls.cpython-310.pyc 0000644 00000003234 15027665106 0012271 0 ustar 00 o �h � @ s& d dl Z ddlmZ G dd� d�ZdS )� N� )�errorsc @ s. e Zd ZdZdZdZdZddd�Zdd� ZdS )� TLSConfigaj TLS configuration. Args: client_cert (tuple of str): Path to client cert, path to client key. ca_cert (str): Path to CA cert file. verify (bool or str): This can be a bool or a path to a CA cert file to verify against. If ``True``, verify using ca_cert; if ``False`` or not specified, do not verify. Nc C s� |r0z|\}}W n t y t�d�d �w |r&|r&tj�|�r&tj�|�s+t�d��||f| _|| _|| _| jrH| jrJtj�| j�sLt�d��d S d S d S )Nz=client_cert must be a tuple of (client certificate, key file)zRPath to a certificate and key files must be provided through the client_cert paramz.Invalid CA certificate provided for `ca_cert`.) � ValueErrorr �TLSParameterError�os�path�isfile�cert�verify�ca_cert)�self� client_certr r �tls_cert�tls_key� r �@/usr/local/CyberPanel/lib/python3.10/site-packages/docker/tls.py�__init__ s0 ��� �� � �zTLSConfig.__init__c C s4 | j r | jr | j|_ n| j |_ | jr| j|_dS dS )z< Configure a client with these TLS options. N)r r r )r �clientr r r �configure_client9 s �zTLSConfig.configure_client)NNN) �__name__� __module__� __qualname__�__doc__r r r r r r r r r r s $r )r � r r r r r r �<module> s __pycache__/constants.cpython-310.pyc 0000644 00000002214 15027665106 0013500 0 ustar 00 o �h� � @ s� d dl Z ddlmZ dZdZdZdZg d�Zd Zd Z d Z dd d dd�Z dZ e j dkZdZde� �ZdZdZdZdZdgZdZdS )� N� )� __version__z1.44z1.24�< � )�memory�memswap� cpushares� cpusetcpusz 127.0.0.1z http+unix:///var/run/docker.sockz npipe:////./pipe/docker_enginei i i @)�b�k�m�gzZThe `insecure_registry` argument to {} is deprecated and non-functional. Please remove it.�win32z\\?\zdocker-sdk-python/� � � i z 10.0.0.0/8� )�sys�versionr �DEFAULT_DOCKER_API_VERSION�MINIMUM_DOCKER_API_VERSION�DEFAULT_TIMEOUT_SECONDS�STREAM_HEADER_SIZE_BYTES�CONTAINER_LIMITS_KEYS�DEFAULT_HTTP_HOST�DEFAULT_UNIX_SOCKET� DEFAULT_NPIPE� BYTE_UNITS�%INSECURE_REGISTRY_DEPRECATION_WARNING�platform�IS_WINDOWS_PLATFORM�WINDOWS_LONGPATH_PREFIX�DEFAULT_USER_AGENT�DEFAULT_NUM_POOLS�DEFAULT_NUM_POOLS_SSH�DEFAULT_MAX_POOL_SIZE�DEFAULT_DATA_CHUNK_SIZE�DEFAULT_SWARM_ADDR_POOL�DEFAULT_SWARM_SUBNET_SIZE� r) r) �F/usr/local/CyberPanel/lib/python3.10/site-packages/docker/constants.py�<module> s4 � � __pycache__/errors.cpython-310.pyc 0000644 00000017215 15027665106 0013007 0 ustar 00 o �h� � @ sf d dl Z edd� dD ��ZG dd� de�Zdd� ZG d d � d e jje�ZG d d � d e�Z G d d� de �Z G dd� de�Z G dd� de�Z G dd� de�Z G dd� de�ZG dd� de�ZG dd� de�ZG dd � d ee�ZG d d � d e�ZG d d � d e�ZG d!d"� d"e�ZG d#d$� d$e�Zd%d&� ZG d'd(� d(e�ZG d)d*� d*e�ZG d+d,� d,e�ZG d-d.� d.e�Z dS )/� Nc c s � | ]}|� � V qd S �N)�lower��.0�fragment� r �C/usr/local/CyberPanel/lib/python3.10/site-packages/docker/errors.py� <genexpr> s � �r )z no such imagez+not found: does not exist or no pull accesszrepository does not existz3was found but does not match the specified platformc @ s e Zd ZdZdS )�DockerExceptionz� A base class from which all other exceptions inherit. If you want to catch all errors that the Docker SDK might raise, catch this base exception. N)�__name__� __module__� __qualname__�__doc__r r r r r s r c s� | j }z|�� d }W n ty |jpd�� }Y nw t}|jdkr9|p&d�� � t� fdd�t D ��r7t }nt }|| ||d�| �)zH Create a suitable APIError from requests.exceptions.HTTPError. �message� i� c 3 s � | ]}|� v V qd S r r r ��explanation_msgr r r " s � �z7create_api_error_from_http_exception.<locals>.<genexpr>)�response� explanation) r �json� ValueError�text�strip�APIError� status_coder �any�&_image_not_found_explanation_fragments� ImageNotFound�NotFound)�er r �clsr r r �$create_api_error_from_http_exception s � �r! c sR e Zd ZdZd� fdd� Z� fdd�Zedd� �Zd d � Zd d � Z d d� Z � Z S )r z% An HTTP error from the API. Nc s t � �|� || _|| _d S r )�super�__init__r r )�selfr r r �� __class__r r r# . s zAPIError.__init__c sx t � �� }| �� r| jj� d| jj� d| jj� �}n| �� r.| jj� d| jj� d| jj� �}| jr:|� d| j� d�}|S )Nz Client Error for �: z Server Error for z ("z")) r" �__str__�is_client_errorr r �url�reason�is_server_errorr )r$ r r% r r r( 5 s$ ��� ���zAPIError.__str__c C s | j d ur | j jS d S r )r r �r$ r r r r I s �zAPIError.status_codec C s | � � p| �� S r )r) r, r- r r r �is_errorN s zAPIError.is_errorc C �( | j d u rdS d| j kodk S S )NFi� �� �r r- r r r r) Q � zAPIError.is_client_errorc C r/ )NFr0 iX r1 r- r r r r, V r2 zAPIError.is_server_error)NN) r r r r r# r( �propertyr r. r) r, � __classcell__r r r% r r * s r c @ � e Zd ZdS )r N�r r r r r r r r \ � r c @ r5 )r Nr6 r r r r r ` r7 r c @ r5 )�InvalidVersionNr6 r r r r r8 d r7 r8 c @ r5 )�InvalidRepositoryNr6 r r r r r9 h r7 r9 c @ r5 )�InvalidConfigFileNr6 r r r r r: l r7 r: c @ r5 )�InvalidArgumentNr6 r r r r r; p r7 r; c @ r5 )�DeprecatedMethodNr6 r r r r r< t r7 r< c @ � e Zd Zdd� Zdd� ZdS )�TLSParameterErrorc C � || _ d S r ��msg�r$ rA r r r r# y � zTLSParameterError.__init__c C s | j d S )Nz�. TLS configurations should map the Docker CLI client configurations. See https://docs.docker.com/engine/articles/https/ for API details.r@ r- r r r r( | rC zTLSParameterError.__str__N�r r r r# r( r r r r r> x � r> c @ r5 )� NullResourceNr6 r r r r rF � r7 rF c s e Zd ZdZ� fdd�Z� ZS )�ContainerErrorzK Represents a container that has exited with a non-zero exit code. c sZ || _ || _|| _|| _|| _|d urd|� �nd}t� �d|� d|� d|� |� �� d S )Nr' r z Command 'z ' in image 'z ' returned non-zero exit status )� container� exit_status�command�image�stderrr" r# )r$ rH rI rJ rK rL �errr% r r r# � s ���zContainerError.__init__)r r r r r# r4 r r r% r rG � s rG c @ s e Zd Zdd� ZdS )�StreamParseErrorc C r? r r@ )r$ r+ r r r r# � rC zStreamParseError.__init__N)r r r r# r r r r rN � s rN c s e Zd Z� fdd�Z� ZS )� BuildErrorc s t � �|� || _|| _d S r )r" r# rA � build_log)r$ r+ rP r% r r r# � s zBuildError.__init__)r r r r# r4 r r r% r rO � s rO c @ r5 )�ImageLoadErrorNr6 r r r r rQ � r7 rQ c C s^ dd� t |�D �}| � d�g}t|�dkr|�d� n|�d� |�d�|�� td�|��S ) Nc S s g | ]}d |� d ��qS )�'r )r �kr r r � <listcomp>� s z2create_unexpected_kwargs_error.<locals>.<listcomp>z() � z#got an unexpected keyword argument z!got unexpected keyword arguments z, r )�sorted�len�append�join� TypeError)�name�kwargs� quoted_kwargsr r r r � create_unexpected_kwargs_error� s r^ c @ r= )�MissingContextParameterc C r? r ��param)r$ ra r r r r# � rC z MissingContextParameter.__init__c C s d| j � �S )Nzmissing parameter: r` r- r r r r( � s z MissingContextParameter.__str__NrD r r r r r_ � rE r_ c @ r= )�ContextAlreadyExistsc C r? r �r[ �r$ r[ r r r r# � rC z ContextAlreadyExists.__init__c C � d| j � d�S )Nzcontext z already existsrc r- r r r r( � � z ContextAlreadyExists.__str__NrD r r r r rb � rE rb c @ r= )�ContextExceptionc C r? r r@ rB r r r r# � rC zContextException.__init__c C s | j S r r@ r- r r r r( � s zContextException.__str__NrD r r r r rg � rE rg c @ r= )�ContextNotFoundc C r? r rc rd r r r r# � rC zContextNotFound.__init__c C re )Nz context 'z ' not foundrc r- r r r r( � rf zContextNotFound.__str__NrD r r r r rh � rE rh ) �requests� frozensetr � Exceptionr r! � exceptions� HTTPErrorr r r r8 r9 r: r; r< r> r rF rG � RuntimeErrorrN rO rQ r^ r_ rb rg rh r r r r �<module> s2 � 2 __pycache__/auth.cpython-310.pyc 0000644 00000023023 15027665106 0012426 0 ustar 00 o �h�2 � @ s� d dl Z d dlZd dlZddlmZmZ ddlmZ dZde� d�Z dZ e� e �Z d d � Zd d � Zd d� Zdd� Zdd� ZG dd� de�Zd$dd�Zdd� Zdd� Zdd � Zd%d d �Zd&d d!�Zd"d#� ZdS )'� N� )� credentials�errors)�configz docker.iozhttps://index.z/v1/z<token>c C s\ d| v r t �d| � d���t| �\}}|d dks |d dkr(t �d|� d���t|�|fS ) Nz://z)Repository name cannot contain a scheme (�)r �-���zInvalid index name (z%). Cannot begin or end with a hyphen.)r �InvalidRepository�split_repo_name�resolve_index_name)� repo_name� index_name� remote_name� r �A/usr/local/CyberPanel/lib/python3.10/site-packages/docker/auth.py�resolve_repository_name s � � r c C s t | �} | dt� �kr t} | S )Nzindex.)�convert_to_hostname� INDEX_NAME)r r r r r s r c C sf t �d� | jr | jjrt �d� t| jd�| _t| j|| jd�}|r,t �d� t|�S t �d� d S )NzLooking for auth configz2No auth config in memory - loading from filesystem)� credstore_envzFound auth configzNo auth config found)�log�debug� _auth_configs�is_empty� load_configr �resolve_authconfig� encode_header)�client�registry�authcfgr r r �get_config_header% s � � r c C sL | � dd�}t|�dks d|d vr"d|d vr"|d dkr"t| fS t|�S )N�/r �.r �:� localhost)�split�lenr �tuple)r �partsr r r r ; s $r c C s t | t�s t| �} | �|�S �N)� isinstance� AuthConfig�get_credential_store)� authconfigr r r r r+ E s r+ c @ s� e Zd Zd dd�Zed dd��Zed dd��Zed d � �Zed d � �Z ed d� �Z edd� �Z d dd�Z dd� Z dd� Zdd� Zdd� Zdd � ZdS ) r* Nc C s* d|vri |d< | � |� || _i | _d S �N�auths)�update�_credstore_env�_stores)�self�dctr r r r �__init__L s zAuthConfig.__init__Fc C s� i }|� � D ]g\}}t|t�s&t�d|� d�� |r"t�d|� ���i S d|v r;t�d|� �� d|d i||< qd|vrMt�d|� d �� i ||< qt|d �\}}t�d |�d |�d �� |||�d �|d�||< q|S )a Parses authentication entries Args: entries: Dict of authentication entries. raise_on_error: If set to true, an invalid format will raise InvalidConfigFile Returns: Authentication registry. zConfig entry for key z is not auth configz#Invalid configuration for registry � identitytokenz*Found an IdentityToken entry for registry � IdentityToken�authzAuth data for z> is absent. Client might be using a credentials store instead.zFound entry (registry=z , username=r �email��username�passwordr8 � serveraddress) �itemsr) �dictr r r �InvalidConfigFile� decode_auth�get)�cls�entries�raise_on_error�confr �entryr: r; r r r � parse_authS s@ ��� �� �zAuthConfig.parse_authc C sH |sKt �|�}|s| i |�S zt|�� }t�|�}W d � n1 s#w Y W n! tttfyJ } zt� |� | t |�|�W Y d}~S d}~ww i }|� d�rft� d� |� d| j |�d�dd�i� |� d�rzt� d� |� d|�d�i� |� d�r�t� d � |� d|�d�i� |r�| ||�S t� d � | d| � |�i|�S ) a8 Loads authentication data from a Docker configuration file in the given root directory or if config_path is passed use given path. Lookup priority: explicit config_path parameter > DOCKER_CONFIG environment variable > ~/.docker/config.json > ~/.dockercfg Nr. zFound 'auths' sectionT)rD � credsStorezFound 'credsStore' section� credHelperszFound 'credHelpers' sectionzNCouldn't find auth-related section ; attempting to interpret as auth-only file)r �find_config_file�open�json�load�OSError�KeyError� ValueErrorr r �_load_legacy_configrA r/ rG �pop)rB � config_path� config_dictr � config_file�f�e�resr r r r � sD �� �� �� �zAuthConfig.load_configc C � | � di �S r- �rA �r2 r r r r. � � zAuthConfig.authsc C s | � dd �S )NrH rZ r[ r r r � creds_store� r\ zAuthConfig.creds_storec C rY )NrI rZ r[ r r r � cred_helpers� r\ zAuthConfig.cred_helpersc C s | j o | j o | j S r( )r. r] r^ r[ r r r r � s �zAuthConfig.is_emptyc C s� | j s| jr)| �|�}|dur)t�d|� d�� | �||�}|dur$|S t�d� |r/t|�nt}t�dt|�� �� || j v rOt�dt|�� �� | j | S | j � � D ]\}}t|�|krlt�dt|�� �� | S qTt�d� dS )a+ Returns the authentication data from the given auth configuration for a specific registry. As with the Docker client, legacy entries in the config with full URLs are stripped down to hostnames before checking for a match. Returns None if no match was found. NzUsing credentials store "�"z/No entry in credstore - fetching from auth dict�Looking for auth entry for zFound �No entry found) r] r^ r+ r r � _resolve_authconfig_credstorer r �reprr. r= )r2 r � store_name�cfg�keyrE r r r r � s, � � z AuthConfig.resolve_authconfigc C s� |r|t krt}t�dt|�� �� | �|�}z'|�|�}d|i}|d tkr0|d |d< |W S |�|d |d d�� |W S t j yN t�d� Y d S t j ye } z t � dt|�� ��|�d }~ww ) Nr` � ServerAddress�Username�Secretr6 )rh �Passwordra zCredentials store error: )r � INDEX_URLr r rc �_get_store_instancerA �TOKEN_USERNAMEr/ r �CredentialsNotFound� StoreErrorr �DockerException)r2 r �credstore_name�store�datarX rW r r r rb � s6 � �� ����z(AuthConfig._resolve_authconfig_credstorec C s* || j vrtj|| jd�| j |< | j | S )N)� environment)r1 r �Storer0 )r2 �namer r r rl s � z AuthConfig._get_store_instancec C s" |r|t krt}| j�|�p| jS r( )r rk r^ rA r] )r2 r r r r r+ s z AuthConfig.get_credential_storec C s� | j �� }| jr(| �| j�}|�� �� D ]}| �|| j�||< || |t|�< q| j� � D ]\}}| �||�||< || |t|�< q-|S r( ) r. �copyr] rl �list�keysrb r r^ r= )r2 � auth_datarr �k�regrd r r r �get_all_credentials s ��z AuthConfig.get_all_credentialsc C s || d |< d S r- r )r2 r| rs r r r �add_auth1 s zAuthConfig.add_authr( �F)�__name__� __module__� __qualname__r4 � classmethodrG r �propertyr. r] r^ r r rb rl r+ r} r~ r r r r r* K s( ; / # r* c C s t | t�s t| |�} | �|�S r( )r) r* r )r, r r r r r r 5 s r c C s | � dd�� dd��dd�d S )Nzhttp://� zhttps://r r r )�replacer$ )�urlr r r r ; s r c C sB t | t�r | �d�} t�| �}|�dd�\}}|�d�|�d�fS )N�ascii� :r �utf8)r) �str�encode�base64� b64decoder$ �decode)r7 �s�login�pwdr r r r@ ? s r@ c C s t �| ��d�}t�|�S )Nr� )rL �dumpsr� r� �urlsafe_b64encode)r7 � auth_jsonr r r r G s r Fc C s t �| |�S )a Parses authentication entries Args: entries: Dict of authentication entries. raise_on_error: If set to true, an invalid format will raise InvalidConfigFile Returns: Authentication registry. )r* rG )rC rD r r r rG L s rG c C s t �| ||�S r( )r* r )rS rT r r r r r \ s r c C s� t �d� zJg }t| ��&}|�� D ]}|�|�� �d�d � qt|�dk r+t� d��W d � n1 s5w Y t |d �\}}dt |||d t d�iiW S t yf } z t �|� W Y d }~nd }~ww t �d � i S ) Nz+Attempting to parse legacy auth file formatz = r � z$Invalid or empty configuration file!r r. r9 z4All parsing attempts failed - returning empty config)r r rK � readlines�append�stripr$ r% r r? r@ r rk � Exception)rU rs rV �liner: r; rW r r r rQ ` s6 �� � ���� rQ )NNr )NNN) r� rL �loggingr� r r �utilsr r rk rm � getLoggerr� r r r r r r+ r> r* r r r@ r rG r rQ r r r r �<module> s. k __pycache__/_version.cpython-310.pyc 0000644 00000000745 15027665106 0013317 0 ustar 00 o �h� � @ sh U d Z e rddlmZmZ eeeef df ZneZeed< eed< eed< eed< d Z Z d Z Z d S ) F� )�Tuple�Union.�version� __version__�__version_tuple__� version_tuplez7.1.0)� � r N) � TYPE_CHECKING�typingr r �int�str� VERSION_TUPLE�object�__annotations__r r r r � r r �E/usr/local/CyberPanel/lib/python3.10/site-packages/docker/_version.py�<module> s tls.py 0000644 00000004420 15027665106 0005730 0 ustar 00 import os from . import errors class TLSConfig: """ TLS configuration. Args: client_cert (tuple of str): Path to client cert, path to client key. ca_cert (str): Path to CA cert file. verify (bool or str): This can be a bool or a path to a CA cert file to verify against. If ``True``, verify using ca_cert; if ``False`` or not specified, do not verify. """ cert = None ca_cert = None verify = None def __init__(self, client_cert=None, ca_cert=None, verify=None): # Argument compatibility/mapping with # https://docs.docker.com/engine/articles/https/ # This diverges from the Docker CLI in that users can specify 'tls' # here, but also disable any public/default CA pool verification by # leaving verify=False # "client_cert" must have both or neither cert/key files. In # either case, Alert the user when both are expected, but any are # missing. if client_cert: try: tls_cert, tls_key = client_cert except ValueError: raise errors.TLSParameterError( 'client_cert must be a tuple of' ' (client certificate, key file)' ) from None if not (tls_cert and tls_key) or (not os.path.isfile(tls_cert) or not os.path.isfile(tls_key)): raise errors.TLSParameterError( 'Path to a certificate and key files must be provided' ' through the client_cert param' ) self.cert = (tls_cert, tls_key) # If verify is set, make sure the cert exists self.verify = verify self.ca_cert = ca_cert if self.verify and self.ca_cert and not os.path.isfile(self.ca_cert): raise errors.TLSParameterError( 'Invalid CA certificate provided for `ca_cert`.' ) def configure_client(self, client): """ Configure a client with these TLS options. """ if self.verify and self.ca_cert: client.verify = self.ca_cert else: client.verify = self.verify if self.cert: client.cert = self.cert utils/fnmatch.py 0000644 00000006337 15027665106 0007717 0 ustar 00 """Filename matching with shell patterns. fnmatch(FILENAME, PATTERN) matches according to the local convention. fnmatchcase(FILENAME, PATTERN) always takes case in account. The functions operate by translating the pattern into a regular expression. They cache the compiled regular expressions for speed. The function translate(PATTERN) returns a regular expression corresponding to PATTERN. (It does not compile it.) """ import re __all__ = ["fnmatch", "fnmatchcase", "translate"] _cache = {} _MAXCACHE = 100 def _purge(): """Clear the pattern cache""" _cache.clear() def fnmatch(name, pat): """Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN). """ name = name.lower() pat = pat.lower() return fnmatchcase(name, pat) def fnmatchcase(name, pat): """Test whether FILENAME matches PATTERN, including case. This is a version of fnmatch() which doesn't case-normalize its arguments. """ try: re_pat = _cache[pat] except KeyError: res = translate(pat) if len(_cache) >= _MAXCACHE: _cache.clear() _cache[pat] = re_pat = re.compile(res) return re_pat.match(name) is not None def translate(pat): """Translate a shell PATTERN to a regular expression. There is no way to quote meta-characters. """ i, n = 0, len(pat) res = '^' while i < n: c = pat[i] i = i + 1 if c == '*': if i < n and pat[i] == '*': # is some flavor of "**" i = i + 1 # Treat **/ as ** so eat the "/" if i < n and pat[i] == '/': i = i + 1 if i >= n: # is "**EOF" - to align with .gitignore just accept all res = f"{res}.*" else: # is "**" # Note that this allows for any # of /'s (even 0) because # the .* will eat everything, even /'s res = f"{res}(.*/)?" else: # is "*" so map it to anything but "/" res = f"{res}[^/]*" elif c == '?': # "?" is any char except "/" res = f"{res}[^/]" elif c == '[': j = i if j < n and pat[j] == '!': j = j + 1 if j < n and pat[j] == ']': j = j + 1 while j < n and pat[j] != ']': j = j + 1 if j >= n: res = f"{res}\\[" else: stuff = pat[i:j].replace('\\', '\\\\') i = j + 1 if stuff[0] == '!': stuff = f"^{stuff[1:]}" elif stuff[0] == '^': stuff = f"\\{stuff}" res = f'{res}[{stuff}]' else: res = res + re.escape(c) return f"{res}$" utils/socket.py 0000644 00000011721 15027665106 0007560 0 ustar 00 import errno import os import select import socket as pysocket import struct try: from ..transport import NpipeSocket except ImportError: NpipeSocket = type(None) STDOUT = 1 STDERR = 2 class SocketError(Exception): pass # NpipeSockets have their own error types # pywintypes.error: (109, 'ReadFile', 'The pipe has been ended.') NPIPE_ENDED = 109 def read(socket, n=4096): """ Reads at most n bytes from socket """ recoverable_errors = (errno.EINTR, errno.EDEADLK, errno.EWOULDBLOCK) if not isinstance(socket, NpipeSocket): if not hasattr(select, "poll"): # Limited to 1024 select.select([socket], [], []) else: poll = select.poll() poll.register(socket, select.POLLIN | select.POLLPRI) poll.poll() try: if hasattr(socket, 'recv'): return socket.recv(n) if isinstance(socket, pysocket.SocketIO): return socket.read(n) return os.read(socket.fileno(), n) except OSError as e: if e.errno not in recoverable_errors: raise except Exception as e: is_pipe_ended = (isinstance(socket, NpipeSocket) and len(e.args) > 0 and e.args[0] == NPIPE_ENDED) if is_pipe_ended: # npipes don't support duplex sockets, so we interpret # a PIPE_ENDED error as a close operation (0-length read). return '' raise def read_exactly(socket, n): """ Reads exactly n bytes from socket Raises SocketError if there isn't enough data """ data = b"" while len(data) < n: next_data = read(socket, n - len(data)) if not next_data: raise SocketError("Unexpected EOF") data += next_data return data def next_frame_header(socket): """ Returns the stream and size of the next frame of data waiting to be read from socket, according to the protocol defined here: https://docs.docker.com/engine/api/v1.24/#attach-to-a-container """ try: data = read_exactly(socket, 8) except SocketError: return (-1, -1) stream, actual = struct.unpack('>BxxxL', data) return (stream, actual) def frames_iter(socket, tty): """ Return a generator of frames read from socket. A frame is a tuple where the first item is the stream number and the second item is a chunk of data. If the tty setting is enabled, the streams are multiplexed into the stdout stream. """ if tty: return ((STDOUT, frame) for frame in frames_iter_tty(socket)) else: return frames_iter_no_tty(socket) def frames_iter_no_tty(socket): """ Returns a generator of data read from the socket when the tty setting is not enabled. """ while True: (stream, n) = next_frame_header(socket) if n < 0: break while n > 0: result = read(socket, n) if result is None: continue data_length = len(result) if data_length == 0: # We have reached EOF return n -= data_length yield (stream, result) def frames_iter_tty(socket): """ Return a generator of data read from the socket when the tty setting is enabled. """ while True: result = read(socket) if len(result) == 0: # We have reached EOF return yield result def consume_socket_output(frames, demux=False): """ Iterate through frames read from the socket and return the result. Args: demux (bool): If False, stdout and stderr are multiplexed, and the result is the concatenation of all the frames. If True, the streams are demultiplexed, and the result is a 2-tuple where each item is the concatenation of frames belonging to the same stream. """ if demux is False: # If the streams are multiplexed, the generator returns strings, that # we just need to concatenate. return b"".join(frames) # If the streams are demultiplexed, the generator yields tuples # (stdout, stderr) out = [None, None] for frame in frames: # It is guaranteed that for each frame, one and only one stream # is not None. assert frame != (None, None) if frame[0] is not None: if out[0] is None: out[0] = frame[0] else: out[0] += frame[0] else: if out[1] is None: out[1] = frame[1] else: out[1] += frame[1] return tuple(out) def demux_adaptor(stream_id, data): """ Utility to demultiplex stdout and stderr when reading frames from the socket. """ if stream_id == STDOUT: return (data, None) elif stream_id == STDERR: return (None, data) else: raise ValueError(f'{stream_id} is not a valid stream') utils/proxy.py 0000644 00000004306 15027665106 0007452 0 ustar 00 from .utils import format_environment class ProxyConfig(dict): ''' Hold the client's proxy configuration ''' @property def http(self): return self.get('http') @property def https(self): return self.get('https') @property def ftp(self): return self.get('ftp') @property def no_proxy(self): return self.get('no_proxy') @staticmethod def from_dict(config): ''' Instantiate a new ProxyConfig from a dictionary that represents a client configuration, as described in `the documentation`_. .. _the documentation: https://docs.docker.com/network/proxy/#configure-the-docker-client ''' return ProxyConfig( http=config.get('httpProxy'), https=config.get('httpsProxy'), ftp=config.get('ftpProxy'), no_proxy=config.get('noProxy'), ) def get_environment(self): ''' Return a dictionary representing the environment variables used to set the proxy settings. ''' env = {} if self.http: env['http_proxy'] = env['HTTP_PROXY'] = self.http if self.https: env['https_proxy'] = env['HTTPS_PROXY'] = self.https if self.ftp: env['ftp_proxy'] = env['FTP_PROXY'] = self.ftp if self.no_proxy: env['no_proxy'] = env['NO_PROXY'] = self.no_proxy return env def inject_proxy_environment(self, environment): ''' Given a list of strings representing environment variables, prepend the environment variables corresponding to the proxy settings. ''' if not self: return environment proxy_env = format_environment(self.get_environment()) if not environment: return proxy_env # It is important to prepend our variables, because we want the # variables defined in "environment" to take precedence. return proxy_env + environment def __str__(self): return ( 'ProxyConfig(' f'http={self.http}, https={self.https}, ' f'ftp={self.ftp}, no_proxy={self.no_proxy}' ')' ) utils/ports.py 0000644 00000005357 15027665106 0007447 0 ustar 00 import re PORT_SPEC = re.compile( "^" # Match full string "(" # External part r"(\[?(?P<host>[a-fA-F\d.:]+)\]?:)?" # Address r"(?P<ext>[\d]*)(-(?P<ext_end>[\d]+))?:" # External range ")?" r"(?P<int>[\d]+)(-(?P<int_end>[\d]+))?" # Internal range "(?P<proto>/(udp|tcp|sctp))?" # Protocol "$" # Match full string ) def add_port_mapping(port_bindings, internal_port, external): if internal_port in port_bindings: port_bindings[internal_port].append(external) else: port_bindings[internal_port] = [external] def add_port(port_bindings, internal_port_range, external_range): if external_range is None: for internal_port in internal_port_range: add_port_mapping(port_bindings, internal_port, None) else: ports = zip(internal_port_range, external_range) for internal_port, external_port in ports: add_port_mapping(port_bindings, internal_port, external_port) def build_port_bindings(ports): port_bindings = {} for port in ports: internal_port_range, external_range = split_port(port) add_port(port_bindings, internal_port_range, external_range) return port_bindings def _raise_invalid_port(port): raise ValueError('Invalid port "%s", should be ' '[[remote_ip:]remote_port[-remote_port]:]' 'port[/protocol]' % port) def port_range(start, end, proto, randomly_available_port=False): if not start: return start if not end: return [start + proto] if randomly_available_port: return [f"{start}-{end}{proto}"] return [str(port) + proto for port in range(int(start), int(end) + 1)] def split_port(port): if hasattr(port, 'legacy_repr'): # This is the worst hack, but it prevents a bug in Compose 1.14.0 # https://github.com/docker/docker-py/issues/1668 # TODO: remove once fixed in Compose stable port = port.legacy_repr() port = str(port) match = PORT_SPEC.match(port) if match is None: _raise_invalid_port(port) parts = match.groupdict() host = parts['host'] proto = parts['proto'] or '' internal = port_range(parts['int'], parts['int_end'], proto) external = port_range( parts['ext'], parts['ext_end'], '', len(internal) == 1) if host is None: if external is not None and len(internal) != len(external): raise ValueError('Port ranges don\'t match in length') return internal, external else: if not external: external = [None] * len(internal) elif len(internal) != len(external): raise ValueError('Port ranges don\'t match in length') return internal, [(host, ext_port) for ext_port in external] utils/decorators.py 0000644 00000002724 15027665106 0010440 0 ustar 00 import functools from .. import errors from . import utils def check_resource(resource_name): def decorator(f): @functools.wraps(f) def wrapped(self, resource_id=None, *args, **kwargs): if resource_id is None and kwargs.get(resource_name): resource_id = kwargs.pop(resource_name) if isinstance(resource_id, dict): resource_id = resource_id.get('Id', resource_id.get('ID')) if not resource_id: raise errors.NullResource( 'Resource ID was not provided' ) return f(self, resource_id, *args, **kwargs) return wrapped return decorator def minimum_version(version): def decorator(f): @functools.wraps(f) def wrapper(self, *args, **kwargs): if utils.version_lt(self._version, version): raise errors.InvalidVersion( f'{f.__name__} is not available for version < {version}', ) return f(self, *args, **kwargs) return wrapper return decorator def update_headers(f): def inner(self, *args, **kwargs): if 'HttpHeaders' in self._general_configs: if not kwargs.get('headers'): kwargs['headers'] = self._general_configs['HttpHeaders'] else: kwargs['headers'].update(self._general_configs['HttpHeaders']) return f(self, *args, **kwargs) return inner utils/__pycache__/decorators.cpython-310.pyc 0000644 00000003505 15027665106 0014775 0 ustar 00 o �h� � @ s< d dl Z ddlmZ ddlmZ dd� Zdd � Zd d � ZdS ) � N� )�errors� )�utilsc � � fdd�}|S )Nc s t �� �d� �fdd� �}|S )Nc s^ |d u r|� ��r|���}t|t�r |� d|� d��}|s#t�d��� | |g|�R i |��S )N�Id�IDz Resource ID was not provided)�get�pop� isinstance�dictr � NullResource)�self� resource_id�args�kwargs)�f� resource_name� �M/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/decorators.py�wrapped s �z2check_resource.<locals>.decorator.<locals>.wrapped)N�� functools�wraps)r r �r �r r � decorator s z!check_resource.<locals>.decoratorr )r r r r r �check_resource s r c r )Nc s t �� �� �fdd��}|S )Nc s: t �| j��rt�� j� d�� ���� | g|�R i |��S )Nz is not available for version < )r � version_lt�_versionr �InvalidVersion�__name__�r r r )r �versionr r �wrapper s �z3minimum_version.<locals>.decorator.<locals>.wrapperr )r r$ �r# r r r s z"minimum_version.<locals>.decoratorr )r# r r r% r �minimum_version s r& c r )Nc sN d| j v r |�d�s| j d |d< n |d �| j d � � | g|�R i |��S )N� HttpHeaders�headers)�_general_configsr �updater" r r r �inner& s z update_headers.<locals>.innerr )r r+ r r r �update_headers% s r, )r � r r r r& r, r r r r �<module> s utils/__pycache__/socket.cpython-310.pyc 0000644 00000010470 15027665106 0014117 0 ustar 00 o �h� � @ s� d dl Z d dlZd dlZd dlZd dlZzddlmZ W n ey) e d�ZY nw dZ dZ G dd� de �Z dZdd d �Zd d � Zd d� Zdd� Zdd� Zdd� Zddd�Zdd� ZdS ) � N� )� NpipeSocket� c @ s e Zd ZdS )� SocketErrorN)�__name__� __module__� __qualname__� r r �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/socket.pyr s r �m � c C s t jt jt jf}t| t�s-ttd�st�| gg g � nt�� }|� | tj tj B � |�� z t| d�r9| � |�W S t| t j�rE| �|�W S t�| �� |�W S tyf } z |j |vr[� W Y d}~dS d}~w ty� } z t| t�ot|j�dko|jd tk}|r�W Y d}~dS � d}~ww )z+ Reads at most n bytes from socket �poll�recvNr � )�errno�EINTR�EDEADLK� EWOULDBLOCK� isinstancer �hasattr�selectr �register�POLLIN�POLLPRIr �pysocket�SocketIO�read�os�fileno�OSError� Exception�len�args� NPIPE_ENDED)�socket�n�recoverable_errorsr �e� is_pipe_endedr r r r s: �� � ���r c C sF d}t |�|k r!t| |t |� �}|std��||7 }t |�|k s|S )z] Reads exactly n bytes from socket Raises SocketError if there isn't enough data � zUnexpected EOF)r! r r )r$ r% �data� next_datar r r � read_exactly> s �r, c C s< zt | d�}W n ty Y dS w t�d|�\}}||fS )z� Returns the stream and size of the next frame of data waiting to be read from socket, according to the protocol defined here: https://docs.docker.com/engine/api/v1.24/#attach-to-a-container � )���r. z>BxxxL)r, r �struct�unpack)r$ r* �stream�actualr r r �next_frame_headerL s �r3 c C s |r dd� t | �D �S t| �S )z� Return a generator of frames read from socket. A frame is a tuple where the first item is the stream number and the second item is a chunk of data. If the tty setting is enabled, the streams are multiplexed into the stdout stream. c s s � | ]}t |fV qd S )N)�STDOUT)�.0�framer r r � <genexpr>e s � z frames_iter.<locals>.<genexpr>)�frames_iter_tty�frames_iter_no_tty)r$ �ttyr r r � frames_iter\ s r; c c sh � t | �\}}|dk rdS |dkr3t| |�}|du r qt|�}|dkr&dS ||8 }||fV |dksq)zc Returns a generator of data read from the socket when the tty setting is not enabled. Tr N)r3 r r! )r$ r1 r% �result� data_lengthr r r r9 j s � ��r9 c c s$ � t | �}t|�dkrdS |V q)z^ Return a generator of data read from the socket when the tty setting is enabled. Tr N)r r! )r$ r< r r r r8 s � �r8 Fc C s� |du r d� | �S ddg}| D ]=}|dksJ �|d dur5|d du r*|d |d< q|d |d 7 < q|d du rB|d |d< q|d |d 7 < qt|�S )a� Iterate through frames read from the socket and return the result. Args: demux (bool): If False, stdout and stderr are multiplexed, and the result is the concatenation of all the frames. If True, the streams are demultiplexed, and the result is a 2-tuple where each item is the concatenation of frames belonging to the same stream. Fr) N)NNr r )�join�tuple)�frames�demux�outr6 r r r �consume_socket_output� s rC c C s. | t kr|dfS | tkrd|fS t| � d���)z[ Utility to demultiplex stdout and stderr when reading frames from the socket. Nz is not a valid stream)r4 �STDERR� ValueError)� stream_idr* r r r � demux_adaptor� s rG )r )F)r r r r$ r r/ � transportr � ImportError�typer4 rD r r r# r r, r3 r; r9 r8 rC rG r r r r �<module> s, � $ % utils/__pycache__/ports.cpython-310.pyc 0000644 00000004455 15027665106 0014004 0 ustar 00 o �h� � @ sH d dl Z e �d�Zdd� Zdd� Zdd� Zd d � Zdd d �Zdd� ZdS )� Nz�^((\[?(?P<host>[a-fA-F\d.:]+)\]?:)?(?P<ext>[\d]*)(-(?P<ext_end>[\d]+))?:)?(?P<int>[\d]+)(-(?P<int_end>[\d]+))?(?P<proto>/(udp|tcp|sctp))?$c C s( || v r | | � |� d S |g| |< d S �N)�append)� port_bindings� internal_port�external� r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/ports.py�add_port_mapping s r c C sJ |d u r|D ]}t | |d � qd S t||�}|D ] \}}t | ||� qd S r )r �zip)r �internal_port_range�external_ranger �ports� external_portr r r �add_port s � �r c C s* i }| D ]}t |�\}}t|||� q|S r )� split_portr )r r �portr r r r r �build_port_bindings s r c C s t d| ��)NzTInvalid port "%s", should be [[remote_ip:]remote_port[-remote_port]:]port[/protocol])� ValueError)r r r r �_raise_invalid_port( s �r Fc sR | s| S |s | � gS |r| � d|� � � �gS � fdd�t t| �t|�d �D �S )N�-c s g | ]}t |�� �qS r )�str)�.0r ��protor r � <listcomp>5 s z port_range.<locals>.<listcomp>� )�range�int)�start�endr �randomly_available_portr r r � port_range. s $r! c s� t | d�r | �� } t| �} t�| �}|d u rt| � |�� }|d � |d p'd}t|d |d |�}t|d |d dt|�d k�}� d u rY|d urUt|�t|�krUt d ��||fS |scd gt|� }n t|�t|�krot d ��|� fd d �|D �fS ) N� legacy_repr�hostr � r �int_end�ext�ext_endr z!Port ranges don't match in lengthc s g | ]}� |f�qS r r )r �ext_port�r# r r r S s z split_port.<locals>.<listcomp>) �hasattrr" r � PORT_SPEC�matchr � groupdictr! �lenr )r r, �partsr �internalr r r) r r 8 s, �r )F) �re�compiler+ r r r r r! r r r r r �<module> s � utils/__pycache__/json_stream.cpython-310.pyc 0000644 00000004602 15027665106 0015153 0 ustar 00 o �h� � @ s\ d dl Z d dlZ ddlmZ e �� Zdd� Zdd� Zdd � Zdd d �Z dd d� fdd�Z dS )� N� )�StreamParseErrorc c s, � | D ]}t |t�s|�dd�}|V qdS )z� Given a stream of bytes or text, if any of the items in the stream are bytes convert them to text. This function can be removed once we return text streams instead of byte streams. zutf-8�replaceN)� isinstance�str�decode)�stream�data� r �N/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/json_stream.py�stream_as_text s � �r c C sR | � � } zt�| �\}}| tjj�| |��� d� }||fW S ty( Y dS w )z�Attempt to parse a json object from a buffer. If there is at least one object, return it and the rest of the buffer, otherwise return None. N) �strip� json_decoder� raw_decode�json�decoder� WHITESPACE�match�end� ValueError)�buffer�obj�index�restr r r � json_splitter s �r c C s t | ttj�S )z�Given a stream of text, return a stream of json objects. This handles streams which are inconsistently buffered (some entries may be newline delimited, and others are not). )� split_bufferr r r )r r r r � json_stream# s r � c C s: | � t|��}|dkr d S | d |d � | |d d � fS )N���� )�findr )r � separatorr r r r � line_splitter+ s r" c C s | S )Nr )�ar r r �<lambda>2 s r$ c c s� � |pt }d}t| �D ]}||7 } ||�}|du rn|\}}|V qq |r@z||�V W dS ty? } zt|�|�d}~ww dS )a Given a generator which yields strings and a splitter function, joins all input, splits on the separator and yields each chunk. Unlike string.split(), each chunk includes the trailing separator, except for the last one if none was found on the end of the input. � TN)r" r � Exceptionr )r �splitterr �bufferedr � buffer_split�item�er r r r 2 s* � � ���r )r ) r � json.decoder�errorsr � JSONDecoderr r r r r" r r r r r �<module> s utils/__pycache__/proxy.cpython-310.pyc 0000644 00000004762 15027665106 0014017 0 ustar 00 o �h� � @ s d dl mZ G dd� de�ZdS )� )�format_environmentc @ sd e Zd ZdZedd� �Zedd� �Zedd� �Zedd � �Ze d d � �Z d d � Z dd� Z dd� Z dS )� ProxyConfigz/ Hold the client's proxy configuration c C � | � d�S )N�http��get��self� r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/proxy.pyr � zProxyConfig.httpc C r )N�httpsr r r r r r r zProxyConfig.httpsc C r )N�ftpr r r r r r r zProxyConfig.ftpc C r )N�no_proxyr r r r r r r zProxyConfig.no_proxyc C s( t | �d�| �d�| �d�| �d�d�S )a Instantiate a new ProxyConfig from a dictionary that represents a client configuration, as described in `the documentation`_. .. _the documentation: https://docs.docker.com/network/proxy/#configure-the-docker-client � httpProxy� httpsProxy�ftpProxy�noProxy�r r r r )r r )�configr r r � from_dict s �zProxyConfig.from_dictc C sh i }| j r| j |d< |d< | jr| j |d< |d< | jr&| j |d< |d< | jr2| j |d< |d< |S ) zt Return a dictionary representing the environment variables used to set the proxy settings. � http_proxy� HTTP_PROXY� https_proxy� HTTPS_PROXY� ftp_proxy� FTP_PROXYr �NO_PROXYr )r �envr r r �get_environment( s zProxyConfig.get_environmentc C s$ | s|S t | �� �}|s|S || S )z� Given a list of strings representing environment variables, prepend the environment variables corresponding to the proxy settings. )r r )r � environment� proxy_envr r r �inject_proxy_environment8 s z$ProxyConfig.inject_proxy_environmentc C s& d| j � d| j� d| j� d| j� d� S )NzProxyConfig(http=z, https=z, ftp=z , no_proxy=�)r r r r r �__str__G s �����zProxyConfig.__str__N)�__name__� __module__� __qualname__�__doc__�propertyr r r r � staticmethodr r r" r$ r r r r r s r N)�utilsr �dictr r r r r �<module> s utils/__pycache__/__init__.cpython-310.pyc 0000644 00000001762 15027665106 0014372 0 ustar 00 o �h� � @ s� d dl mZmZmZmZmZ d dlmZmZm Z d dl m Z m Z m Z mZmZmZmZmZmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z m Z dS )� )�create_archive� exclude_paths� match_tag�mkbuildcontext�tar)�check_resource�minimum_version�update_headers)�compare_version�convert_filters�convert_port_bindings�convert_service_networks�convert_volume_binds�create_host_config�create_ipam_config�create_ipam_pool�datetime_to_timestamp�decode_json_header�format_environment�format_extra_hosts�kwargs_from_env�normalize_links� parse_bytes� parse_devices�parse_env_file� parse_host�parse_repository_tag� split_command� version_gte� version_ltN)!�buildr r r r r � decoratorsr r r �utilsr r r r r r r r r r r r r r r r r r r r r r � r# r# �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/__init__.py�<module> s d utils/__pycache__/utils.cpython-310.pyc 0000644 00000026160 15027665106 0013772 0 ustar 00 o �h,7 � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlmZmZ d dl m Z d dl m Z d dl mZmZ ddlmZ ddlmZmZmZmZ dd lmZ e�d d �Zd d � Zdd� Z dd� Z e dd�dd� �Z dd� Z dd� Z dd� Z!dd � Z"d d � Z#d d � Z$d!d"� Z%d#d$� Z&d>d&d'�Z'd(d)� Z(d?d*d+�Z)d,d-� Z*d.d/� Z+d0d1� Z,d2d3� Z-d4d5� Z.d6d7� Z/d8d9� Z0d@d:d;�Z1d<d=� Z2dS )A� N)�datetime�timezone)� lru_cache)� zip_longest)�urlparse� urlunparse� )�errors)� BYTE_UNITS�DEFAULT_HTTP_HOST� DEFAULT_NPIPE�DEFAULT_UNIX_SOCKET)� TLSConfig� URLComponentsz'scheme netloc url params query fragmentc O � t �d��)Nz[utils.create_ipam_pool has been removed. Please use a docker.types.IPAMPool object instead.�r �DeprecatedMethod��args�kwargs� r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/utils.py�create_ipam_pool � �r c O r )Nz_utils.create_ipam_config has been removed. Please use a docker.types.IPAMConfig object instead.r r r r r �create_ipam_config# r r c C s t �| �}|�d�}t�|�S )N�utf-8)�base64� b64decode�decode�json�loads)�header�datar r r �decode_json_header* s r# )�maxsizec C st | |krdS t dd� | �d�D ��}t dd� |�d�D ��}t||dd�D ]\}}||kr.q%||kr5 dS dS dS ) z�Compare docker versions >>> v1 = '1.9' >>> v2 = '1.10' >>> compare_version(v1, v2) 1 >>> compare_version(v2, v1) -1 >>> compare_version(v2, v2) 0 r c s � � | ]}t |�V qd S �N��int��.0�pr r r � <genexpr>@ � � z"compare_version.<locals>.<genexpr>�.c s r% r& r' r) r r r r, A r- )� fillvalue���� )�tuple�splitr )�v1�v2�s1�s2�c1�c2r r r �compare_version0 s r: c C s t | |�dkS )Nr )r: �r4 r5 r r r � version_ltM s r< c C s t | |� S r& )r< r; r r r � version_gteQ s r= c C s� ddd�}t | t�r2t| �dkr | d |d< | d |d< n7t | d t�r+| d |d< n)| d |d< n"t | t�rPd| v rL| d |d< d| v rK| d |d< nt| ��| |d< |d d u r`d|d< |S t|d �|d< |S )N� )�HostIp�HostPortr r1 r@ r r? )� isinstancer2 �len�str�dict� ValueError)�binding�resultr r r �_convert_port_bindingU s* � �rH c C sb i }t | �� �D ]&\}}t|�}d|vr|d7 }t|t�r'dd� |D �||< qt|�g||< q|S )N�/z/tcpc S s g | ]}t |��qS r )rH )r* rF r r r � <listcomp>x � z)convert_port_bindings.<locals>.<listcomp>)�iter�itemsrC rA �listrH )� port_bindingsrG �k�v�keyr r r �convert_port_bindingsq s rS c C s2 t | t�r| S g }| �� D ]�\}}t |t�r|�d�}t |t�r�d|v r/d|v r/td|����|d }t |t�r=|�d�}d|v rJ|d rGdnd}n d|v rS|d }nd}g d�}d|v rs|d |v rs|ro|� d |d � �}n|d }|�|� d |� d |� �� q t |t�r�|�d�}|�|� d |� d �� q |S ) Nr �ro�modez-Binding cannot contain both "ro" and "mode": �bind�rw)�rshared�shared�rslave�slave�rprivate�private� propagation�,�:z:rw)rA rN rM �bytesr rD rE �append)�bindsrG rP rQ rV rU �propagation_modesr r r �convert_volume_binds~ sB � � �re c C s� t | t�r| S t | t�stdt| �j� ���i }| D ]'}t |t�r3d|v r.|�dd�\}}n|}d}n tdt|�j� ���|||< q|S )Nz;Expected tmpfs value to be either a list or a dict, found: r` r1 r> z3Expected item in tmpfs list to be a string, found: )rA rD rN rE �type�__name__rC r3 )�tmpfsrG �mount�name�optionsr r r �convert_tmpfs_mounts� s, �� �� rl c C sH | s| S t | t�s td��g }| D ]}t |t�r d|i}|�|� q|S )Nz"networks parameter must be a list.�Target)rA rN � TypeErrorrC rb )�networksrG �nr r r �convert_service_networks� s rq c C sT | � dd�}t|�dkrt|�S | � dd�}t|�dkr&d|d vr&t|�S | d fS )N�@r1 r r` rI )�rsplitrB r2 )� repo_name�partsr r r �parse_repository_tag� s rv Fc C s | s|rt S | r| �� dkrtS | �� } t| �}|j}|r&tdd� |D ��r0td| � �d�}d}|dkr9t�d��|dksA|d krH|d k}d}n|d krNd }|d vrZt�d | � ���|dkri|jsit�d| � ���t|j |j |j |j g�r}t�d| � ���|j r�|dkr�t�d| � ���|j }|d kr�|jd ur�|j� d|� �}|j}|dv r�|jp�d}|dkr�|dkr�t�d| � ���d}|j� d|� �}|js�t� d|� �}|dkr�d|r�dnd� �}n|d kr�d }|dv r�|� d|� ��d�S tt|||dddd���d�S ) Nzunix://c s s � | ] }|t j� d �vV qdS )�+N)�string� ascii_letters)r* �xr r r r, � s � z parse_host.<locals>.<genexpr>z//�tcp�fdz fd protocol is not implemented�http�https� http+unix�unix)r{ r� �npipe�sshz Invalid bind address protocol: z Invalid bind address format: r� z@Invalid bind address format: no path allowed for this protocol: rI )r{ r� r z/Invalid bind address format: port is required: � r` �sr> )r r� z://)�scheme�netloc�url�params�query�fragment)r �stripr r r� �anyr �DockerExceptionr� r� r� r� �password�path�hostname�portr �rstripr r )�addr�is_win32�tls� parsed_url�protor� r� r� r r r � parse_host� s� �� ��� ���r� c C s� g }| D ]J}t |t�r|�|� qt |t�s t�dt|�� ���|�d�}|rN|d }t|�dkr6|d }n|}t|�dkrC|d }nd}|�|||d�� q|S )NzInvalid device type r` r r1 r �rwm)� PathOnHost�PathInContainer�CgroupPermissions) rA rD rb rC r r� rf r3 rB )�devices� device_list�device�device_mapping� path_on_host�path_in_container� permissionsr r r � parse_devicesD s2 � ��r� c C s� | st j} | �d�}| �d�pd }| �d�}|dkr d}n|d u}|p$|}i }|r-||d< |s1|S |s>t j�t j�d�d�}tt j�|d �t j�|d �ft j�|d �|d �|d < |S )N� DOCKER_HOST�DOCKER_CERT_PATH�DOCKER_TLS_VERIFYr> F�base_url�~z.dockerzcert.pemzkey.pemzca.pem)� client_cert�ca_cert�verifyr� )�os�environ�getr� �join� expanduserr )� environment�host� cert_path� tls_verify� enable_tlsr� r r r �kwargs_from_enva s0 � �r� c C s\ i }t | �� �D ] \}}t|t�r|rdnd}t|t�s |g}dd� |D �||< qt�|�S )N�true�falsec S s" g | ] }t |t�s t|�n|�qS r )rA rC )r* �itemr r r rJ � s ��z#convert_filters.<locals>.<listcomp>)rL rM rA �boolrN r �dumps)�filtersrG rP rQ r r r �convert_filters� s � r� c C s2 | � tj�tdddtjd� }|j|jd d S )z&Convert a datetime to a Unix timestampi� r1 )�tzinfo� i )� astimezoner �utcr �seconds�days)�dt�deltar r r �datetime_to_timestamp� s r� c C s t | ttf�r | S t| �dkrdS | dd� �� r1| d �� r1| d dks+| d dkr1| d d� } t}| d �� }|�� rB| }d}n| d d� }||�� v sR|�� ryzt|�}W n t yn } z t � d|� d��|�d }~ww t||| �} | S t � d| � d ���) Nr ���r0 �b�Bz/Failed converting the string value for memory (z) to an integer.z The specified value for memory (zW) should specify the units. The postfix should be one of the `b` `k` `m` `g` characters) rA r( �floatrB �isalphar �lower�isdigit�keysrE r r� )r� �units�suffix� digits_part�digits�ver r r � parse_bytes� s> ������ �r� c C s( t | t�r t| �� �} dd� t| �D �S )Nc S s& g | ]\}}|r|� d |� �n|�qS �r` r �r* rP rQ r r r rJ � s & z#normalize_links.<locals>.<listcomp>)rA rD rL rM �sorted)�linksr r r �normalize_links� s r� c C s� i }t | ��;}|D ]/}|d dkrq |�� }|sq |�dd�}t|�dkr.|\}}|||< q t�d| � d|� ���W d � |S 1 sDw Y |S ) ze Reads a line-separated environment file. The format of each line should be "key=value". r �#�=r1 r z!Invalid line in environment file z: N)�openr� r3 rB r r� )�env_filer� �f�line� parse_linerP rQ r r r �parse_env_file� s( �� ��r� c C s t �| �S r& )�shlexr3 )�commandr r r � split_command� s r� c s" dd� � � fdd�t | �� �D �S )Nc S s. |d u r| S t |t�r|�d�}| � d|� �S )Nr r� )rA ra r )rR �valuer r r � format_env� s z&format_environment.<locals>.format_envc s g | ]}� |� �qS r r )r* �var�r� r r rJ � rK z&format_environment.<locals>.<listcomp>)rL rM )r� r r� r �format_environment� s r� c C s8 |rdd� t t| �� ��D �S dd� t t| �� ��D �S )Nc S s g | ] \}}|� d |� ��qS )� r r� r r r rJ � � �z&format_extra_hosts.<locals>.<listcomp>c S s g | ] \}}|� d |� ��qS r� r r� r r r rJ � r� )r� rL rM )� extra_hosts�taskr r r �format_extra_hosts� s ��r� c O r )Nz_utils.create_host_config has been removed. Please use a docker.types.HostConfig object instead.r )�selfr r r r r �create_host_config r r� )FFr& )F)3r � collectionsr r� �os.pathr� rx r r � functoolsr � itertoolsr � urllib.parser r r> r � constantsr r r r r� r � namedtupler r r r# r: r< r= rH rS re rl rq rv r� r� r� r� r� r� r� r� r� r� r� r� r r r r �<module> sV � 6 [ &( utils/__pycache__/fnmatch.cpython-310.pyc 0000644 00000005202 15027665106 0014244 0 ustar 00 o �h� � @ s@ d Z ddlZg d�Zi ZdZdd� Zdd� Zd d � Zd d � ZdS ) a� Filename matching with shell patterns. fnmatch(FILENAME, PATTERN) matches according to the local convention. fnmatchcase(FILENAME, PATTERN) always takes case in account. The functions operate by translating the pattern into a regular expression. They cache the compiled regular expressions for speed. The function translate(PATTERN) returns a regular expression corresponding to PATTERN. (It does not compile it.) � N)�fnmatch� fnmatchcase� translate�d c C s t �� dS )zClear the pattern cacheN)�_cache�clear� r r �J/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/fnmatch.py�_purge s r c C s | � � } |� � }t| |�S )a� Test whether FILENAME matches PATTERN. Patterns are Unix shell style: * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq An initial period in FILENAME is not special. Both FILENAME and PATTERN are first case-normalized if the operating system requires it. If you don't want this, use fnmatchcase(FILENAME, PATTERN). )�lowerr )�name�patr r r r s r c C s\ zt | }W n ty& t|�}tt �tkrt �� t�|� t |< }Y nw |�| �duS )z�Test whether FILENAME matches PATTERN, including case. This is a version of fnmatch() which doesn't case-normalize its arguments. N) r �KeyErrorr �len� _MAXCACHEr �re�compile�match)r r �re_pat�resr r r r / s �r c C s� dt | �}}d}||k r�| | }|d }|dkrK||k rE| | dkrE|d }||k r5| | dkr5|d }||kr?|� d�}n�|� d�}n�|� d�}n�|d krU|� d �}n}|d kr�|}||k ri| | d kri|d }||k rw| | d krw|d }||k r�| | d kr�|d }||k r�| | d ks�||kr�|� d�}n9| ||� �dd�}|d }|d d kr�d|dd� � �}n |d dkr�d|� �}|� d |� d �}n|t�|� }||k s |� d�S )zfTranslate a shell PATTERN to a regular expression. There is no way to quote meta-characters. r �^� �*�/z.*z(.*/)?z[^/]*�?z[^/]�[�!�]z\[�\z\\N�$)r �replacer �escape)r �i�nr �c�j�stuffr r r r ? sJ � � -r ) �__doc__r �__all__r r r r r r r r r r �<module> s utils/__pycache__/build.cpython-310.pyc 0000644 00000015112 15027665106 0013724 0 ustar 00 o �hJ � @ s� d dl Z d dlZd dlZd dlZd dlZddlmZ ddlmZ er'e�d�ne�d�Z e�d�Z d e d e fd d �Z d#dd�Zd$dd�Zdd� Z d%dd�Zdd� Zdd� Zdd� Zd&d d �ZG d d � d �ZG d!d"� d"�ZdS )'� N� )�IS_WINDOWS_PLATFORM� )�fnmatchz/|\\�/zy^[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(?::[0-9]+)?(/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*(:[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127})?$�tag�returnc C s t t�| ��S �N)�bool�_TAG�match)r � r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/build.py� match_tag s r Fc C sv t j�| �}|p g }|p d}g }|d d ur)d�|p dg|d g �}d|f|g}ttt|||d d��||||d�S )N)NNr � z .dockerignorer )� dockerfile)�files�root�fileobj�gzip� extra_files)�os�path�abspath�join�create_archive�sorted� exclude_paths)r �excluder r r r r �dockerignore_contentsr r r �tar s ���r c C s2 |du rd}|� d|� �� t|�}t|�| ��S )a Given a root directory path and a list of .dockerignore patterns, return an iterator of all paths (both regular files and directories) in the root directory that do *not* match any of the patterns. All paths returned are relative to the root. N� Dockerfile�!)�append�PatternMatcher�set�walk)r �patternsr �pmr r r r ) s r c C sT g }t �| �D ] \}}}|| D ]}t j�||�}|�|�| dd��d�� qq|S )N� r r )r r& r r r# �replace�lstrip)r r �dirname�dirnames�fnames�filename�longpathr r r �build_file_list: s ��r1 c C s� |pg }|s t �� }tj|rdnd|d�}|d u r t| �}dd� |D �}|D ]p}||v r-q&tj�| |�}|j||d�} | d u r@q&| j dk sJ| j dkrPt | j �| _ t rZ| j d @ d B | _ | � � r�z t|d ��} |�| | � W d � n1 suw Y W q& ty� } ztd |� ��| �d } ~ ww |�| d � q&|D ] \} } t�| �}| �d �}t|�|_|�|t�|�� q�|�� |�d� |S )Nzw:gz�w��moder c S s h | ]}|d �qS )r r )�.0�er r r � <setcomp>N � z!create_archive.<locals>.<setcomp>)�arcnamer l �� i� �I �rbz Can not read file in context: zutf-8)�tempfile�NamedTemporaryFile�tarfile�openr1 r r r � gettarinfo�mtime�intr r4 �isfile�addfile�OSError�TarInfo�encode�len�size�io�BytesIO�close�seek)r r r r r �t� extra_namesr � full_path�i�f�oe�name�contents�info�contents_encodedr r r r F sR ������ r c C s� t �� }tjd|d�}t| tj�rt�d�}td��t| tj �r2t�d�}t | � � �|_ | � d� n|j| dd�}|�|| � |�� |� d� |S )Nr2 r3 r! zCPlease use io.BytesIO to create in-memory Dockerfiles with Python 3r )r r9 )r< r= r> r? � isinstancerJ �StringIOrF � TypeErrorrK rH �getvaluerI rM r@ rD rL )r rR rN �dfinfor r r �mkbuildcontext{ s r] c C s dd� t �t| �D �S )Nc S s g | ] }|r|d kr|�qS )�.r )r5 �ptr r r � <listcomp>� s z split_path.<locals>.<listcomp>)�re�split�_SEP��pr r r � split_path� s rf c C s t r d�t| ��S | S )Nr )r r rf rd r r r �normalize_slashes� s rg Tc C s t |�}|�| �S r )r$ r& )r r' �defaultr( r r r r& � s r& c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )r$ c C s2 t tdd� dd� |D ���| _| j�td�� d S )Nc S s | j S r )�dirsrd r r r �<lambda>� s z)PatternMatcher.__init__.<locals>.<lambda>c S s g | ]}t |��qS r )�Pattern)r5 re r r r r` � r8 z+PatternMatcher.__init__.<locals>.<listcomp>z!.dockerignore)�list�filterr' r# rk )�selfr' r r r �__init__� s �zPatternMatcher.__init__c C s� d}t j�|�}t|�}| jD ]/}|j}|�|�}|s9|dkr9t|j�t|�kr9|�t jj � |d t|j�� ��}|r>| }q|S )NFr) ) r r r, rf r' � exclusionr rH ri �sepr )rn �filepath�matched� parent_path�parent_path_dirs�pattern�negativer r r r �matches� s ��zPatternMatcher.matchesc s � ��fdd�� � ��S )Nc 3 s� � t �| �D ]`}t j�t j�| ��|�}|�dt jj� ��r$|dd � }��|�}|s.|V t j��|�}t j�|�rAt j� |�rBq|r_d}�j D ]}|j sOqI|j �t |��r[d} nqI|r_q� |�E d H qd S )Nr^ r TF)r �listdirr r �relpath� startswithrq rx �isdir�islinkr' rp �cleaned_patternrg )� current_dirrR �fpathr �cur�skip�pat��rec_walkr rn r r r� � s8 �� ���z%PatternMatcher.walk.<locals>.rec_walkr )rn r r r� r r& � s !zPatternMatcher.walkN)�__name__� __module__� __qualname__ro rx r& r r r r r$ � s r$ c @ s( e Zd Zdd� Zedd� �Zdd� ZdS )rk c C s@ d| _ |�d�rd| _ |dd � }| �|�| _d�| j�| _d S )NFr" Tr r )rp r{ � normalizeri r r~ )rn � pattern_strr r r ro � s zPattern.__init__c C sf |� � }d}t|�}|t|�k r1|| dkr'||= |dkr&||d = |d8 }n|d7 }|t|�k s|S )Nr z..r )�striprf rH )�clsre rQ rb r r r r� � s � �zPattern.normalizec C s t t|�| j�S r )r rg r~ )rn rr r r r r s z Pattern.matchN)r� r� r� ro � classmethodr� r r r r r rk � s rk )NNNFr )NNFN)T)rJ r ra r> r< � constantsr r �compilerc r �strr r r r r1 r r] rf rg r& r$ rk r r r r �<module> s0 � �5 ? utils/__pycache__/config.cpython-310.pyc 0000644 00000003433 15027665106 0014075 0 ustar 00 o �h� � @ sh d dl Z d dlZd dlZddlmZ ej�dd�ZdZe� e �Z ddd�Z d d � Z d d � Zdd d�ZdS )� N� )�IS_WINDOWS_PLATFORMz.dockerz config.jsonz .dockercfgc C s� t td | t� tj�t� t�tj�t� t�g��}t � dt |�� �� |D ]}tj� |�r8t � d|� �� | S q$t � d� d S )NzTrying paths: zFound file at path: zNo config file found) �list�filter� config_path_from_environment�os�path�join�home_dir�DOCKER_CONFIG_FILENAME� LEGACY_DOCKER_CONFIG_FILENAME�log�debug�repr�exists)� config_path�pathsr � r �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/utils/config.py�find_config_file s � � r c C s* t j�d�} | s d S t j�| t j�t��S )N� DOCKER_CONFIG)r �environ�getr r �basenamer )� config_dirr r r r ! s r c C s t r tj�dd�S tj�d�S )z� Get the user's home directory, using the same logic as the Docker Engine client - use %USERPROFILE% on Windows, $HOME/getuid on POSIX. � USERPROFILE� �~)r r r r r � expanduserr r r r r ( s r c C s� t | �}|si S z t|��}t�|�W d � W S 1 s w Y W n ttfy= } z t�|� W Y d }~nd }~ww t�d� i S )Nz4All parsing attempts failed - returning empty config)r �open�json�load�OSError� ValueErrorr r )r � config_file�f�er r r �load_general_config3 s &��� r' )N)r �loggingr � constantsr r r r r � getLogger�__name__r r r r r' r r r r �<module> s utils/build.py 0000644 00000020112 15027665106 0007361 0 ustar 00 import io import os import re import tarfile import tempfile from ..constants import IS_WINDOWS_PLATFORM from .fnmatch import fnmatch _SEP = re.compile('/|\\\\') if IS_WINDOWS_PLATFORM else re.compile('/') _TAG = re.compile( r"^[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*" r"(?::[0-9]+)?(/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*" r"(:[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127})?$" ) def match_tag(tag: str) -> bool: return bool(_TAG.match(tag)) def tar(path, exclude=None, dockerfile=None, fileobj=None, gzip=False): root = os.path.abspath(path) exclude = exclude or [] dockerfile = dockerfile or (None, None) extra_files = [] if dockerfile[1] is not None: dockerignore_contents = '\n'.join( (exclude or ['.dockerignore']) + [dockerfile[0]] ) extra_files = [ ('.dockerignore', dockerignore_contents), dockerfile, ] return create_archive( files=sorted(exclude_paths(root, exclude, dockerfile=dockerfile[0])), root=root, fileobj=fileobj, gzip=gzip, extra_files=extra_files ) def exclude_paths(root, patterns, dockerfile=None): """ Given a root directory path and a list of .dockerignore patterns, return an iterator of all paths (both regular files and directories) in the root directory that do *not* match any of the patterns. All paths returned are relative to the root. """ if dockerfile is None: dockerfile = 'Dockerfile' patterns.append(f"!{dockerfile}") pm = PatternMatcher(patterns) return set(pm.walk(root)) def build_file_list(root): files = [] for dirname, dirnames, fnames in os.walk(root): for filename in fnames + dirnames: longpath = os.path.join(dirname, filename) files.append( longpath.replace(root, '', 1).lstrip('/') ) return files def create_archive(root, files=None, fileobj=None, gzip=False, extra_files=None): extra_files = extra_files or [] if not fileobj: fileobj = tempfile.NamedTemporaryFile() t = tarfile.open(mode='w:gz' if gzip else 'w', fileobj=fileobj) if files is None: files = build_file_list(root) extra_names = {e[0] for e in extra_files} for path in files: if path in extra_names: # Extra files override context files with the same name continue full_path = os.path.join(root, path) i = t.gettarinfo(full_path, arcname=path) if i is None: # This happens when we encounter a socket file. We can safely # ignore it and proceed. continue # Workaround https://bugs.python.org/issue32713 if i.mtime < 0 or i.mtime > 8**11 - 1: i.mtime = int(i.mtime) if IS_WINDOWS_PLATFORM: # Windows doesn't keep track of the execute bit, so we make files # and directories executable by default. i.mode = i.mode & 0o755 | 0o111 if i.isfile(): try: with open(full_path, 'rb') as f: t.addfile(i, f) except OSError as oe: raise OSError( f'Can not read file in context: {full_path}' ) from oe else: # Directories, FIFOs, symlinks... don't need to be read. t.addfile(i, None) for name, contents in extra_files: info = tarfile.TarInfo(name) contents_encoded = contents.encode('utf-8') info.size = len(contents_encoded) t.addfile(info, io.BytesIO(contents_encoded)) t.close() fileobj.seek(0) return fileobj def mkbuildcontext(dockerfile): f = tempfile.NamedTemporaryFile() t = tarfile.open(mode='w', fileobj=f) if isinstance(dockerfile, io.StringIO): dfinfo = tarfile.TarInfo('Dockerfile') raise TypeError('Please use io.BytesIO to create in-memory ' 'Dockerfiles with Python 3') elif isinstance(dockerfile, io.BytesIO): dfinfo = tarfile.TarInfo('Dockerfile') dfinfo.size = len(dockerfile.getvalue()) dockerfile.seek(0) else: dfinfo = t.gettarinfo(fileobj=dockerfile, arcname='Dockerfile') t.addfile(dfinfo, dockerfile) t.close() f.seek(0) return f def split_path(p): return [pt for pt in re.split(_SEP, p) if pt and pt != '.'] def normalize_slashes(p): if IS_WINDOWS_PLATFORM: return '/'.join(split_path(p)) return p def walk(root, patterns, default=True): pm = PatternMatcher(patterns) return pm.walk(root) # Heavily based on # https://github.com/moby/moby/blob/master/pkg/fileutils/fileutils.go class PatternMatcher: def __init__(self, patterns): self.patterns = list(filter( lambda p: p.dirs, [Pattern(p) for p in patterns] )) self.patterns.append(Pattern('!.dockerignore')) def matches(self, filepath): matched = False parent_path = os.path.dirname(filepath) parent_path_dirs = split_path(parent_path) for pattern in self.patterns: negative = pattern.exclusion match = pattern.match(filepath) if not match and parent_path != '': if len(pattern.dirs) <= len(parent_path_dirs): match = pattern.match( os.path.sep.join(parent_path_dirs[:len(pattern.dirs)]) ) if match: matched = not negative return matched def walk(self, root): def rec_walk(current_dir): for f in os.listdir(current_dir): fpath = os.path.join( os.path.relpath(current_dir, root), f ) if fpath.startswith(f".{os.path.sep}"): fpath = fpath[2:] match = self.matches(fpath) if not match: yield fpath cur = os.path.join(root, fpath) if not os.path.isdir(cur) or os.path.islink(cur): continue if match: # If we want to skip this file and it's a directory # then we should first check to see if there's an # excludes pattern (e.g. !dir/file) that starts with this # dir. If so then we can't skip this dir. skip = True for pat in self.patterns: if not pat.exclusion: continue if pat.cleaned_pattern.startswith( normalize_slashes(fpath)): skip = False break if skip: continue yield from rec_walk(cur) return rec_walk(root) class Pattern: def __init__(self, pattern_str): self.exclusion = False if pattern_str.startswith('!'): self.exclusion = True pattern_str = pattern_str[1:] self.dirs = self.normalize(pattern_str) self.cleaned_pattern = '/'.join(self.dirs) @classmethod def normalize(cls, p): # Remove trailing spaces p = p.strip() # Leading and trailing slashes are not relevant. Yes, # "foo.py/" must exclude the "foo.py" regular file. "." # components are not relevant either, even if the whole # pattern is only ".", as the Docker reference states: "For # historical reasons, the pattern . is ignored." # ".." component must be cleared with the potential previous # component, regardless of whether it exists: "A preprocessing # step [...] eliminates . and .. elements using Go's # filepath.". i = 0 split = split_path(p) while i < len(split): if split[i] == '..': del split[i] if i > 0: del split[i - 1] i -= 1 else: i += 1 return split def match(self, filepath): return fnmatch(normalize_slashes(filepath), self.cleaned_pattern) utils/config.py 0000644 00000003274 15027665106 0007541 0 ustar 00 import json import logging import os from ..constants import IS_WINDOWS_PLATFORM DOCKER_CONFIG_FILENAME = os.path.join('.docker', 'config.json') LEGACY_DOCKER_CONFIG_FILENAME = '.dockercfg' log = logging.getLogger(__name__) def find_config_file(config_path=None): paths = list(filter(None, [ config_path, # 1 config_path_from_environment(), # 2 os.path.join(home_dir(), DOCKER_CONFIG_FILENAME), # 3 os.path.join(home_dir(), LEGACY_DOCKER_CONFIG_FILENAME), # 4 ])) log.debug(f"Trying paths: {repr(paths)}") for path in paths: if os.path.exists(path): log.debug(f"Found file at path: {path}") return path log.debug("No config file found") return None def config_path_from_environment(): config_dir = os.environ.get('DOCKER_CONFIG') if not config_dir: return None return os.path.join(config_dir, os.path.basename(DOCKER_CONFIG_FILENAME)) def home_dir(): """ Get the user's home directory, using the same logic as the Docker Engine client - use %USERPROFILE% on Windows, $HOME/getuid on POSIX. """ if IS_WINDOWS_PLATFORM: return os.environ.get('USERPROFILE', '') else: return os.path.expanduser('~') def load_general_config(config_path=None): config_file = find_config_file(config_path) if not config_file: return {} try: with open(config_file) as f: return json.load(f) except (OSError, ValueError) as e: # In the case of a legacy `.dockercfg` file, we won't # be able to load any JSON data. log.debug(e) log.debug("All parsing attempts failed - returning empty config") return {} utils/json_stream.py 0000644 00000004210 15027665106 0010607 0 ustar 00 import json import json.decoder from ..errors import StreamParseError json_decoder = json.JSONDecoder() def stream_as_text(stream): """ Given a stream of bytes or text, if any of the items in the stream are bytes convert them to text. This function can be removed once we return text streams instead of byte streams. """ for data in stream: if not isinstance(data, str): data = data.decode('utf-8', 'replace') yield data def json_splitter(buffer): """Attempt to parse a json object from a buffer. If there is at least one object, return it and the rest of the buffer, otherwise return None. """ buffer = buffer.strip() try: obj, index = json_decoder.raw_decode(buffer) rest = buffer[json.decoder.WHITESPACE.match(buffer, index).end():] return obj, rest except ValueError: return None def json_stream(stream): """Given a stream of text, return a stream of json objects. This handles streams which are inconsistently buffered (some entries may be newline delimited, and others are not). """ return split_buffer(stream, json_splitter, json_decoder.decode) def line_splitter(buffer, separator='\n'): index = buffer.find(str(separator)) if index == -1: return None return buffer[:index + 1], buffer[index + 1:] def split_buffer(stream, splitter=None, decoder=lambda a: a): """Given a generator which yields strings and a splitter function, joins all input, splits on the separator and yields each chunk. Unlike string.split(), each chunk includes the trailing separator, except for the last one if none was found on the end of the input. """ splitter = splitter or line_splitter buffered = '' for data in stream_as_text(stream): buffered += data while True: buffer_split = splitter(buffered) if buffer_split is None: break item, buffered = buffer_split yield item if buffered: try: yield decoder(buffered) except Exception as e: raise StreamParseError(e) from e utils/__init__.py 0000644 00000001230 15027665106 0010021 0 ustar 00 from .build import create_archive, exclude_paths, match_tag, mkbuildcontext, tar from .decorators import check_resource, minimum_version, update_headers from .utils import ( compare_version, convert_filters, convert_port_bindings, convert_service_networks, convert_volume_binds, create_host_config, create_ipam_config, create_ipam_pool, datetime_to_timestamp, decode_json_header, format_environment, format_extra_hosts, kwargs_from_env, normalize_links, parse_bytes, parse_devices, parse_env_file, parse_host, parse_repository_tag, split_command, version_gte, version_lt, ) utils/utils.py 0000644 00000033454 15027665106 0007437 0 ustar 00 import base64 import collections import json import os import os.path import shlex import string from datetime import datetime, timezone from functools import lru_cache from itertools import zip_longest from urllib.parse import urlparse, urlunparse from .. import errors from ..constants import ( BYTE_UNITS, DEFAULT_HTTP_HOST, DEFAULT_NPIPE, DEFAULT_UNIX_SOCKET, ) from ..tls import TLSConfig URLComponents = collections.namedtuple( 'URLComponents', 'scheme netloc url params query fragment', ) def create_ipam_pool(*args, **kwargs): raise errors.DeprecatedMethod( 'utils.create_ipam_pool has been removed. Please use a ' 'docker.types.IPAMPool object instead.' ) def create_ipam_config(*args, **kwargs): raise errors.DeprecatedMethod( 'utils.create_ipam_config has been removed. Please use a ' 'docker.types.IPAMConfig object instead.' ) def decode_json_header(header): data = base64.b64decode(header) data = data.decode('utf-8') return json.loads(data) @lru_cache(maxsize=None) def compare_version(v1, v2): """Compare docker versions >>> v1 = '1.9' >>> v2 = '1.10' >>> compare_version(v1, v2) 1 >>> compare_version(v2, v1) -1 >>> compare_version(v2, v2) 0 """ if v1 == v2: return 0 # Split into `sys.version_info` like tuples. s1 = tuple(int(p) for p in v1.split('.')) s2 = tuple(int(p) for p in v2.split('.')) # Compare each component, padding with 0 if necessary. for c1, c2 in zip_longest(s1, s2, fillvalue=0): if c1 == c2: continue elif c1 > c2: return -1 else: return 1 return 0 def version_lt(v1, v2): return compare_version(v1, v2) > 0 def version_gte(v1, v2): return not version_lt(v1, v2) def _convert_port_binding(binding): result = {'HostIp': '', 'HostPort': ''} if isinstance(binding, tuple): if len(binding) == 2: result['HostPort'] = binding[1] result['HostIp'] = binding[0] elif isinstance(binding[0], str): result['HostIp'] = binding[0] else: result['HostPort'] = binding[0] elif isinstance(binding, dict): if 'HostPort' in binding: result['HostPort'] = binding['HostPort'] if 'HostIp' in binding: result['HostIp'] = binding['HostIp'] else: raise ValueError(binding) else: result['HostPort'] = binding if result['HostPort'] is None: result['HostPort'] = '' else: result['HostPort'] = str(result['HostPort']) return result def convert_port_bindings(port_bindings): result = {} for k, v in iter(port_bindings.items()): key = str(k) if '/' not in key: key += '/tcp' if isinstance(v, list): result[key] = [_convert_port_binding(binding) for binding in v] else: result[key] = [_convert_port_binding(v)] return result def convert_volume_binds(binds): if isinstance(binds, list): return binds result = [] for k, v in binds.items(): if isinstance(k, bytes): k = k.decode('utf-8') if isinstance(v, dict): if 'ro' in v and 'mode' in v: raise ValueError( f'Binding cannot contain both "ro" and "mode": {v!r}' ) bind = v['bind'] if isinstance(bind, bytes): bind = bind.decode('utf-8') if 'ro' in v: mode = 'ro' if v['ro'] else 'rw' elif 'mode' in v: mode = v['mode'] else: mode = 'rw' # NOTE: this is only relevant for Linux hosts # (doesn't apply in Docker Desktop) propagation_modes = [ 'rshared', 'shared', 'rslave', 'slave', 'rprivate', 'private', ] if 'propagation' in v and v['propagation'] in propagation_modes: if mode: mode = f"{mode},{v['propagation']}" else: mode = v['propagation'] result.append( f'{k}:{bind}:{mode}' ) else: if isinstance(v, bytes): v = v.decode('utf-8') result.append( f'{k}:{v}:rw' ) return result def convert_tmpfs_mounts(tmpfs): if isinstance(tmpfs, dict): return tmpfs if not isinstance(tmpfs, list): raise ValueError( 'Expected tmpfs value to be either a list or a dict, ' f'found: {type(tmpfs).__name__}' ) result = {} for mount in tmpfs: if isinstance(mount, str): if ":" in mount: name, options = mount.split(":", 1) else: name = mount options = "" else: raise ValueError( "Expected item in tmpfs list to be a string, " f"found: {type(mount).__name__}" ) result[name] = options return result def convert_service_networks(networks): if not networks: return networks if not isinstance(networks, list): raise TypeError('networks parameter must be a list.') result = [] for n in networks: if isinstance(n, str): n = {'Target': n} result.append(n) return result def parse_repository_tag(repo_name): parts = repo_name.rsplit('@', 1) if len(parts) == 2: return tuple(parts) parts = repo_name.rsplit(':', 1) if len(parts) == 2 and '/' not in parts[1]: return tuple(parts) return repo_name, None def parse_host(addr, is_win32=False, tls=False): # Sensible defaults if not addr and is_win32: return DEFAULT_NPIPE if not addr or addr.strip() == 'unix://': return DEFAULT_UNIX_SOCKET addr = addr.strip() parsed_url = urlparse(addr) proto = parsed_url.scheme if not proto or any(x not in f"{string.ascii_letters}+" for x in proto): # https://bugs.python.org/issue754016 parsed_url = urlparse(f"//{addr}", 'tcp') proto = 'tcp' if proto == 'fd': raise errors.DockerException('fd protocol is not implemented') # These protos are valid aliases for our library but not for the # official spec if proto == 'http' or proto == 'https': tls = proto == 'https' proto = 'tcp' elif proto == 'http+unix': proto = 'unix' if proto not in ('tcp', 'unix', 'npipe', 'ssh'): raise errors.DockerException( f"Invalid bind address protocol: {addr}" ) if proto == 'tcp' and not parsed_url.netloc: # "tcp://" is exceptionally disallowed by convention; # omitting a hostname for other protocols is fine raise errors.DockerException( f'Invalid bind address format: {addr}' ) if any([ parsed_url.params, parsed_url.query, parsed_url.fragment, parsed_url.password ]): raise errors.DockerException( f'Invalid bind address format: {addr}' ) if parsed_url.path and proto == 'ssh': raise errors.DockerException( f'Invalid bind address format: no path allowed for this protocol: {addr}' ) else: path = parsed_url.path if proto == 'unix' and parsed_url.hostname is not None: # For legacy reasons, we consider unix://path # to be valid and equivalent to unix:///path path = f"{parsed_url.hostname}/{path}" netloc = parsed_url.netloc if proto in ('tcp', 'ssh'): port = parsed_url.port or 0 if port <= 0: if proto != 'ssh': raise errors.DockerException( f'Invalid bind address format: port is required: {addr}' ) port = 22 netloc = f'{parsed_url.netloc}:{port}' if not parsed_url.hostname: netloc = f'{DEFAULT_HTTP_HOST}:{port}' # Rewrite schemes to fit library internals (requests adapters) if proto == 'tcp': proto = f"http{'s' if tls else ''}" elif proto == 'unix': proto = 'http+unix' if proto in ('http+unix', 'npipe'): return f"{proto}://{path}".rstrip('/') return urlunparse(URLComponents( scheme=proto, netloc=netloc, url=path, params='', query='', fragment='', )).rstrip('/') def parse_devices(devices): device_list = [] for device in devices: if isinstance(device, dict): device_list.append(device) continue if not isinstance(device, str): raise errors.DockerException( f'Invalid device type {type(device)}' ) device_mapping = device.split(':') if device_mapping: path_on_host = device_mapping[0] if len(device_mapping) > 1: path_in_container = device_mapping[1] else: path_in_container = path_on_host if len(device_mapping) > 2: permissions = device_mapping[2] else: permissions = 'rwm' device_list.append({ 'PathOnHost': path_on_host, 'PathInContainer': path_in_container, 'CgroupPermissions': permissions }) return device_list def kwargs_from_env(environment=None): if not environment: environment = os.environ host = environment.get('DOCKER_HOST') # empty string for cert path is the same as unset. cert_path = environment.get('DOCKER_CERT_PATH') or None # empty string for tls verify counts as "false". # Any value or 'unset' counts as true. tls_verify = environment.get('DOCKER_TLS_VERIFY') if tls_verify == '': tls_verify = False else: tls_verify = tls_verify is not None enable_tls = cert_path or tls_verify params = {} if host: params['base_url'] = host if not enable_tls: return params if not cert_path: cert_path = os.path.join(os.path.expanduser('~'), '.docker') params['tls'] = TLSConfig( client_cert=(os.path.join(cert_path, 'cert.pem'), os.path.join(cert_path, 'key.pem')), ca_cert=os.path.join(cert_path, 'ca.pem'), verify=tls_verify, ) return params def convert_filters(filters): result = {} for k, v in iter(filters.items()): if isinstance(v, bool): v = 'true' if v else 'false' if not isinstance(v, list): v = [v, ] result[k] = [ str(item) if not isinstance(item, str) else item for item in v ] return json.dumps(result) def datetime_to_timestamp(dt): """Convert a datetime to a Unix timestamp""" delta = dt.astimezone(timezone.utc) - datetime(1970, 1, 1, tzinfo=timezone.utc) return delta.seconds + delta.days * 24 * 3600 def parse_bytes(s): if isinstance(s, (int, float,)): return s if len(s) == 0: return 0 if s[-2:-1].isalpha() and s[-1].isalpha(): if s[-1] == "b" or s[-1] == "B": s = s[:-1] units = BYTE_UNITS suffix = s[-1].lower() # Check if the variable is a string representation of an int # without a units part. Assuming that the units are bytes. if suffix.isdigit(): digits_part = s suffix = 'b' else: digits_part = s[:-1] if suffix in units.keys() or suffix.isdigit(): try: digits = float(digits_part) except ValueError as ve: raise errors.DockerException( 'Failed converting the string value for memory ' f'({digits_part}) to an integer.' ) from ve # Reconvert to long for the final result s = int(digits * units[suffix]) else: raise errors.DockerException( f'The specified value for memory ({s}) should specify the units. ' 'The postfix should be one of the `b` `k` `m` `g` characters' ) return s def normalize_links(links): if isinstance(links, dict): links = iter(links.items()) return [f'{k}:{v}' if v else k for k, v in sorted(links)] def parse_env_file(env_file): """ Reads a line-separated environment file. The format of each line should be "key=value". """ environment = {} with open(env_file) as f: for line in f: if line[0] == '#': continue line = line.strip() if not line: continue parse_line = line.split('=', 1) if len(parse_line) == 2: k, v = parse_line environment[k] = v else: raise errors.DockerException( f'Invalid line in environment file {env_file}:\n{line}') return environment def split_command(command): return shlex.split(command) def format_environment(environment): def format_env(key, value): if value is None: return key if isinstance(value, bytes): value = value.decode('utf-8') return f'{key}={value}' return [format_env(*var) for var in iter(environment.items())] def format_extra_hosts(extra_hosts, task=False): # Use format dictated by Swarm API if container is part of a task if task: return [ f'{v} {k}' for k, v in sorted(iter(extra_hosts.items())) ] return [ f'{k}:{v}' for k, v in sorted(iter(extra_hosts.items())) ] def create_host_config(self, *args, **kwargs): raise errors.DeprecatedMethod( 'utils.create_host_config has been removed. Please use a ' 'docker.types.HostConfig object instead.' ) version.py 0000644 00000000360 15027665106 0006612 0 ustar 00 try: from ._version import __version__ except ImportError: from importlib.metadata import PackageNotFoundError, version try: __version__ = version('docker') except PackageNotFoundError: __version__ = '0.0.0' models/secrets.py 0000644 00000003465 15027665106 0010071 0 ustar 00 from ..api import APIClient from .resource import Collection, Model class Secret(Model): """A secret.""" id_attribute = 'ID' def __repr__(self): return f"<{self.__class__.__name__}: '{self.name}'>" @property def name(self): return self.attrs['Spec']['Name'] def remove(self): """ Remove this secret. Raises: :py:class:`docker.errors.APIError` If secret failed to remove. """ return self.client.api.remove_secret(self.id) class SecretCollection(Collection): """Secrets on the Docker server.""" model = Secret def create(self, **kwargs): obj = self.client.api.create_secret(**kwargs) obj.setdefault("Spec", {})["Name"] = kwargs.get("name") return self.prepare_model(obj) create.__doc__ = APIClient.create_secret.__doc__ def get(self, secret_id): """ Get a secret. Args: secret_id (str): Secret ID. Returns: (:py:class:`Secret`): The secret. Raises: :py:class:`docker.errors.NotFound` If the secret does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.prepare_model(self.client.api.inspect_secret(secret_id)) def list(self, **kwargs): """ List secrets. Similar to the ``docker secret ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Secret`): The secrets. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.secrets(**kwargs) return [self.prepare_model(obj) for obj in resp] models/swarm.py 0000644 00000020142 15027665106 0007541 0 ustar 00 from docker.api import APIClient from docker.errors import APIError from .resource import Model class Swarm(Model): """ The server's Swarm state. This a singleton that must be reloaded to get the current state of the Swarm. """ id_attribute = 'ID' def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) if self.client: try: self.reload() except APIError as e: # FIXME: https://github.com/docker/docker/issues/29192 if e.response.status_code not in (406, 503): raise @property def version(self): """ The version number of the swarm. If this is not the same as the server, the :py:meth:`update` function will not work and you will need to call :py:meth:`reload` before calling it again. """ return self.attrs.get('Version').get('Index') def get_unlock_key(self): return self.client.api.get_unlock_key() get_unlock_key.__doc__ = APIClient.get_unlock_key.__doc__ def init(self, advertise_addr=None, listen_addr='0.0.0.0:2377', force_new_cluster=False, default_addr_pool=None, subnet_size=None, data_path_addr=None, data_path_port=None, **kwargs): """ Initialize a new swarm on this Engine. Args: advertise_addr (str): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If not specified, it will be automatically detected when possible. listen_addr (str): Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the default swarm listening port is used. Default: ``0.0.0.0:2377`` force_new_cluster (bool): Force creating a new Swarm, even if already part of one. Default: False default_addr_pool (list of str): Default Address Pool specifies default subnet pools for global scope networks. Each pool should be specified as a CIDR block, like '10.0.0.0/8'. Default: None subnet_size (int): SubnetSize specifies the subnet size of the networks created from the default subnet pool. Default: None data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. data_path_port (int): Port number to use for data path traffic. Acceptable port range is 1024 to 49151. If set to ``None`` or 0, the default port 4789 will be used. Default: None task_history_retention_limit (int): Maximum number of tasks history stored. snapshot_interval (int): Number of logs entries between snapshot. keep_old_snapshots (int): Number of snapshots to keep beyond the current snapshot. log_entries_for_slow_followers (int): Number of log entries to keep around to sync up slow followers after a snapshot is created. heartbeat_tick (int): Amount of ticks (in seconds) between each heartbeat. election_tick (int): Amount of ticks (in seconds) needed without a leader to trigger a new election. dispatcher_heartbeat_period (int): The delay for an agent to send a heartbeat to the dispatcher. node_cert_expiry (int): Automatic expiry for nodes certificates. external_ca (dict): Configuration for forwarding signing requests to an external certificate authority. Use ``docker.types.SwarmExternalCA``. name (string): Swarm's name labels (dict): User-defined key/value metadata. signing_ca_cert (str): The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. signing_ca_key (str): The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. ca_force_rotate (int): An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified. autolock_managers (boolean): If set, generate a key and use it to lock data stored on the managers. log_driver (DriverConfig): The default log driver to use for tasks created in the orchestrator. Returns: (str): The ID of the created node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.swarm.init( advertise_addr='eth0', listen_addr='0.0.0.0:5000', force_new_cluster=False, default_addr_pool=['10.20.0.0/16], subnet_size=24, snapshot_interval=5000, log_entries_for_slow_followers=1200 ) """ init_kwargs = { 'advertise_addr': advertise_addr, 'listen_addr': listen_addr, 'force_new_cluster': force_new_cluster, 'default_addr_pool': default_addr_pool, 'subnet_size': subnet_size, 'data_path_addr': data_path_addr, 'data_path_port': data_path_port, } init_kwargs['swarm_spec'] = self.client.api.create_swarm_spec(**kwargs) node_id = self.client.api.init_swarm(**init_kwargs) self.reload() return node_id def join(self, *args, **kwargs): return self.client.api.join_swarm(*args, **kwargs) join.__doc__ = APIClient.join_swarm.__doc__ def leave(self, *args, **kwargs): return self.client.api.leave_swarm(*args, **kwargs) leave.__doc__ = APIClient.leave_swarm.__doc__ def reload(self): """ Inspect the swarm on the server and store the response in :py:attr:`attrs`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ self.attrs = self.client.api.inspect_swarm() def unlock(self, key): return self.client.api.unlock_swarm(key) unlock.__doc__ = APIClient.unlock_swarm.__doc__ def update(self, rotate_worker_token=False, rotate_manager_token=False, rotate_manager_unlock_key=False, **kwargs): """ Update the swarm's configuration. It takes the same arguments as :py:meth:`init`, except ``advertise_addr``, ``listen_addr``, and ``force_new_cluster``. In addition, it takes these arguments: Args: rotate_worker_token (bool): Rotate the worker join token. Default: ``False``. rotate_manager_token (bool): Rotate the manager join token. Default: ``False``. rotate_manager_unlock_key (bool): Rotate the manager unlock key. Default: ``False``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ # this seems to have to be set if kwargs.get('node_cert_expiry') is None: kwargs['node_cert_expiry'] = 7776000000000000 return self.client.api.update_swarm( version=self.version, swarm_spec=self.client.api.create_swarm_spec(**kwargs), rotate_worker_token=rotate_worker_token, rotate_manager_token=rotate_manager_token, rotate_manager_unlock_key=rotate_manager_unlock_key ) models/volumes.py 0000644 00000005440 15027665106 0010106 0 ustar 00 from ..api import APIClient from .resource import Collection, Model class Volume(Model): """A volume.""" id_attribute = 'Name' @property def name(self): """The name of the volume.""" return self.attrs['Name'] def remove(self, force=False): """ Remove this volume. Args: force (bool): Force removal of volumes that were already removed out of band by the volume driver plugin. Raises: :py:class:`docker.errors.APIError` If volume failed to remove. """ return self.client.api.remove_volume(self.id, force=force) class VolumeCollection(Collection): """Volumes on the Docker server.""" model = Volume def create(self, name=None, **kwargs): """ Create a volume. Args: name (str): Name of the volume. If not specified, the engine generates a name. driver (str): Name of the driver used to create the volume driver_opts (dict): Driver options as a key-value dictionary labels (dict): Labels to set on the volume Returns: (:py:class:`Volume`): The volume created. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> volume = client.volumes.create(name='foobar', driver='local', driver_opts={'foo': 'bar', 'baz': 'false'}, labels={"key": "value"}) """ obj = self.client.api.create_volume(name, **kwargs) return self.prepare_model(obj) def get(self, volume_id): """ Get a volume. Args: volume_id (str): Volume name. Returns: (:py:class:`Volume`): The volume. Raises: :py:class:`docker.errors.NotFound` If the volume does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.prepare_model(self.client.api.inspect_volume(volume_id)) def list(self, **kwargs): """ List volumes. Similar to the ``docker volume ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Volume`): The volumes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.volumes(**kwargs) if not resp.get('Volumes'): return [] return [self.prepare_model(obj) for obj in resp['Volumes']] def prune(self, filters=None): return self.client.api.prune_volumes(filters=filters) prune.__doc__ = APIClient.prune_volumes.__doc__ models/__pycache__/nodes.cpython-310.pyc 0000644 00000007263 15027665106 0014070 0 ustar 00 o �hp � @ s4 d dl mZmZ G dd� de�ZG dd� de�ZdS )� )� Collection�Modelc @ s2 e Zd ZdZdZedd� �Zdd� Zd dd �Zd S ) �NodezA node in a swarm.�IDc C s | j �d��d�S )z� The version number of the service. If this is not the same as the server, the :py:meth:`update` function will not work and you will need to call :py:meth:`reload` before calling it again. �Version�Index)�attrs�get��self� r �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/nodes.py�version s z Node.versionc C s | j j�| j| j|�S )a� Update the node's configuration. Args: node_spec (dict): Configuration settings to update. Any values not provided will be removed. Default: ``None`` Returns: `True` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> node_spec = {'Availability': 'active', 'Name': 'node-name', 'Role': 'manager', 'Labels': {'foo': 'bar'} } >>> node.update(node_spec) )�client�api� update_node�idr )r � node_specr r r �update s z Node.updateFc C s | j jj| j|d�S )a� Remove this node from the swarm. Args: force (bool): Force remove an active node. Default: `False` Returns: `True` if the request was successful. Raises: :py:class:`docker.errors.NotFound` If the node doesn't exist in the swarm. :py:class:`docker.errors.APIError` If the server returns an error. )�force)r r � remove_noder )r r r r r �remove, s z Node.removeN)F) �__name__� __module__� __qualname__�__doc__� id_attribute�propertyr r r r r r r r s r c @ s$ e Zd ZdZeZdd� Zdd� ZdS )�NodeCollectionzNodes on the Docker server.c C s | � | jj�|��S )a Get a node. Args: node_id (string): ID of the node to be inspected. Returns: A :py:class:`Node` object. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )� prepare_modelr r � inspect_node)r �node_idr r r r D s zNodeCollection.getc s" � fdd�� j jj|i |��D �S )a� List swarm nodes. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name``, ``membership`` and ``role``. Default: ``None`` Returns: A list of :py:class:`Node` objects. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.nodes.list(filters={'role': 'manager'}) c s g | ]}� � |��qS r )r )�.0�nr r r � <listcomp>h s ��z'NodeCollection.list.<locals>.<listcomp>)r r �nodes)r �args�kwargsr r r �listT s �zNodeCollection.listN)r r r r r �modelr r( r r r r r @ s r N)�resourcer r r r r r r r �<module> s < models/__pycache__/services.cpython-310.pyc 0000644 00000031360 15027665106 0014576 0 ustar 00 o �hd6 � @ s� d dl Z d dlmZmZ d dlmZmZmZmZ ddl m Z m Z G dd� de �Z G dd � d e �Z g d �Zg d �Zg d �Zg d �Zdd� ZdS )� N)�InvalidArgument� create_unexpected_kwargs_error)� ContainerSpec� Placement� ServiceMode� TaskTemplate� )� Collection�Modelc @ s^ e Zd ZdZdZedd� �Zedd� �Zdd� Zdd d �Z d d � Z dd� Z dd� Z dd� Z d S )�Servicez A service.�IDc C s | j d d S )zThe service's name.�Spec�Name)�attrs��self� r �L/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/services.py�name s z Service.namec C s | j �d��d�S )z� The version number of the service. If this is not the same as the server, the :py:meth:`update` function will not work and you will need to call :py:meth:`reload` before calling it again. �Version�Index)r �getr r r r �version s zService.versionc C s | j j�| j�S )z� Stop and remove the service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�client�api�remove_service�idr r r r �remove s zService.removeNc C s& |du ri }| j |d< | jjj|d�S )a� List the tasks in this service. Args: filters (dict): A map of filters to process on the tasks list. Valid filters: ``id``, ``name``, ``node``, ``label``, and ``desired-state``. Returns: :py:class:`list`: List of task dictionaries. Raises: :py:class:`docker.errors.APIError` If the server returns an error. N�service)�filters)r r r �tasks)r r r r r r % s z Service.tasksc K s� d|vr| j d d d }|d |d< |�d�du r/| j d d }t|�dd ��}|d |d< td |�}| jjj| j| jfi |��S ) a) Update a service's configuration. Similar to the ``docker service update`` command. Takes the same parameters as :py:meth:`~ServiceCollection.create`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �imager r r �Image� force_updateT� ForceUpdater r �update) r r �int�_get_create_service_kwargsr r �update_servicer r )r �kwargs�spec� task_template� current_value� create_kwargsr r r r% : s ��zService.updatec K s6 | j d d d �dd�}| jjj| jfd|i|��S )a� Get log stream for the service. Note: This method works only for services with the ``json-file`` or ``journald`` logging drivers. Args: details (bool): Show extra details provided to logs. Default: ``False`` follow (bool): Keep connection open to read logs as they are sent by the Engine. Default: ``False`` stdout (bool): Return logs from ``stdout``. Default: ``False`` stderr (bool): Return logs from ``stderr``. Default: ``False`` since (int): UNIX timestamp for the logs staring point. Default: 0 timestamps (bool): Add timestamps to every log line. tail (string or int): Number of log lines to be returned, counting from the current end of the logs. Specify an integer or ``'all'`` to output all log lines. Default: ``all`` Returns: generator: Logs for the service. r r r �TTYF�is_tty)r r r r � service_logsr )r r) r/ r r r �logsW s � z Service.logsc C sB d| j d d �� v rtd��td|�}| jjj| j| j|dd�S )z� Scale service container. Args: replicas (int): The number of containers that should be running. Returns: bool: ``True`` if successful. �Globalr �Modez Cannot scale a global container� replicatedT)�mode�fetch_current_spec) r �keysr r r r r( r r )r �replicas� service_moder r r �scalet s �z Service.scalec C s | j ddd�S )z� Force update the service even if no changes require it. Returns: bool: ``True`` if successful. T)r# r6 )r% r r r r r# � s zService.force_update�N)�__name__� __module__� __qualname__�__doc__� id_attribute�propertyr r r r r% r1 r: r# r r r r r s r c @ s0 e Zd ZdZeZd dd�Zd dd�Zdd� ZdS ) �ServiceCollectionz Services on the Docker server.Nc K s8 ||d< ||d< t d|�}| jjjdi |��}| �|�S )a� Create a service. Similar to the ``docker service create`` command. Args: image (str): The image name to use for the containers. command (list of str or str): Command to run. args (list of str): Arguments to the command. constraints (list of str): :py:class:`~docker.types.Placement` constraints. preferences (list of tuple): :py:class:`~docker.types.Placement` preferences. maxreplicas (int): :py:class:`~docker.types.Placement` maxreplicas or (int) representing maximum number of replicas per node. platforms (list of tuple): A list of platform constraints expressed as ``(arch, os)`` tuples. container_labels (dict): Labels to apply to the container. endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. env (list of str): Environment variables, in the form ``KEY=val``. hostname (string): Hostname to set on the container. init (boolean): Run an init inside the container that forwards signals and reaps processes isolation (string): Isolation technology used by the service's containers. Only used for Windows containers. labels (dict): Labels to apply to the service. log_driver (str): Log driver to use for containers. log_driver_options (dict): Log driver options. mode (ServiceMode): Scheduling mode for the service. Default:``None`` mounts (list of str): Mounts for the containers, in the form ``source:target:options``, where options is either ``ro`` or ``rw``. name (str): Name to give to the service. networks (:py:class:`list`): List of network names or IDs or :py:class:`~docker.types.NetworkAttachmentConfig` to attach the service to. Default: ``None``. resources (Resources): Resource limits and reservations. restart_policy (RestartPolicy): Restart policy for containers. secrets (list of :py:class:`~docker.types.SecretReference`): List of secrets accessible to containers for this service. stop_grace_period (int): Amount of time to wait for containers to terminate before forcefully killing them. update_config (UpdateConfig): Specification for the update strategy of the service. Default: ``None`` rollback_config (RollbackConfig): Specification for the rollback strategy of the service. Default: ``None`` user (str): User to run commands as. workdir (str): Working directory for commands to run. tty (boolean): Whether a pseudo-TTY should be allocated. groups (:py:class:`list`): A list of additional groups that the container process will run as. open_stdin (boolean): Open ``stdin`` read_only (boolean): Mount the container's root filesystem as read only. stop_signal (string): Set signal to stop the service's containers healthcheck (Healthcheck): Healthcheck configuration for this service. hosts (:py:class:`dict`): A set of host to IP mappings to add to the container's `hosts` file. dns_config (DNSConfig): Specification for DNS related configurations in resolver configuration file. configs (:py:class:`list`): List of :py:class:`~docker.types.ConfigReference` that will be exposed to the service. privileges (Privileges): Security options for the service's containers. cap_add (:py:class:`list`): A list of kernel capabilities to add to the default set for the container. cap_drop (:py:class:`list`): A list of kernel capabilities to drop from the default set for the container. sysctls (:py:class:`dict`): A dict of sysctl values to add to the container Returns: :py:class:`Service`: The created service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. r! �command�createNr )r' r r �create_servicer )r r! rC r) r- � service_idr r r rD � s R zServiceCollection.createc C s | � | jj�||��S )a} Get a service. Args: service_id (str): The ID of the service. insert_defaults (boolean): If true, default values will be merged into the output. Returns: :py:class:`Service`: The service. Raises: :py:class:`docker.errors.NotFound` If the service does not exist. :py:class:`docker.errors.APIError` If the server returns an error. :py:class:`docker.errors.InvalidVersion` If one of the arguments is not supported with the current API version. )� prepare_modelr r �inspect_service)r rF �insert_defaultsr r r r � s �zServiceCollection.getc s" � fdd�� j jjdi |��D �S )a List services. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name`` , ``label`` and ``mode``. Default: ``None``. status (bool): Include the service task count of running and desired tasks. Default: ``None``. Returns: list of :py:class:`Service`: The services. Raises: :py:class:`docker.errors.APIError` If the server returns an error. c s g | ]}� � |��qS r )rG )�.0�sr r r � <listcomp> s ��z*ServiceCollection.list.<locals>.<listcomp>Nr )r r �services)r r) r r r �list s �zServiceCollection.listr; ) r< r= r> r? r �modelrD r rN r r r r rB � s X rB )�args�cap_add�cap_droprC �configs� dns_config�env�groups� healthcheck�hostname�hostsr! �init� isolation�labels�mounts� open_stdin� privileges� read_only�secrets�stop_grace_period� stop_signal�tty�user�workdir�sysctls)�networks� resources�restart_policy)r r\ r5 � update_config�rollback_config� endpoint_spec)� constraints� preferences� platforms� maxreplicasc C sd i }t � |�D ] }|tv r|�|�||< qi }t � |�D ] }|tv r)|�|�||< q i }t � |�D ] }|tv r>|�|�||< q1d|v rJ|�d�|d< i }t � |�D ] }|tv r^|�|�||< qQtd i |��}||d< d|v r||�d�|�di �d�|d< | dkr�d|v r�|�d�|d< |�d d �}||d < |r�t| |��td i |��}||d < t d i |��|d < |S )N�container_labelsr\ � placement� log_driver�log_driver_options)r �Optionsr% r# r6 T�container_specr+ r ) �copy�CREATE_SERVICE_KWARGS�pop�CONTAINER_SPEC_KWARGS�TASK_TEMPLATE_KWARGS�PLACEMENT_KWARGSr r r r ) � func_namer) r- �key�container_spec_kwargs�task_template_kwargsrs r6 rw r r r r' V sN ���� � r' )rx � docker.errorsr r � docker.typesr r r r �resourcer r r rB r{ r| ry r} r' r r r r �<module> s models/__pycache__/__init__.cpython-310.pyc 0000644 00000000251 15027665106 0014505 0 ustar 00 o �h � @ s d S )N� r r r �L/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/__init__.py�<module> s models/__pycache__/plugins.cpython-310.pyc 0000644 00000015564 15027665106 0014444 0 ustar 00 o �hS � @ s@ d dl mZ ddlmZmZ G dd� de�ZG dd� de�ZdS ) � )�errors� )� Collection�Modelc @ st e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Zd d � Z dd d�Z ddd�Z dd� Z ddd�Z ddd�ZdS ) �Pluginz! A plugin on the server. c C s d| j j� d| j� d�S )N�<z: 'z'>)� __class__�__name__�name��self� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/plugins.py�__repr__ s zPlugin.__repr__c C � | j �d�S )z$ The plugin's name. �Name��attrs�getr r r r r � z Plugin.namec C r )z0 Whether the plugin is enabled. �Enabledr r r r r �enabled r zPlugin.enabledc C r )zG A dictionary representing the plugin's configuration. �Settingsr r r r r �settings r zPlugin.settingsc C � | j j�| 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)�client�api�configure_pluginr �reload)r �optionsr r r � configure! � zPlugin.configureFc C r )z� Disable the plugin. Args: force (bool): Force disable. Default: False Raises: :py:class:`docker.errors.APIError` If the server returns an error. N)r r �disable_pluginr r �r �forcer r r �disable/ s zPlugin.disable� c C r )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)r r � enable_pluginr r )r �timeoutr r r �enable> r! z Plugin.enablec C s | j j�| j�S )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. )r r � push_pluginr r r r r �pushL s z Plugin.pushc C s | j jj| j|d�S )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. )r$ )r r � remove_pluginr r# r r r �removeY s z Plugin.removeNc c sT � | j r t�d��|du r| j}| jj�|�}| jj�| j||�E dH | �� 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) r r � DockerErrorr r r �plugin_privileges�upgrade_pluginr )r �remote� privilegesr r r �upgradeg s � � � zPlugin.upgrade�F)r& �N)r � __module__� __qualname__�__doc__r �propertyr r r r r% r) r+ r- r3 r r r r r s r c @ s4 e Zd ZeZd dd�Zdd� Zd dd�Zd d � ZdS ) �PluginCollectionFc C s | j j�|||� | �|�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. )r r � create_pluginr )r r �plugin_data_dir�gzipr r r �create� s zPluginCollection.createc C s | � | 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_modelr r �inspect_plugin)r r r r r r � s zPluginCollection.getNc C s8 | j j�|�}| j j�|||�}|D ]}q| �|p|�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. )r r r/ � pull_pluginr )r � remote_name� local_namer2 �it�_datar r r �install� s zPluginCollection.installc s � j j�� }� fdd�|D �S )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. c s g | ]}� � |��qS r )r? )�.0�rr r r � <listcomp>� s z)PluginCollection.list.<locals>.<listcomp>)r r �plugins)r �respr r r �list� s zPluginCollection.listr4 r5 ) r r6 r7 r �modelr> r rF rL r r r r r: � s r: N)� r �resourcer r r r: r r r r �<module> s ~ models/__pycache__/volumes.cpython-310.pyc 0000644 00000007230 15027665106 0014444 0 ustar 00 o �h � @ s@ d dl mZ ddlmZmZ G dd� de�ZG dd� de�ZdS ) � )� APIClient� )� Collection�Modelc @ s* e Zd ZdZdZedd� �Zd dd�ZdS ) �Volumez A volume.�Namec C s | j d S )zThe name of the volume.r )�attrs��self� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/volumes.py�name s z Volume.nameFc C s | j jj| j|d�S )a% Remove this volume. Args: force (bool): Force removal of volumes that were already removed out of band by the volume driver plugin. Raises: :py:class:`docker.errors.APIError` If volume failed to remove. )�force)�client�api� remove_volume�id)r r r r r �remove s z Volume.removeN)F)�__name__� __module__� __qualname__�__doc__� id_attribute�propertyr r r r r r r s r c @ sB e Zd ZdZeZd dd�Zdd� Zdd� Zd d d �Z e j je _dS ) �VolumeCollectionz Volumes on the Docker server.Nc K s | j jj|fi |��}| �|�S )a� Create a volume. Args: name (str): Name of the volume. If not specified, the engine generates a name. driver (str): Name of the driver used to create the volume driver_opts (dict): Driver options as a key-value dictionary labels (dict): Labels to set on the volume Returns: (:py:class:`Volume`): The volume created. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> volume = client.volumes.create(name='foobar', driver='local', driver_opts={'foo': 'bar', 'baz': 'false'}, labels={"key": "value"}) )r r � create_volume� prepare_model)r r �kwargs�objr r r �create s zVolumeCollection.createc C s | � | jj�|��S )ae Get a volume. Args: volume_id (str): Volume name. Returns: (:py:class:`Volume`): The volume. Raises: :py:class:`docker.errors.NotFound` If the volume does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )r r r �inspect_volume)r � volume_idr r r �get< s zVolumeCollection.getc s8 � j jjdi |��}|�d�sg S � fdd�|d D �S )aT List volumes. Similar to the ``docker volume ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Volume`): The volumes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �Volumesc s g | ]}� � |��qS r )r )�.0r r r r � <listcomp>_ s z)VolumeCollection.list.<locals>.<listcomp>Nr )r r �volumesr" )r r �respr r r �listN s zVolumeCollection.listc C s | j jj|d�S )N)�filters)r r � prune_volumes)r r) r r r �prunea s zVolumeCollection.prune)N) r r r r r �modelr r" r( r+ r r* r r r r r s r N)r r �resourcer r r r r r r r �<module> s models/__pycache__/swarm.cpython-310.pyc 0000644 00000020130 15027665106 0014075 0 ustar 00 o �hb � @ s8 d dl mZ d dlmZ ddlmZ G dd� de�ZdS )� )� APIClient)�APIError� )�Modelc s� e Zd ZdZdZ� fdd�Zedd� �Zdd� Ze jje_ dd d �Z dd� Z e j je _dd� Z e jje _dd� Zdd� Ze jje_ ddd�Z� ZS )�Swarmzu The server's Swarm state. This a singleton that must be reloaded to get the current state of the Swarm. �IDc s` t � j|i |�� | jr.z| �� W d S ty- } z|jjdvr"� W Y d }~d S d }~ww d S )N)i� i� )�super�__init__�client�reloadr �response� status_code)�self�args�kwargs�e�� __class__� �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/swarm.pyr s ����zSwarm.__init__c C s | j �d��d�S )z� The version number of the swarm. If this is not the same as the server, the :py:meth:`update` function will not work and you will need to call :py:meth:`reload` before calling it again. �Version�Index)�attrs�get�r r r r �version s z Swarm.versionc C s | j j�� S �N)r �api�get_unlock_keyr r r r r ! s zSwarm.get_unlock_keyN� 0.0.0.0:2377Fc K sL |||||||d�} | j jjdi |��| d< | j jjdi | ��} | �� | S )a Initialize a new swarm on this Engine. Args: advertise_addr (str): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If not specified, it will be automatically detected when possible. listen_addr (str): Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the default swarm listening port is used. Default: ``0.0.0.0:2377`` force_new_cluster (bool): Force creating a new Swarm, even if already part of one. Default: False default_addr_pool (list of str): Default Address Pool specifies default subnet pools for global scope networks. Each pool should be specified as a CIDR block, like '10.0.0.0/8'. Default: None subnet_size (int): SubnetSize specifies the subnet size of the networks created from the default subnet pool. Default: None data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. data_path_port (int): Port number to use for data path traffic. Acceptable port range is 1024 to 49151. If set to ``None`` or 0, the default port 4789 will be used. Default: None task_history_retention_limit (int): Maximum number of tasks history stored. snapshot_interval (int): Number of logs entries between snapshot. keep_old_snapshots (int): Number of snapshots to keep beyond the current snapshot. log_entries_for_slow_followers (int): Number of log entries to keep around to sync up slow followers after a snapshot is created. heartbeat_tick (int): Amount of ticks (in seconds) between each heartbeat. election_tick (int): Amount of ticks (in seconds) needed without a leader to trigger a new election. dispatcher_heartbeat_period (int): The delay for an agent to send a heartbeat to the dispatcher. node_cert_expiry (int): Automatic expiry for nodes certificates. external_ca (dict): Configuration for forwarding signing requests to an external certificate authority. Use ``docker.types.SwarmExternalCA``. name (string): Swarm's name labels (dict): User-defined key/value metadata. signing_ca_cert (str): The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. signing_ca_key (str): The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. ca_force_rotate (int): An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified. autolock_managers (boolean): If set, generate a key and use it to lock data stored on the managers. log_driver (DriverConfig): The default log driver to use for tasks created in the orchestrator. Returns: (str): The ID of the created node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.swarm.init( advertise_addr='eth0', listen_addr='0.0.0.0:5000', force_new_cluster=False, default_addr_pool=['10.20.0.0/16], subnet_size=24, snapshot_interval=5000, log_entries_for_slow_followers=1200 ) )�advertise_addr� listen_addr�force_new_cluster�default_addr_pool� subnet_size�data_path_addr�data_path_port� swarm_specNr )r r �create_swarm_spec� init_swarmr ) r r r! r" r# r$ r% r& r � init_kwargs�node_idr r r �init% s V� z Swarm.initc O � | j jj|i |��S r )r r � join_swarm�r r r r r r �join� � z Swarm.joinc O r- r )r r � leave_swarmr/ r r r �leave� r1 z Swarm.leavec C s | j j�� | _dS )z� Inspect the swarm on the server and store the response in :py:attr:`attrs`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. N)r r � inspect_swarmr r r r r r � s z Swarm.reloadc C s | j j�|�S r )r r � unlock_swarm)r �keyr r r �unlock� s z Swarm.unlockc K s@ |� d�du r d|d< | jjj| j| jjjdi |��|||d�S )a� Update the swarm's configuration. It takes the same arguments as :py:meth:`init`, except ``advertise_addr``, ``listen_addr``, and ``force_new_cluster``. In addition, it takes these arguments: Args: rotate_worker_token (bool): Rotate the worker join token. Default: ``False``. rotate_manager_token (bool): Rotate the manager join token. Default: ``False``. rotate_manager_unlock_key (bool): Rotate the manager unlock key. Default: ``False``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �node_cert_expiryNl �+� � )r r' �rotate_worker_token�rotate_manager_token�rotate_manager_unlock_keyr )r r r � update_swarmr r( )r r9 r: r; r r r r �update� s �z Swarm.update)Nr FNNNN)FFF)�__name__� __module__� __qualname__�__doc__� id_attributer �propertyr r r r, r0 r. r3 r2 r r7 r5 r= � __classcell__r r r r r s, �c �r N)� docker.apir � docker.errorsr �resourcer r r r r r �<module> s models/__pycache__/images.cpython-310.pyc 0000644 00000043737 15027665106 0014233 0 ustar 00 o �hPF � @ s� d dl Z d dlZd dlZddlmZ ddlmZ ddlmZm Z m Z ddl m Z ddl mZ dd lmZmZ G d d � d e�ZG d d � d e�ZG dd� de�Zdd� ZdS )� N� )� APIClient)�DEFAULT_DATA_CHUNK_SIZE)� BuildError�ImageLoadError�InvalidArgument)�parse_repository_tag)� json_stream� )� Collection�Modelc @ sf e Zd ZdZdd� Zedd� �Zedd� �Zedd � �Zd d � Z dd d�Z e d fdd�Z ddd�Z dS )�Imagez! An image on the server. c C s" d� | j�}d| jj� d|� d�S )Nz', '�<z: 'z'>)�join�tags� __class__�__name__)�self�tag_str� r �J/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/images.py�__repr__ s zImage.__repr__c C s | j d �d�}|p i S )z7 The labels of an image as dictionary. �Config�Labels��attrs�get)r �resultr r r �labels s z Image.labelsc C s( | j �d�r | j dd� S | j dd� S )�f The ID of the image truncated to 12 characters, plus the ``sha256:`` prefix. �sha256:N� � )�id� startswith�r r r r �short_id s zImage.short_idc C s& | j �d�}|du r g }dd� |D �S )z# The image's tags. �RepoTagsNc S s g | ]}|d kr|�qS )z <none>:<none>r )�.0�tagr r r � <listcomp>/ s z Image.tags.<locals>.<listcomp>r )r r r r r r ' s z Image.tagsc C s | j j�| j�S )z� Show the history of an image. Returns: (list): The history of the image. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�client�api�historyr# r% r r r r- 1 s z Image.historyFc C s | j jj| j||d�S )a Remove this image. Args: force (bool): Force removal of the image noprune (bool): Do not delete untagged parents Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�force�noprune)r+ r, � remove_imager# )r r. r/ r r r �remove> s �z Image.removec C sT | j }|r"| jr | jd n|}t|t�r"|| jvr t|� d���|}| jj�||�S )a� Get a tarball of an image. Similar to the ``docker save`` command. Args: chunk_size (int): The generator will return up to that much data per iteration, but may return less. If ``None``, data will be streamed as it is received. Default: 2 MB named (str or bool): If ``False`` (default), the tarball will not retain repository and tag information for this image. If set to ``True``, the first tag in the :py:attr:`~tags` list will be used to identify the image. Alternatively, any element of the :py:attr:`~tags` list can be used as an argument to use that specific tag as the saved identifier. Returns: (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> image = cli.images.get("busybox:latest") >>> f = open('/tmp/busybox-latest.tar', 'wb') >>> for chunk in image.save(): >>> f.write(chunk) >>> f.close() r z" is not a valid tag for this image)r# r � isinstance�strr r+ r, � get_image)r � chunk_size�named�imgr r r �saveP s �z Image.saveNc K s | j jj| j|fd|i|��S )a� Tag this image into a repository. Similar to the ``docker tag`` command. Args: repository (str): The repository to set for the tag tag (str): The tag name force (bool): Force Raises: :py:class:`docker.errors.APIError` If the server returns an error. Returns: (bool): ``True`` if successful r) )r+ r, r) r# �r � repositoryr) �kwargsr r r r) z s z Image.tag)FF�N)r � __module__� __qualname__�__doc__r �propertyr r& r r- r1 r r8 r) r r r r r s *r c s\ e Zd ZdZ� fdd�Zedd� �Zedd� �Zdd d �Zd d � Z d d� Z e j je _� Z S )� RegistryDatazO Image metadata stored on the registry, including available platforms. c s t � j|i |�� || _d S r< )�super�__init__� image_name)r rD �argsr; �r r r rC � s zRegistryData.__init__c C s | j d d S )z' The ID of the object. � Descriptor�digest)r r% r r r r# � s zRegistryData.idc C s | j dd� S )r Nr! )r# r% r r r r& � s zRegistryData.short_idNc C s" t | j�\}}| jj|| j|d�S )z� Pull the image digest. Args: platform (str): The platform to pull the image for. Default: ``None`` Returns: (:py:class:`Image`): A reference to the pulled image. )r) �platform)r rD � collection�pullr# )r rI r: �_r r r rK � s zRegistryData.pullc C s� |r>t |t�s>|�d�}t|�dkst|�dk r td|� d���d|d i}t|�dkr2|d |d < t|�dkr>|d |d < t|| j�� �| jd v S ) a� Check whether the given platform identifier is available for this digest. Args: platform (str or dict): A string using the ``os[/arch[/variant]]`` format, or a platform dictionary. Returns: (bool): ``True`` if the platform is recognized as available, ``False`` otherwise. Raises: :py:class:`docker.errors.InvalidArgument` If the platform argument is not a valid descriptor. �/� r �"z$" is not a valid platform descriptor�osr r �variant� architecture� Platforms) r2 �dict�split�lenr �normalize_platformr+ �versionr )r rI �partsr r r � has_platform� s � ��zRegistryData.has_platformc C s | j j�| j�| _d S r< )r+ r, �inspect_distributionrD r r% r r r �reload� s zRegistryData.reloadr< ) r r= r> r? rC r@ r# r& rK rZ r\ r � __classcell__r r rF r rA � s rA c @ s� e Zd ZeZdd� Zdd� Zddd�Zdd d �Zd d � Z dd d�Z ddd�Z e j j e _ dd� Ze jj e_ dd� Ze jj e_ ddd�Ze jj e_ dd� Ze jj e_ dS ) �ImageCollectionc K s� | j jjdi |��}t|t�r| �|�S d}d}t�t|��\}}|D ]"}d|v r0t |d |��d|v rCt � d|d �}|rC|� d�}|}q#|rO| �|�|fS t |pSd|��)a� Build an image and return it. Similar to the ``docker build`` command. Either ``path`` or ``fileobj`` must be set. If you already have a tar file for the Docker build context (including a Dockerfile), pass a readable file-like object to ``fileobj`` and also pass ``custom_context=True``. If the stream is also compressed, set ``encoding`` to the correct value (e.g ``gzip``). If you want to get the raw output of the build, use the :py:meth:`~docker.api.build.BuildApiMixin.build` method in the low-level API. Args: path (str): Path to the directory containing the Dockerfile fileobj: A file object to use as the Dockerfile. (Or a file-like object) tag (str): A tag to add to the final image quiet (bool): Whether to return the status nocache (bool): Don't use the cache when set to ``True`` rm (bool): Remove intermediate containers. The ``docker build`` command now defaults to ``--rm=true``, but we have kept the old default of `False` to preserve backward compatibility timeout (int): HTTP timeout custom_context (bool): Optional if using ``fileobj`` encoding (str): The encoding for a stream. Set to ``gzip`` for compressing pull (bool): Downloads any updates to the FROM image in Dockerfiles forcerm (bool): Always remove intermediate containers, even after unsuccessful builds dockerfile (str): path within the build context to the Dockerfile buildargs (dict): A dictionary of build arguments container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys: - memory (int): set memory limit for build - memswap (int): Total memory (memory + swap), -1 to disable swap - cpushares (int): CPU shares (relative weight) - cpusetcpus (str): CPUs in which to allow execution, e.g., ``"0-3"``, ``"0,1"`` shmsize (int): Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB labels (dict): A dictionary of labels to set on the image cache_from (list): A list of images used for build cache resolution target (str): Name of the build-stage to build in a multi-stage Dockerfile network_mode (str): networking mode for the run commands during build squash (bool): Squash the resulting images layers into a single layer. extra_hosts (dict): Extra hosts to add to /etc/hosts in building containers, as a mapping of hostname to IP address. platform (str): Platform in the format ``os[/arch[/variant]]``. isolation (str): Isolation technology used during build. Default: `None`. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. Returns: (tuple): The first item is the :py:class:`Image` object for the image that was built. The second item is a generator of the build logs as JSON-decoded objects. Raises: :py:class:`docker.errors.BuildError` If there is an error during the build. :py:class:`docker.errors.APIError` If the server returns any other error. ``TypeError`` If neither ``path`` nor ``fileobj`` is specified. N�error�streamz*(^Successfully built |sha256:)([0-9a-f]+)$r �Unknownr ) r+ r, �buildr2 r3 r � itertools�teer r �re�search�group) r r; �resp� last_event�image_id� result_stream�internal_stream�chunk�matchr r r rb � s( L � zImageCollection.buildc C s | � | jj�|��S )am Gets an image. Args: name (str): The name of the image. Returns: (:py:class:`Image`): The image. Raises: :py:class:`docker.errors.ImageNotFound` If the image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )� prepare_modelr+ r, � inspect_image)r �namer r r r = s zImageCollection.getNc C s t || jj�||�| j| d�S )a Gets the registry data for an image. Args: name (str): The name of the image. auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. Returns: (:py:class:`RegistryData`): The data object. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )rD r r+ rJ )rA r+ r, r[ )r rq � auth_configr r r �get_registry_dataO s �z!ImageCollection.get_registry_dataFc s& � j jj|||d�}� fdd�|D �S )a� List images on the server. Args: name (str): Only show images belonging to the repository ``name`` all (bool): Show intermediate image layers. By default, these are filtered out. filters (dict): Filters to be processed on the image list. Available filters: - ``dangling`` (bool) - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. Returns: (list of :py:class:`Image`): The images. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )rq �all�filtersc s g | ] }� � |d ��qS )�Id�r )r( �rr% r r r* } s z(ImageCollection.list.<locals>.<listcomp>)r+ r, �images)r rq rt ru rh r r% r �listg s zImageCollection.listc sr � j j�|�}g }|D ]$}d|v r%t�d|d �}|r%|�d�}|�|� d|v r/t|d ��q � fdd�|D �S )a� Load an image that was previously saved using :py:meth:`~docker.models.images.Image.save` (or ``docker save``). Similar to ``docker load``. Args: data (binary): Image data to be loaded. Returns: (list of :py:class:`Image`): The images. Raises: :py:class:`docker.errors.APIError` If the server returns an error. r` z)(^Loaded image ID: |^Loaded image: )(.+)$r r_ c s g | ]}� � |��qS r rw )r( �ir% r r r* � s z(ImageCollection.load.<locals>.<listcomp>)r+ r, � load_imagere rf rg �appendr )r �datarh ry rm rn rj r r% r �load s � �zImageCollection.loadc K s� t |�\}}|p |p d}d|v rtjddd� |d= | jjj|f|d|d�|��}|D ]}q+|sD|�d�r7d nd }| �|� |� |� ��S | �|�S ) a� Pull an image of the given name and return it. Similar to the ``docker pull`` command. If ``tag`` is ``None`` or empty, it is set to ``latest``. If ``all_tags`` is set, the ``tag`` parameter is ignored and all image tags will be pulled. If you want to get the raw pull output, use the :py:meth:`~docker.api.image.ImageApiMixin.pull` method in the low-level API. Args: repository (str): The repository to pull tag (str): The tag to pull auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. platform (str): Platform in the format ``os[/arch[/variant]]`` all_tags (bool): Pull all image tags Returns: (:py:class:`Image` or list): The image that has been pulled. If ``all_tags`` is True, the method will return a list of :py:class:`Image` objects belonging to this repository. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> # Pull the image tagged `latest` in the busybox repo >>> image = client.images.pull('busybox') >>> # Pull all tags in the busybox repo >>> images = client.images.pull('busybox', all_tags=True) �latestr` zH`stream` is not a valid parameter for this method and will be overriddenr )� stacklevelT)r) r` �all_tagsr �@�:) r �warnings�warnr+ r, rK r$ r rz ) r r: r) r� r; � image_tag�pull_logrL �sepr r r rK � s* & ���� zImageCollection.pullc K s | j jj|fd|i|��S )Nr) )r+ r, �pushr9 r r r r� � s zImageCollection.pushc O s | j jj|i |�� d S r< )r+ r, r0 �r rE r; r r r r1 � s zImageCollection.removec O � | j jj|i |��S r< )r+ r, rf r� r r r rf � � zImageCollection.searchc C s | j jj|d�S )N)ru )r+ r, � prune_images)r ru r r r �prune� s zImageCollection.prunec O r� r< )r+ r, � prune_buildsr� r r r r� � r� z ImageCollection.prune_buildsr< )NFN)NF)r r= r> r �modelrb r rs rz r rK r� r r? r1 r0 rf r� r� r� r r r r r^ � s$ a > r^ c C s8 | d u ri } d| vr|d | d< d| vr|d | d< | S )NrP �OsrR �Archr )rI � engine_infor r r rW � s rW )rc re r� r, r � constantsr �errorsr r r �utilsr �utils.json_streamr �resourcer r r rA r^ rW r r r r �<module> s K models/__pycache__/secrets.cpython-310.pyc 0000644 00000005354 15027665106 0014427 0 ustar 00 o �h5 � @ s@ d dl mZ ddlmZmZ G dd� de�ZG dd� de�ZdS ) � )� APIClient� )� Collection�Modelc @ s0 e Zd ZdZdZdd� Zedd� �Zdd� Zd S ) �Secretz A secret.�IDc C s d| j j� d| j� d�S )N�<z: 'z'>)� __class__�__name__�name��self� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/secrets.py�__repr__ s zSecret.__repr__c C s | j d d S )N�Spec�Name)�attrsr r r r r s z Secret.namec C s | j j�| j�S )z� Remove this secret. Raises: :py:class:`docker.errors.APIError` If secret failed to remove. )�client�api� remove_secret�idr r r r �remove s z Secret.removeN) r � __module__� __qualname__�__doc__� id_attributer �propertyr r r r r r r s r c @ s6 e Zd ZdZeZdd� Zejje_dd� Z dd� Z dS ) �SecretCollectionz Secrets on the Docker server.c K s4 | j jjdi |��}|�d�|�di �d< | �|�S )Nr r r r )r r � create_secret�get� setdefault� prepare_model)r �kwargs�objr r r �create s zSecretCollection.createc C s | � | jj�|��S )ac Get a secret. Args: secret_id (str): Secret ID. Returns: (:py:class:`Secret`): The secret. Raises: :py:class:`docker.errors.NotFound` If the secret does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )r" r r �inspect_secret)r � secret_idr r r r % s zSecretCollection.getc s& � j jjdi |��}� fdd�|D �S )aT List secrets. Similar to the ``docker secret ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Secret`): The secrets. Raises: :py:class:`docker.errors.APIError` If the server returns an error. c s g | ]}� � |��qS r )r" )�.0r$ r r r � <listcomp>F s z)SecretCollection.list.<locals>.<listcomp>Nr )r r �secrets)r r# �respr r r �list7 s zSecretCollection.listN) r r r r r �modelr% r r r r, r r r r r s r N)r r �resourcer r r r r r r r �<module> s models/__pycache__/configs.cpython-310.pyc 0000644 00000005354 15027665106 0014407 0 ustar 00 o �h5 � @ s@ d dl mZ ddlmZmZ G dd� de�ZG dd� de�ZdS ) � )� APIClient� )� Collection�Modelc @ s0 e Zd ZdZdZdd� Zedd� �Zdd� Zd S ) �Configz A config.�IDc C s d| j j� d| j� d�S )N�<z: 'z'>)� __class__�__name__�name��self� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/configs.py�__repr__ s zConfig.__repr__c C s | j d d S )N�Spec�Name)�attrsr r r r r s z Config.namec C s | j j�| j�S )z� Remove this config. Raises: :py:class:`docker.errors.APIError` If config failed to remove. )�client�api� remove_config�idr r r r �remove s z Config.removeN) r � __module__� __qualname__�__doc__� id_attributer �propertyr r r r r r r s r c @ s6 e Zd ZdZeZdd� Zejje_dd� Z dd� Z dS ) �ConfigCollectionz Configs on the Docker server.c K s4 | j jjdi |��}|�d�|�di �d< | �|�S )Nr r r r )r r � create_config�get� setdefault� prepare_model)r �kwargs�objr r r �create s zConfigCollection.createc C s | � | jj�|��S )ac Get a config. Args: config_id (str): Config ID. Returns: (:py:class:`Config`): The config. Raises: :py:class:`docker.errors.NotFound` If the config does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )r" r r �inspect_config)r � config_idr r r r % s zConfigCollection.getc s& � j jjdi |��}� fdd�|D �S )aT List configs. Similar to the ``docker config ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Config`): The configs. Raises: :py:class:`docker.errors.APIError` If the server returns an error. c s g | ]}� � |��qS r )r" )�.0r$ r r r � <listcomp>F s z)ConfigCollection.list.<locals>.<listcomp>Nr )r r �configs)r r# �respr r r �list7 s zConfigCollection.listN) r r r r r �modelr% r r r r, r r r r r s r N)r r �resourcer r r r r r r r �<module> s models/__pycache__/containers.cpython-310.pyc 0000644 00000127622 15027665106 0015127 0 ustar 00 o �h�� � @ s� d dl Z d dlZd dlmZ ddlmZ ddlmZ ddlm Z m Z m Z m Z m Z ddlmZmZ ddlmZ d d lmZ d d lmZmZ G d d � d e�ZG dd� de�Zg d�Zg d�Zdd� Z dd� Z edd�Z dS )� N)� namedtuple� )� APIClient)�DEFAULT_DATA_CHUNK_SIZE)�ContainerError�DockerException� ImageNotFound�NotFound� create_unexpected_kwargs_error)� HostConfig�NetworkingConfig)� version_gte� )�Image)� Collection�Modelc @ s e Zd ZdZedd� �Zedd� �Zedd� �Zedd � �Zed d � �Z ed d � �Z dd� Z dd� Z d>dd�Z dd� Z d?dd�Zefd d �Zedfd d �Zd@d d!�Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Zd2d3� Z d4d5� Z d6d7� Z d8d9� Z d:d;� Z d<d=� Z!dS )A� ContaineraI Local representation of a container object. Detailed configuration may be accessed through the :py:attr:`attrs` attribute. Note that local attributes are cached; users may call :py:meth:`reload` to query the Docker daemon for the current properties, causing :py:attr:`attrs` to be refreshed. c C s$ | j �d�dur| j d �d�S dS )z, The name of the container. �NameN�/)�attrs�get�lstrip��self� r �N/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/containers.py�name s �zContainer.namec C s8 | j �d| j d �}|du rdS | jj�|�d�d �S )z- The image of the container. �ImageIDr N�:r )r r �client�images�split)r �image_idr r r �image$ s zContainer.imagec C s> z | j d �d�}|p i W S ty } ztd�|�d}~ww )z: The labels of a container as dictionary. �Config�LabelszYLabel data is not available for sparse objects. Call reload() to retrieve all informationN)r r �KeyErrorr )r �result�ker r r �labels. s ����zContainer.labelsc C s( t | jd t�r| jd d S | jd S )zW The status of the container. For example, ``running``, or ``exited``. �State�Status)� isinstancer �dictr r r r �status< s zContainer.statusc C s | j �di ��di ��dd�S )zm The healthcheck status of the container. For example, ``healthy`, or ``unhealthy`. r* �Healthr+ �unknown�r r r r r r �healthE s zContainer.healthc C s | j �di ��di �S )zG The ports that the container exposes as a dictionary. �NetworkSettings�Portsr1 r r r r �portsN s zContainer.portsc K � | j jj| jfi |��S )a Attach to this container. :py:meth:`logs` is a wrapper around this method, which you can use instead if you want to fetch/stream container output without first retrieving the entire backlog. Args: stdout (bool): Include stdout. stderr (bool): Include stderr. stream (bool): Return container output progressively as an iterator of strings, rather than a single string. logs (bool): Include the container's previous output. Returns: By default, the container's output as a single string. If ``stream=True``, an iterator of output strings. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r �api�attach�id�r �kwargsr r r r8 U s zContainer.attachc K r6 )a� Like :py:meth:`attach`, but returns the underlying socket-like object for the HTTP request. Args: params (dict): Dictionary of request parameters (e.g. ``stdout``, ``stderr``, ``stream``). ws (bool): Use websockets instead of raw HTTP. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 � attach_socketr9 r: r r r r< o � zContainer.attach_socketNc K s0 | j jj| jf||d�|��}| j j�|d �S )a Commit a container to an image. Similar to the ``docker commit`` command. Args: repository (str): The repository to push the image to tag (str): The tag to push message (str): A commit message author (str): The name of the author pause (bool): Whether to pause the container before committing changes (str): Dockerfile instructions to apply while committing conf (dict): The configuration for the container. See the `Engine API documentation <https://docs.docker.com/reference/api/docker_remote_api/>`_ for full details. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )� repository�tag�Id)r r7 �commitr9 r r )r r> r? r; �respr r r rA s �zContainer.commitc C � | j j�| j�S )a' Inspect changes on a container's filesystem. Returns: (list) A list of dictionaries containing the attributes `Path` and `Kind`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �diffr9 r r r r rD � s zContainer.diffTF� c C sp | j jj| j|||||||| | d� }| j jj|d ||| | | d�}| s%| r*td|�S t| j j�|d �d |�S )a1 Run a command inside this container. Similar to ``docker exec``. Args: cmd (str or list): Command to be executed stdout (bool): Attach to stdout. Default: ``True`` stderr (bool): Attach to stderr. Default: ``True`` stdin (bool): Attach to stdin. Default: ``False`` tty (bool): Allocate a pseudo-TTY. Default: False privileged (bool): Run as privileged. user (str): User to execute command as. Default: root detach (bool): If true, detach from the exec command. Default: False stream (bool): Stream response data. Default: False socket (bool): Return the connection socket to allow custom read/write operations. Default: False environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. workdir (str): Path to working directory for this exec session demux (bool): Return stdout and stderr separately Returns: (ExecResult): A tuple of (exit_code, output) exit_code: (int): Exit code for the executed command or ``None`` if either ``stream`` or ``socket`` is ``True``. output: (generator, bytes, or tuple): If ``stream=True``, a generator yielding response chunks. If ``socket=True``, a socket object for the connection. If ``demux=True``, a tuple of two bytes: stdout and stderr. A bytestring containing response data otherwise. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�stdout�stderr�stdin�tty� privileged�user� environment�workdirr@ )�detachrI �stream�socket�demuxN�ExitCode)r r7 � exec_creater9 � exec_start� ExecResult� exec_inspect)r �cmdrF rG rH rI rJ rK rN rO rP rL rM rQ rB � exec_outputr r r �exec_run� s )�� �zContainer.exec_runc C � | j j�| j|�S )a� Export the contents of the container's filesystem as a tar archive. Args: chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (str): The filesystem tar archive Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �exportr9 )r � chunk_sizer r r r[ � s zContainer.exportc C s | j j�| j|||�S )a� Retrieve a file or folder from the container in the form of a tar archive. Args: path (str): Path to the file or folder to retrieve chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB encode_stream (bool): Determines if data should be encoded (gzip-compressed) during transmission. Default: False Returns: (tuple): First element is a raw tar data stream. Second element is a dict containing ``stat`` information on the specified ``path``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> f = open('./sh_bin.tar', 'wb') >>> bits, stat = container.get_archive('/bin/sh') >>> print(stat) {'name': 'sh', 'size': 1075464, 'mode': 493, 'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''} >>> for chunk in bits: ... f.write(chunk) >>> f.close() )r r7 � get_archiver9 )r �pathr\ � encode_streamr r r r] � s !�zContainer.get_archivec C s | j jj| j|d�S )a Kill or send a signal to the container. Args: signal (str or int): The signal to send. Defaults to ``SIGKILL`` Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�signal)r r7 �killr9 )r r` r r r ra � zContainer.killc K r6 )a Get logs from this container. Similar to the ``docker logs`` command. The ``stream`` parameter makes the ``logs`` function return a blocking generator you can iterate over to retrieve log output as it happens. Args: stdout (bool): Get ``STDOUT``. Default ``True`` stderr (bool): Get ``STDERR``. Default ``True`` stream (bool): Stream the response. Default ``False`` timestamps (bool): Show timestamps. Default ``False`` tail (str or int): Output specified number of lines at the end of logs. Either an integer of number of lines or the string ``all``. Default ``all`` since (datetime, int, or float): Show logs since a given datetime, integer epoch (in seconds) or float (in nanoseconds) follow (bool): Follow log output. Default ``False`` until (datetime, int, or float): Show logs that occurred before the given datetime, integer epoch (in seconds), or float (in nanoseconds) Returns: (generator of bytes or bytes): Logs from the container. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �logsr9 r: r r r rc % s zContainer.logsc C rC )z� Pauses all processes within this container. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �pauser9 r r r r rd D � zContainer.pausec C � | j j�| j||�S )a� Insert a file or folder in this container using a tar archive as source. Args: path (str): Path inside the container where the file(s) will be extracted. Must exist. data (bytes or stream): tar data to be extracted Returns: (bool): True if the call succeeds. Raises: :py:class:`~docker.errors.APIError` If an error occurs. )r r7 � put_archiver9 )r r^ �datar r r rg N s zContainer.put_archivec K r6 )a� Remove this container. Similar to the ``docker rm`` command. Args: v (bool): Remove the volumes associated with the container link (bool): Remove the specified link and not the underlying container force (bool): Force the removal of a running container (uses ``SIGKILL``) Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �remove_containerr9 r: r r r �remove` s zContainer.removec C rZ )a Rename this container. Similar to the ``docker rename`` command. Args: name (str): New name for the container Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �renamer9 )r r r r r rk q s zContainer.renamec C rf )a Resize the tty session. Args: height (int): Height of tty session width (int): Width of tty session Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �resizer9 )r �height�widthr r r rl ~ rb zContainer.resizec K r6 )a� Restart this container. Similar to the ``docker restart`` command. Args: timeout (int): Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �restartr9 r: r r r ro � s zContainer.restartc K r6 )z� Start this container. Similar to the ``docker start`` command, but doesn't support attach options. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �startr9 r: r r r rp � s zContainer.startc K r6 )a# Stream statistics for this container. Similar to the ``docker stats`` command. Args: decode (bool): If set to true, stream will be decoded into dicts on the fly. Only applicable if ``stream`` is True. False by default. stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �statsr9 r: r r r rq � s zContainer.statsc K r6 )aU Stops a container. Similar to the ``docker stop`` command. Args: timeout (int): Timeout in seconds to wait for the container to stop before sending a ``SIGKILL``. Default: 10 Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �stopr9 r: r r r rr � s zContainer.stopc K r6 )aH Display the running processes of the container. Args: ps_args (str): An optional arguments passed to ps (e.g. ``aux``) Returns: (str): The output of the top Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �topr9 r: r r r rs � r= z Container.topc C rC )z� Unpause all processes within the container. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �unpauser9 r r r r rt � re zContainer.unpausec K r6 )a Update resource configuration of the containers. Args: blkio_weight (int): Block IO (relative weight), between 10 and 1000 cpu_period (int): Limit CPU CFS (Completely Fair Scheduler) period cpu_quota (int): Limit CPU CFS (Completely Fair Scheduler) quota cpu_shares (int): CPU shares (relative weight) cpuset_cpus (str): CPUs in which to allow execution cpuset_mems (str): MEMs in which to allow execution mem_limit (int or str): Memory limit mem_reservation (int or str): Memory soft limit memswap_limit (int or str): Total memory (memory + swap), -1 to disable swap kernel_memory (int or str): Kernel memory limit restart_policy (dict): Restart policy dictionary Returns: (dict): Dictionary containing a ``Warnings`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �update_containerr9 r: r r r �update� s zContainer.updatec K r6 )a� Block until the container stops, then return its exit code. Similar to the ``docker wait`` command. Args: timeout (int): Request timeout condition (str): Wait until a container state reaches the given condition, either ``not-running`` (default), ``next-exit``, or ``removed`` Returns: (dict): The API's response as a Python dictionary, including the container's exit code under the ``StatusCode`` attribute. Raises: :py:class:`requests.exceptions.ReadTimeout` If the timeout is exceeded. :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �waitr9 r: r r r rw � s zContainer.wait)NN) TTFFFrE FFFNNF�N)"�__name__� __module__� __qualname__�__doc__�propertyr r# r) r. r2 r5 r8 r< rA rD rY r r[ r] ra rc rd rg rj rk rl ro rp rq rr rs rt rv rw r r r r r sR � : � $ r c @ sR e Zd ZeZ ddd�Zddd�Zdd � Z dd d �Zdd d�Z e j j e _ dS )�ContainerCollectionNTFc K s� t |t�r|j}|�dd�}|�dd�}|�dd�} |r/|r/t| jjjd�r+d|d< nt d ��|�d �r=|�d �r=t d ��|�d �rK|�d �sKt d��z| j d|||d�|��} W n t yw | jj j || d� | j d|||d�|��} Y nw | �� |r�| S | jd d d } d} | dks�| dkr�| j||ddd�} | �� d } | dkr�d} |�d�s�| jddd�} |r�| �� | dkr�t| | ||| ��|s�| du r�| S d�| �S ) a�A Run a container. By default, it will wait for the container to finish and return its logs, similar to ``docker run``. If the ``detach`` argument is ``True``, it will start the container and immediately return a :py:class:`Container` object, similar to ``docker run -d``. Example: Run a container and get its output: >>> import docker >>> client = docker.from_env() >>> client.containers.run('alpine', 'echo hello world') b'hello world\n' Run a container and detach: >>> container = client.containers.run('bfirsh/reticulate-splines', detach=True) >>> container.logs() 'Reticulating spline 1...\nReticulating spline 2...\n' Args: image (str): The image to run. command (str or list): The command to run in the container. auto_remove (bool): enable auto-removal of the container on daemon side when the container's process exits. blkio_weight_device: Block IO weight (relative device weight) in the form of: ``[{"Path": "device_path", "Weight": weight}]``. blkio_weight: Block IO weight (relative weight), accepts a weight value between 10 and 1000. cap_add (list of str): Add kernel capabilities. For example, ``["SYS_ADMIN", "MKNOD"]``. cap_drop (list of str): Drop kernel capabilities. cgroup_parent (str): Override the default parent cgroup. cgroupns (str): Override the default cgroup namespace mode for the container. One of: - ``private`` the container runs in its own private cgroup namespace. - ``host`` use the host system's cgroup namespace. cpu_count (int): Number of usable CPUs (Windows only). cpu_percent (int): Usable percentage of the available CPUs (Windows only). cpu_period (int): The length of a CPU period in microseconds. cpu_quota (int): Microseconds of CPU time that the container can get in a CPU period. cpu_rt_period (int): Limit CPU real-time period in microseconds. cpu_rt_runtime (int): Limit CPU real-time runtime in microseconds. cpu_shares (int): CPU shares (relative weight). cpuset_cpus (str): CPUs in which to allow execution (``0-3``, ``0,1``). cpuset_mems (str): Memory nodes (MEMs) in which to allow execution (``0-3``, ``0,1``). Only effective on NUMA systems. detach (bool): Run container in the background and return a :py:class:`Container` object. device_cgroup_rules (:py:class:`list`): A list of cgroup rules to apply to the container. device_read_bps: Limit read rate (bytes per second) from a device in the form of: `[{"Path": "device_path", "Rate": rate}]` device_read_iops: Limit read rate (IO per second) from a device. device_write_bps: Limit write rate (bytes per second) from a device. device_write_iops: Limit write rate (IO per second) from a device. devices (:py:class:`list`): Expose host devices to the container, as a list of strings in the form ``<path_on_host>:<path_in_container>:<cgroup_permissions>``. For example, ``/dev/sda:/dev/xvda:rwm`` allows the container to have read-write access to the host's ``/dev/sda`` via a node named ``/dev/xvda`` inside the container. device_requests (:py:class:`list`): Expose host resources such as GPUs to the container, as a list of :py:class:`docker.types.DeviceRequest` instances. dns (:py:class:`list`): Set custom DNS servers. dns_opt (:py:class:`list`): Additional options to be added to the container's ``resolv.conf`` file. dns_search (:py:class:`list`): DNS search domains. domainname (str or list): Set custom DNS search domains. entrypoint (str or list): The entrypoint for the container. environment (dict or list): Environment variables to set inside the container, as a dictionary or a list of strings in the format ``["SOMEVARIABLE=xxx"]``. extra_hosts (dict): Additional hostnames to resolve inside the container, as a mapping of hostname to IP address. group_add (:py:class:`list`): List of additional group names and/or IDs that the container process will run as. healthcheck (dict): Specify a test to perform to check that the container is healthy. The dict takes the following keys: - test (:py:class:`list` or str): Test to perform to determine container health. Possible values: - Empty list: Inherit healthcheck from parent image - ``["NONE"]``: Disable healthcheck - ``["CMD", args...]``: exec arguments directly. - ``["CMD-SHELL", command]``: Run command in the system's default shell. If a string is provided, it will be used as a ``CMD-SHELL`` command. - interval (int): The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). - timeout (int): The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). - retries (int): The number of consecutive failures needed to consider a container as unhealthy. - start_period (int): Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). hostname (str): Optional hostname for the container. init (bool): Run an init inside the container that forwards signals and reaps processes init_path (str): Path to the docker-init binary ipc_mode (str): Set the IPC mode for the container. isolation (str): Isolation technology to use. Default: `None`. kernel_memory (int or str): Kernel memory limit labels (dict or list): A dictionary of name-value labels (e.g. ``{"label1": "value1", "label2": "value2"}``) or a list of names of labels to set with empty values (e.g. ``["label1", "label2"]``) links (dict): Mapping of links using the ``{'container': 'alias'}`` format. The alias is optional. Containers declared in this dict will be linked to the new container using the provided alias. Default: ``None``. log_config (LogConfig): Logging configuration. lxc_conf (dict): LXC config. mac_address (str): MAC address to assign to the container. mem_limit (int or str): Memory limit. Accepts float values (which represent the memory limit of the created container in bytes) or a string with a units identification char (``100000b``, ``1000k``, ``128m``, ``1g``). If a string is specified without a units character, bytes are assumed as an intended unit. mem_reservation (int or str): Memory soft limit. mem_swappiness (int): Tune a container's memory swappiness behavior. Accepts number between 0 and 100. memswap_limit (str or int): Maximum amount of memory + swap a container is allowed to consume. mounts (:py:class:`list`): Specification for mounts to be added to the container. More powerful alternative to ``volumes``. Each item in the list is expected to be a :py:class:`docker.types.Mount` object. name (str): The name for this container. nano_cpus (int): CPU quota in units of 1e-9 CPUs. network (str): Name of the network this container will be connected to at creation time. You can connect to additional networks using :py:meth:`Network.connect`. Incompatible with ``network_mode``. network_disabled (bool): Disable networking. network_mode (str): One of: - ``bridge`` Create a new network stack for the container on the bridge network. - ``none`` No networking for this container. - ``container:<name|id>`` Reuse another container's network stack. - ``host`` Use the host network stack. This mode is incompatible with ``ports``. Incompatible with ``network``. networking_config (Dict[str, EndpointConfig]): Dictionary of EndpointConfig objects for each container network. The key is the name of the network. Defaults to ``None``. Used in conjuction with ``network``. Incompatible with ``network_mode``. oom_kill_disable (bool): Whether to disable OOM killer. oom_score_adj (int): An integer value containing the score given to the container in order to tune OOM killer preferences. pid_mode (str): If set to ``host``, use the host PID namespace inside the container. pids_limit (int): Tune a container's pids limit. Set ``-1`` for unlimited. platform (str): Platform in the format ``os[/arch[/variant]]``. Only used if the method needs to pull the requested image. ports (dict): Ports to bind inside the container. The keys of the dictionary are the ports to bind inside the container, either as an integer or a string in the form ``port/protocol``, where the protocol is either ``tcp``, ``udp``, or ``sctp``. The values of the dictionary are the corresponding ports to open on the host, which can be either: - The port number, as an integer. For example, ``{'2222/tcp': 3333}`` will expose port 2222 inside the container as port 3333 on the host. - ``None``, to assign a random host port. For example, ``{'2222/tcp': None}``. - A tuple of ``(address, port)`` if you want to specify the host interface. For example, ``{'1111/tcp': ('127.0.0.1', 1111)}``. - A list of integers, if you want to bind multiple host ports to a single container port. For example, ``{'1111/tcp': [1234, 4567]}``. Incompatible with ``host`` network mode. privileged (bool): Give extended privileges to this container. publish_all_ports (bool): Publish all ports to the host. read_only (bool): Mount the container's root filesystem as read only. remove (bool): Remove the container when it has finished running. Default: ``False``. restart_policy (dict): Restart the container when it exits. Configured as a dictionary with keys: - ``Name`` One of ``on-failure``, or ``always``. - ``MaximumRetryCount`` Number of times to restart the container on failure. For example: ``{"Name": "on-failure", "MaximumRetryCount": 5}`` runtime (str): Runtime to use with this container. security_opt (:py:class:`list`): A list of string values to customize labels for MLS systems, such as SELinux. shm_size (str or int): Size of /dev/shm (e.g. ``1G``). stdin_open (bool): Keep ``STDIN`` open even if not attached. stdout (bool): Return logs from ``STDOUT`` when ``detach=False``. Default: ``True``. stderr (bool): Return logs from ``STDERR`` when ``detach=False``. Default: ``False``. stop_signal (str): The stop signal to use to stop the container (e.g. ``SIGINT``). storage_opt (dict): Storage driver options per container as a key-value mapping. stream (bool): If true and ``detach`` is false, return a log generator instead of a string. Ignored if ``detach`` is true. Default: ``False``. sysctls (dict): Kernel parameters to set in the container. tmpfs (dict): Temporary filesystems to mount, as a dictionary mapping a path inside the container to options for that path. For example: .. code-block:: python { '/mnt/vol2': '', '/mnt/vol1': 'size=3G,uid=1000' } tty (bool): Allocate a pseudo-TTY. ulimits (:py:class:`list`): Ulimits to set inside the container, as a list of :py:class:`docker.types.Ulimit` instances. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. user (str or int): Username or UID to run commands as inside the container. userns_mode (str): Sets the user namespace mode for the container when user namespace remapping option is enabled. Supported values are: ``host`` uts_mode (str): Sets the UTS namespace mode for the container. Supported values are: ``host`` version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``1.35`` volume_driver (str): The name of a volume driver/plugin. volumes (dict or list): A dictionary to configure volumes mounted inside the container. The key is either the host path or a volume name, and the value is a dictionary with the keys: - ``bind`` The path to mount the volume inside the container - ``mode`` Either ``rw`` to mount the volume read/write, or ``ro`` to mount it read-only. For example: .. code-block:: python {'/home/user1/': {'bind': '/mnt/vol2', 'mode': 'rw'}, '/var/www': {'bind': '/mnt/vol1', 'mode': 'ro'}} Or a list of strings which each one of its elements specifies a mount volume. For example: .. code-block:: python ['/home/user1/:/mnt/vol2','/var/www:/mnt/vol1'] volumes_from (:py:class:`list`): List of container names or IDs to get volumes from. working_dir (str): Path to the working directory. Returns: The container logs, either ``STDOUT``, ``STDERR``, or both, depending on the value of the ``stdout`` and ``stderr`` arguments. ``STDOUT`` and ``STDERR`` may be read only if either ``json-file`` or ``journald`` logging driver used. Thus, if you are using none of these drivers, a ``None`` object is returned instead. See the `Engine API documentation <https://docs.docker.com/engine/api/v1.30/#operation/ContainerLogs/>`_ for full details. If ``detach`` is ``True``, a :py:class:`Container` object is returned instead. Raises: :py:class:`docker.errors.ContainerError` If the container exits with a non-zero exit code and ``detach`` is ``False``. :py:class:`docker.errors.ImageNotFound` If the specified image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. rO FrN �platformNz1.25T� auto_removezQThe options 'detach' and 'remove' cannot be used together in api versions < 1.25.�network� network_modezBThe options "network" and "network_mode" can not be used together.�networking_configzAThe option "networking_config" can not be used without "network".)r# �commandrN )r r � LogConfig�Typez json-file�journald)rF rG rO �follow� StatusCoder )rF rG � r )r, r r9 �popr r r r7 �_version� RuntimeError�creater r �pullrp r rc rw rj r �join)r r# r� rF rG rj r; rO rN r � container�logging_driver�out� exit_statusr r r �run sp > �� � � � ��� � zContainerCollection.runc K sX t |t�r|j}||d< ||d< | jjj|d< t|�}| jjjdi |��}| �|d �S )a� Create a container without starting it. Similar to ``docker create``. Takes the same arguments as :py:meth:`run`, except for ``stdout``, ``stderr``, and ``remove``. Returns: A :py:class:`Container` object. Raises: :py:class:`docker.errors.ImageNotFound` If the specified image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. r# r� �versionr@ Nr ) r, r r9 r r7 r� �_create_container_args�create_containerr )r r# r� r; � create_kwargsrB r r r r� � s zContainerCollection.createc C s | j j�|�}| �|�S )a� Get a container by name or ID. Args: container_id (str): Container name or ID. Returns: A :py:class:`Container` object. Raises: :py:class:`docker.errors.NotFound` If the container does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )r r7 �inspect_container� prepare_model)r � container_idrB r r r r � s zContainerCollection.get���c sp � j jj|||||d�}|r� fdd�|D �S g } |D ]} z | �� �| d �� W q ty5 |s3� Y qw | S )af List containers. Similar to the ``docker ps`` command. Args: all (bool): Show all containers. Only running containers are shown by default since (str): Show only containers created since Id or Name, include non-running ones before (str): Show only container created before Id or Name, include non-running ones limit (int): Show `limit` last created containers, include non-running ones filters (dict): Filters to be processed on the image list. Available filters: - `exited` (int): Only containers with specified exit code - `status` (str): One of ``restarting``, ``running``, ``paused``, ``exited`` - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. - `id` (str): The id of the container. - `name` (str): The name of the container. - `ancestor` (str): Filter by container ancestor. Format of ``<image-name>[:tag]``, ``<image-id>``, or ``<image@digest>``. - `before` (str): Only containers created before a particular container. Give the container name or id. - `since` (str): Only containers created after a particular container. Give container name or id. A comprehensive list can be found in the documentation for `docker ps <https://docs.docker.com/engine/reference/commandline/ps>`_. sparse (bool): Do not inspect containers. Returns partial information, but guaranteed not to block. Use :py:meth:`Container.reload` on resulting objects to retrieve all attributes. Default: ``False`` ignore_removed (bool): Ignore failures due to missing containers when attempting to inspect containers from the original list. Set to ``True`` if race conditions are likely. Has no effect if ``sparse=True``. Default: ``False`` Returns: (list of :py:class:`Container`) Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�all�before�filters�limit�sincec s g | ]}� � |��qS r )r� )�.0�rr r r � <listcomp>� s z,ContainerCollection.list.<locals>.<listcomp>r@ )r r7 � containers�appendr r ) r r� r� r� r� r� �sparse�ignore_removedrB r� r� r r r �list� s 4� ��zContainerCollection.listc C s | j jj|d�S )N)r� )r r7 �prune_containers)r r� r r r �prune s zContainerCollection.prune)NTFFrx )FNNr� NFF) ry rz r{ r �modelr� r� r r� r� r r� r| r r r r r~ s � } � Dr~ )r� rN � domainname� entrypointrL � healthcheck�hostnamer# r) � mac_addressr �network_disabledr � stdin_open� stop_signalrI �use_config_proxyrK � working_dir)?r� �blkio_weight_device� blkio_weight�cap_add�cap_drop� cgroup_parent�cgroupns� cpu_count� cpu_percent� cpu_period� cpu_quota� cpu_shares� cpuset_cpus� cpuset_mems� cpu_rt_period�cpu_rt_runtime�device_cgroup_rules�device_read_bps�device_read_iops�device_write_bps�device_write_iops�devices�device_requests�dns_opt� dns_search�dns� extra_hosts� group_add�init� init_path�ipc_mode� isolation� kernel_memory�links� log_config�lxc_conf� mem_limit�mem_reservation�mem_swappiness� memswap_limit�mounts� nano_cpusr� �oom_kill_disable� oom_score_adj�pid_mode� pids_limitrJ �publish_all_ports� read_only�restart_policy� security_opt�shm_size� storage_opt�sysctls�tmpfs�ulimits� userns_mode�uts_moder� � volume_driver� volumes_from�runtimec C sZ i }t � | �D ] }|tv r| �|�||< qi }t � | �D ] }|tv r)| �|�||< q | �di �}|r6||d< | �di �}|rB||d< | �dd�}| �dd�}|rh|rX||vrXd}|r^t|�n|di|d< ||d< | rotd | ��tdi |��|d < |d �d �}|r�d d � t|� � �D �|d< |r�t |t �r�dd � |� � D �|d< |S dd � |D �|d< |S )zK Convert arguments to create() to arguments to create_container(). r5 � port_bindings�volumes�bindsr� Nr� r� r� � host_config� PortBindingsc S s g | ] }t |�d d���qS )r r )�tupler! )r� �pr r r r� � s �z*_create_container_args.<locals>.<listcomp>c S s g | ]}|� d ��qS )�bind)r �r� �vr r r r� � s �c S s g | ]}t |��qS r )�_host_volume_from_bindr� r r r r� � s �r ) �copy�RUN_CREATE_KWARGSr� �RUN_HOST_CONFIG_KWARGSr r r r �sorted�keysr, r- �values) r; r� �key�host_config_kwargsr5 r� r� r� r� r r r r� b s^ �� ��� � �� �r� c C sr t �| �\}}|�dd�}t|�dks|d dv r ||d S |d �d�s-|d �d�r5|d d d� S |d S )Nr r )�ro�rwr z:roz:rw���)�ntpath� splitdriver! �len�endswith)r� �drive�rest�bitsr r r r� � s r� rU zexit_code,output) r� r � collectionsr r7 r � constantsr �errorsr r r r r �typesr r �utilsr r r �resourcer r r r~ r� r r� r� rU r r r r �<module> s2 xC> models/__pycache__/networks.cpython-310.pyc 0000644 00000021225 15027665106 0014626 0 ustar 00 o �h � @ sX d dl mZ d dlmZ ddlmZ ddlmZmZ G dd� de�Z G dd � d e�Z d S ) � )� APIClient)� version_gte� )� Container)� Collection�Modelc @ s@ e Zd ZdZedd� �Zedd� �Zdd� Zdd � Zd d � Z d S ) �Networkz A Docker network. c C s | j �d�S )z* The name of the network. �Name)�attrs�get��self� r �L/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/networks.py�name s z Network.namec s" � fdd�� j �d�p i �� D �S )z� The containers that are connected to the network, as a list of :py:class:`~docker.models.containers.Container` objects. c s g | ] }� j j�|��qS r )�client� containersr )�.0�cidr r r � <listcomp> s �z&Network.containers.<locals>.<listcomp>� Containers)r r �keysr r r r r s �zNetwork.containersc O �0 t |t�r|j}| jjj|| jg|�R i |��S )a Connect a container to this network. Args: container (str): Container to connect to this network, as either an ID, name, or :py:class:`~docker.models.containers.Container` object. aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. links (:py:class:`list`): A list of links for this endpoint. Containers declared in this list will be linkedto this container. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. driver_opt (dict): A dictionary of options to provide to the network driver. Defaults to ``None``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )� isinstancer �idr �api� connect_container_to_network�r � container�args�kwargsr r r �connect s ���zNetwork.connectc O r )a� Disconnect a container from this network. Args: container (str): Container to disconnect from this network, as either an ID, name, or :py:class:`~docker.models.containers.Container` object. force (bool): Force the container to disconnect from a network. Default: ``False`` Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r r r r �!disconnect_container_from_networkr r r r � disconnect> s ���zNetwork.disconnectc C s | j j�| j�S )z� Remove this network. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r r �remove_networkr r r r r �removeS s zNetwork.removeN) �__name__� __module__� __qualname__�__doc__�propertyr r r! r# r% r r r r r s ! r c @ s@ e Zd ZdZeZdd� Zdd� Zdd� Zd d d �Z e j je _dS ) �NetworkCollectionz( Networks on the Docker server. c O s* | j jj|g|�R i |��}| �|d �S )a� Create a network. Similar to the ``docker network create``. Args: name (str): Name of the network driver (str): Name of the driver used to create the network options (dict): Driver options as a key-value dictionary ipam (IPAMConfig): Optional custom IP scheme for the network. check_duplicate (bool): Request daemon to check for networks with same name. Default: ``None``. internal (bool): Restrict external access to the network. Default ``False``. labels (dict): Map of labels to set on the network. Default ``None``. enable_ipv6 (bool): Enable IPv6 on the network. Default ``False``. attachable (bool): If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network. scope (str): Specify the network's scope (``local``, ``global`` or ``swarm``) ingress (bool): If set, create an ingress network which provides the routing-mesh in swarm mode. Returns: (:py:class:`Network`): The network that was created. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: A network using the bridge driver: >>> client.networks.create("network1", driver="bridge") You can also create more advanced networks with custom IPAM configurations. For example, setting the subnet to ``192.168.52.0/24`` and gateway address to ``192.168.52.254``. .. code-block:: python >>> ipam_pool = docker.types.IPAMPool( subnet='192.168.52.0/24', gateway='192.168.52.254' ) >>> ipam_config = docker.types.IPAMConfig( pool_configs=[ipam_pool] ) >>> client.networks.create( "network1", driver="bridge", ipam=ipam_config ) �Id)r r �create_networkr )r r r r �respr r r �created s 8zNetworkCollection.createc O s" | � | jjj|g|�R i |���S )aU Get a network by its ID. Args: network_id (str): The ID of the network. verbose (bool): Retrieve the service details across the cluster in swarm mode. scope (str): Filter the network by scope (``swarm``, ``global`` or ``local``). Returns: (:py:class:`Network`) The network. Raises: :py:class:`docker.errors.NotFound` If the network does not exist. :py:class:`docker.errors.APIError` If the server returns an error. )� prepare_modelr r �inspect_network)r � network_idr r r r r r � s �zNetworkCollection.getc s\ |� dd�}� jjj|i |��}� fdd�|D �}|r,t� jjjd�r,|D ]}|�� q%|S )a� List networks. Similar to the ``docker network ls`` command. Args: names (:py:class:`list`): List of names to filter by. ids (:py:class:`list`): List of ids to filter by. filters (dict): Filters to be processed on the network list. Available filters: - ``driver=[<driver-name>]`` Matches a network's driver. - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. - ``type=["custom"|"builtin"]`` Filters networks by type. greedy (bool): Fetch more details for each network individually. You might want this to get the containers attached to them. Returns: (list of :py:class:`Network`) The networks on the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �greedyFc s g | ]}� � |��qS r )r0 )r �itemr r r r � s z*NetworkCollection.list.<locals>.<listcomp>z1.28)�popr r �networksr �_version�reload)r r r r3 r. r6 �netr r r �list� s zNetworkCollection.listNc C s | j jj|d�S )N)�filters)r r �prune_networks)r r; r r r �prune� s zNetworkCollection.prune)N) r& r' r( r) r �modelr/ r r: r= r r< r r r r r+ ^ s ; r+ N) r r �utilsr r r �resourcer r r r+ r r r r �<module> s W models/__pycache__/resource.cpython-310.pyc 0000644 00000006133 15027665106 0014602 0 ustar 00 o �h � @ s G d d� d�Z G dd� d�ZdS )c @ sV e Zd ZdZdZddd�Zdd� Zdd � Zd d � Ze d d � �Z e dd� �Z dd� Z dS )�ModelzF A base class for representing a single object on the server. �IdNc C s* || _ || _|| _| jd u ri | _d S d S �N)�client� collection�attrs)�selfr r r � r �L/usr/local/CyberPanel/lib/python3.10/site-packages/docker/models/resource.py�__init__ s �zModel.__init__c C s d| j j� d| j� d�S )N�<z: �>)� __class__�__name__�short_id�r r r r �__repr__ � zModel.__repr__c C s t || j�o | j|jkS r )� isinstancer �id)r �otherr r r �__eq__ r z Model.__eq__c C s t | jj� d| j� ��S )N�:)�hashr r r r r r r �__hash__ r zModel.__hash__c C s | j �| j�S )z' The ID of the object. )r �get� id_attributer r r r r � zModel.idc C s | j dd� S )zC The ID of the object, truncated to 12 characters. N� )r r r r r r # r zModel.short_idc C s | j �| j�}|j| _dS )zh Load this object from the server again and update ``attrs`` with the new data. N)r r r r )r � new_modelr r r �reload* s z Model.reload)NNN) r � __module__� __qualname__�__doc__r r r r r �propertyr r r r r r r r s r c @ sH e Zd ZdZdZddd�Zdd� Zdd� Zd d � Zdd d �Z d d� Z dS )� Collectionz[ A base class for representing all objects of a particular type on the server. Nc C s || _ d S r )r )r r r r r r < s zCollection.__init__c O s t d| jj� d���)N�'zh' object is not callable. You might be trying to use the old (pre-2.0) API - use docker.APIClient if so.)� TypeErrorr r )r �args�kwargsr r r �__call__A s �zCollection.__call__c C � t �r ��NotImplementedErrorr r r r �listH � zCollection.listc C r* r r+ )r �keyr r r r K r. zCollection.getc C r* r r+ �r r r r r �createN r. zCollection.createc C sP t |t�r| j|_| |_|S t |t�r | j|| j| d�S td| jj� d|� ���)z: Create a model from a set of attributes. )r r r z Can't create z from )r r r r �dict�model� Exceptionr r0 r r r � prepare_modelQ s zCollection.prepare_modelr ) r r r! r" r3 r r) r- r r1 r5 r r r r r$ 3 s r$ N)r r$ r r r r �<module> s 2 models/resource.py 0000644 00000005024 15027665106 0010241 0 ustar 00 class Model: """ A base class for representing a single object on the server. """ id_attribute = 'Id' def __init__(self, attrs=None, client=None, collection=None): #: A client pointing at the server that this object is on. self.client = client #: The collection that this model is part of. self.collection = collection #: The raw representation of this object from the API self.attrs = attrs if self.attrs is None: self.attrs = {} def __repr__(self): return f"<{self.__class__.__name__}: {self.short_id}>" def __eq__(self, other): return isinstance(other, self.__class__) and self.id == other.id def __hash__(self): return hash(f"{self.__class__.__name__}:{self.id}") @property def id(self): """ The ID of the object. """ return self.attrs.get(self.id_attribute) @property def short_id(self): """ The ID of the object, truncated to 12 characters. """ return self.id[:12] def reload(self): """ Load this object from the server again and update ``attrs`` with the new data. """ new_model = self.collection.get(self.id) self.attrs = new_model.attrs class Collection: """ A base class for representing all objects of a particular type on the server. """ #: The type of object this collection represents, set by subclasses model = None def __init__(self, client=None): #: The client pointing at the server that this collection of objects #: is on. self.client = client def __call__(self, *args, **kwargs): raise TypeError( f"'{self.__class__.__name__}' object is not callable. " "You might be trying to use the old (pre-2.0) API - " "use docker.APIClient if so." ) def list(self): raise NotImplementedError def get(self, key): raise NotImplementedError def create(self, attrs=None): raise NotImplementedError def prepare_model(self, attrs): """ Create a model from a set of attributes. """ if isinstance(attrs, Model): attrs.client = self.client attrs.collection = self return attrs elif isinstance(attrs, dict): return self.model(attrs=attrs, client=self.client, collection=self) else: raise Exception(f"Can't create {self.model.__name__} from {attrs}") models/plugins.py 0000644 00000013523 15027665106 0010076 0 ustar 00 from .. import errors from .resource import Collection, Model class Plugin(Model): """ A plugin on the server. """ def __repr__(self): return f"<{self.__class__.__name__}: '{self.name}'>" @property def name(self): """ The plugin's name. """ return self.attrs.get('Name') @property def enabled(self): """ Whether the plugin is enabled. """ return self.attrs.get('Enabled') @property def settings(self): """ A dictionary representing the plugin's configuration. """ return self.attrs.get('Settings') def configure(self, options): """ 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. """ self.client.api.configure_plugin(self.name, options) self.reload() def disable(self, force=False): """ Disable the plugin. Args: force (bool): Force disable. Default: False Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ self.client.api.disable_plugin(self.name, force) self.reload() def enable(self, timeout=0): """ Enable the plugin. Args: timeout (int): Timeout in seconds. Default: 0 Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ self.client.api.enable_plugin(self.name, timeout) self.reload() def push(self): """ 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. """ return self.client.api.push_plugin(self.name) def remove(self, force=False): """ 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. """ return self.client.api.remove_plugin(self.name, force=force) def upgrade(self, remote=None): """ 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 """ if self.enabled: raise errors.DockerError( 'Plugin must be disabled before upgrading.' ) if remote is None: remote = self.name privileges = self.client.api.plugin_privileges(remote) yield from self.client.api.upgrade_plugin( self.name, remote, privileges, ) self.reload() class PluginCollection(Collection): model = Plugin def create(self, name, plugin_data_dir, gzip=False): """ 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. """ self.client.api.create_plugin(name, plugin_data_dir, gzip) return self.get(name) def get(self, name): """ 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. """ return self.prepare_model(self.client.api.inspect_plugin(name)) def install(self, remote_name, local_name=None): """ 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. """ privileges = self.client.api.plugin_privileges(remote_name) it = self.client.api.pull_plugin(remote_name, privileges, local_name) for _data in it: pass return self.get(local_name or remote_name) def list(self): """ 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. """ resp = self.client.api.plugins() return [self.prepare_model(r) for r in resp] models/images.py 0000644 00000043120 15027665106 0007656 0 ustar 00 import itertools import re import warnings from ..api import APIClient from ..constants import DEFAULT_DATA_CHUNK_SIZE from ..errors import BuildError, ImageLoadError, InvalidArgument from ..utils import parse_repository_tag from ..utils.json_stream import json_stream from .resource import Collection, Model class Image(Model): """ An image on the server. """ def __repr__(self): tag_str = "', '".join(self.tags) return f"<{self.__class__.__name__}: '{tag_str}'>" @property def labels(self): """ The labels of an image as dictionary. """ result = self.attrs['Config'].get('Labels') return result or {} @property def short_id(self): """ The ID of the image truncated to 12 characters, plus the ``sha256:`` prefix. """ if self.id.startswith('sha256:'): return self.id[:19] return self.id[:12] @property def tags(self): """ The image's tags. """ tags = self.attrs.get('RepoTags') if tags is None: tags = [] return [tag for tag in tags if tag != '<none>:<none>'] def history(self): """ Show the history of an image. Returns: (list): The history of the image. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.history(self.id) def remove(self, force=False, noprune=False): """ Remove this image. Args: force (bool): Force removal of the image noprune (bool): Do not delete untagged parents Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.remove_image( self.id, force=force, noprune=noprune, ) def save(self, chunk_size=DEFAULT_DATA_CHUNK_SIZE, named=False): """ Get a tarball of an image. Similar to the ``docker save`` command. Args: chunk_size (int): The generator will return up to that much data per iteration, but may return less. If ``None``, data will be streamed as it is received. Default: 2 MB named (str or bool): If ``False`` (default), the tarball will not retain repository and tag information for this image. If set to ``True``, the first tag in the :py:attr:`~tags` list will be used to identify the image. Alternatively, any element of the :py:attr:`~tags` list can be used as an argument to use that specific tag as the saved identifier. Returns: (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> image = cli.images.get("busybox:latest") >>> f = open('/tmp/busybox-latest.tar', 'wb') >>> for chunk in image.save(): >>> f.write(chunk) >>> f.close() """ img = self.id if named: img = self.tags[0] if self.tags else img if isinstance(named, str): if named not in self.tags: raise InvalidArgument( f"{named} is not a valid tag for this image" ) img = named return self.client.api.get_image(img, chunk_size) def tag(self, repository, tag=None, **kwargs): """ Tag this image into a repository. Similar to the ``docker tag`` command. Args: repository (str): The repository to set for the tag tag (str): The tag name force (bool): Force Raises: :py:class:`docker.errors.APIError` If the server returns an error. Returns: (bool): ``True`` if successful """ return self.client.api.tag(self.id, repository, tag=tag, **kwargs) class RegistryData(Model): """ Image metadata stored on the registry, including available platforms. """ def __init__(self, image_name, *args, **kwargs): super().__init__(*args, **kwargs) self.image_name = image_name @property def id(self): """ The ID of the object. """ return self.attrs['Descriptor']['digest'] @property def short_id(self): """ The ID of the image truncated to 12 characters, plus the ``sha256:`` prefix. """ return self.id[:19] def pull(self, platform=None): """ Pull the image digest. Args: platform (str): The platform to pull the image for. Default: ``None`` Returns: (:py:class:`Image`): A reference to the pulled image. """ repository, _ = parse_repository_tag(self.image_name) return self.collection.pull(repository, tag=self.id, platform=platform) def has_platform(self, platform): """ Check whether the given platform identifier is available for this digest. Args: platform (str or dict): A string using the ``os[/arch[/variant]]`` format, or a platform dictionary. Returns: (bool): ``True`` if the platform is recognized as available, ``False`` otherwise. Raises: :py:class:`docker.errors.InvalidArgument` If the platform argument is not a valid descriptor. """ if platform and not isinstance(platform, dict): parts = platform.split('/') if len(parts) > 3 or len(parts) < 1: raise InvalidArgument( f'"{platform}" is not a valid platform descriptor' ) platform = {'os': parts[0]} if len(parts) > 2: platform['variant'] = parts[2] if len(parts) > 1: platform['architecture'] = parts[1] return normalize_platform( platform, self.client.version() ) in self.attrs['Platforms'] def reload(self): self.attrs = self.client.api.inspect_distribution(self.image_name) reload.__doc__ = Model.reload.__doc__ class ImageCollection(Collection): model = Image def build(self, **kwargs): """ Build an image and return it. Similar to the ``docker build`` command. Either ``path`` or ``fileobj`` must be set. If you already have a tar file for the Docker build context (including a Dockerfile), pass a readable file-like object to ``fileobj`` and also pass ``custom_context=True``. If the stream is also compressed, set ``encoding`` to the correct value (e.g ``gzip``). If you want to get the raw output of the build, use the :py:meth:`~docker.api.build.BuildApiMixin.build` method in the low-level API. Args: path (str): Path to the directory containing the Dockerfile fileobj: A file object to use as the Dockerfile. (Or a file-like object) tag (str): A tag to add to the final image quiet (bool): Whether to return the status nocache (bool): Don't use the cache when set to ``True`` rm (bool): Remove intermediate containers. The ``docker build`` command now defaults to ``--rm=true``, but we have kept the old default of `False` to preserve backward compatibility timeout (int): HTTP timeout custom_context (bool): Optional if using ``fileobj`` encoding (str): The encoding for a stream. Set to ``gzip`` for compressing pull (bool): Downloads any updates to the FROM image in Dockerfiles forcerm (bool): Always remove intermediate containers, even after unsuccessful builds dockerfile (str): path within the build context to the Dockerfile buildargs (dict): A dictionary of build arguments container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys: - memory (int): set memory limit for build - memswap (int): Total memory (memory + swap), -1 to disable swap - cpushares (int): CPU shares (relative weight) - cpusetcpus (str): CPUs in which to allow execution, e.g., ``"0-3"``, ``"0,1"`` shmsize (int): Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB labels (dict): A dictionary of labels to set on the image cache_from (list): A list of images used for build cache resolution target (str): Name of the build-stage to build in a multi-stage Dockerfile network_mode (str): networking mode for the run commands during build squash (bool): Squash the resulting images layers into a single layer. extra_hosts (dict): Extra hosts to add to /etc/hosts in building containers, as a mapping of hostname to IP address. platform (str): Platform in the format ``os[/arch[/variant]]``. isolation (str): Isolation technology used during build. Default: `None`. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. Returns: (tuple): The first item is the :py:class:`Image` object for the image that was built. The second item is a generator of the build logs as JSON-decoded objects. Raises: :py:class:`docker.errors.BuildError` If there is an error during the build. :py:class:`docker.errors.APIError` If the server returns any other error. ``TypeError`` If neither ``path`` nor ``fileobj`` is specified. """ resp = self.client.api.build(**kwargs) if isinstance(resp, str): return self.get(resp) last_event = None image_id = None result_stream, internal_stream = itertools.tee(json_stream(resp)) for chunk in internal_stream: if 'error' in chunk: raise BuildError(chunk['error'], result_stream) if 'stream' in chunk: match = re.search( r'(^Successfully built |sha256:)([0-9a-f]+)$', chunk['stream'] ) if match: image_id = match.group(2) last_event = chunk if image_id: return (self.get(image_id), result_stream) raise BuildError(last_event or 'Unknown', result_stream) def get(self, name): """ Gets an image. Args: name (str): The name of the image. Returns: (:py:class:`Image`): The image. Raises: :py:class:`docker.errors.ImageNotFound` If the image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.prepare_model(self.client.api.inspect_image(name)) def get_registry_data(self, name, auth_config=None): """ Gets the registry data for an image. Args: name (str): The name of the image. auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. Returns: (:py:class:`RegistryData`): The data object. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return RegistryData( image_name=name, attrs=self.client.api.inspect_distribution(name, auth_config), client=self.client, collection=self, ) def list(self, name=None, all=False, filters=None): """ List images on the server. Args: name (str): Only show images belonging to the repository ``name`` all (bool): Show intermediate image layers. By default, these are filtered out. filters (dict): Filters to be processed on the image list. Available filters: - ``dangling`` (bool) - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. Returns: (list of :py:class:`Image`): The images. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.images(name=name, all=all, filters=filters) return [self.get(r["Id"]) for r in resp] def load(self, data): """ Load an image that was previously saved using :py:meth:`~docker.models.images.Image.save` (or ``docker save``). Similar to ``docker load``. Args: data (binary): Image data to be loaded. Returns: (list of :py:class:`Image`): The images. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.load_image(data) images = [] for chunk in resp: if 'stream' in chunk: match = re.search( r'(^Loaded image ID: |^Loaded image: )(.+)$', chunk['stream'] ) if match: image_id = match.group(2) images.append(image_id) if 'error' in chunk: raise ImageLoadError(chunk['error']) return [self.get(i) for i in images] def pull(self, repository, tag=None, all_tags=False, **kwargs): """ Pull an image of the given name and return it. Similar to the ``docker pull`` command. If ``tag`` is ``None`` or empty, it is set to ``latest``. If ``all_tags`` is set, the ``tag`` parameter is ignored and all image tags will be pulled. If you want to get the raw pull output, use the :py:meth:`~docker.api.image.ImageApiMixin.pull` method in the low-level API. Args: repository (str): The repository to pull tag (str): The tag to pull auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. platform (str): Platform in the format ``os[/arch[/variant]]`` all_tags (bool): Pull all image tags Returns: (:py:class:`Image` or list): The image that has been pulled. If ``all_tags`` is True, the method will return a list of :py:class:`Image` objects belonging to this repository. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> # Pull the image tagged `latest` in the busybox repo >>> image = client.images.pull('busybox') >>> # Pull all tags in the busybox repo >>> images = client.images.pull('busybox', all_tags=True) """ repository, image_tag = parse_repository_tag(repository) tag = tag or image_tag or 'latest' if 'stream' in kwargs: warnings.warn( '`stream` is not a valid parameter for this method' ' and will be overridden', stacklevel=1, ) del kwargs['stream'] pull_log = self.client.api.pull( repository, tag=tag, stream=True, all_tags=all_tags, **kwargs ) for _ in pull_log: # We don't do anything with the logs, but we need # to keep the connection alive and wait for the image # to be pulled. pass if not all_tags: sep = '@' if tag.startswith('sha256:') else ':' return self.get(f'{repository}{sep}{tag}') return self.list(repository) def push(self, repository, tag=None, **kwargs): return self.client.api.push(repository, tag=tag, **kwargs) push.__doc__ = APIClient.push.__doc__ def remove(self, *args, **kwargs): self.client.api.remove_image(*args, **kwargs) remove.__doc__ = APIClient.remove_image.__doc__ def search(self, *args, **kwargs): return self.client.api.search(*args, **kwargs) search.__doc__ = APIClient.search.__doc__ def prune(self, filters=None): return self.client.api.prune_images(filters=filters) prune.__doc__ = APIClient.prune_images.__doc__ def prune_builds(self, *args, **kwargs): return self.client.api.prune_builds(*args, **kwargs) prune_builds.__doc__ = APIClient.prune_builds.__doc__ def normalize_platform(platform, engine_info): if platform is None: platform = {} if 'os' not in platform: platform['os'] = engine_info['Os'] if 'architecture' not in platform: platform['architecture'] = engine_info['Arch'] return platform models/containers.py 0000644 00000133217 15027665106 0010565 0 ustar 00 import copy import ntpath from collections import namedtuple from ..api import APIClient from ..constants import DEFAULT_DATA_CHUNK_SIZE from ..errors import ( ContainerError, DockerException, ImageNotFound, NotFound, create_unexpected_kwargs_error, ) from ..types import HostConfig, NetworkingConfig from ..utils import version_gte from .images import Image from .resource import Collection, Model class Container(Model): """ Local representation of a container object. Detailed configuration may be accessed through the :py:attr:`attrs` attribute. Note that local attributes are cached; users may call :py:meth:`reload` to query the Docker daemon for the current properties, causing :py:attr:`attrs` to be refreshed. """ @property def name(self): """ The name of the container. """ if self.attrs.get('Name') is not None: return self.attrs['Name'].lstrip('/') @property def image(self): """ The image of the container. """ image_id = self.attrs.get('ImageID', self.attrs['Image']) if image_id is None: return None return self.client.images.get(image_id.split(':')[1]) @property def labels(self): """ The labels of a container as dictionary. """ try: result = self.attrs['Config'].get('Labels') return result or {} except KeyError as ke: raise DockerException( 'Label data is not available for sparse objects. Call reload()' ' to retrieve all information' ) from ke @property def status(self): """ The status of the container. For example, ``running``, or ``exited``. """ if isinstance(self.attrs['State'], dict): return self.attrs['State']['Status'] return self.attrs['State'] @property def health(self): """ The healthcheck status of the container. For example, ``healthy`, or ``unhealthy`. """ return self.attrs.get('State', {}).get('Health', {}).get('Status', 'unknown') @property def ports(self): """ The ports that the container exposes as a dictionary. """ return self.attrs.get('NetworkSettings', {}).get('Ports', {}) def attach(self, **kwargs): """ Attach to this container. :py:meth:`logs` is a wrapper around this method, which you can use instead if you want to fetch/stream container output without first retrieving the entire backlog. Args: stdout (bool): Include stdout. stderr (bool): Include stderr. stream (bool): Return container output progressively as an iterator of strings, rather than a single string. logs (bool): Include the container's previous output. Returns: By default, the container's output as a single string. If ``stream=True``, an iterator of output strings. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.attach(self.id, **kwargs) def attach_socket(self, **kwargs): """ Like :py:meth:`attach`, but returns the underlying socket-like object for the HTTP request. Args: params (dict): Dictionary of request parameters (e.g. ``stdout``, ``stderr``, ``stream``). ws (bool): Use websockets instead of raw HTTP. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.attach_socket(self.id, **kwargs) def commit(self, repository=None, tag=None, **kwargs): """ Commit a container to an image. Similar to the ``docker commit`` command. Args: repository (str): The repository to push the image to tag (str): The tag to push message (str): A commit message author (str): The name of the author pause (bool): Whether to pause the container before committing changes (str): Dockerfile instructions to apply while committing conf (dict): The configuration for the container. See the `Engine API documentation <https://docs.docker.com/reference/api/docker_remote_api/>`_ for full details. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.commit(self.id, repository=repository, tag=tag, **kwargs) return self.client.images.get(resp['Id']) def diff(self): """ Inspect changes on a container's filesystem. Returns: (list) A list of dictionaries containing the attributes `Path` and `Kind`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.diff(self.id) def exec_run(self, cmd, stdout=True, stderr=True, stdin=False, tty=False, privileged=False, user='', detach=False, stream=False, socket=False, environment=None, workdir=None, demux=False): """ Run a command inside this container. Similar to ``docker exec``. Args: cmd (str or list): Command to be executed stdout (bool): Attach to stdout. Default: ``True`` stderr (bool): Attach to stderr. Default: ``True`` stdin (bool): Attach to stdin. Default: ``False`` tty (bool): Allocate a pseudo-TTY. Default: False privileged (bool): Run as privileged. user (str): User to execute command as. Default: root detach (bool): If true, detach from the exec command. Default: False stream (bool): Stream response data. Default: False socket (bool): Return the connection socket to allow custom read/write operations. Default: False environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. workdir (str): Path to working directory for this exec session demux (bool): Return stdout and stderr separately Returns: (ExecResult): A tuple of (exit_code, output) exit_code: (int): Exit code for the executed command or ``None`` if either ``stream`` or ``socket`` is ``True``. output: (generator, bytes, or tuple): If ``stream=True``, a generator yielding response chunks. If ``socket=True``, a socket object for the connection. If ``demux=True``, a tuple of two bytes: stdout and stderr. A bytestring containing response data otherwise. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.exec_create( self.id, cmd, stdout=stdout, stderr=stderr, stdin=stdin, tty=tty, privileged=privileged, user=user, environment=environment, workdir=workdir, ) exec_output = self.client.api.exec_start( resp['Id'], detach=detach, tty=tty, stream=stream, socket=socket, demux=demux ) if socket or stream: return ExecResult(None, exec_output) return ExecResult( self.client.api.exec_inspect(resp['Id'])['ExitCode'], exec_output ) def export(self, chunk_size=DEFAULT_DATA_CHUNK_SIZE): """ Export the contents of the container's filesystem as a tar archive. Args: chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (str): The filesystem tar archive Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.export(self.id, chunk_size) def get_archive(self, path, chunk_size=DEFAULT_DATA_CHUNK_SIZE, encode_stream=False): """ Retrieve a file or folder from the container in the form of a tar archive. Args: path (str): Path to the file or folder to retrieve chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB encode_stream (bool): Determines if data should be encoded (gzip-compressed) during transmission. Default: False Returns: (tuple): First element is a raw tar data stream. Second element is a dict containing ``stat`` information on the specified ``path``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> f = open('./sh_bin.tar', 'wb') >>> bits, stat = container.get_archive('/bin/sh') >>> print(stat) {'name': 'sh', 'size': 1075464, 'mode': 493, 'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''} >>> for chunk in bits: ... f.write(chunk) >>> f.close() """ return self.client.api.get_archive(self.id, path, chunk_size, encode_stream) def kill(self, signal=None): """ Kill or send a signal to the container. Args: signal (str or int): The signal to send. Defaults to ``SIGKILL`` Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.kill(self.id, signal=signal) def logs(self, **kwargs): """ Get logs from this container. Similar to the ``docker logs`` command. The ``stream`` parameter makes the ``logs`` function return a blocking generator you can iterate over to retrieve log output as it happens. Args: stdout (bool): Get ``STDOUT``. Default ``True`` stderr (bool): Get ``STDERR``. Default ``True`` stream (bool): Stream the response. Default ``False`` timestamps (bool): Show timestamps. Default ``False`` tail (str or int): Output specified number of lines at the end of logs. Either an integer of number of lines or the string ``all``. Default ``all`` since (datetime, int, or float): Show logs since a given datetime, integer epoch (in seconds) or float (in nanoseconds) follow (bool): Follow log output. Default ``False`` until (datetime, int, or float): Show logs that occurred before the given datetime, integer epoch (in seconds), or float (in nanoseconds) Returns: (generator of bytes or bytes): Logs from the container. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.logs(self.id, **kwargs) def pause(self): """ Pauses all processes within this container. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.pause(self.id) def put_archive(self, path, data): """ Insert a file or folder in this container using a tar archive as source. Args: path (str): Path inside the container where the file(s) will be extracted. Must exist. data (bytes or stream): tar data to be extracted Returns: (bool): True if the call succeeds. Raises: :py:class:`~docker.errors.APIError` If an error occurs. """ return self.client.api.put_archive(self.id, path, data) def remove(self, **kwargs): """ Remove this container. Similar to the ``docker rm`` command. Args: v (bool): Remove the volumes associated with the container link (bool): Remove the specified link and not the underlying container force (bool): Force the removal of a running container (uses ``SIGKILL``) Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.remove_container(self.id, **kwargs) def rename(self, name): """ Rename this container. Similar to the ``docker rename`` command. Args: name (str): New name for the container Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.rename(self.id, name) def resize(self, height, width): """ Resize the tty session. Args: height (int): Height of tty session width (int): Width of tty session Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.resize(self.id, height, width) def restart(self, **kwargs): """ Restart this container. Similar to the ``docker restart`` command. Args: timeout (int): Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.restart(self.id, **kwargs) def start(self, **kwargs): """ Start this container. Similar to the ``docker start`` command, but doesn't support attach options. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.start(self.id, **kwargs) def stats(self, **kwargs): """ Stream statistics for this container. Similar to the ``docker stats`` command. Args: decode (bool): If set to true, stream will be decoded into dicts on the fly. Only applicable if ``stream`` is True. False by default. stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.stats(self.id, **kwargs) def stop(self, **kwargs): """ Stops a container. Similar to the ``docker stop`` command. Args: timeout (int): Timeout in seconds to wait for the container to stop before sending a ``SIGKILL``. Default: 10 Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.stop(self.id, **kwargs) def top(self, **kwargs): """ Display the running processes of the container. Args: ps_args (str): An optional arguments passed to ps (e.g. ``aux``) Returns: (str): The output of the top Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.top(self.id, **kwargs) def unpause(self): """ Unpause all processes within the container. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.unpause(self.id) def update(self, **kwargs): """ Update resource configuration of the containers. Args: blkio_weight (int): Block IO (relative weight), between 10 and 1000 cpu_period (int): Limit CPU CFS (Completely Fair Scheduler) period cpu_quota (int): Limit CPU CFS (Completely Fair Scheduler) quota cpu_shares (int): CPU shares (relative weight) cpuset_cpus (str): CPUs in which to allow execution cpuset_mems (str): MEMs in which to allow execution mem_limit (int or str): Memory limit mem_reservation (int or str): Memory soft limit memswap_limit (int or str): Total memory (memory + swap), -1 to disable swap kernel_memory (int or str): Kernel memory limit restart_policy (dict): Restart policy dictionary Returns: (dict): Dictionary containing a ``Warnings`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.update_container(self.id, **kwargs) def wait(self, **kwargs): """ Block until the container stops, then return its exit code. Similar to the ``docker wait`` command. Args: timeout (int): Request timeout condition (str): Wait until a container state reaches the given condition, either ``not-running`` (default), ``next-exit``, or ``removed`` Returns: (dict): The API's response as a Python dictionary, including the container's exit code under the ``StatusCode`` attribute. Raises: :py:class:`requests.exceptions.ReadTimeout` If the timeout is exceeded. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.wait(self.id, **kwargs) class ContainerCollection(Collection): model = Container def run(self, image, command=None, stdout=True, stderr=False, remove=False, **kwargs): """ Run a container. By default, it will wait for the container to finish and return its logs, similar to ``docker run``. If the ``detach`` argument is ``True``, it will start the container and immediately return a :py:class:`Container` object, similar to ``docker run -d``. Example: Run a container and get its output: >>> import docker >>> client = docker.from_env() >>> client.containers.run('alpine', 'echo hello world') b'hello world\\n' Run a container and detach: >>> container = client.containers.run('bfirsh/reticulate-splines', detach=True) >>> container.logs() 'Reticulating spline 1...\\nReticulating spline 2...\\n' Args: image (str): The image to run. command (str or list): The command to run in the container. auto_remove (bool): enable auto-removal of the container on daemon side when the container's process exits. blkio_weight_device: Block IO weight (relative device weight) in the form of: ``[{"Path": "device_path", "Weight": weight}]``. blkio_weight: Block IO weight (relative weight), accepts a weight value between 10 and 1000. cap_add (list of str): Add kernel capabilities. For example, ``["SYS_ADMIN", "MKNOD"]``. cap_drop (list of str): Drop kernel capabilities. cgroup_parent (str): Override the default parent cgroup. cgroupns (str): Override the default cgroup namespace mode for the container. One of: - ``private`` the container runs in its own private cgroup namespace. - ``host`` use the host system's cgroup namespace. cpu_count (int): Number of usable CPUs (Windows only). cpu_percent (int): Usable percentage of the available CPUs (Windows only). cpu_period (int): The length of a CPU period in microseconds. cpu_quota (int): Microseconds of CPU time that the container can get in a CPU period. cpu_rt_period (int): Limit CPU real-time period in microseconds. cpu_rt_runtime (int): Limit CPU real-time runtime in microseconds. cpu_shares (int): CPU shares (relative weight). cpuset_cpus (str): CPUs in which to allow execution (``0-3``, ``0,1``). cpuset_mems (str): Memory nodes (MEMs) in which to allow execution (``0-3``, ``0,1``). Only effective on NUMA systems. detach (bool): Run container in the background and return a :py:class:`Container` object. device_cgroup_rules (:py:class:`list`): A list of cgroup rules to apply to the container. device_read_bps: Limit read rate (bytes per second) from a device in the form of: `[{"Path": "device_path", "Rate": rate}]` device_read_iops: Limit read rate (IO per second) from a device. device_write_bps: Limit write rate (bytes per second) from a device. device_write_iops: Limit write rate (IO per second) from a device. devices (:py:class:`list`): Expose host devices to the container, as a list of strings in the form ``<path_on_host>:<path_in_container>:<cgroup_permissions>``. For example, ``/dev/sda:/dev/xvda:rwm`` allows the container to have read-write access to the host's ``/dev/sda`` via a node named ``/dev/xvda`` inside the container. device_requests (:py:class:`list`): Expose host resources such as GPUs to the container, as a list of :py:class:`docker.types.DeviceRequest` instances. dns (:py:class:`list`): Set custom DNS servers. dns_opt (:py:class:`list`): Additional options to be added to the container's ``resolv.conf`` file. dns_search (:py:class:`list`): DNS search domains. domainname (str or list): Set custom DNS search domains. entrypoint (str or list): The entrypoint for the container. environment (dict or list): Environment variables to set inside the container, as a dictionary or a list of strings in the format ``["SOMEVARIABLE=xxx"]``. extra_hosts (dict): Additional hostnames to resolve inside the container, as a mapping of hostname to IP address. group_add (:py:class:`list`): List of additional group names and/or IDs that the container process will run as. healthcheck (dict): Specify a test to perform to check that the container is healthy. The dict takes the following keys: - test (:py:class:`list` or str): Test to perform to determine container health. Possible values: - Empty list: Inherit healthcheck from parent image - ``["NONE"]``: Disable healthcheck - ``["CMD", args...]``: exec arguments directly. - ``["CMD-SHELL", command]``: Run command in the system's default shell. If a string is provided, it will be used as a ``CMD-SHELL`` command. - interval (int): The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). - timeout (int): The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). - retries (int): The number of consecutive failures needed to consider a container as unhealthy. - start_period (int): Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). hostname (str): Optional hostname for the container. init (bool): Run an init inside the container that forwards signals and reaps processes init_path (str): Path to the docker-init binary ipc_mode (str): Set the IPC mode for the container. isolation (str): Isolation technology to use. Default: `None`. kernel_memory (int or str): Kernel memory limit labels (dict or list): A dictionary of name-value labels (e.g. ``{"label1": "value1", "label2": "value2"}``) or a list of names of labels to set with empty values (e.g. ``["label1", "label2"]``) links (dict): Mapping of links using the ``{'container': 'alias'}`` format. The alias is optional. Containers declared in this dict will be linked to the new container using the provided alias. Default: ``None``. log_config (LogConfig): Logging configuration. lxc_conf (dict): LXC config. mac_address (str): MAC address to assign to the container. mem_limit (int or str): Memory limit. Accepts float values (which represent the memory limit of the created container in bytes) or a string with a units identification char (``100000b``, ``1000k``, ``128m``, ``1g``). If a string is specified without a units character, bytes are assumed as an intended unit. mem_reservation (int or str): Memory soft limit. mem_swappiness (int): Tune a container's memory swappiness behavior. Accepts number between 0 and 100. memswap_limit (str or int): Maximum amount of memory + swap a container is allowed to consume. mounts (:py:class:`list`): Specification for mounts to be added to the container. More powerful alternative to ``volumes``. Each item in the list is expected to be a :py:class:`docker.types.Mount` object. name (str): The name for this container. nano_cpus (int): CPU quota in units of 1e-9 CPUs. network (str): Name of the network this container will be connected to at creation time. You can connect to additional networks using :py:meth:`Network.connect`. Incompatible with ``network_mode``. network_disabled (bool): Disable networking. network_mode (str): One of: - ``bridge`` Create a new network stack for the container on the bridge network. - ``none`` No networking for this container. - ``container:<name|id>`` Reuse another container's network stack. - ``host`` Use the host network stack. This mode is incompatible with ``ports``. Incompatible with ``network``. networking_config (Dict[str, EndpointConfig]): Dictionary of EndpointConfig objects for each container network. The key is the name of the network. Defaults to ``None``. Used in conjuction with ``network``. Incompatible with ``network_mode``. oom_kill_disable (bool): Whether to disable OOM killer. oom_score_adj (int): An integer value containing the score given to the container in order to tune OOM killer preferences. pid_mode (str): If set to ``host``, use the host PID namespace inside the container. pids_limit (int): Tune a container's pids limit. Set ``-1`` for unlimited. platform (str): Platform in the format ``os[/arch[/variant]]``. Only used if the method needs to pull the requested image. ports (dict): Ports to bind inside the container. The keys of the dictionary are the ports to bind inside the container, either as an integer or a string in the form ``port/protocol``, where the protocol is either ``tcp``, ``udp``, or ``sctp``. The values of the dictionary are the corresponding ports to open on the host, which can be either: - The port number, as an integer. For example, ``{'2222/tcp': 3333}`` will expose port 2222 inside the container as port 3333 on the host. - ``None``, to assign a random host port. For example, ``{'2222/tcp': None}``. - A tuple of ``(address, port)`` if you want to specify the host interface. For example, ``{'1111/tcp': ('127.0.0.1', 1111)}``. - A list of integers, if you want to bind multiple host ports to a single container port. For example, ``{'1111/tcp': [1234, 4567]}``. Incompatible with ``host`` network mode. privileged (bool): Give extended privileges to this container. publish_all_ports (bool): Publish all ports to the host. read_only (bool): Mount the container's root filesystem as read only. remove (bool): Remove the container when it has finished running. Default: ``False``. restart_policy (dict): Restart the container when it exits. Configured as a dictionary with keys: - ``Name`` One of ``on-failure``, or ``always``. - ``MaximumRetryCount`` Number of times to restart the container on failure. For example: ``{"Name": "on-failure", "MaximumRetryCount": 5}`` runtime (str): Runtime to use with this container. security_opt (:py:class:`list`): A list of string values to customize labels for MLS systems, such as SELinux. shm_size (str or int): Size of /dev/shm (e.g. ``1G``). stdin_open (bool): Keep ``STDIN`` open even if not attached. stdout (bool): Return logs from ``STDOUT`` when ``detach=False``. Default: ``True``. stderr (bool): Return logs from ``STDERR`` when ``detach=False``. Default: ``False``. stop_signal (str): The stop signal to use to stop the container (e.g. ``SIGINT``). storage_opt (dict): Storage driver options per container as a key-value mapping. stream (bool): If true and ``detach`` is false, return a log generator instead of a string. Ignored if ``detach`` is true. Default: ``False``. sysctls (dict): Kernel parameters to set in the container. tmpfs (dict): Temporary filesystems to mount, as a dictionary mapping a path inside the container to options for that path. For example: .. code-block:: python { '/mnt/vol2': '', '/mnt/vol1': 'size=3G,uid=1000' } tty (bool): Allocate a pseudo-TTY. ulimits (:py:class:`list`): Ulimits to set inside the container, as a list of :py:class:`docker.types.Ulimit` instances. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. user (str or int): Username or UID to run commands as inside the container. userns_mode (str): Sets the user namespace mode for the container when user namespace remapping option is enabled. Supported values are: ``host`` uts_mode (str): Sets the UTS namespace mode for the container. Supported values are: ``host`` version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``1.35`` volume_driver (str): The name of a volume driver/plugin. volumes (dict or list): A dictionary to configure volumes mounted inside the container. The key is either the host path or a volume name, and the value is a dictionary with the keys: - ``bind`` The path to mount the volume inside the container - ``mode`` Either ``rw`` to mount the volume read/write, or ``ro`` to mount it read-only. For example: .. code-block:: python {'/home/user1/': {'bind': '/mnt/vol2', 'mode': 'rw'}, '/var/www': {'bind': '/mnt/vol1', 'mode': 'ro'}} Or a list of strings which each one of its elements specifies a mount volume. For example: .. code-block:: python ['/home/user1/:/mnt/vol2','/var/www:/mnt/vol1'] volumes_from (:py:class:`list`): List of container names or IDs to get volumes from. working_dir (str): Path to the working directory. Returns: The container logs, either ``STDOUT``, ``STDERR``, or both, depending on the value of the ``stdout`` and ``stderr`` arguments. ``STDOUT`` and ``STDERR`` may be read only if either ``json-file`` or ``journald`` logging driver used. Thus, if you are using none of these drivers, a ``None`` object is returned instead. See the `Engine API documentation <https://docs.docker.com/engine/api/v1.30/#operation/ContainerLogs/>`_ for full details. If ``detach`` is ``True``, a :py:class:`Container` object is returned instead. Raises: :py:class:`docker.errors.ContainerError` If the container exits with a non-zero exit code and ``detach`` is ``False``. :py:class:`docker.errors.ImageNotFound` If the specified image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ if isinstance(image, Image): image = image.id stream = kwargs.pop('stream', False) detach = kwargs.pop('detach', False) platform = kwargs.get('platform', None) if detach and remove: if version_gte(self.client.api._version, '1.25'): kwargs["auto_remove"] = True else: raise RuntimeError("The options 'detach' and 'remove' cannot " "be used together in api versions < 1.25.") if kwargs.get('network') and kwargs.get('network_mode'): raise RuntimeError( 'The options "network" and "network_mode" can not be used ' 'together.' ) if kwargs.get('networking_config') and not kwargs.get('network'): raise RuntimeError( 'The option "networking_config" can not be used ' 'without "network".' ) try: container = self.create(image=image, command=command, detach=detach, **kwargs) except ImageNotFound: self.client.images.pull(image, platform=platform) container = self.create(image=image, command=command, detach=detach, **kwargs) container.start() if detach: return container logging_driver = container.attrs['HostConfig']['LogConfig']['Type'] out = None if logging_driver == 'json-file' or logging_driver == 'journald': out = container.logs( stdout=stdout, stderr=stderr, stream=True, follow=True ) exit_status = container.wait()['StatusCode'] if exit_status != 0: out = None if not kwargs.get('auto_remove'): out = container.logs(stdout=False, stderr=True) if remove: container.remove() if exit_status != 0: raise ContainerError( container, exit_status, command, image, out ) if stream or out is None: return out return b''.join(out) def create(self, image, command=None, **kwargs): """ Create a container without starting it. Similar to ``docker create``. Takes the same arguments as :py:meth:`run`, except for ``stdout``, ``stderr``, and ``remove``. Returns: A :py:class:`Container` object. Raises: :py:class:`docker.errors.ImageNotFound` If the specified image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ if isinstance(image, Image): image = image.id kwargs['image'] = image kwargs['command'] = command kwargs['version'] = self.client.api._version create_kwargs = _create_container_args(kwargs) resp = self.client.api.create_container(**create_kwargs) return self.get(resp['Id']) def get(self, container_id): """ Get a container by name or ID. Args: container_id (str): Container name or ID. Returns: A :py:class:`Container` object. Raises: :py:class:`docker.errors.NotFound` If the container does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.inspect_container(container_id) return self.prepare_model(resp) def list(self, all=False, before=None, filters=None, limit=-1, since=None, sparse=False, ignore_removed=False): """ List containers. Similar to the ``docker ps`` command. Args: all (bool): Show all containers. Only running containers are shown by default since (str): Show only containers created since Id or Name, include non-running ones before (str): Show only container created before Id or Name, include non-running ones limit (int): Show `limit` last created containers, include non-running ones filters (dict): Filters to be processed on the image list. Available filters: - `exited` (int): Only containers with specified exit code - `status` (str): One of ``restarting``, ``running``, ``paused``, ``exited`` - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. - `id` (str): The id of the container. - `name` (str): The name of the container. - `ancestor` (str): Filter by container ancestor. Format of ``<image-name>[:tag]``, ``<image-id>``, or ``<image@digest>``. - `before` (str): Only containers created before a particular container. Give the container name or id. - `since` (str): Only containers created after a particular container. Give container name or id. A comprehensive list can be found in the documentation for `docker ps <https://docs.docker.com/engine/reference/commandline/ps>`_. sparse (bool): Do not inspect containers. Returns partial information, but guaranteed not to block. Use :py:meth:`Container.reload` on resulting objects to retrieve all attributes. Default: ``False`` ignore_removed (bool): Ignore failures due to missing containers when attempting to inspect containers from the original list. Set to ``True`` if race conditions are likely. Has no effect if ``sparse=True``. Default: ``False`` Returns: (list of :py:class:`Container`) Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.containers(all=all, before=before, filters=filters, limit=limit, since=since) if sparse: return [self.prepare_model(r) for r in resp] else: containers = [] for r in resp: try: containers.append(self.get(r['Id'])) # a container may have been removed while iterating except NotFound: if not ignore_removed: raise return containers def prune(self, filters=None): return self.client.api.prune_containers(filters=filters) prune.__doc__ = APIClient.prune_containers.__doc__ # kwargs to copy straight from run to create RUN_CREATE_KWARGS = [ 'command', 'detach', 'domainname', 'entrypoint', 'environment', 'healthcheck', 'hostname', 'image', 'labels', 'mac_address', 'name', 'network_disabled', 'platform', 'stdin_open', 'stop_signal', 'tty', 'use_config_proxy', 'user', 'working_dir', ] # kwargs to copy straight from run to host_config RUN_HOST_CONFIG_KWARGS = [ 'auto_remove', 'blkio_weight_device', 'blkio_weight', 'cap_add', 'cap_drop', 'cgroup_parent', 'cgroupns', 'cpu_count', 'cpu_percent', 'cpu_period', 'cpu_quota', 'cpu_shares', 'cpuset_cpus', 'cpuset_mems', 'cpu_rt_period', 'cpu_rt_runtime', 'device_cgroup_rules', 'device_read_bps', 'device_read_iops', 'device_write_bps', 'device_write_iops', 'devices', 'device_requests', 'dns_opt', 'dns_search', 'dns', 'extra_hosts', 'group_add', 'init', 'init_path', 'ipc_mode', 'isolation', 'kernel_memory', 'links', 'log_config', 'lxc_conf', 'mem_limit', 'mem_reservation', 'mem_swappiness', 'memswap_limit', 'mounts', 'nano_cpus', 'network_mode', 'oom_kill_disable', 'oom_score_adj', 'pid_mode', 'pids_limit', 'privileged', 'publish_all_ports', 'read_only', 'restart_policy', 'security_opt', 'shm_size', 'storage_opt', 'sysctls', 'tmpfs', 'ulimits', 'userns_mode', 'uts_mode', 'version', 'volume_driver', 'volumes_from', 'runtime' ] def _create_container_args(kwargs): """ Convert arguments to create() to arguments to create_container(). """ # Copy over kwargs which can be copied directly create_kwargs = {} for key in copy.copy(kwargs): if key in RUN_CREATE_KWARGS: create_kwargs[key] = kwargs.pop(key) host_config_kwargs = {} for key in copy.copy(kwargs): if key in RUN_HOST_CONFIG_KWARGS: host_config_kwargs[key] = kwargs.pop(key) # Process kwargs which are split over both create and host_config ports = kwargs.pop('ports', {}) if ports: host_config_kwargs['port_bindings'] = ports volumes = kwargs.pop('volumes', {}) if volumes: host_config_kwargs['binds'] = volumes network = kwargs.pop('network', None) networking_config = kwargs.pop('networking_config', None) if network: if networking_config: # Sanity check: check if the network is defined in the # networking config dict, otherwise switch to None if network not in networking_config: networking_config = None create_kwargs['networking_config'] = NetworkingConfig( networking_config ) if networking_config else {network: None} host_config_kwargs['network_mode'] = network # All kwargs should have been consumed by this point, so raise # error if any are left if kwargs: raise create_unexpected_kwargs_error('run', kwargs) create_kwargs['host_config'] = HostConfig(**host_config_kwargs) # Fill in any kwargs which need processing by create_host_config first port_bindings = create_kwargs['host_config'].get('PortBindings') if port_bindings: # sort to make consistent for tests create_kwargs['ports'] = [tuple(p.split('/', 1)) for p in sorted(port_bindings.keys())] if volumes: if isinstance(volumes, dict): create_kwargs['volumes'] = [ v.get('bind') for v in volumes.values() ] else: create_kwargs['volumes'] = [ _host_volume_from_bind(v) for v in volumes ] return create_kwargs def _host_volume_from_bind(bind): drive, rest = ntpath.splitdrive(bind) bits = rest.split(':', 1) if len(bits) == 1 or bits[1] in ('ro', 'rw'): return drive + bits[0] elif bits[1].endswith(':ro') or bits[1].endswith(':rw'): return bits[1][:-3] else: return bits[1] ExecResult = namedtuple('ExecResult', 'exit_code,output') """ A result of Container.exec_run with the properties ``exit_code`` and ``output``. """ models/services.py 0000644 00000033144 15027665106 0010241 0 ustar 00 import copy from docker.errors import InvalidArgument, create_unexpected_kwargs_error from docker.types import ContainerSpec, Placement, ServiceMode, TaskTemplate from .resource import Collection, Model class Service(Model): """A service.""" id_attribute = 'ID' @property def name(self): """The service's name.""" return self.attrs['Spec']['Name'] @property def version(self): """ The version number of the service. If this is not the same as the server, the :py:meth:`update` function will not work and you will need to call :py:meth:`reload` before calling it again. """ return self.attrs.get('Version').get('Index') def remove(self): """ Stop and remove the service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.remove_service(self.id) def tasks(self, filters=None): """ List the tasks in this service. Args: filters (dict): A map of filters to process on the tasks list. Valid filters: ``id``, ``name``, ``node``, ``label``, and ``desired-state``. Returns: :py:class:`list`: List of task dictionaries. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if filters is None: filters = {} filters['service'] = self.id return self.client.api.tasks(filters=filters) def update(self, **kwargs): """ Update a service's configuration. Similar to the ``docker service update`` command. Takes the same parameters as :py:meth:`~ServiceCollection.create`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ # Image is required, so if it hasn't been set, use current image if 'image' not in kwargs: spec = self.attrs['Spec']['TaskTemplate']['ContainerSpec'] kwargs['image'] = spec['Image'] if kwargs.get('force_update') is True: task_template = self.attrs['Spec']['TaskTemplate'] current_value = int(task_template.get('ForceUpdate', 0)) kwargs['force_update'] = current_value + 1 create_kwargs = _get_create_service_kwargs('update', kwargs) return self.client.api.update_service( self.id, self.version, **create_kwargs ) def logs(self, **kwargs): """ Get log stream for the service. Note: This method works only for services with the ``json-file`` or ``journald`` logging drivers. Args: details (bool): Show extra details provided to logs. Default: ``False`` follow (bool): Keep connection open to read logs as they are sent by the Engine. Default: ``False`` stdout (bool): Return logs from ``stdout``. Default: ``False`` stderr (bool): Return logs from ``stderr``. Default: ``False`` since (int): UNIX timestamp for the logs staring point. Default: 0 timestamps (bool): Add timestamps to every log line. tail (string or int): Number of log lines to be returned, counting from the current end of the logs. Specify an integer or ``'all'`` to output all log lines. Default: ``all`` Returns: generator: Logs for the service. """ is_tty = self.attrs['Spec']['TaskTemplate']['ContainerSpec'].get( 'TTY', False ) return self.client.api.service_logs(self.id, is_tty=is_tty, **kwargs) def scale(self, replicas): """ Scale service container. Args: replicas (int): The number of containers that should be running. Returns: bool: ``True`` if successful. """ if 'Global' in self.attrs['Spec']['Mode'].keys(): raise InvalidArgument('Cannot scale a global container') service_mode = ServiceMode('replicated', replicas) return self.client.api.update_service(self.id, self.version, mode=service_mode, fetch_current_spec=True) def force_update(self): """ Force update the service even if no changes require it. Returns: bool: ``True`` if successful. """ return self.update(force_update=True, fetch_current_spec=True) class ServiceCollection(Collection): """Services on the Docker server.""" model = Service def create(self, image, command=None, **kwargs): """ Create a service. Similar to the ``docker service create`` command. Args: image (str): The image name to use for the containers. command (list of str or str): Command to run. args (list of str): Arguments to the command. constraints (list of str): :py:class:`~docker.types.Placement` constraints. preferences (list of tuple): :py:class:`~docker.types.Placement` preferences. maxreplicas (int): :py:class:`~docker.types.Placement` maxreplicas or (int) representing maximum number of replicas per node. platforms (list of tuple): A list of platform constraints expressed as ``(arch, os)`` tuples. container_labels (dict): Labels to apply to the container. endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. env (list of str): Environment variables, in the form ``KEY=val``. hostname (string): Hostname to set on the container. init (boolean): Run an init inside the container that forwards signals and reaps processes isolation (string): Isolation technology used by the service's containers. Only used for Windows containers. labels (dict): Labels to apply to the service. log_driver (str): Log driver to use for containers. log_driver_options (dict): Log driver options. mode (ServiceMode): Scheduling mode for the service. Default:``None`` mounts (list of str): Mounts for the containers, in the form ``source:target:options``, where options is either ``ro`` or ``rw``. name (str): Name to give to the service. networks (:py:class:`list`): List of network names or IDs or :py:class:`~docker.types.NetworkAttachmentConfig` to attach the service to. Default: ``None``. resources (Resources): Resource limits and reservations. restart_policy (RestartPolicy): Restart policy for containers. secrets (list of :py:class:`~docker.types.SecretReference`): List of secrets accessible to containers for this service. stop_grace_period (int): Amount of time to wait for containers to terminate before forcefully killing them. update_config (UpdateConfig): Specification for the update strategy of the service. Default: ``None`` rollback_config (RollbackConfig): Specification for the rollback strategy of the service. Default: ``None`` user (str): User to run commands as. workdir (str): Working directory for commands to run. tty (boolean): Whether a pseudo-TTY should be allocated. groups (:py:class:`list`): A list of additional groups that the container process will run as. open_stdin (boolean): Open ``stdin`` read_only (boolean): Mount the container's root filesystem as read only. stop_signal (string): Set signal to stop the service's containers healthcheck (Healthcheck): Healthcheck configuration for this service. hosts (:py:class:`dict`): A set of host to IP mappings to add to the container's `hosts` file. dns_config (DNSConfig): Specification for DNS related configurations in resolver configuration file. configs (:py:class:`list`): List of :py:class:`~docker.types.ConfigReference` that will be exposed to the service. privileges (Privileges): Security options for the service's containers. cap_add (:py:class:`list`): A list of kernel capabilities to add to the default set for the container. cap_drop (:py:class:`list`): A list of kernel capabilities to drop from the default set for the container. sysctls (:py:class:`dict`): A dict of sysctl values to add to the container Returns: :py:class:`Service`: The created service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ kwargs['image'] = image kwargs['command'] = command create_kwargs = _get_create_service_kwargs('create', kwargs) service_id = self.client.api.create_service(**create_kwargs) return self.get(service_id) def get(self, service_id, insert_defaults=None): """ Get a service. Args: service_id (str): The ID of the service. insert_defaults (boolean): If true, default values will be merged into the output. Returns: :py:class:`Service`: The service. Raises: :py:class:`docker.errors.NotFound` If the service does not exist. :py:class:`docker.errors.APIError` If the server returns an error. :py:class:`docker.errors.InvalidVersion` If one of the arguments is not supported with the current API version. """ return self.prepare_model( self.client.api.inspect_service(service_id, insert_defaults) ) def list(self, **kwargs): """ List services. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name`` , ``label`` and ``mode``. Default: ``None``. status (bool): Include the service task count of running and desired tasks. Default: ``None``. Returns: list of :py:class:`Service`: The services. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return [ self.prepare_model(s) for s in self.client.api.services(**kwargs) ] # kwargs to copy straight over to ContainerSpec CONTAINER_SPEC_KWARGS = [ 'args', 'cap_add', 'cap_drop', 'command', 'configs', 'dns_config', 'env', 'groups', 'healthcheck', 'hostname', 'hosts', 'image', 'init', 'isolation', 'labels', 'mounts', 'open_stdin', 'privileges', 'read_only', 'secrets', 'stop_grace_period', 'stop_signal', 'tty', 'user', 'workdir', 'sysctls', ] # kwargs to copy straight over to TaskTemplate TASK_TEMPLATE_KWARGS = [ 'networks', 'resources', 'restart_policy', ] # kwargs to copy straight over to create_service CREATE_SERVICE_KWARGS = [ 'name', 'labels', 'mode', 'update_config', 'rollback_config', 'endpoint_spec', ] PLACEMENT_KWARGS = [ 'constraints', 'preferences', 'platforms', 'maxreplicas', ] def _get_create_service_kwargs(func_name, kwargs): # Copy over things which can be copied directly create_kwargs = {} for key in copy.copy(kwargs): if key in CREATE_SERVICE_KWARGS: create_kwargs[key] = kwargs.pop(key) container_spec_kwargs = {} for key in copy.copy(kwargs): if key in CONTAINER_SPEC_KWARGS: container_spec_kwargs[key] = kwargs.pop(key) task_template_kwargs = {} for key in copy.copy(kwargs): if key in TASK_TEMPLATE_KWARGS: task_template_kwargs[key] = kwargs.pop(key) if 'container_labels' in kwargs: container_spec_kwargs['labels'] = kwargs.pop('container_labels') placement = {} for key in copy.copy(kwargs): if key in PLACEMENT_KWARGS: placement[key] = kwargs.pop(key) placement = Placement(**placement) task_template_kwargs['placement'] = placement if 'log_driver' in kwargs: task_template_kwargs['log_driver'] = { 'Name': kwargs.pop('log_driver'), 'Options': kwargs.pop('log_driver_options', {}) } if func_name == 'update': if 'force_update' in kwargs: task_template_kwargs['force_update'] = kwargs.pop('force_update') # fetch the current spec by default if updating the service # through the model fetch_current_spec = kwargs.pop('fetch_current_spec', True) create_kwargs['fetch_current_spec'] = fetch_current_spec # All kwargs should have been consumed by this point, so raise # error if any are left if kwargs: raise create_unexpected_kwargs_error(func_name, kwargs) container_spec = ContainerSpec(**container_spec_kwargs) task_template_kwargs['container_spec'] = container_spec create_kwargs['task_template'] = TaskTemplate(**task_template_kwargs) return create_kwargs models/nodes.py 0000644 00000005560 15027665106 0007527 0 ustar 00 from .resource import Collection, Model class Node(Model): """A node in a swarm.""" id_attribute = 'ID' @property def version(self): """ The version number of the service. If this is not the same as the server, the :py:meth:`update` function will not work and you will need to call :py:meth:`reload` before calling it again. """ return self.attrs.get('Version').get('Index') def update(self, node_spec): """ Update the node's configuration. Args: node_spec (dict): Configuration settings to update. Any values not provided will be removed. Default: ``None`` Returns: `True` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> node_spec = {'Availability': 'active', 'Name': 'node-name', 'Role': 'manager', 'Labels': {'foo': 'bar'} } >>> node.update(node_spec) """ return self.client.api.update_node(self.id, self.version, node_spec) def remove(self, force=False): """ Remove this node from the swarm. Args: force (bool): Force remove an active node. Default: `False` Returns: `True` if the request was successful. Raises: :py:class:`docker.errors.NotFound` If the node doesn't exist in the swarm. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.remove_node(self.id, force=force) class NodeCollection(Collection): """Nodes on the Docker server.""" model = Node def get(self, node_id): """ Get a node. Args: node_id (string): ID of the node to be inspected. Returns: A :py:class:`Node` object. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.prepare_model(self.client.api.inspect_node(node_id)) def list(self, *args, **kwargs): """ List swarm nodes. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name``, ``membership`` and ``role``. Default: ``None`` Returns: A list of :py:class:`Node` objects. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.nodes.list(filters={'role': 'manager'}) """ return [ self.prepare_model(n) for n in self.client.api.nodes(*args, **kwargs) ] models/networks.py 0000644 00000017432 15027665106 0010274 0 ustar 00 from ..api import APIClient from ..utils import version_gte from .containers import Container from .resource import Collection, Model class Network(Model): """ A Docker network. """ @property def name(self): """ The name of the network. """ return self.attrs.get('Name') @property def containers(self): """ The containers that are connected to the network, as a list of :py:class:`~docker.models.containers.Container` objects. """ return [ self.client.containers.get(cid) for cid in (self.attrs.get('Containers') or {}).keys() ] def connect(self, container, *args, **kwargs): """ Connect a container to this network. Args: container (str): Container to connect to this network, as either an ID, name, or :py:class:`~docker.models.containers.Container` object. aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. links (:py:class:`list`): A list of links for this endpoint. Containers declared in this list will be linkedto this container. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. driver_opt (dict): A dictionary of options to provide to the network driver. Defaults to ``None``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if isinstance(container, Container): container = container.id return self.client.api.connect_container_to_network( container, self.id, *args, **kwargs ) def disconnect(self, container, *args, **kwargs): """ Disconnect a container from this network. Args: container (str): Container to disconnect from this network, as either an ID, name, or :py:class:`~docker.models.containers.Container` object. force (bool): Force the container to disconnect from a network. Default: ``False`` Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if isinstance(container, Container): container = container.id return self.client.api.disconnect_container_from_network( container, self.id, *args, **kwargs ) def remove(self): """ Remove this network. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self.client.api.remove_network(self.id) class NetworkCollection(Collection): """ Networks on the Docker server. """ model = Network def create(self, name, *args, **kwargs): """ Create a network. Similar to the ``docker network create``. Args: name (str): Name of the network driver (str): Name of the driver used to create the network options (dict): Driver options as a key-value dictionary ipam (IPAMConfig): Optional custom IP scheme for the network. check_duplicate (bool): Request daemon to check for networks with same name. Default: ``None``. internal (bool): Restrict external access to the network. Default ``False``. labels (dict): Map of labels to set on the network. Default ``None``. enable_ipv6 (bool): Enable IPv6 on the network. Default ``False``. attachable (bool): If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network. scope (str): Specify the network's scope (``local``, ``global`` or ``swarm``) ingress (bool): If set, create an ingress network which provides the routing-mesh in swarm mode. Returns: (:py:class:`Network`): The network that was created. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: A network using the bridge driver: >>> client.networks.create("network1", driver="bridge") You can also create more advanced networks with custom IPAM configurations. For example, setting the subnet to ``192.168.52.0/24`` and gateway address to ``192.168.52.254``. .. code-block:: python >>> ipam_pool = docker.types.IPAMPool( subnet='192.168.52.0/24', gateway='192.168.52.254' ) >>> ipam_config = docker.types.IPAMConfig( pool_configs=[ipam_pool] ) >>> client.networks.create( "network1", driver="bridge", ipam=ipam_config ) """ resp = self.client.api.create_network(name, *args, **kwargs) return self.get(resp['Id']) def get(self, network_id, *args, **kwargs): """ Get a network by its ID. Args: network_id (str): The ID of the network. verbose (bool): Retrieve the service details across the cluster in swarm mode. scope (str): Filter the network by scope (``swarm``, ``global`` or ``local``). Returns: (:py:class:`Network`) The network. Raises: :py:class:`docker.errors.NotFound` If the network does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.prepare_model( self.client.api.inspect_network(network_id, *args, **kwargs) ) def list(self, *args, **kwargs): """ List networks. Similar to the ``docker network ls`` command. Args: names (:py:class:`list`): List of names to filter by. ids (:py:class:`list`): List of ids to filter by. filters (dict): Filters to be processed on the network list. Available filters: - ``driver=[<driver-name>]`` Matches a network's driver. - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. - ``type=["custom"|"builtin"]`` Filters networks by type. greedy (bool): Fetch more details for each network individually. You might want this to get the containers attached to them. Returns: (list of :py:class:`Network`) The networks on the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ greedy = kwargs.pop('greedy', False) resp = self.client.api.networks(*args, **kwargs) networks = [self.prepare_model(item) for item in resp] if greedy and version_gte(self.client.api._version, '1.28'): for net in networks: net.reload() return networks def prune(self, filters=None): return self.client.api.prune_networks(filters=filters) prune.__doc__ = APIClient.prune_networks.__doc__ models/configs.py 0000644 00000003465 15027665106 0010051 0 ustar 00 from ..api import APIClient from .resource import Collection, Model class Config(Model): """A config.""" id_attribute = 'ID' def __repr__(self): return f"<{self.__class__.__name__}: '{self.name}'>" @property def name(self): return self.attrs['Spec']['Name'] def remove(self): """ Remove this config. Raises: :py:class:`docker.errors.APIError` If config failed to remove. """ return self.client.api.remove_config(self.id) class ConfigCollection(Collection): """Configs on the Docker server.""" model = Config def create(self, **kwargs): obj = self.client.api.create_config(**kwargs) obj.setdefault("Spec", {})["Name"] = kwargs.get("name") return self.prepare_model(obj) create.__doc__ = APIClient.create_config.__doc__ def get(self, config_id): """ Get a config. Args: config_id (str): Config ID. Returns: (:py:class:`Config`): The config. Raises: :py:class:`docker.errors.NotFound` If the config does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ return self.prepare_model(self.client.api.inspect_config(config_id)) def list(self, **kwargs): """ List configs. Similar to the ``docker config ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (list of :py:class:`Config`): The configs. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ resp = self.client.api.configs(**kwargs) return [self.prepare_model(obj) for obj in resp] models/__init__.py 0000644 00000000000 15027665106 0010136 0 ustar 00 context/context.py 0000644 00000017224 15027665106 0010304 0 ustar 00 import json import os from shutil import copyfile, rmtree from docker.errors import ContextException from docker.tls import TLSConfig from .config import ( get_context_host, get_meta_dir, get_meta_file, get_tls_dir, ) class Context: """A context.""" def __init__(self, name, orchestrator=None, host=None, endpoints=None, tls=False): if not name: raise Exception("Name not provided") self.name = name self.context_type = None self.orchestrator = orchestrator self.endpoints = {} self.tls_cfg = {} self.meta_path = "IN MEMORY" self.tls_path = "IN MEMORY" if not endpoints: # set default docker endpoint if no endpoint is set default_endpoint = "docker" if ( not orchestrator or orchestrator == "swarm" ) else orchestrator self.endpoints = { default_endpoint: { "Host": get_context_host(host, tls), "SkipTLSVerify": not tls } } return # check docker endpoints for k, v in endpoints.items(): if not isinstance(v, dict): # unknown format raise ContextException( f"Unknown endpoint format for context {name}: {v}", ) self.endpoints[k] = v if k != "docker": continue self.endpoints[k]["Host"] = v.get("Host", get_context_host( host, tls)) self.endpoints[k]["SkipTLSVerify"] = bool(v.get( "SkipTLSVerify", not tls)) def set_endpoint( self, name="docker", host=None, tls_cfg=None, skip_tls_verify=False, def_namespace=None): self.endpoints[name] = { "Host": get_context_host(host, not skip_tls_verify), "SkipTLSVerify": skip_tls_verify } if def_namespace: self.endpoints[name]["DefaultNamespace"] = def_namespace if tls_cfg: self.tls_cfg[name] = tls_cfg def inspect(self): return self.__call__() @classmethod def load_context(cls, name): meta = Context._load_meta(name) if meta: instance = cls( meta["Name"], orchestrator=meta["Metadata"].get("StackOrchestrator", None), endpoints=meta.get("Endpoints", None)) instance.context_type = meta["Metadata"].get("Type", None) instance._load_certs() instance.meta_path = get_meta_dir(name) return instance return None @classmethod def _load_meta(cls, name): meta_file = get_meta_file(name) if not os.path.isfile(meta_file): return None metadata = {} try: with open(meta_file) as f: metadata = json.load(f) except (OSError, KeyError, ValueError) as e: # unknown format raise Exception( f"Detected corrupted meta file for context {name} : {e}" ) from e # for docker endpoints, set defaults for # Host and SkipTLSVerify fields for k, v in metadata["Endpoints"].items(): if k != "docker": continue metadata["Endpoints"][k]["Host"] = v.get( "Host", get_context_host(None, False)) metadata["Endpoints"][k]["SkipTLSVerify"] = bool( v.get("SkipTLSVerify", True)) return metadata def _load_certs(self): certs = {} tls_dir = get_tls_dir(self.name) for endpoint in self.endpoints.keys(): if not os.path.isdir(os.path.join(tls_dir, endpoint)): continue ca_cert = None cert = None key = None for filename in os.listdir(os.path.join(tls_dir, endpoint)): if filename.startswith("ca"): ca_cert = os.path.join(tls_dir, endpoint, filename) elif filename.startswith("cert"): cert = os.path.join(tls_dir, endpoint, filename) elif filename.startswith("key"): key = os.path.join(tls_dir, endpoint, filename) if all([ca_cert, cert, key]): verify = None if endpoint == "docker" and not self.endpoints["docker"].get( "SkipTLSVerify", False): verify = True certs[endpoint] = TLSConfig( client_cert=(cert, key), ca_cert=ca_cert, verify=verify) self.tls_cfg = certs self.tls_path = tls_dir def save(self): meta_dir = get_meta_dir(self.name) if not os.path.isdir(meta_dir): os.makedirs(meta_dir) with open(get_meta_file(self.name), "w") as f: f.write(json.dumps(self.Metadata)) tls_dir = get_tls_dir(self.name) for endpoint, tls in self.tls_cfg.items(): if not os.path.isdir(os.path.join(tls_dir, endpoint)): os.makedirs(os.path.join(tls_dir, endpoint)) ca_file = tls.ca_cert if ca_file: copyfile(ca_file, os.path.join( tls_dir, endpoint, os.path.basename(ca_file))) if tls.cert: cert_file, key_file = tls.cert copyfile(cert_file, os.path.join( tls_dir, endpoint, os.path.basename(cert_file))) copyfile(key_file, os.path.join( tls_dir, endpoint, os.path.basename(key_file))) self.meta_path = get_meta_dir(self.name) self.tls_path = get_tls_dir(self.name) def remove(self): if os.path.isdir(self.meta_path): rmtree(self.meta_path) if os.path.isdir(self.tls_path): rmtree(self.tls_path) def __repr__(self): return f"<{self.__class__.__name__}: '{self.name}'>" def __str__(self): return json.dumps(self.__call__(), indent=2) def __call__(self): result = self.Metadata result.update(self.TLSMaterial) result.update(self.Storage) return result def is_docker_host(self): return self.context_type is None @property def Name(self): return self.name @property def Host(self): if not self.orchestrator or self.orchestrator == "swarm": endpoint = self.endpoints.get("docker", None) if endpoint: return endpoint.get("Host", None) return None return self.endpoints[self.orchestrator].get("Host", None) @property def Orchestrator(self): return self.orchestrator @property def Metadata(self): meta = {} if self.orchestrator: meta = {"StackOrchestrator": self.orchestrator} return { "Name": self.name, "Metadata": meta, "Endpoints": self.endpoints } @property def TLSConfig(self): key = self.orchestrator if not key or key == "swarm": key = "docker" if key in self.tls_cfg.keys(): return self.tls_cfg[key] return None @property def TLSMaterial(self): certs = {} for endpoint, tls in self.tls_cfg.items(): cert, key = tls.cert certs[endpoint] = list( map(os.path.basename, [tls.ca_cert, cert, key])) return { "TLSMaterial": certs } @property def Storage(self): return { "Storage": { "MetadataPath": self.meta_path, "TLSPath": self.tls_path }} context/__pycache__/__init__.cpython-310.pyc 0000644 00000000367 15027665106 0014716 0 ustar 00 o �h9 � @ s d dl mZ d dlmZ dS )� )� ContextAPI)�ContextN)�apir �contextr � r r �M/usr/local/CyberPanel/lib/python3.10/site-packages/docker/context/__init__.py�<module> s context/__pycache__/context.cpython-310.pyc 0000644 00000014225 15027665106 0014641 0 ustar 00 o �h� � @ sb d dl Z d dlZd dlmZmZ d dlmZ d dlmZ ddl m Z m Z m Z m Z G dd� d�ZdS ) � N)�copyfile�rmtree)�ContextException)� TLSConfig� )�get_context_host� get_meta_dir� get_meta_file� get_tls_dirc @ s� e Zd ZdZ d+dd�Z d,dd�Zd d � Zed d � �Zed d� �Z dd� Z dd� Z dd� Z dd� Z dd� Zdd� Zdd � Zed d � �Zed d � �Zed!d"� �Zed#d$� �Zed%d&� �Zed'd(� �Zed)d*� �ZdS )-�Contextz A context.NFc C s� |st d��|| _d | _|| _i | _i | _d| _d| _|s5|r#|dkr%dn|}|t||�| d�i| _d S |� � D ]9\}}t |t �sLt d|� d|� ���|| j|< |dkrVq9|� dt||��| j| d< t|� d | ��| j| d < q9d S ) NzName not providedz IN MEMORY�swarm�docker��Host� SkipTLSVerifyz$Unknown endpoint format for context z: r r )� Exception�name� context_type� orchestrator� endpoints�tls_cfg� meta_path�tls_pathr �items� isinstance�dictr �get�bool) �selfr r �hostr �tls�default_endpoint�k�v� r$ �L/usr/local/CyberPanel/lib/python3.10/site-packages/docker/context/context.py�__init__ sJ ����� � ���zContext.__init__r c C s@ t || �|d�| j|< |r|| j| d< |r || j|< d S d S )Nr �DefaultNamespace)r r r )r r r r �skip_tls_verify� def_namespacer$ r$ r% � set_endpoint> s ��zContext.set_endpointc C s | � � S �N)�__call__�r r$ r$ r% �inspectK s zContext.inspectc C s` t �|�}|r.| |d |d �dd �|�dd �d�}|d �dd �|_|�� t|�|_|S d S )N�Name�Metadata�StackOrchestrator� Endpoints)r r �Type)r � _load_metar r � _load_certsr r )�clsr �meta�instancer$ r$ r% � load_contextN s � zContext.load_contextc C s� t |�}tj�|�s d S i }zt|�� }t�|�}W d � n1 s#w Y W n ttt fyC } z t d|� d|� ��|�d }~ww |d � � D ]&\}}|dkrSqJ|� dt d d��|d | d< t|� dd��|d | d< qJ|S ) Nz)Detected corrupted meta file for context z : r2 r r Fr T)r �os�path�isfile�open�json�load�OSError�KeyError� ValueErrorr r r r r )r6 r � meta_file�metadata�f�er" r# r$ r$ r% r4 \ s6 ������ � �zContext._load_metac C s i }t | j�}| j�� D ]m}tj�tj�||��sq d }d }d }t�tj�||��D ]+}|� d�r:tj�|||�}q*|� d�rHtj�|||�}q*|� d�rUtj�|||�}q*t |||g�ryd }|dkrn| jd � dd�snd}t ||f||d�||< q || _ || _d S ) N�ca�cert�keyr r FT)� client_cert�ca_cert�verify)r r r �keysr: r; �isdir�join�listdir� startswith�allr r r r ) r �certs�tls_dir�endpointrK rH rI �filenamerL r$ r$ r% r5 x s8 �� �� zContext._load_certsc C s: t | j�}tj�|�st�|� tt| j�d��}|�t � | j �� W d � n1 s,w Y t | j�}| j �� D ]S\}}tj�tj�||��sTt�tj�||�� |j}|rht|tj�||tj�|��� |jr�|j\}}t|tj�||tj�|��� t|tj�||tj�|��� q;t | j�| _t | j�| _d S )N�w)r r r: r; rN �makedirsr= r �writer> �dumpsr0 r r r rO rK r �basenamerH r r ) r �meta_dirrE rT rU r �ca_file� cert_file�key_filer$ r$ r% �save� s4 � � � �� z Context.savec C s8 t j�| j�r t| j� t j�| j�rt| j� d S d S r+ )r: r; rN r r r r- r$ r$ r% �remove� s �zContext.removec C s d| j j� d| j� d�S )N�<z: 'z'>)� __class__�__name__r r- r$ r$ r% �__repr__� s zContext.__repr__c C s t j| �� dd�S )N� )�indent)r> rZ r, r- r$ r$ r% �__str__� s zContext.__str__c C s" | j }|�| j� |�| j� |S r+ )r0 �update� TLSMaterial�Storage)r �resultr$ r$ r% r, � s zContext.__call__c C s | j d u S r+ )r r- r$ r$ r% �is_docker_host� s zContext.is_docker_hostc C � | j S r+ )r r- r$ r$ r% r/ � � z Context.Namec C sF | j r| j dkr| j�dd �}|r|�dd �S d S | j| j �dd �S )Nr r r )r r r )r rU r$ r$ r% r � s z Context.Hostc C rn r+ )r r- r$ r$ r% � Orchestrator� ro zContext.Orchestratorc C s$ i }| j r d| j i}| j|| jd�S )Nr1 )r/ r0 r2 )r r r )r r7 r$ r$ r% r0 � s �zContext.Metadatac C s2 | j }|r |dkr d}|| j�� v r| j| S d S )Nr r )r r rM )r rI r$ r$ r% r � s zContext.TLSConfigc C sH i }| j �� D ]\}}|j\}}tttjj|j||g��||< qd|iS )Nrj ) r r rH �list�mapr: r; r[ rK )r rS rU r rH rI r$ r$ r% rj � s ��zContext.TLSMaterialc C s d| j | jd�iS )Nrk )� MetadataPath�TLSPath)r r r- r$ r$ r% rk � s ��zContext.Storage)NNNF)r NNFN)rd � __module__� __qualname__�__doc__r& r* r. � classmethodr9 r4 r5 r` ra re rh r, rm �propertyr/ r rp r0 r rj rk r$ r$ r$ r% r sD �, � r )r> r: �shutilr r � docker.errorsr � docker.tlsr �configr r r r r r$ r$ r$ r% �<module> s context/__pycache__/api.cpython-310.pyc 0000644 00000013442 15027665106 0013726 0 ustar 00 o �h� � @ sR d dl Z d dlZd dlmZ ddlmZmZmZmZ ddl m Z G dd� d�Z dS )� N)�errors� )�METAFILE�get_current_context_name� get_meta_dir�#write_context_name_to_docker_config)�Contextc @ sz e Zd ZdZedd�Ze ddd��Zeddd ��Zed d � �Z ed d � �Z eddd��Z edd� �Z eddd��Z dS )� ContextAPIzfContext API. Contains methods for context management: create, list, remove, get, inspect. �default�swarmNFc C sv |st �d��|dkrt �d��t�|�}|r t �|��d}|r&|dkr&|}t||�}|j|||||d� |�� |S )aR Creates a new context. Returns: (Context): a Context object. Raises: :py:class:`docker.errors.MissingContextParameter` If a context name is not provided. :py:class:`docker.errors.ContextAlreadyExists` If a context with the name already exists. :py:class:`docker.errors.ContextException` If name is default. Example: >>> from docker.context import ContextAPI >>> ctx = ContextAPI.create_context(name='test') >>> print(ctx.Metadata) { "Name": "test", "Metadata": {}, "Endpoints": { "docker": { "Host": "unix:///var/run/docker.sock", "SkipTLSVerify": false } } } �namer z$"default" is a reserved context name�dockerr )�skip_tls_verify� def_namespace)r �MissingContextParameter�ContextExceptionr � load_context�ContextAlreadyExists� set_endpoint�save) �clsr � orchestrator�host�tls_cfg�default_namespacer �ctx�endpoint� r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/context/api.py�create_context s( � �zContextAPI.create_contextc C s" |st � }|dkr | jS t�|�S )a� Retrieves a context object. Args: name (str): The name of the context Example: >>> from docker.context import ContextAPI >>> ctx = ContextAPI.get_context(name='test') >>> print(ctx.Metadata) { "Name": "test", "Metadata": {}, "Endpoints": { "docker": { "Host": "unix:///var/run/docker.sock", "SkipTLSVerify": false } } } r )r �DEFAULT_CONTEXTr r )r r r r r � get_contextH s zContextAPI.get_contextc C s� g }t �t� �D ]>\}}}|| D ]4}|tkrEzt�tt j�||���}|� |d � W q t yD } z t � d|� d|� ��|�d}~ww qq| j g}|D ] } |� t�| �� qM|S )z�Context list. Returns: (Context): List of context objects. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �NamezFailed to load metafile z: N)�os�walkr r �json�load�open�path�join�append� Exceptionr r r r r ) r �names�dirname�dirnames�fnames�filename�data�e�contextsr r r r r3 d s. ������� zContextAPI.contextsc C s | � � S )z]Get current context. Returns: (Context): current context object. )r! )r r r r �get_current_context s z ContextAPI.get_current_contextc C s8 | � |�}|s t�|��t|�}|rt�d|� ���d S )Nz Failed to set current context: )r! r �ContextNotFoundr r )r r r �errr r r �set_current_context� s ��z ContextAPI.set_current_contextc C sV |st �d��|dkrt �d��t�|�}|s t �|��|t� kr%td� |�� dS )aY Remove a context. Similar to the ``docker context rm`` command. Args: name (str): The name of the context Raises: :py:class:`docker.errors.MissingContextParameter` If a context name is not provided. :py:class:`docker.errors.ContextNotFound` If a context with the name does not exist. :py:class:`docker.errors.ContextException` If name is default. Example: >>> from docker.context import ContextAPI >>> ContextAPI.remove_context(name='test') >>> r r z#context "default" cannot be removedN) r r r r r r5 r r �remove�r r r r r r �remove_context� s � zContextAPI.remove_contextc C s< |st �d��|dkr| �� S t�|�}|st �|��|� S )a Remove a context. Similar to the ``docker context inspect`` command. Args: name (str): The name of the context Raises: :py:class:`docker.errors.MissingContextParameter` If a context name is not provided. :py:class:`docker.errors.ContextNotFound` If a context with the name does not exist. Example: >>> from docker.context import ContextAPI >>> ContextAPI.remove_context(name='test') >>> r r )r r r r r r5 r9 r r r �inspect_context� s zContextAPI.inspect_context)NNNNF)N)r )�__name__� __module__� __qualname__�__doc__r r � classmethodr r! r3 r4 r7 r: r; r r r r r s& �1 r ) r% r# r r �configr r r r �contextr r r r r r �<module> s context/__pycache__/config.cpython-310.pyc 0000644 00000004626 15027665106 0014426 0 ustar 00 o �hg � @ s� d dl Z d dlZd dlZd dlmZ d dlmZmZ d dlm Z dZ dd� Z ddd �Z d d � Z d d � Zddd�Zdd� Zddd�Zddd�ZdS )� N)�utils)�DEFAULT_UNIX_SOCKET�IS_WINDOWS_PLATFORM)�find_config_filez meta.jsonc C sl d} t � }|r4z"t|��}t�|��dd�} W d � W | S 1 s"w Y W | S ty3 Y dS w | S )N�default�currentContext)r �open�json�load�get� Exception)�name�docker_cfg_path�f� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/context/config.py�get_current_context_name s �� ��r c C s | dkrd } t � }i }|r=zt|�� }t�|�}W d � n1 s"w Y W n ty< } z|W Y d }~S d }~ww |�dd �}|rK| sK|d= n | rR| |d< nd S z"t|d��}tj||dd� W d � W d S 1 sow Y W d S ty� } z|W Y d }~S d }~ww )Nr r �w� )�indent)r r r r r r �dump)r r �configr �e�current_contextr r r �#write_context_name_to_docker_config s8 ���� &���r c C s t �| �d���� S )Nzutf-8)�hashlib�sha256�encode� hexdigest�r r r r �get_context_id1 s r c C s t j�t j�t� p d�d�S )N� �contexts)�os�path�join�dirnamer r r r r �get_context_dir5 s r' c C s* t j�t� d�}| rt j�|t| ��S |S )N�meta)r# r$ r% r' r )r �meta_dirr r r � get_meta_dir9 s r* c C s t j�t| �t�S �N)r# r$ r% r* �METAFILEr r r r � get_meta_file@ s r- r! c C s. t � }| rtj�|dt| �|�S tj�|d�S )N�tls)r' r# r$ r% r )r �endpoint� context_dirr r r � get_tls_dirD s r1 Fc C s0 t �| t|�}|tkr|�d�r|dd � }|S )Nzhttp+� )r � parse_hostr r � startswith)r$ r. �hostr r r �get_context_hostK s r6 r+ )Nr! )NF)r r r# �dockerr �docker.constantsr r �docker.utils.configr r, r r r r' r* r- r1 r6 r r r r �<module> s context/config.py 0000644 00000004147 15027665106 0010065 0 ustar 00 import hashlib import json import os from docker import utils from docker.constants import DEFAULT_UNIX_SOCKET, IS_WINDOWS_PLATFORM from docker.utils.config import find_config_file METAFILE = "meta.json" def get_current_context_name(): name = "default" docker_cfg_path = find_config_file() if docker_cfg_path: try: with open(docker_cfg_path) as f: name = json.load(f).get("currentContext", "default") except Exception: return "default" return name def write_context_name_to_docker_config(name=None): if name == 'default': name = None docker_cfg_path = find_config_file() config = {} if docker_cfg_path: try: with open(docker_cfg_path) as f: config = json.load(f) except Exception as e: return e current_context = config.get("currentContext", None) if current_context and not name: del config["currentContext"] elif name: config["currentContext"] = name else: return try: with open(docker_cfg_path, "w") as f: json.dump(config, f, indent=4) except Exception as e: return e def get_context_id(name): return hashlib.sha256(name.encode('utf-8')).hexdigest() def get_context_dir(): return os.path.join(os.path.dirname(find_config_file() or ""), "contexts") def get_meta_dir(name=None): meta_dir = os.path.join(get_context_dir(), "meta") if name: return os.path.join(meta_dir, get_context_id(name)) return meta_dir def get_meta_file(name): return os.path.join(get_meta_dir(name), METAFILE) def get_tls_dir(name=None, endpoint=""): context_dir = get_context_dir() if name: return os.path.join(context_dir, "tls", get_context_id(name), endpoint) return os.path.join(context_dir, "tls") def get_context_host(path=None, tls=False): host = utils.parse_host(path, IS_WINDOWS_PLATFORM, tls) if host == DEFAULT_UNIX_SOCKET: # remove http+ from default docker socket url if host.startswith("http+"): host = host[5:] return host context/api.py 0000644 00000014266 15027665106 0007374 0 ustar 00 import json import os from docker import errors from .config import ( METAFILE, get_current_context_name, get_meta_dir, write_context_name_to_docker_config, ) from .context import Context class ContextAPI: """Context API. Contains methods for context management: create, list, remove, get, inspect. """ DEFAULT_CONTEXT = Context("default", "swarm") @classmethod def create_context( cls, name, orchestrator=None, host=None, tls_cfg=None, default_namespace=None, skip_tls_verify=False): """Creates a new context. Returns: (Context): a Context object. Raises: :py:class:`docker.errors.MissingContextParameter` If a context name is not provided. :py:class:`docker.errors.ContextAlreadyExists` If a context with the name already exists. :py:class:`docker.errors.ContextException` If name is default. Example: >>> from docker.context import ContextAPI >>> ctx = ContextAPI.create_context(name='test') >>> print(ctx.Metadata) { "Name": "test", "Metadata": {}, "Endpoints": { "docker": { "Host": "unix:///var/run/docker.sock", "SkipTLSVerify": false } } } """ if not name: raise errors.MissingContextParameter("name") if name == "default": raise errors.ContextException( '"default" is a reserved context name') ctx = Context.load_context(name) if ctx: raise errors.ContextAlreadyExists(name) endpoint = "docker" if orchestrator and orchestrator != "swarm": endpoint = orchestrator ctx = Context(name, orchestrator) ctx.set_endpoint( endpoint, host, tls_cfg, skip_tls_verify=skip_tls_verify, def_namespace=default_namespace) ctx.save() return ctx @classmethod def get_context(cls, name=None): """Retrieves a context object. Args: name (str): The name of the context Example: >>> from docker.context import ContextAPI >>> ctx = ContextAPI.get_context(name='test') >>> print(ctx.Metadata) { "Name": "test", "Metadata": {}, "Endpoints": { "docker": { "Host": "unix:///var/run/docker.sock", "SkipTLSVerify": false } } } """ if not name: name = get_current_context_name() if name == "default": return cls.DEFAULT_CONTEXT return Context.load_context(name) @classmethod def contexts(cls): """Context list. Returns: (Context): List of context objects. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ names = [] for dirname, dirnames, fnames in os.walk(get_meta_dir()): for filename in fnames + dirnames: if filename == METAFILE: try: data = json.load( open(os.path.join(dirname, filename))) names.append(data["Name"]) except Exception as e: raise errors.ContextException( f"Failed to load metafile {filename}: {e}", ) from e contexts = [cls.DEFAULT_CONTEXT] for name in names: contexts.append(Context.load_context(name)) return contexts @classmethod def get_current_context(cls): """Get current context. Returns: (Context): current context object. """ return cls.get_context() @classmethod def set_current_context(cls, name="default"): ctx = cls.get_context(name) if not ctx: raise errors.ContextNotFound(name) err = write_context_name_to_docker_config(name) if err: raise errors.ContextException( f'Failed to set current context: {err}') @classmethod def remove_context(cls, name): """Remove a context. Similar to the ``docker context rm`` command. Args: name (str): The name of the context Raises: :py:class:`docker.errors.MissingContextParameter` If a context name is not provided. :py:class:`docker.errors.ContextNotFound` If a context with the name does not exist. :py:class:`docker.errors.ContextException` If name is default. Example: >>> from docker.context import ContextAPI >>> ContextAPI.remove_context(name='test') >>> """ if not name: raise errors.MissingContextParameter("name") if name == "default": raise errors.ContextException( 'context "default" cannot be removed') ctx = Context.load_context(name) if not ctx: raise errors.ContextNotFound(name) if name == get_current_context_name(): write_context_name_to_docker_config(None) ctx.remove() @classmethod def inspect_context(cls, name="default"): """Remove a context. Similar to the ``docker context inspect`` command. Args: name (str): The name of the context Raises: :py:class:`docker.errors.MissingContextParameter` If a context name is not provided. :py:class:`docker.errors.ContextNotFound` If a context with the name does not exist. Example: >>> from docker.context import ContextAPI >>> ContextAPI.remove_context(name='test') >>> """ if not name: raise errors.MissingContextParameter("name") if name == "default": return cls.DEFAULT_CONTEXT() ctx = Context.load_context(name) if not ctx: raise errors.ContextNotFound(name) return ctx() context/__init__.py 0000644 00000000071 15027665106 0010347 0 ustar 00 from .api import ContextAPI from .context import Context types/base.py 0000644 00000000156 15027665106 0007206 0 ustar 00 class DictType(dict): def __init__(self, init): for k, v in init.items(): self[k] = v types/swarm.py 0000644 00000011055 15027665106 0007425 0 ustar 00 from ..errors import InvalidVersion from ..utils import version_lt class SwarmSpec(dict): """ Describe a Swarm's configuration and options. Use :py:meth:`~docker.api.swarm.SwarmApiMixin.create_swarm_spec` to instantiate. """ def __init__(self, version, task_history_retention_limit=None, snapshot_interval=None, keep_old_snapshots=None, log_entries_for_slow_followers=None, heartbeat_tick=None, election_tick=None, dispatcher_heartbeat_period=None, node_cert_expiry=None, external_cas=None, name=None, labels=None, signing_ca_cert=None, signing_ca_key=None, ca_force_rotate=None, autolock_managers=None, log_driver=None): if task_history_retention_limit is not None: self['Orchestration'] = { 'TaskHistoryRetentionLimit': task_history_retention_limit } if any([snapshot_interval, keep_old_snapshots, log_entries_for_slow_followers, heartbeat_tick, election_tick]): self['Raft'] = { 'SnapshotInterval': snapshot_interval, 'KeepOldSnapshots': keep_old_snapshots, 'LogEntriesForSlowFollowers': log_entries_for_slow_followers, 'HeartbeatTick': heartbeat_tick, 'ElectionTick': election_tick } if dispatcher_heartbeat_period: self['Dispatcher'] = { 'HeartbeatPeriod': dispatcher_heartbeat_period } ca_config = {} if node_cert_expiry is not None: ca_config['NodeCertExpiry'] = node_cert_expiry if external_cas: if version_lt(version, '1.25'): if len(external_cas) > 1: raise InvalidVersion( 'Support for multiple external CAs is not available ' 'for API version < 1.25' ) ca_config['ExternalCA'] = external_cas[0] else: ca_config['ExternalCAs'] = external_cas if signing_ca_key: if version_lt(version, '1.30'): raise InvalidVersion( 'signing_ca_key is not supported in API version < 1.30' ) ca_config['SigningCAKey'] = signing_ca_key if signing_ca_cert: if version_lt(version, '1.30'): raise InvalidVersion( 'signing_ca_cert is not supported in API version < 1.30' ) ca_config['SigningCACert'] = signing_ca_cert if ca_force_rotate is not None: if version_lt(version, '1.30'): raise InvalidVersion( 'force_rotate is not supported in API version < 1.30' ) ca_config['ForceRotate'] = ca_force_rotate if ca_config: self['CAConfig'] = ca_config if autolock_managers is not None: if version_lt(version, '1.25'): raise InvalidVersion( 'autolock_managers is not supported in API version < 1.25' ) self['EncryptionConfig'] = {'AutoLockManagers': autolock_managers} if log_driver is not None: if version_lt(version, '1.25'): raise InvalidVersion( 'log_driver is not supported in API version < 1.25' ) self['TaskDefaults'] = {'LogDriver': log_driver} if name is not None: self['Name'] = name if labels is not None: self['Labels'] = labels class SwarmExternalCA(dict): """ Configuration for forwarding signing requests to an external certificate authority. Args: url (string): URL where certificate signing requests should be sent. protocol (string): Protocol for communication with the external CA. options (dict): An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. ca_cert (string): The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). """ def __init__(self, url, protocol=None, options=None, ca_cert=None): self['URL'] = url self['Protocol'] = protocol self['Options'] = options self['CACert'] = ca_cert types/__pycache__/services.cpython-310.pyc 0000644 00000067614 15027665106 0014472 0 ustar 00 o �h� � @ sj d dl mZ d dlmZ d dlmZmZmZmZm Z m Z G dd� de �Z G dd� de �Z G dd � d e �ZG d d � d e �Zd d � ZG dd� de �ZG dd� de�ZG dd� d�ZG dd� de �ZG dd� de �ZG dd� de �Zdd� ZG d d � d e �ZG d d � d e �ZG d d!� d!e �ZG d"d#� d#e �ZG d$d%� d%e �Z G d&d'� d'e �Z G d(d)� d)e �Z G d*d+� d+e �Z d,S )-� )�errors)�IS_WINDOWS_PLATFORM)�check_resource�convert_service_networks�format_environment�format_extra_hosts� parse_bytes� split_commandc @ sP e Zd ZdZ d dd�Zedd� �Zedd� �Zed d � �Zed d � �Z dS )� TaskTemplateaC Describe the task specification to be used when creating or updating a service. Args: container_spec (ContainerSpec): Container settings for containers started as part of this task. log_driver (DriverConfig): Log configuration for containers created as part of the service. resources (Resources): Resource requirements which apply to each individual container created as part of the service. restart_policy (RestartPolicy): Specification for the restart policy which applies to containers created as part of this service. placement (Placement): Placement instructions for the scheduler. If a list is passed instead, it is assumed to be a list of constraints as part of a :py:class:`Placement` object. networks (:py:class:`list`): List of network names or IDs or :py:class:`NetworkAttachmentConfig` to attach the service to. force_update (int): A counter that triggers an update even if no relevant parameters have been changed. Nc C s� || d< |r || d< |r|| d< |r t |t�r t|d�}|| d< |r&|| d< |r.t|�| d< |d urAt |t�s;td��|| d < d S d S ) N� ContainerSpec� Resources� RestartPolicy)� constraints� Placement� LogDriver�Networksz force_update must be an integer� ForceUpdate)� isinstance�listr r �int� TypeError)�self�container_spec� resources�restart_policy� placement� log_driver�networks� force_update� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/services.py�__init__% s$ �zTaskTemplate.__init__c C � | � d�S )Nr ��get�r r r r r ; � zTaskTemplate.container_specc C r" )Nr r# r% r r r r ? r& zTaskTemplate.resourcesc C r" )Nr r# r% r r r r C r& zTaskTemplate.restart_policyc C r" )Nr r# r% r r r r G r& zTaskTemplate.placement)NNNNNN) �__name__� __module__� __qualname__�__doc__r! �propertyr r r r r r r r r s � r c @ s( e Zd ZdZ ddd�ZdS )r aI Describes the behavior of containers that are part of a task, and is used when declaring a :py:class:`~docker.types.TaskTemplate`. Args: image (string): The image name to use for the container. command (string or list): The command to be run in the image. args (:py:class:`list`): Arguments to the command. hostname (string): The hostname to set on the container. env (dict): Environment variables. workdir (string): The working directory for commands to run in. user (string): The user inside the container. labels (dict): A map of labels to associate with the service. mounts (:py:class:`list`): A list of specifications for mounts to be added to containers created as part of the service. See the :py:class:`~docker.types.Mount` class for details. stop_grace_period (int): Amount of time to wait for the container to terminate before forcefully killing it. secrets (:py:class:`list`): List of :py:class:`SecretReference` to be made available inside the containers. tty (boolean): Whether a pseudo-TTY should be allocated. groups (:py:class:`list`): A list of additional groups that the container process will run as. open_stdin (boolean): Open ``stdin`` read_only (boolean): Mount the container's root filesystem as read only. stop_signal (string): Set signal to stop the service's containers healthcheck (Healthcheck): Healthcheck configuration for this service. hosts (:py:class:`dict`): A set of host to IP mappings to add to the container's ``hosts`` file. dns_config (DNSConfig): Specification for DNS related configurations in resolver configuration file. configs (:py:class:`list`): List of :py:class:`ConfigReference` that will be exposed to the service. privileges (Privileges): Security options for the service's containers. isolation (string): Isolation technology used by the service's containers. Only used for Windows containers. init (boolean): Run an init inside the container that forwards signals and reaps processes. cap_add (:py:class:`list`): A list of kernel capabilities to add to the default set for the container. cap_drop (:py:class:`list`): A list of kernel capabilities to drop from the default set for the container. sysctls (:py:class:`dict`): A dict of sysctl values to add to the container Nc C sZ || d< t |t�r t|�}|| d< || d< |d ur || d< |d ur1t |t�r-t|�| d< n|| d< |d ur9|| d< |d urA|| d< | d urI| | d< |d urQ|| d < | d urY| | d < |d ura|| d < |d urmt|d d �| d< | d ur�g }| D ]} t | t�r�|�t�| �� qu|�| � qu|| d< | d ur�t | t �s�t d��| | d< |d ur�t |t �s�t d��|| d< |d ur�|| d< |d ur�|| d< |d ur�|| d< | d ur�| | d< |d ur�|| d< |d ur�|| d< |d ur�|| d< |d ur�|| d< |d u�rt |t �s�t d ��|| d < |d u�rt |t ��st d ��|| d < |d u�r+t |t��s%t d ��|| d!< d S d S )"N�Image�Command�Args�Hostname�Env�Dir�User�Groups� StopSignal�StopGracePeriod�LabelsT)�task�Hosts�Mountszsecrets must be a list�Secretszconfigs must be a list�Configs� DNSConfig� Privileges� Healthcheck�TTY� OpenStdin�ReadOnly� Isolation�Initzcap_add must be a list� CapabilityAddzcap_drop must be a list�CapabilityDropzsysctls must be a dict�Sysctls) r �strr �dictr r �append�Mount�parse_mount_stringr r ) r �image�command�args�hostname�env�workdir�user�labels�mounts�stop_grace_period�secrets�tty�groups� open_stdin� read_only� stop_signal� healthcheck�hosts� dns_config�configs� privileges� isolation�init�cap_add�cap_drop�sysctls� parsed_mounts�mountr r r r! ~ s� �zContainerSpec.__init__)NNNNNNNNNNNNNNNNNNNNNNNNN�r' r( r) r* r! r r r r r L s 1�r c @ s. e Zd ZdZ d dd�Zedd� �ZdS ) rJ a2 Describes a mounted folder's configuration inside a container. A list of :py:class:`Mount` would be used as part of a :py:class:`~docker.types.ContainerSpec`. Args: target (string): Container path. source (string): Mount source (e.g. a volume name or a host path). type (string): The mount type (``bind`` / ``volume`` / ``tmpfs`` / ``npipe``). Default: ``volume``. read_only (bool): Whether the mount should be read-only. consistency (string): The consistency requirement for the mount. One of ``default```, ``consistent``, ``cached``, ``delegated``. propagation (string): A propagation mode with the value ``[r]private``, ``[r]shared``, or ``[r]slave``. Only valid for the ``bind`` type. no_copy (bool): False if the volume should be populated with the data from the target. Default: ``False``. Only valid for the ``volume`` type. labels (dict): User-defined name and labels for the volume. Only valid for the ``volume`` type. driver_config (DriverConfig): Volume driver configuration. Only valid for the ``volume`` type. tmpfs_size (int or string): The size for the tmpfs mount in bytes. tmpfs_mode (int): The permission mode for the tmpfs mount. �volumeFNc C sD || d< || d< |dvrt �d|� d���|| d< || d< |r#|| d< |d krA|d ur1d |i| d < t|| || | g�r?t �d ��d S |d krmi } |rMd| d< |rS|| d< | rY| | d< | r_| | d< t|| | g�rkt �d��d S |dkr�i } | r�t| t�st �d��| | d< | r�t| �| d< | r�| | d< t||| |g�r�t �d��d S d S )N�Target�Source)�bindri �tmpfs�npipezUnsupported mount type: "�"�TyperA � Consistencyrl � Propagation� BindOptionsz@Incompatible options have been provided for the bind type mount.ri T�NoCopyr6 � DriverConfig� VolumeOptionszBIncompatible options have been provided for the volume type mount.rm z tmpfs_mode must be an integer�Mode� SizeBytes� TmpfsOptionszAIncompatible options have been provided for the tmpfs type mount.)r �InvalidArgument�anyr r r )r �target�source�typerZ � consistency� propagation�no_copyrS � driver_config� tmpfs_size� tmpfs_mode� volume_opts� tmpfs_optsr r r r! � sh ������ � �� zMount.__init__c C s� |� d�}t|�dkrt�d|� d���t|�dkr"| |d d d�S |d }|d }d}|�d �s?trA|d �� rA|d dkrAd }t|�d kpL|d d k }| ||||d �S )N�:� zInvalid mount format "ro � � )r| r} ri �/rl r �rw)rZ r~ )�split�lenr rz � startswithr �isalpha)�cls�string�partsr| r} � mount_typerZ r r r rK 4 s& � � � zMount.parse_mount_string) ri FNNFNNNN)r' r( r) r* r! � classmethodrK r r r r rJ � s �;rJ c @ � e Zd ZdZ ddd�ZdS )r a� Configures resource allocation for containers when made part of a :py:class:`~docker.types.ContainerSpec`. Args: cpu_limit (int): CPU limit in units of 10^9 CPU shares. mem_limit (int): Memory limit in Bytes. cpu_reservation (int): CPU reservation in units of 10^9 CPU shares. mem_reservation (int): Memory reservation in Bytes. generic_resources (dict or :py:class:`list`): Node level generic resources, for example a GPU, using the following format: ``{ resource_name: resource_value }``. Alternatively, a list of of resource specifications as defined by the Engine API. Nc C s| i }i }|d ur ||d< |d ur||d< |d ur ||d< |d ur$||d< |d ur.t |�|d< |r4|| d< |r<|| d< d S d S )N�NanoCPUs� MemoryBytes�GenericResources�Limits� Reservations)� _convert_generic_resources_dict)r � cpu_limit� mem_limit�cpu_reservation�mem_reservation�generic_resources�limits� reservationr r r r! ^ s$ � �zResources.__init__)NNNNNrh r r r r r M s �r c C s� t | t�r| S t | t�st�dt| �� d���g }| �� D ],\}}d }t |t�r+d}nt |t�r3d}n ||i}t�d|� ���|� |||d�i� q |S )Nz2generic_resources must be a dict or a list (found �)�DiscreteResourceSpec�NamedResourceSpecz/Unsupported generic resource reservation type: )�Kind�Value) r r rH r rz r~ �itemsr rG rI )r� r �kind�value� resource_type�kvr r r r� t s. �� � �r� c @ s e Zd ZdZ ddd�ZdS )� UpdateConfiga Used to specify the way container updates should be performed by a service. Args: parallelism (int): Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). Default: 0. delay (int): Amount of time between updates, in nanoseconds. failure_action (string): Action to take if an updated task fails to run, or stops running during the update. Acceptable values are ``continue``, ``pause``, as well as ``rollback`` since API v1.28. Default: ``continue`` monitor (int): Amount of time to monitor each updated task for failures, in nanoseconds. max_failure_ratio (float): The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. Default: 0 order (string): Specifies the order of operations when rolling out an updated task. Either ``start-first`` or ``stop-first`` are accepted. r� N�continuec C s� || d< |d ur || d< |dvrt �d��|| d< |d ur*t|t�s&td��|| d< |d urJt|ttf�s9td��|d ksA|d k rFt �d ��|| d < |d ur]|d vrWt �d��|| d< d S d S )N� Parallelism�Delay)�pauser� �rollbackz=failure_action must be one of `pause`, `continue`, `rollback`� FailureActionzmonitor must be an integer�Monitorz!max_failure_ratio must be a floatr� r� z2max_failure_ratio must be a number between 0 and 1�MaxFailureRatio)z start-firstz stop-firstz2order must be either `start-first` or `stop-first`�Order)r rz r r r �float)r � parallelism�delay�failure_action�monitor�max_failure_ratio�orderr r r r! � s6 � �� �zUpdateConfig.__init__)r� Nr� NNNrh r r r r r� � s �r� c @ s e Zd ZdZdS )�RollbackConfiga Used to specify the way container rollbacks should be performed by a service Args: parallelism (int): Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). Default: 0 delay (int): Amount of time between rollbacks, in nanoseconds. failure_action (string): Action to take if a rolled back task fails to run, or stops running during the rollback. Acceptable values are ``continue``, ``pause`` or ``rollback``. Default: ``continue`` monitor (int): Amount of time to monitor each rolled back task for failures, in nanoseconds. max_failure_ratio (float): The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. Default: 0 order (string): Specifies the order of operations when rolling out a rolled back task. Either ``start-first`` or ``stop-first`` are accepted. N)r' r( r) r* r r r r r� � s r� c @ s e Zd ZdZe\ZZZdS )�RestartConditionTypesEnum)�nonez on-failurer{ N)r' r( r) �_values�NONE� ON_FAILURE�ANYr r r r r� � s r� c @ s( e Zd ZdZeZejdddfdd�ZdS )r aX Used when creating a :py:class:`~docker.types.ContainerSpec`, dictates whether a container should restart after stopping or failing. Args: condition (string): Condition for restart (``none``, ``on-failure``, or ``any``). Default: `none`. delay (int): Delay between restart attempts. Default: 0 max_attempts (int): Maximum attempts to restart a given container before giving up. Default value is 0, which is ignored. window (int): Time window used to evaluate the restart policy. Default value is 0, which is unbounded. r� c C s> || j jvr td|� ���|| d< || d< || d< || d< d S )Nz Invalid RestartPolicy condition � Conditionr� � MaxAttempts�Window)�condition_typesr� r )r � conditionr� � max_attempts�windowr r r r! � s � zRestartPolicy.__init__N)r' r( r) r* r� r� r� r! r r r r r � s �r c @ � e Zd ZdZddd�ZdS )ru a� Indicates which driver to use, as well as its configuration. Can be used as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`, for the `driver_config` in a volume :py:class:`~docker.types.Mount`, or as the driver object in :py:meth:`create_secret`. Args: name (string): Name of the driver to use. options (dict): Driver-specific options. Default: ``None``. Nc C s || d< |r || d< d S d S )N�Name�Optionsr )r �name�optionsr r r r! s �zDriverConfig.__init__)Nrh r r r r ru s ru c @ r� )� EndpointSpecaz Describes properties to access and load-balance a service. Args: mode (string): The mode of resolution to use for internal load balancing between tasks (``'vip'`` or ``'dnsrr'``). Defaults to ``'vip'`` if not provided. ports (dict): Exposed ports that this service is accessible on from the outside, in the form of ``{ published_port: target_port }`` or ``{ published_port: <port_config_tuple> }``. Port config tuple format is ``(target_port [, protocol [, publish_mode]])``. Ports can only be provided if the ``vip`` resolution mode is used. Nc C s$ |rt |�| d< |r|| d< d S d S )N�Portsrw )�convert_service_ports)r �mode�portsr r r r! + s �zEndpointSpec.__init__�NNrh r r r r r� s r� c C s� t | t�r| S t | t�std��g }| �� D ]F\}}d|d�}t |t�rS|d |d< t|�dkr<|d d ur<|d |d< t|�d krH|d |d < t|�d krRtd ��n||d< |�|� q|S ) Nz-Invalid type for ports, expected dict or list�tcp)�Protocol� PublishedPortr� � TargetPortr r� r� r� � PublishModezUService port configuration can have at most 3 elements: (target_port, protocol, mode)) r r rH r r� �tupler� � ValueErrorrI )r� �result�k�v� port_specr r r r� 2 s2 �� �� r� c @ s2 e Zd ZdZd dd�Zedd� �Zedd� �ZdS ) � ServiceModea� Indicate whether a service or a job should be deployed as a replicated or global service, and associated parameters Args: mode (string): Can be either ``replicated``, ``global``, ``replicated-job`` or ``global-job`` replicas (int): Number of replicas. For replicated services only. concurrency (int): Number of concurrent jobs. For replicated job services only. Nc C s� d}|d }||vrt �d��||vr%|d ur t �d��|d ur%t �d��| �|�}|| _i | |< |d urS|dkr?|| | d< |dkrU|pFd | | d < || | d < d S d S d S ) N)� replicated�replicated-job)�global� global-jobzLmode must be either "replicated", "global", "replicated-job" or "global-job"zCreplicas can only be used for "replicated" or "replicated-job" modez6concurrency can only be used for "replicated-job" moder� �Replicasr� r� � MaxConcurrent�TotalCompletions)r rz � _convert_moder� )r r� �replicas� concurrency�replicated_modes�supported_modes� service_moder r r r! ` s4 ��� �zServiceMode.__init__c C s | dkrdS | dkr dS | S )Nr� � GlobalJobr� � ReplicatedJobr )� original_moder r r r� � s zServiceMode._convert_modec C s0 d| v r | d � d�S d| v r| d � d�S d S )Nr� r� r� r� r# r% r r r r� � s zServiceMode.replicasr� ) r' r( r) r* r! � staticmethodr� r+ r� r r r r r� S s " r� c @ �& e Zd ZdZed� ddd��ZdS )�SecretReferencea� Secret reference to be used as part of a :py:class:`ContainerSpec`. Describes how a secret is made accessible inside the service's containers. Args: secret_id (string): Secret's ID secret_name (string): Secret's name as defined at its creation. filename (string): Name of the file containing the secret. Defaults to the secret's name if not specified. uid (string): UID of the secret file's owner. Default: 0 gid (string): GID of the secret file's group. Default: 0 mode (int): File access mode inside the container. Default: 0o444 � secret_idN�$ c C �2 || d< || d< |p ||pd|pd|d�| d< d S )N� SecretName�SecretID�0�r� �UID�GIDrw �Filer )r r� � secret_name�filename�uid�gidr� r r r r! � � �zSecretReference.__init__�NNNr� �r' r( r) r* r r! r r r r r� � � �r� c @ r� )�ConfigReferencea� Config reference to be used as part of a :py:class:`ContainerSpec`. Describes how a config is made accessible inside the service's containers. Args: config_id (string): Config's ID config_name (string): Config's name as defined at its creation. filename (string): Name of the file containing the config. Defaults to the config's name if not specified. uid (string): UID of the config file's owner. Default: 0 gid (string): GID of the config file's group. Default: 0 mode (int): File access mode inside the container. Default: 0o444 � config_idNr� c C r� )N� ConfigName�ConfigIDr� r� r r )r r � config_namer r r r� r r r r! � r zConfigReference.__init__r r r r r r r � r r c @ r� )r a� Placement constraints to be used as part of a :py:class:`TaskTemplate` Args: constraints (:py:class:`list` of str): A list of constraints preferences (:py:class:`list` of tuple): Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence and are expressed as ``(strategy, descriptor)`` tuples. See :py:class:`PlacementPreference` for details. maxreplicas (int): Maximum number of replicas per node platforms (:py:class:`list` of tuple): A list of platforms expressed as ``(arch, os)`` tuples Nc C s� |d ur|| d< |d ur%g | d< |D ]}t |t�r t|� }| d �|� q|d ur-|| d< |rFg | d< |D ]}| d �|d |d d�� q5d S d S )N� Constraints� Preferences� MaxReplicas� Platformsr� r� )� Architecture�OS)r r� �PlacementPreferencerI )r r � preferences� platforms� maxreplicas�pref�platr r r r! � s$ ��zPlacement.__init__)NNNNrh r r r r r � s �r c @ s e Zd ZdZdd� ZdS )r a� Placement preference to be used as an element in the list of preferences for :py:class:`Placement` objects. Args: strategy (string): The placement strategy to implement. Currently, the only supported strategy is ``spread``. descriptor (string): A label descriptor. For the spread strategy, the scheduler will try to spread tasks evenly over groups of nodes identified by this label. c C s* |dkr t �d|� d���d|i| d< d S )N�spreadz/PlacementPreference strategy value is invalid (z): must be "spread".�SpreadDescriptor�Spread)r rz )r �strategy� descriptorr r r r! s �z PlacementPreference.__init__Nrh r r r r r � s r c @ r� )r< a� Specification for DNS related configurations in resolver configuration file (``resolv.conf``). Part of a :py:class:`ContainerSpec` definition. Args: nameservers (:py:class:`list`): The IP addresses of the name servers. search (:py:class:`list`): A search list for host-name lookup. options (:py:class:`list`): A list of internal resolver variables to be modified (e.g., ``debug``, ``ndots:3``, etc.). Nc C � || d< || d< || d< d S )N� Nameservers�Searchr� r )r � nameservers�searchr� r r r r! � zDNSConfig.__init__)NNNrh r r r r r< � r< c @ s e Zd ZdZ ddd�ZdS )r= ak Security options for a service's containers. Part of a :py:class:`ContainerSpec` definition. Args: credentialspec_file (str): Load credential spec from this file. The file is read by the daemon, and must be present in the CredentialSpecs subdirectory in the docker data directory, which defaults to ``C:\ProgramData\Docker\`` on Windows. Can not be combined with credentialspec_registry. credentialspec_registry (str): Load credential spec from this value in the Windows registry. The specified registry value must be located in: ``HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion \Virtualization\Containers\CredentialSpecs``. Can not be combined with credentialspec_file. selinux_disable (boolean): Disable SELinux selinux_user (string): SELinux user label selinux_role (string): SELinux role label selinux_type (string): SELinux type label selinux_level (string): SELinux level label Nc C sz i }|d ur ||d< |d ur||d< t |�dkr t�d��|||||d�} t |�dkr/|| d< t | �dkr;| | d< d S d S ) N�Registryr r� zFcredentialspec_file and credentialspec_registry are mutually exclusive)�Disabler2 �Rolerp �Levelr� �CredentialSpec�SELinuxContext)r� r rz ) r �credentialspec_file�credentialspec_registry�selinux_disable� selinux_user� selinux_role� selinux_type� selinux_level�credential_spec�selinux_contextr r r r! 5 s( �� �zPrivileges.__init__)NNNNNNNrh r r r r r= s �r= c @ r� )�NetworkAttachmentConfiga� Network attachment options for a service. Args: target (str): The target network for attachment. Can be a network name or ID. aliases (:py:class:`list`): A list of discoverable alternate names for the service. options (:py:class:`dict`): Driver attachment options for the network target. Nc C r )Nrj �Aliases� DriverOptsr )r r| �aliasesr� r r r r! ` r$ z NetworkAttachmentConfig.__init__r� rh r r r r r5 S r% r5 N) � r � constantsr �utilsr r r r r r rH r r rJ r r� r� r� r� r ru r� r� r� r� r r r r< r= r5 r r r r �<module> s0 ? p'8 !D $7 types/__pycache__/__init__.cpython-310.pyc 0000644 00000001744 15027665106 0014376 0 ustar 00 o �hq � @ s� d dl mZmZmZmZmZ d dlmZ d dlm Z d dl m Z m Z m Z mZ d dlmZmZmZmZmZmZmZmZmZmZmZmZm Z m Z m Z m Z m Z d dl!m"Z"m#Z# dS )� )�ContainerConfig� DeviceRequest� HostConfig� LogConfig�Ulimit)�CancellableStream)� Healthcheck)�EndpointConfig� IPAMConfig�IPAMPool�NetworkingConfig)�ConfigReference� ContainerSpec� DNSConfig� DriverConfig� EndpointSpec�Mount�NetworkAttachmentConfig� Placement�PlacementPreference� Privileges� Resources� RestartPolicy�RollbackConfig�SecretReference� ServiceMode� TaskTemplate� UpdateConfig)�SwarmExternalCA� SwarmSpecN)$� containersr r r r r �daemonr � healthcheckr �networksr r r r �servicesr r r r r r r r r r r r r r r r r �swarmr r � r& r& �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/__init__.py�<module> s L types/__pycache__/healthcheck.cpython-310.pyc 0000644 00000006322 15027665106 0015077 0 ustar 00 o �h� � @ s d dl mZ G dd� de�ZdS )� )�DictTypec s� e Zd ZdZ� fdd�Zedd� �Zejdd� �Zedd� �Zejd d� �Zed d � �Z e jd d � �Z ed d� �Z e jdd� �Z edd� �Z e jdd� �Z � Z S )� Healthchecka� Defines a healthcheck configuration for a container or service. Args: test (:py:class:`list` or str): Test to perform to determine container health. Possible values: - Empty list: Inherit healthcheck from parent image - ``["NONE"]``: Disable healthcheck - ``["CMD", args...]``: exec arguments directly. - ``["CMD-SHELL", command]``: Run command in the system's default shell. If a string is provided, it will be used as a ``CMD-SHELL`` command. interval (int): The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). timeout (int): The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). retries (int): The number of consecutive failures needed to consider a container as unhealthy. start_period (int): Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). c s� |� d|� d��}t|t�rd|g}|� d|� d��}|� d|� d��}|� d|� d ��}|� d |� d ��}t� �|||||d �� d S ) N�test�Test� CMD-SHELL�interval�Interval�timeout�Timeout�retries�Retries� start_period� StartPeriod)r r r r r )�get� isinstance�str�super�__init__)�self�kwargsr r r r r �� __class__� �N/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/healthcheck.pyr s �zHealthcheck.__init__c C � | d S )Nr r �r r r r r 0 � zHealthcheck.testc C s t |t�r d|g}|| d< d S )Nr r )r r �r �valuer r r r 4 s c C r �Nr r r r r r r : r zHealthcheck.intervalc C � || d< d S r r r r r r r > � c C r �Nr r r r r r r B r zHealthcheck.timeoutc C r r" r r r r r r F r! c C r �Nr r r r r r r J r zHealthcheck.retriesc C r r# r r r r r r N r! c C r �Nr r r r r r r R r zHealthcheck.start_periodc C r r$ r r r r r r V r! ) �__name__� __module__� __qualname__�__doc__r �propertyr �setterr r r r � __classcell__r r r r r s. r N)�baser r r r r r �<module> s types/__pycache__/swarm.cpython-310.pyc 0000644 00000006412 15027665106 0013765 0 ustar 00 o �h- � @ s< d dl mZ d dlmZ G dd� de�ZG dd� de�ZdS )� )�InvalidVersion)� version_ltc @ s* e Zd ZdZ ddd�ZdS )� SwarmSpecz� Describe a Swarm's configuration and options. Use :py:meth:`~docker.api.swarm.SwarmApiMixin.create_swarm_spec` to instantiate. Nc C st |d ur d|i| d< t |||||g�r |||||d�| d< |r%d|i| d< i }| d ur/| |d< | rKt|d�rGt| �d kr@td ��| d |d < n| |d < |rZt|d�rVtd��||d< | rit|d�retd��| |d< |d urzt|d�rvtd��||d< |r�|| d< |d ur�t|d�r�td��d|i| d< |d ur�t|d�r�td��d|i| d< | d ur�| | d < | d ur�| | d < d S d S ) N�TaskHistoryRetentionLimit� Orchestration)�SnapshotInterval�KeepOldSnapshots�LogEntriesForSlowFollowers� HeartbeatTick� ElectionTick�Raft�HeartbeatPeriod� Dispatcher�NodeCertExpiryz1.25� zISupport for multiple external CAs is not available for API version < 1.25� � ExternalCA� ExternalCAsz1.30z5signing_ca_key is not supported in API version < 1.30� SigningCAKeyz6signing_ca_cert is not supported in API version < 1.30� SigningCACertz3force_rotate is not supported in API version < 1.30� ForceRotate�CAConfigz8autolock_managers is not supported in API version < 1.25�AutoLockManagers�EncryptionConfigz1log_driver is not supported in API version < 1.25� LogDriver� TaskDefaults�Name�Labels)�anyr �lenr )�self�version� task_history_retention_limit�snapshot_interval�keep_old_snapshots� log_entries_for_slow_followers�heartbeat_tick� election_tick�dispatcher_heartbeat_period�node_cert_expiry� external_cas�name�labels�signing_ca_cert�signing_ca_key�ca_force_rotate�autolock_managers� log_driver� ca_config� r3 �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/swarm.py�__init__ s� �� �� � � � � � � �zSwarmSpec.__init__)NNNNNNNNNNNNNNNN��__name__� __module__� __qualname__�__doc__r5 r3 r3 r3 r4 r s �r c @ s e Zd ZdZddd�ZdS )�SwarmExternalCAa� Configuration for forwarding signing requests to an external certificate authority. Args: url (string): URL where certificate signing requests should be sent. protocol (string): Protocol for communication with the external CA. options (dict): An object with key/value pairs that are interpreted as protocol-specific options for the external CA driver. ca_cert (string): The root CA certificate (in PEM format) this external CA uses to issue TLS certificates (assumed to be to the current swarm root CA certificate if not provided). Nc C s$ || d< || d< || d< || d< d S )N�URL�Protocol�Options�CACertr3 )r �url�protocol�options�ca_certr3 r3 r4 r5 s s zSwarmExternalCA.__init__)NNNr6 r3 r3 r3 r4 r; a s r; N)�errorsr �utilsr �dictr r; r3 r3 r3 r4 �<module> s \ types/__pycache__/containers.cpython-310.pyc 0000644 00000042103 15027665106 0014776 0 ustar 00 o �hk � @ s� d dl mZ d dlmZmZmZmZmZmZm Z m Z m Z m Z m Z ddlmZ ddlmZ G dd� d�ZG dd � d e�ZG d d � d e�ZG d d � d e�ZG dd� de�Zdd� Zd dd�Zdd� Zdd� ZG dd� de�Z dS ) � )�errors) �convert_port_bindings�convert_tmpfs_mounts�convert_volume_binds�format_environment�format_extra_hosts�normalize_links� parse_bytes� parse_devices� split_command� version_gte� version_lt� )�DictType)� Healthcheckc @ s e Zd ZdZe\ZZZZZZ dS )�LogConfigTypesEnum)z json-file�syslog�journald�gelf�fluentd�noneN) �__name__� __module__� __qualname__�_values�JSON�SYSLOG�JOURNALD�GELF�FLUENTD�NONE� r! r! �M/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/containers.pyr s r c sZ e Zd ZdZeZ� fdd�Zedd� �Zej dd� �Zedd� �Z d d � Z d d � Z � Z S ) � LogConfiga6 Configure logging for a container, when provided as an argument to :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. You may refer to the `official logging driver documentation <https://docs.docker.com/config/containers/logging/configure/>`_ for more information. Args: type (str): Indicate which log driver to use. A set of valid drivers is provided as part of the :py:attr:`LogConfig.types` enum. Other values may be accepted depending on the engine version and available logging plugins. config (dict): A driver-dependent configuration dictionary. Please refer to the driver's documentation for a list of valid config keys. Example: >>> from docker.types import LogConfig >>> lc = LogConfig(type=LogConfig.types.JSON, config={ ... 'max-size': '1g', ... 'labels': 'production_status,geo' ... }) >>> hc = client.create_host_config(log_config=lc) >>> container = client.create_container('busybox', 'true', ... host_config=hc) >>> client.inspect_container(container)['HostConfig']['LogConfig'] { 'Type': 'json-file', 'Config': {'labels': 'production_status,geo', 'max-size': '1g'} } c sT |� d|� d��}|� d|� d��pi }|r t|t�s td��t� �||d�� d S )N�type�Type�config�Configz%LogConfig.config must be a dictionary)r% r' )�get� isinstance�dict� ValueError�super�__init__)�self�kwargs�log_driver_typer& �� __class__r! r" r- B s �zLogConfig.__init__c C � | d S �Nr% r! �r. r! r! r" r$ N � zLogConfig.typec C � || d< d S r4 r! �r. �valuer! r! r" r$ R � c C r3 )Nr' r! r5 r! r! r" r& V r6 zLogConfig.configc C s || j |< dS )zZ Set a the value for ``key`` to ``value`` inside the ``config`` dict. N�r& )r. �keyr9 r! r! r" �set_config_valueZ s zLogConfig.set_config_valuec C s || j v r | j |= dS dS )z7 Remove the ``key`` property from the ``config`` dict. Nr; )r. r< r! r! r" � unset_config` s �zLogConfig.unset_config)r r r �__doc__r �typesr- �propertyr$ �setterr& r= r> � __classcell__r! r! r1 r" r# s r# c sn e Zd ZdZ� fdd�Zedd� �Zejdd� �Zedd� �Zejd d� �Zed d � �Z e jd d � �Z � Z S ) �Ulimita$ Create a ulimit declaration to be used with :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. Args: name (str): Which ulimit will this apply to. The valid names can be found in '/etc/security/limits.conf' on a gnu/linux system. soft (int): The soft limit for this ulimit. Optional. hard (int): The hard limit for this ulimit. Optional. Example: >>> nproc_limit = docker.types.Ulimit(name='nproc', soft=1024) >>> hc = client.create_host_config(ulimits=[nproc_limit]) >>> container = client.create_container( 'busybox', 'true', host_config=hc ) >>> client.inspect_container(container)['HostConfig']['Ulimits'] [{'Name': 'nproc', 'Hard': 0, 'Soft': 1024}] c s� |� d|� d��}|� d|� d��}|� d|� d��}t|t�s$td��|r/t|t�s/td��|r:t|t�s:td ��t� �|||d �� d S ) N�name�Name�soft�Soft�hard�Hardz Ulimit.name must be a stringz Ulimit.soft must be an integerz Ulimit.hard must be an integer)rF rH rJ )r( r) �strr+ �intr, r- )r. r/ rE rG rI r1 r! r" r- } s �zUlimit.__init__c C r3 �NrF r! r5 r! r! r" rE � r6 z Ulimit.namec C r7 rM r! r8 r! r! r" rE � r: c C � | � d�S �NrH �r( r5 r! r! r" rG � � z Ulimit.softc C r7 rO r! r8 r! r! r" rG � r: c C rN �NrJ rP r5 r! r! r" rI � rQ z Ulimit.hardc C r7 rR r! r8 r! r! r" rI � r: ) r r r r? r- rA rE rB rG rI rC r! r! r1 r" rD f s rD c s� e Zd ZdZ� fdd�Zedd� �Zejdd� �Zedd� �Zejd d� �Zed d � �Z e jd d � �Z ed d� �Z e jdd� �Z edd� �Z e jdd� �Z � Z S )� DeviceRequestax Create a device request to be used with :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. Args: driver (str): Which driver to use for this device. Optional. count (int): Number or devices to request. Optional. Set to -1 to request all available devices. device_ids (list): List of strings for device IDs. Optional. Set either ``count`` or ``device_ids``. capabilities (list): List of lists of strings to request capabilities. Optional. The global list acts like an OR, and the sub-lists are AND. The driver will try to satisfy one of the sub-lists. Available capabilities for the ``nvidia`` driver can be found `here <https://github.com/NVIDIA/nvidia-container-runtime>`_. options (dict): Driver-specific options. Optional. c s |� d|� d��}|� d|� d��}|� d|� d��}|� d|� d��}|� d |� d ��}|d u r4d }n t|t�s=td ��|d u rDd }n t|t�sMtd��|d u rTg }n t|t�s]td��|d u rdg }n t|t�smtd��|d u rti }n t|t�s}td��t� �|||||d�� d S )N�driver�Driver�count�Count� device_ids� DeviceIDs� capabilities� Capabilities�options�Options� z%DeviceRequest.driver must be a string� z&DeviceRequest.count must be an integerz'DeviceRequest.device_ids must be a listz)DeviceRequest.capabilities must be a listz$DeviceRequest.options must be a dict)rU rW rY r[ r] ) r( r) rK r+ rL �listr* r, r- )r. r/ rT rV rX rZ r\ r1 r! r" r- � s@ �zDeviceRequest.__init__c C r3 �NrU r! r5 r! r! r" rT � r6 zDeviceRequest.driverc C r7 ra r! r8 r! r! r" rT � r: c C r3 �NrW r! r5 r! r! r" rV � r6 zDeviceRequest.countc C r7 rb r! r8 r! r! r" rV � r: c C r3 �NrY r! r5 r! r! r" rX � r6 zDeviceRequest.device_idsc C r7 rc r! r8 r! r! r" rX � r: c C r3 �Nr[ r! r5 r! r! r" rZ � r6 zDeviceRequest.capabilitiesc C r7 rd r! r8 r! r! r" rZ � r: c C r3 �Nr] r! r5 r! r! r" r\ � r6 zDeviceRequest.optionsc C r7 re r! r8 r! r! r" r\ r: ) r r r r? r- rA rT rB rV rX rZ r\ rC r! r! r1 r" rS � s. $ rS c @ sD e Zd Z ddd�ZdS )� HostConfigNFcB G C s� |d ur t |�| d< |d urt |�| d< |r t |�| d< |r$t |�| d< |d ur7t|t�s3td|d��|| d< |'d urHt|'t�rDt |'�}'|'| d< |r\t|d �rX|d krXtd |��|| d < |rb|| d < |rh|| d< |&rn|&| d< |*r�t|d�rztdd��t|*t�s�td|*d��|*| d< |r�|| d< |d ur�|| d< | r�| | d< | d kr�|r�tdd d��| p�d| d< | r�t| t �s�td| d��| | d < | r�| | d < |r�|| d < |r�t |�| d < | r�d d!� | D �| d"< |d ur�|| d#< |+d ur�|+| d$< |d u�rt|t �s�td%|d&��|| d'< |(�r(t|(t ��std(|(d��i | d)< |(� � D ] \}B}Ct|C�| d) |B< �q| d u�r<t| t��r8| � d*�} | | d+< |d u�rGt|�| d,< |d u�rRt|�| d-< |d u�ret|t ��rat|�}|| d.< |d u�rpt|�| d/< t|t ��r�g }D|� � D ]\}B}C|D�|Bt|C�d0�� �q||D}|d u�r�|| d1< | d u�r�| | d2< |d u�r�t|t ��s�td3|d&��g | d4< |D ]}Et|Et��s�td{i |E��}E| d4 �|E� �q�|d u�r�t|t��s�t|t ��s�td5|d6��td{i |��}|| d6< | �rt| t��s td7| d��| | d8< | �rt| t��std9| d��| | d:< |,�r*t|,t��s&td;|,d��|,| d<< |-�r1|-| d=< |:�rDt|:t��s@td>|:d?��|:| d@< |=�rbt|dA��rRtdBdA��t|=t��s^tdB|=d��|=| dC< |>�r�t|dA��rptdDdA��t|>t��s|tdD|>d��|>| dE< | �r�t| t��s�tdF| d��t|d��r�tdFd��| | dG< |!�r�t|!t ��s�tdH|!d&��t|d��r�tdHd��|!| dI< |"�r�t|"t ��s�tdJ|"d&��t|d��r�tdJd��|"| dK< |#�r�t|#t ��s�tdL|#d&��t|d��r�tdLd��|#| dM< |$�rt|$t ��stdN|$d&��t|d��rtdNd��|$| dO< |%�r4t|%t ��s%tdP|%d&��t|d��r0tdPd��|%| dQ< |)�rHt|d��rBtdRd��t|)�| dS< |.�rdt|dT��rVtdUdT��|.d k�r`tdU|.��|.| dV< |/�ru|/d k�rqtdW|/��|/| dX< |0�r�t|0t��s�tdY|0d��t|dT��r�tdYdT��|0| dZ< |1�r�t|1t��s�td[|1d\��t|d ��r�td[d ��|1| d]< |2�r�t|dA��r�td^dA��|2| d_< |3d u�r�t|d ��r�td`d ��|3| da< |4d u�r�t|dA��r�tdbdA��|4| dc< |5d u�r t|dA��r�tdddA��t|de��rtdddedf��|5| dg< |6d u�r|6| dh< |7�r2t|7t��s#tdi|7d��t|dA��r.tdidA��|7| dj< |8�rPt|8t��sAtdk|8d��t|dA��rLtdkdA��|8| dl< |9�rnt|9t��s_tdm|9d��t|dA��rjtdmdA��|9| dn< |;�r�t|dA��r|tdodA��|;| dp< |<d u�r�t|dq��r�tdrdq��|<| ds< |?d u�r�t|dt��r�tdudt��t|?t ��s�tdu|?d&��|?| dv< |@d u�r�t|dw��r�tdxdw��t|@t ��s�tdx|@d&��g | dy< |@D ]}Ft|Ft��s�td{i |F��}F| dy �|F� �q�|A�r�|A| dz< d S d S )|N�Memory� MemorySwap�MemoryReservation� KernelMemory�mem_swappinessrL �MemorySwappiness�ShmSize�1.24�host�pid_mode�PidMode�IpcMode� Privileged�OomKillDisablez1.22� oom_score_adj� OomScoreAdj�PublishAllPorts�ReadonlyRootfs� DnsSearch� network_mode� port_bindings�default� NetworkMode�restart_policyr* � RestartPolicy�CapAdd�CapDrop�Devicesc S s g | ]}t |��qS r! )rK )�.0�grpr! r! r" � <listcomp>s s z'HostConfig.__init__.<locals>.<listcomp>�GroupAdd�Dns� DnsOptions� security_optr` � SecurityOpt�sysctls�Sysctls�,� VolumesFrom�Binds� PortBindings� ExtraHosts�Links)�Key�Value�LxcConf� CgroupParent�ulimits�Ulimits� log_configr# � cpu_quota�CpuQuota� cpu_period� CpuPeriod� cpu_shares� CpuShares� CpusetCpus� cpuset_memsrK � CpusetMems�1.25� cpu_rt_period�CPURealtimePeriod�cpu_rt_runtime�CPURealtimeRuntime� blkio_weight� BlkioWeight�blkio_weight_device�BlkioWeightDevice�device_read_bps�BlkioDeviceReadBps�device_write_bps�BlkioDeviceWriteBps�device_read_iops�BlkioDeviceReadIOps�device_write_iops�BlkioDeviceWriteIOps�tmpfs�Tmpfsz1.23� userns_mode� UsernsMode�uts_mode�UTSMode� pids_limit� PidsLimit� isolation�string� Isolation� auto_remove� AutoRemove� storage_opt� StorageOpt�init�Init� init_path�1.29F�InitPath� VolumeDriver� cpu_count�CpuCount� cpu_percent� CpuPercent� nano_cpus�NanoCpus�runtime�Runtimez1.30�mounts�Mountsz1.28�device_cgroup_rules�DeviceCgroupRulesz1.40�device_requests�DeviceRequests� CgroupnsModer! )r r) rL �host_config_type_errorrK r �host_config_value_error�host_config_version_error� host_config_incompatible_errorr* r r` �items�splitr r r r �appendrD r# r r rS )Gr. �version�bindsr{ �lxc_conf�publish_all_ports�links� privileged�dns� dns_search� volumes_fromrz r~ �cap_add�cap_drop�devices� extra_hosts� read_onlyrp �ipc_moder� r� r� � mem_limit� memswap_limit�mem_reservation� kernel_memoryrk � cgroup_parent� group_addr� r� r� r� r� r� r� r� �oom_kill_disable�shm_sizer� r� ru �dns_optr� � cpuset_cpusr� r� r� r� r� r� r� r� � volume_driverr� r� r� r� r� r� r� r� r� r� �cgroupns�k�v� formatted�lmt�reqr! r! r" r- sN � � � � � � � � � � � � � � � � � �zHostConfig.__init__)@NNNFNFNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNFNNNNNNNNNNNFNNNNNNNNNNNNNNN�r r r r- r! r! r! r" rf s2 �rf c C s t d| � d|� dt|�� ��S )NzInvalid type for z param: expected z but found )� TypeErrorr$ )�param� param_value�expectedr! r! r" r� � s ��r� Tc C s& |rdnd}t �| � d|� d|� ��S )N�<�>z( param is not supported in API versions � )r �InvalidVersion)r r� � less_than�operatorr! r! r" r� � s �r� c C s t d| � d|� ��S )NzInvalid value for z param: )r+ )r r r! r! r" r� � s r� c C s t �d|� d| � d|� ��S )N�"z" z is incompatible with )r �InvalidArgument)r r �incompatible_paramr! r! r" r� � s �r� c @ s" e Zd Z ddd�ZdS )�ContainerConfigNFc " C s |d urt |d�rt�d��|d ur*t |d�r t�d��t |d�r*d|v r*t�d��t|t�r3t|�}t| t�r<t| �} t| t�rEt| �} t|t�rQdd � |D �}t| t�ri }| D ]"}|}d }t|t �rst |�d kro|d }|d }i ||� d|� �< qZ|} t| t�r�| g} t| t�r�i } | D ]} i | | < q�| } |r�t|t�r�t d#i |��}d} d} d} d}!|s�d} d} |r�d} d}!| � i d|�d|�d| �d|d ur�t|�nd �d|�d|�d|!�d| �d| �d| �d| �d |�d |�d | �d | �d | �d!|�||||||||d"��� d S )$Nr� z4stop_timeout was only introduced in API version 1.25rn z7Health options were only introduced in API version 1.24r� � StartPeriodz;healthcheck start period was introduced in API version 1.29c S s i | ]}|d �qS )r^ r! )r� �lblr! r! r" � <dictcomp>� s z,ContainerConfig.__init__.<locals>.<dictcomp>�tcpr r r_ �/FT�Hostname� Domainname� ExposedPorts�User�Tty� OpenStdin� StdinOnce� AttachStdin� AttachStdout� AttachStderr�Env�Cmd�Image�Volumes�NetworkDisabled� Entrypoint� WorkingDir)rf �NetworkingConfig� MacAddress�Labels� StopSignalr � StopTimeoutr� r! ) r r r r) rK r r* r r` �tuple�lenr �update)"r. r� �image�command�hostname�user�detach� stdin_open�tty�ports� environment�volumes�network_disabled� entrypoint� working_dir� domainname� host_config� mac_address�labels� stop_signal�networking_config� healthcheck� stop_timeoutr� � exposed_ports�port_definition�port�proto� volumes_dict�vol� attach_stdin� attach_stdout� attach_stderr� stdin_oncer! r! r" r- � s� � �� �������� � � � � ������zContainerConfig.__init__)NNFFFNNNFNNNNNNNNNNNr� r! r! r! r" r � s �r N)T) r^ r � utils.utilsr r r r r r r r r r r �baser r? r r r# rD rS r* rf r� r� r� r� r r! r! r! r" �<module> s" 4 G@b types/__pycache__/daemon.cpython-310.pyc 0000644 00000003526 15027665106 0014102 0 ustar 00 o �h� � @ s. d dl Z d dlZddlmZ G dd� d�ZdS )� N� )�DockerExceptionc @ s4 e Zd ZdZdd� Zdd� Zdd� ZeZdd � Zd S ) �CancellableStreama Stream wrapper for real-time events, logs, etc. from the server. Example: >>> events = client.events() >>> for event in events: ... print(event) >>> # and cancel from another thread >>> events.close() c C s || _ || _d S �N)�_stream� _response)�self�stream�response� r �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/daemon.py�__init__ s zCancellableStream.__init__c C s | S r r �r r r r �__iter__ s zCancellableStream.__iter__c C s8 zt | j�W S tjjy td � ty td �w r )�nextr �urllib3� exceptions� ProtocolError� StopIteration�OSErrorr r r r �__next__ s �zCancellableStream.__next__c C s� | j jjsN| j jjj}t|d�r%|j}t|d�r |j}nt|d�r$|j}n t|d�r.td��|j}tt j d�rBt |t j j j �rB|j}|�tj� |�� dS dS )z- Closes the event streaming. �raw�sock�_sock�channelz6Cancellable streams not supported for the SSH protocol� pyopensslN)r r �closed�_fp�fp�hasattrr r r r �contrib� isinstancer � WrappedSocket�socket�shutdown� SHUT_RDWR�close)r �sock_fp�sock_rawr r r r r& % s* � � � �zCancellableStream.closeN) �__name__� __module__� __qualname__�__doc__r r r r r& r r r r r s r )r# r �errorsr r r r r r �<module> s types/__pycache__/base.cpython-310.pyc 0000644 00000000750 15027665106 0013545 0 ustar 00 o �hn � @ s G d d� de �ZdS )c @ s e Zd Zdd� ZdS )�DictTypec C s |� � D ]\}}|| |< qd S )N)�items)�self�init�k�v� r �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/base.py�__init__ s �zDictType.__init__N)�__name__� __module__� __qualname__r r r r r r s r N)�dictr r r r r �<module> s types/__pycache__/networks.cpython-310.pyc 0000644 00000010140 15027665106 0014501 0 ustar 00 o �h� � @ s` d dl mZ d dlmZmZ G dd� de�ZG dd� de�ZG dd� de�ZG d d � d e�Z d S ) � )�errors)�normalize_links� version_ltc @ s e Zd Z ddd�ZdS )�EndpointConfigNc C s� t |d�r t�d��|r|| d< |rt|�| d< i } |r || d< |r&|| d< |r6t |d�r2t�d��|| d < |d urHt |d �rDt�d ��|| d < | rN| | d < |rit |d�rZt�d��t|t�sctd��|| d< d S d S )Nz1.22z7Endpoint config is not supported for API version < 1.22�Aliases�Links� IPv4Address� IPv6Addressz1.25z3mac_address is not supported for API version < 1.25� MacAddressz1.24z6link_local_ips is not supported for API version < 1.24� LinkLocalIPs� IPAMConfigz1.32z2DriverOpts is not supported for API version < 1.32z driver_opt must be a dictionary� DriverOpts)r r �InvalidVersionr � isinstance�dict� TypeError) �self�version�aliases�links� ipv4_address� ipv6_address�link_local_ips� driver_opt� mac_address� ipam_config� r �K/usr/local/CyberPanel/lib/python3.10/site-packages/docker/types/networks.py�__init__ sH � � � � �zEndpointConfig.__init__)NNNNNNN��__name__� __module__� __qualname__r r r r r r s �r c @ s e Zd Zddd�ZdS )�NetworkingConfigNc C s |r|| d< d S d S )N�EndpointsConfigr )r �endpoints_configr r r r 7 s �zNetworkingConfig.__init__)Nr r r r r r# 6 s r# c @ s e Zd ZdZddd�ZdS )r au Create an IPAM (IP Address Management) config dictionary to be used with :py:meth:`~docker.api.network.NetworkApiMixin.create_network`. Args: driver (str): The IPAM driver to use. Defaults to ``default``. pool_configs (:py:class:`list`): A list of pool configurations (:py:class:`~docker.types.IPAMPool`). Defaults to empty list. options (dict): Driver options as a key-value dictionary. Defaults to `None`. Example: >>> ipam_config = docker.types.IPAMConfig(driver='default') >>> network = client.create_network('network1', ipam=ipam_config) �defaultNc C s: | � ||pg d�� |rt|t�std��|| d< d S d S )N)�Driver�Configz'IPAMConfig options must be a dictionary�Options)�updater r r )r �driver� pool_configs�optionsr r r r O s � �zIPAMConfig.__init__)r& NN�r r! r" �__doc__r r r r r r < s r c @ s e Zd ZdZ ddd�ZdS )�IPAMPoola� Create an IPAM pool config dictionary to be added to the ``pool_configs`` parameter of :py:class:`~docker.types.IPAMConfig`. Args: subnet (str): Custom subnet for this IPAM pool using the CIDR notation. Defaults to ``None``. iprange (str): Custom IP range for endpoints in this IPAM pool using the CIDR notation. Defaults to ``None``. gateway (str): Custom IP address for the pool's gateway. aux_addresses (dict): A dictionary of ``key -> ip_address`` relationships specifying auxiliary addresses that need to be allocated by the IPAM driver. Example: >>> ipam_pool = docker.types.IPAMPool( subnet='124.42.0.0/16', iprange='124.42.0.0/24', gateway='124.42.0.254', aux_addresses={ 'reserved1': '124.42.1.1' } ) >>> ipam_config = docker.types.IPAMConfig( pool_configs=[ipam_pool]) Nc C s | � ||||d�� d S )N)�Subnet�IPRange�Gateway�AuxiliaryAddresses)r* )r �subnet�iprange�gateway� aux_addressesr r r r y s �zIPAMPool.__init__)NNNNr. r r r r r0 [ s �r0 N) � r �utilsr r r r r# r r0 r r r r �<module> s 1 types/daemon.py 0000644 00000003627 15027665106 0007545 0 ustar 00 import socket import urllib3 from ..errors import DockerException class CancellableStream: """ Stream wrapper for real-time events, logs, etc. from the server. Example: >>> events = client.events() >>> for event in events: ... print(event) >>> # and cancel from another thread >>> events.close() """ def __init__(self, stream, response): self._stream = stream self._response = response def __iter__(self): return self def __next__(self): try: return next(self._stream) except urllib3.exceptions.ProtocolError: raise StopIteration from None except OSError: raise StopIteration from None next = __next__ def close(self): """ Closes the event streaming. """ if not self._response.raw.closed: # find the underlying socket object # based on api.client._get_raw_response_socket sock_fp = self._response.raw._fp.fp if hasattr(sock_fp, 'raw'): sock_raw = sock_fp.raw if hasattr(sock_raw, 'sock'): sock = sock_raw.sock elif hasattr(sock_raw, '_sock'): sock = sock_raw._sock elif hasattr(sock_fp, 'channel'): # We're working with a paramiko (SSH) channel, which doesn't # support cancelable streams with the current implementation raise DockerException( 'Cancellable streams not supported for the SSH protocol' ) else: sock = sock_fp._sock if hasattr(urllib3.contrib, 'pyopenssl') and isinstance( sock, urllib3.contrib.pyopenssl.WrappedSocket): sock = sock.socket sock.shutdown(socket.SHUT_RDWR) sock.close() types/containers.py 0000644 00000065424 15027665106 0010452 0 ustar 00 from .. import errors from ..utils.utils import ( convert_port_bindings, convert_tmpfs_mounts, convert_volume_binds, format_environment, format_extra_hosts, normalize_links, parse_bytes, parse_devices, split_command, version_gte, version_lt, ) from .base import DictType from .healthcheck import Healthcheck class LogConfigTypesEnum: _values = ( 'json-file', 'syslog', 'journald', 'gelf', 'fluentd', 'none' ) JSON, SYSLOG, JOURNALD, GELF, FLUENTD, NONE = _values class LogConfig(DictType): """ Configure logging for a container, when provided as an argument to :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. You may refer to the `official logging driver documentation <https://docs.docker.com/config/containers/logging/configure/>`_ for more information. Args: type (str): Indicate which log driver to use. A set of valid drivers is provided as part of the :py:attr:`LogConfig.types` enum. Other values may be accepted depending on the engine version and available logging plugins. config (dict): A driver-dependent configuration dictionary. Please refer to the driver's documentation for a list of valid config keys. Example: >>> from docker.types import LogConfig >>> lc = LogConfig(type=LogConfig.types.JSON, config={ ... 'max-size': '1g', ... 'labels': 'production_status,geo' ... }) >>> hc = client.create_host_config(log_config=lc) >>> container = client.create_container('busybox', 'true', ... host_config=hc) >>> client.inspect_container(container)['HostConfig']['LogConfig'] { 'Type': 'json-file', 'Config': {'labels': 'production_status,geo', 'max-size': '1g'} } """ types = LogConfigTypesEnum def __init__(self, **kwargs): log_driver_type = kwargs.get('type', kwargs.get('Type')) config = kwargs.get('config', kwargs.get('Config')) or {} if config and not isinstance(config, dict): raise ValueError("LogConfig.config must be a dictionary") super().__init__({ 'Type': log_driver_type, 'Config': config }) @property def type(self): return self['Type'] @type.setter def type(self, value): self['Type'] = value @property def config(self): return self['Config'] def set_config_value(self, key, value): """ Set a the value for ``key`` to ``value`` inside the ``config`` dict. """ self.config[key] = value def unset_config(self, key): """ Remove the ``key`` property from the ``config`` dict. """ if key in self.config: del self.config[key] class Ulimit(DictType): """ Create a ulimit declaration to be used with :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. Args: name (str): Which ulimit will this apply to. The valid names can be found in '/etc/security/limits.conf' on a gnu/linux system. soft (int): The soft limit for this ulimit. Optional. hard (int): The hard limit for this ulimit. Optional. Example: >>> nproc_limit = docker.types.Ulimit(name='nproc', soft=1024) >>> hc = client.create_host_config(ulimits=[nproc_limit]) >>> container = client.create_container( 'busybox', 'true', host_config=hc ) >>> client.inspect_container(container)['HostConfig']['Ulimits'] [{'Name': 'nproc', 'Hard': 0, 'Soft': 1024}] """ def __init__(self, **kwargs): name = kwargs.get('name', kwargs.get('Name')) soft = kwargs.get('soft', kwargs.get('Soft')) hard = kwargs.get('hard', kwargs.get('Hard')) if not isinstance(name, str): raise ValueError("Ulimit.name must be a string") if soft and not isinstance(soft, int): raise ValueError("Ulimit.soft must be an integer") if hard and not isinstance(hard, int): raise ValueError("Ulimit.hard must be an integer") super().__init__({ 'Name': name, 'Soft': soft, 'Hard': hard }) @property def name(self): return self['Name'] @name.setter def name(self, value): self['Name'] = value @property def soft(self): return self.get('Soft') @soft.setter def soft(self, value): self['Soft'] = value @property def hard(self): return self.get('Hard') @hard.setter def hard(self, value): self['Hard'] = value class DeviceRequest(DictType): """ Create a device request to be used with :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. Args: driver (str): Which driver to use for this device. Optional. count (int): Number or devices to request. Optional. Set to -1 to request all available devices. device_ids (list): List of strings for device IDs. Optional. Set either ``count`` or ``device_ids``. capabilities (list): List of lists of strings to request capabilities. Optional. The global list acts like an OR, and the sub-lists are AND. The driver will try to satisfy one of the sub-lists. Available capabilities for the ``nvidia`` driver can be found `here <https://github.com/NVIDIA/nvidia-container-runtime>`_. options (dict): Driver-specific options. Optional. """ def __init__(self, **kwargs): driver = kwargs.get('driver', kwargs.get('Driver')) count = kwargs.get('count', kwargs.get('Count')) device_ids = kwargs.get('device_ids', kwargs.get('DeviceIDs')) capabilities = kwargs.get('capabilities', kwargs.get('Capabilities')) options = kwargs.get('options', kwargs.get('Options')) if driver is None: driver = '' elif not isinstance(driver, str): raise ValueError('DeviceRequest.driver must be a string') if count is None: count = 0 elif not isinstance(count, int): raise ValueError('DeviceRequest.count must be an integer') if device_ids is None: device_ids = [] elif not isinstance(device_ids, list): raise ValueError('DeviceRequest.device_ids must be a list') if capabilities is None: capabilities = [] elif not isinstance(capabilities, list): raise ValueError('DeviceRequest.capabilities must be a list') if options is None: options = {} elif not isinstance(options, dict): raise ValueError('DeviceRequest.options must be a dict') super().__init__({ 'Driver': driver, 'Count': count, 'DeviceIDs': device_ids, 'Capabilities': capabilities, 'Options': options }) @property def driver(self): return self['Driver'] @driver.setter def driver(self, value): self['Driver'] = value @property def count(self): return self['Count'] @count.setter def count(self, value): self['Count'] = value @property def device_ids(self): return self['DeviceIDs'] @device_ids.setter def device_ids(self, value): self['DeviceIDs'] = value @property def capabilities(self): return self['Capabilities'] @capabilities.setter def capabilities(self, value): self['Capabilities'] = value @property def options(self): return self['Options'] @options.setter def options(self, value): self['Options'] = value class HostConfig(dict): def __init__(self, version, binds=None, port_bindings=None, lxc_conf=None, publish_all_ports=False, links=None, privileged=False, dns=None, dns_search=None, volumes_from=None, network_mode=None, restart_policy=None, cap_add=None, cap_drop=None, devices=None, extra_hosts=None, read_only=None, pid_mode=None, ipc_mode=None, security_opt=None, ulimits=None, log_config=None, mem_limit=None, memswap_limit=None, mem_reservation=None, kernel_memory=None, mem_swappiness=None, cgroup_parent=None, group_add=None, cpu_quota=None, cpu_period=None, blkio_weight=None, blkio_weight_device=None, device_read_bps=None, device_write_bps=None, device_read_iops=None, device_write_iops=None, oom_kill_disable=False, shm_size=None, sysctls=None, tmpfs=None, oom_score_adj=None, dns_opt=None, cpu_shares=None, cpuset_cpus=None, userns_mode=None, uts_mode=None, pids_limit=None, isolation=None, auto_remove=False, storage_opt=None, init=None, init_path=None, volume_driver=None, cpu_count=None, cpu_percent=None, nano_cpus=None, cpuset_mems=None, runtime=None, mounts=None, cpu_rt_period=None, cpu_rt_runtime=None, device_cgroup_rules=None, device_requests=None, cgroupns=None): if mem_limit is not None: self['Memory'] = parse_bytes(mem_limit) if memswap_limit is not None: self['MemorySwap'] = parse_bytes(memswap_limit) if mem_reservation: self['MemoryReservation'] = parse_bytes(mem_reservation) if kernel_memory: self['KernelMemory'] = parse_bytes(kernel_memory) if mem_swappiness is not None: if not isinstance(mem_swappiness, int): raise host_config_type_error( 'mem_swappiness', mem_swappiness, 'int' ) self['MemorySwappiness'] = mem_swappiness if shm_size is not None: if isinstance(shm_size, str): shm_size = parse_bytes(shm_size) self['ShmSize'] = shm_size if pid_mode: if version_lt(version, '1.24') and pid_mode != 'host': raise host_config_value_error('pid_mode', pid_mode) self['PidMode'] = pid_mode if ipc_mode: self['IpcMode'] = ipc_mode if privileged: self['Privileged'] = privileged if oom_kill_disable: self['OomKillDisable'] = oom_kill_disable if oom_score_adj: if version_lt(version, '1.22'): raise host_config_version_error('oom_score_adj', '1.22') if not isinstance(oom_score_adj, int): raise host_config_type_error( 'oom_score_adj', oom_score_adj, 'int' ) self['OomScoreAdj'] = oom_score_adj if publish_all_ports: self['PublishAllPorts'] = publish_all_ports if read_only is not None: self['ReadonlyRootfs'] = read_only if dns_search: self['DnsSearch'] = dns_search if network_mode == 'host' and port_bindings: raise host_config_incompatible_error( 'network_mode', 'host', 'port_bindings' ) self['NetworkMode'] = network_mode or 'default' if restart_policy: if not isinstance(restart_policy, dict): raise host_config_type_error( 'restart_policy', restart_policy, 'dict' ) self['RestartPolicy'] = restart_policy if cap_add: self['CapAdd'] = cap_add if cap_drop: self['CapDrop'] = cap_drop if devices: self['Devices'] = parse_devices(devices) if group_add: self['GroupAdd'] = [str(grp) for grp in group_add] if dns is not None: self['Dns'] = dns if dns_opt is not None: self['DnsOptions'] = dns_opt if security_opt is not None: if not isinstance(security_opt, list): raise host_config_type_error( 'security_opt', security_opt, 'list' ) self['SecurityOpt'] = security_opt if sysctls: if not isinstance(sysctls, dict): raise host_config_type_error('sysctls', sysctls, 'dict') self['Sysctls'] = {} for k, v in sysctls.items(): self['Sysctls'][k] = str(v) if volumes_from is not None: if isinstance(volumes_from, str): volumes_from = volumes_from.split(',') self['VolumesFrom'] = volumes_from if binds is not None: self['Binds'] = convert_volume_binds(binds) if port_bindings is not None: self['PortBindings'] = convert_port_bindings(port_bindings) if extra_hosts is not None: if isinstance(extra_hosts, dict): extra_hosts = format_extra_hosts(extra_hosts) self['ExtraHosts'] = extra_hosts if links is not None: self['Links'] = normalize_links(links) if isinstance(lxc_conf, dict): formatted = [] for k, v in lxc_conf.items(): formatted.append({'Key': k, 'Value': str(v)}) lxc_conf = formatted if lxc_conf is not None: self['LxcConf'] = lxc_conf if cgroup_parent is not None: self['CgroupParent'] = cgroup_parent if ulimits is not None: if not isinstance(ulimits, list): raise host_config_type_error('ulimits', ulimits, 'list') self['Ulimits'] = [] for lmt in ulimits: if not isinstance(lmt, Ulimit): lmt = Ulimit(**lmt) self['Ulimits'].append(lmt) if log_config is not None: if not isinstance(log_config, LogConfig): if not isinstance(log_config, dict): raise host_config_type_error( 'log_config', log_config, 'LogConfig' ) log_config = LogConfig(**log_config) self['LogConfig'] = log_config if cpu_quota: if not isinstance(cpu_quota, int): raise host_config_type_error('cpu_quota', cpu_quota, 'int') self['CpuQuota'] = cpu_quota if cpu_period: if not isinstance(cpu_period, int): raise host_config_type_error('cpu_period', cpu_period, 'int') self['CpuPeriod'] = cpu_period if cpu_shares: if not isinstance(cpu_shares, int): raise host_config_type_error('cpu_shares', cpu_shares, 'int') self['CpuShares'] = cpu_shares if cpuset_cpus: self['CpusetCpus'] = cpuset_cpus if cpuset_mems: if not isinstance(cpuset_mems, str): raise host_config_type_error( 'cpuset_mems', cpuset_mems, 'str' ) self['CpusetMems'] = cpuset_mems if cpu_rt_period: if version_lt(version, '1.25'): raise host_config_version_error('cpu_rt_period', '1.25') if not isinstance(cpu_rt_period, int): raise host_config_type_error( 'cpu_rt_period', cpu_rt_period, 'int' ) self['CPURealtimePeriod'] = cpu_rt_period if cpu_rt_runtime: if version_lt(version, '1.25'): raise host_config_version_error('cpu_rt_runtime', '1.25') if not isinstance(cpu_rt_runtime, int): raise host_config_type_error( 'cpu_rt_runtime', cpu_rt_runtime, 'int' ) self['CPURealtimeRuntime'] = cpu_rt_runtime if blkio_weight: if not isinstance(blkio_weight, int): raise host_config_type_error( 'blkio_weight', blkio_weight, 'int' ) if version_lt(version, '1.22'): raise host_config_version_error('blkio_weight', '1.22') self["BlkioWeight"] = blkio_weight if blkio_weight_device: if not isinstance(blkio_weight_device, list): raise host_config_type_error( 'blkio_weight_device', blkio_weight_device, 'list' ) if version_lt(version, '1.22'): raise host_config_version_error('blkio_weight_device', '1.22') self["BlkioWeightDevice"] = blkio_weight_device if device_read_bps: if not isinstance(device_read_bps, list): raise host_config_type_error( 'device_read_bps', device_read_bps, 'list' ) if version_lt(version, '1.22'): raise host_config_version_error('device_read_bps', '1.22') self["BlkioDeviceReadBps"] = device_read_bps if device_write_bps: if not isinstance(device_write_bps, list): raise host_config_type_error( 'device_write_bps', device_write_bps, 'list' ) if version_lt(version, '1.22'): raise host_config_version_error('device_write_bps', '1.22') self["BlkioDeviceWriteBps"] = device_write_bps if device_read_iops: if not isinstance(device_read_iops, list): raise host_config_type_error( 'device_read_iops', device_read_iops, 'list' ) if version_lt(version, '1.22'): raise host_config_version_error('device_read_iops', '1.22') self["BlkioDeviceReadIOps"] = device_read_iops if device_write_iops: if not isinstance(device_write_iops, list): raise host_config_type_error( 'device_write_iops', device_write_iops, 'list' ) if version_lt(version, '1.22'): raise host_config_version_error('device_write_iops', '1.22') self["BlkioDeviceWriteIOps"] = device_write_iops if tmpfs: if version_lt(version, '1.22'): raise host_config_version_error('tmpfs', '1.22') self["Tmpfs"] = convert_tmpfs_mounts(tmpfs) if userns_mode: if version_lt(version, '1.23'): raise host_config_version_error('userns_mode', '1.23') if userns_mode != "host": raise host_config_value_error("userns_mode", userns_mode) self['UsernsMode'] = userns_mode if uts_mode: if uts_mode != "host": raise host_config_value_error("uts_mode", uts_mode) self['UTSMode'] = uts_mode if pids_limit: if not isinstance(pids_limit, int): raise host_config_type_error('pids_limit', pids_limit, 'int') if version_lt(version, '1.23'): raise host_config_version_error('pids_limit', '1.23') self["PidsLimit"] = pids_limit if isolation: if not isinstance(isolation, str): raise host_config_type_error('isolation', isolation, 'string') if version_lt(version, '1.24'): raise host_config_version_error('isolation', '1.24') self['Isolation'] = isolation if auto_remove: if version_lt(version, '1.25'): raise host_config_version_error('auto_remove', '1.25') self['AutoRemove'] = auto_remove if storage_opt is not None: if version_lt(version, '1.24'): raise host_config_version_error('storage_opt', '1.24') self['StorageOpt'] = storage_opt if init is not None: if version_lt(version, '1.25'): raise host_config_version_error('init', '1.25') self['Init'] = init if init_path is not None: if version_lt(version, '1.25'): raise host_config_version_error('init_path', '1.25') if version_gte(version, '1.29'): # https://github.com/moby/moby/pull/32470 raise host_config_version_error('init_path', '1.29', False) self['InitPath'] = init_path if volume_driver is not None: self['VolumeDriver'] = volume_driver if cpu_count: if not isinstance(cpu_count, int): raise host_config_type_error('cpu_count', cpu_count, 'int') if version_lt(version, '1.25'): raise host_config_version_error('cpu_count', '1.25') self['CpuCount'] = cpu_count if cpu_percent: if not isinstance(cpu_percent, int): raise host_config_type_error('cpu_percent', cpu_percent, 'int') if version_lt(version, '1.25'): raise host_config_version_error('cpu_percent', '1.25') self['CpuPercent'] = cpu_percent if nano_cpus: if not isinstance(nano_cpus, int): raise host_config_type_error('nano_cpus', nano_cpus, 'int') if version_lt(version, '1.25'): raise host_config_version_error('nano_cpus', '1.25') self['NanoCpus'] = nano_cpus if runtime: if version_lt(version, '1.25'): raise host_config_version_error('runtime', '1.25') self['Runtime'] = runtime if mounts is not None: if version_lt(version, '1.30'): raise host_config_version_error('mounts', '1.30') self['Mounts'] = mounts if device_cgroup_rules is not None: if version_lt(version, '1.28'): raise host_config_version_error('device_cgroup_rules', '1.28') if not isinstance(device_cgroup_rules, list): raise host_config_type_error( 'device_cgroup_rules', device_cgroup_rules, 'list' ) self['DeviceCgroupRules'] = device_cgroup_rules if device_requests is not None: if version_lt(version, '1.40'): raise host_config_version_error('device_requests', '1.40') if not isinstance(device_requests, list): raise host_config_type_error( 'device_requests', device_requests, 'list' ) self['DeviceRequests'] = [] for req in device_requests: if not isinstance(req, DeviceRequest): req = DeviceRequest(**req) self['DeviceRequests'].append(req) if cgroupns: self['CgroupnsMode'] = cgroupns def host_config_type_error(param, param_value, expected): return TypeError( f'Invalid type for {param} param: expected {expected} ' f'but found {type(param_value)}' ) def host_config_version_error(param, version, less_than=True): operator = '<' if less_than else '>' return errors.InvalidVersion( f'{param} param is not supported in API versions {operator} {version}', ) def host_config_value_error(param, param_value): return ValueError(f'Invalid value for {param} param: {param_value}') def host_config_incompatible_error(param, param_value, incompatible_param): return errors.InvalidArgument( f'\"{param_value}\" {param} is incompatible with {incompatible_param}' ) class ContainerConfig(dict): def __init__( self, version, image, command, hostname=None, user=None, detach=False, stdin_open=False, tty=False, ports=None, environment=None, volumes=None, network_disabled=False, entrypoint=None, working_dir=None, domainname=None, host_config=None, mac_address=None, labels=None, stop_signal=None, networking_config=None, healthcheck=None, stop_timeout=None, runtime=None ): if stop_timeout is not None and version_lt(version, '1.25'): raise errors.InvalidVersion( 'stop_timeout was only introduced in API version 1.25' ) if healthcheck is not None: if version_lt(version, '1.24'): raise errors.InvalidVersion( 'Health options were only introduced in API version 1.24' ) if version_lt(version, '1.29') and 'StartPeriod' in healthcheck: raise errors.InvalidVersion( 'healthcheck start period was introduced in API ' 'version 1.29' ) if isinstance(command, str): command = split_command(command) if isinstance(entrypoint, str): entrypoint = split_command(entrypoint) if isinstance(environment, dict): environment = format_environment(environment) if isinstance(labels, list): labels = {lbl: '' for lbl in labels} if isinstance(ports, list): exposed_ports = {} for port_definition in ports: port = port_definition proto = 'tcp' if isinstance(port_definition, tuple): if len(port_definition) == 2: proto = port_definition[1] port = port_definition[0] exposed_ports[f'{port}/{proto}'] = {} ports = exposed_ports if isinstance(volumes, str): volumes = [volumes, ] if isinstance(volumes, list): volumes_dict = {} for vol in volumes: volumes_dict[vol] = {} volumes = volumes_dict if healthcheck and isinstance(healthcheck, dict): healthcheck = Healthcheck(**healthcheck) attach_stdin = False attach_stdout = False attach_stderr = False stdin_once = False if not detach: attach_stdout = True attach_stderr = True if stdin_open: attach_stdin = True stdin_once = True self.update({ 'Hostname': hostname, 'Domainname': domainname, 'ExposedPorts': ports, 'User': str(user) if user is not None else None, 'Tty': tty, 'OpenStdin': stdin_open, 'StdinOnce': stdin_once, 'AttachStdin': attach_stdin, 'AttachStdout': attach_stdout, 'AttachStderr': attach_stderr, 'Env': environment, 'Cmd': command, 'Image': image, 'Volumes': volumes, 'NetworkDisabled': network_disabled, 'Entrypoint': entrypoint, 'WorkingDir': working_dir, 'HostConfig': host_config, 'NetworkingConfig': networking_config, 'MacAddress': mac_address, 'Labels': labels, 'StopSignal': stop_signal, 'Healthcheck': healthcheck, 'StopTimeout': stop_timeout, 'Runtime': runtime }) types/services.py 0000644 00000100577 15027665106 0010127 0 ustar 00 from .. import errors from ..constants import IS_WINDOWS_PLATFORM from ..utils import ( check_resource, convert_service_networks, format_environment, format_extra_hosts, parse_bytes, split_command, ) class TaskTemplate(dict): """ Describe the task specification to be used when creating or updating a service. Args: container_spec (ContainerSpec): Container settings for containers started as part of this task. log_driver (DriverConfig): Log configuration for containers created as part of the service. resources (Resources): Resource requirements which apply to each individual container created as part of the service. restart_policy (RestartPolicy): Specification for the restart policy which applies to containers created as part of this service. placement (Placement): Placement instructions for the scheduler. If a list is passed instead, it is assumed to be a list of constraints as part of a :py:class:`Placement` object. networks (:py:class:`list`): List of network names or IDs or :py:class:`NetworkAttachmentConfig` to attach the service to. force_update (int): A counter that triggers an update even if no relevant parameters have been changed. """ def __init__(self, container_spec, resources=None, restart_policy=None, placement=None, log_driver=None, networks=None, force_update=None): self['ContainerSpec'] = container_spec if resources: self['Resources'] = resources if restart_policy: self['RestartPolicy'] = restart_policy if placement: if isinstance(placement, list): placement = Placement(constraints=placement) self['Placement'] = placement if log_driver: self['LogDriver'] = log_driver if networks: self['Networks'] = convert_service_networks(networks) if force_update is not None: if not isinstance(force_update, int): raise TypeError('force_update must be an integer') self['ForceUpdate'] = force_update @property def container_spec(self): return self.get('ContainerSpec') @property def resources(self): return self.get('Resources') @property def restart_policy(self): return self.get('RestartPolicy') @property def placement(self): return self.get('Placement') class ContainerSpec(dict): """ Describes the behavior of containers that are part of a task, and is used when declaring a :py:class:`~docker.types.TaskTemplate`. Args: image (string): The image name to use for the container. command (string or list): The command to be run in the image. args (:py:class:`list`): Arguments to the command. hostname (string): The hostname to set on the container. env (dict): Environment variables. workdir (string): The working directory for commands to run in. user (string): The user inside the container. labels (dict): A map of labels to associate with the service. mounts (:py:class:`list`): A list of specifications for mounts to be added to containers created as part of the service. See the :py:class:`~docker.types.Mount` class for details. stop_grace_period (int): Amount of time to wait for the container to terminate before forcefully killing it. secrets (:py:class:`list`): List of :py:class:`SecretReference` to be made available inside the containers. tty (boolean): Whether a pseudo-TTY should be allocated. groups (:py:class:`list`): A list of additional groups that the container process will run as. open_stdin (boolean): Open ``stdin`` read_only (boolean): Mount the container's root filesystem as read only. stop_signal (string): Set signal to stop the service's containers healthcheck (Healthcheck): Healthcheck configuration for this service. hosts (:py:class:`dict`): A set of host to IP mappings to add to the container's ``hosts`` file. dns_config (DNSConfig): Specification for DNS related configurations in resolver configuration file. configs (:py:class:`list`): List of :py:class:`ConfigReference` that will be exposed to the service. privileges (Privileges): Security options for the service's containers. isolation (string): Isolation technology used by the service's containers. Only used for Windows containers. init (boolean): Run an init inside the container that forwards signals and reaps processes. cap_add (:py:class:`list`): A list of kernel capabilities to add to the default set for the container. cap_drop (:py:class:`list`): A list of kernel capabilities to drop from the default set for the container. sysctls (:py:class:`dict`): A dict of sysctl values to add to the container """ def __init__(self, image, command=None, args=None, hostname=None, env=None, workdir=None, user=None, labels=None, mounts=None, stop_grace_period=None, secrets=None, tty=None, groups=None, open_stdin=None, read_only=None, stop_signal=None, healthcheck=None, hosts=None, dns_config=None, configs=None, privileges=None, isolation=None, init=None, cap_add=None, cap_drop=None, sysctls=None): self['Image'] = image if isinstance(command, str): command = split_command(command) self['Command'] = command self['Args'] = args if hostname is not None: self['Hostname'] = hostname if env is not None: if isinstance(env, dict): self['Env'] = format_environment(env) else: self['Env'] = env if workdir is not None: self['Dir'] = workdir if user is not None: self['User'] = user if groups is not None: self['Groups'] = groups if stop_signal is not None: self['StopSignal'] = stop_signal if stop_grace_period is not None: self['StopGracePeriod'] = stop_grace_period if labels is not None: self['Labels'] = labels if hosts is not None: self['Hosts'] = format_extra_hosts(hosts, task=True) if mounts is not None: parsed_mounts = [] for mount in mounts: if isinstance(mount, str): parsed_mounts.append(Mount.parse_mount_string(mount)) else: # If mount already parsed parsed_mounts.append(mount) self['Mounts'] = parsed_mounts if secrets is not None: if not isinstance(secrets, list): raise TypeError('secrets must be a list') self['Secrets'] = secrets if configs is not None: if not isinstance(configs, list): raise TypeError('configs must be a list') self['Configs'] = configs if dns_config is not None: self['DNSConfig'] = dns_config if privileges is not None: self['Privileges'] = privileges if healthcheck is not None: self['Healthcheck'] = healthcheck if tty is not None: self['TTY'] = tty if open_stdin is not None: self['OpenStdin'] = open_stdin if read_only is not None: self['ReadOnly'] = read_only if isolation is not None: self['Isolation'] = isolation if init is not None: self['Init'] = init if cap_add is not None: if not isinstance(cap_add, list): raise TypeError('cap_add must be a list') self['CapabilityAdd'] = cap_add if cap_drop is not None: if not isinstance(cap_drop, list): raise TypeError('cap_drop must be a list') self['CapabilityDrop'] = cap_drop if sysctls is not None: if not isinstance(sysctls, dict): raise TypeError('sysctls must be a dict') self['Sysctls'] = sysctls class Mount(dict): """ Describes a mounted folder's configuration inside a container. A list of :py:class:`Mount` would be used as part of a :py:class:`~docker.types.ContainerSpec`. Args: target (string): Container path. source (string): Mount source (e.g. a volume name or a host path). type (string): The mount type (``bind`` / ``volume`` / ``tmpfs`` / ``npipe``). Default: ``volume``. read_only (bool): Whether the mount should be read-only. consistency (string): The consistency requirement for the mount. One of ``default```, ``consistent``, ``cached``, ``delegated``. propagation (string): A propagation mode with the value ``[r]private``, ``[r]shared``, or ``[r]slave``. Only valid for the ``bind`` type. no_copy (bool): False if the volume should be populated with the data from the target. Default: ``False``. Only valid for the ``volume`` type. labels (dict): User-defined name and labels for the volume. Only valid for the ``volume`` type. driver_config (DriverConfig): Volume driver configuration. Only valid for the ``volume`` type. tmpfs_size (int or string): The size for the tmpfs mount in bytes. tmpfs_mode (int): The permission mode for the tmpfs mount. """ def __init__(self, target, source, type='volume', read_only=False, consistency=None, propagation=None, no_copy=False, labels=None, driver_config=None, tmpfs_size=None, tmpfs_mode=None): self['Target'] = target self['Source'] = source if type not in ('bind', 'volume', 'tmpfs', 'npipe'): raise errors.InvalidArgument( f'Unsupported mount type: "{type}"' ) self['Type'] = type self['ReadOnly'] = read_only if consistency: self['Consistency'] = consistency if type == 'bind': if propagation is not None: self['BindOptions'] = { 'Propagation': propagation } if any([labels, driver_config, no_copy, tmpfs_size, tmpfs_mode]): raise errors.InvalidArgument( 'Incompatible options have been provided for the bind ' 'type mount.' ) elif type == 'volume': volume_opts = {} if no_copy: volume_opts['NoCopy'] = True if labels: volume_opts['Labels'] = labels if driver_config: volume_opts['DriverConfig'] = driver_config if volume_opts: self['VolumeOptions'] = volume_opts if any([propagation, tmpfs_size, tmpfs_mode]): raise errors.InvalidArgument( 'Incompatible options have been provided for the volume ' 'type mount.' ) elif type == 'tmpfs': tmpfs_opts = {} if tmpfs_mode: if not isinstance(tmpfs_mode, int): raise errors.InvalidArgument( 'tmpfs_mode must be an integer' ) tmpfs_opts['Mode'] = tmpfs_mode if tmpfs_size: tmpfs_opts['SizeBytes'] = parse_bytes(tmpfs_size) if tmpfs_opts: self['TmpfsOptions'] = tmpfs_opts if any([propagation, labels, driver_config, no_copy]): raise errors.InvalidArgument( 'Incompatible options have been provided for the tmpfs ' 'type mount.' ) @classmethod def parse_mount_string(cls, string): parts = string.split(':') if len(parts) > 3: raise errors.InvalidArgument( f'Invalid mount format "{string}"' ) if len(parts) == 1: return cls(target=parts[0], source=None) else: target = parts[1] source = parts[0] mount_type = 'volume' if source.startswith('/') or ( IS_WINDOWS_PLATFORM and source[0].isalpha() and source[1] == ':' ): # FIXME: That windows condition will fail earlier since we # split on ':'. We should look into doing a smarter split # if we detect we are on Windows. mount_type = 'bind' read_only = not (len(parts) == 2 or parts[2] == 'rw') return cls(target, source, read_only=read_only, type=mount_type) class Resources(dict): """ Configures resource allocation for containers when made part of a :py:class:`~docker.types.ContainerSpec`. Args: cpu_limit (int): CPU limit in units of 10^9 CPU shares. mem_limit (int): Memory limit in Bytes. cpu_reservation (int): CPU reservation in units of 10^9 CPU shares. mem_reservation (int): Memory reservation in Bytes. generic_resources (dict or :py:class:`list`): Node level generic resources, for example a GPU, using the following format: ``{ resource_name: resource_value }``. Alternatively, a list of of resource specifications as defined by the Engine API. """ def __init__(self, cpu_limit=None, mem_limit=None, cpu_reservation=None, mem_reservation=None, generic_resources=None): limits = {} reservation = {} if cpu_limit is not None: limits['NanoCPUs'] = cpu_limit if mem_limit is not None: limits['MemoryBytes'] = mem_limit if cpu_reservation is not None: reservation['NanoCPUs'] = cpu_reservation if mem_reservation is not None: reservation['MemoryBytes'] = mem_reservation if generic_resources is not None: reservation['GenericResources'] = ( _convert_generic_resources_dict(generic_resources) ) if limits: self['Limits'] = limits if reservation: self['Reservations'] = reservation def _convert_generic_resources_dict(generic_resources): if isinstance(generic_resources, list): return generic_resources if not isinstance(generic_resources, dict): raise errors.InvalidArgument( 'generic_resources must be a dict or a list ' f'(found {type(generic_resources)})' ) resources = [] for kind, value in generic_resources.items(): resource_type = None if isinstance(value, int): resource_type = 'DiscreteResourceSpec' elif isinstance(value, str): resource_type = 'NamedResourceSpec' else: kv = {kind: value} raise errors.InvalidArgument( f'Unsupported generic resource reservation type: {kv}' ) resources.append({ resource_type: {'Kind': kind, 'Value': value} }) return resources class UpdateConfig(dict): """ Used to specify the way container updates should be performed by a service. Args: parallelism (int): Maximum number of tasks to be updated in one iteration (0 means unlimited parallelism). Default: 0. delay (int): Amount of time between updates, in nanoseconds. failure_action (string): Action to take if an updated task fails to run, or stops running during the update. Acceptable values are ``continue``, ``pause``, as well as ``rollback`` since API v1.28. Default: ``continue`` monitor (int): Amount of time to monitor each updated task for failures, in nanoseconds. max_failure_ratio (float): The fraction of tasks that may fail during an update before the failure action is invoked, specified as a floating point number between 0 and 1. Default: 0 order (string): Specifies the order of operations when rolling out an updated task. Either ``start-first`` or ``stop-first`` are accepted. """ def __init__(self, parallelism=0, delay=None, failure_action='continue', monitor=None, max_failure_ratio=None, order=None): self['Parallelism'] = parallelism if delay is not None: self['Delay'] = delay if failure_action not in ('pause', 'continue', 'rollback'): raise errors.InvalidArgument( 'failure_action must be one of `pause`, `continue`, `rollback`' ) self['FailureAction'] = failure_action if monitor is not None: if not isinstance(monitor, int): raise TypeError('monitor must be an integer') self['Monitor'] = monitor if max_failure_ratio is not None: if not isinstance(max_failure_ratio, (float, int)): raise TypeError('max_failure_ratio must be a float') if max_failure_ratio > 1 or max_failure_ratio < 0: raise errors.InvalidArgument( 'max_failure_ratio must be a number between 0 and 1' ) self['MaxFailureRatio'] = max_failure_ratio if order is not None: if order not in ('start-first', 'stop-first'): raise errors.InvalidArgument( 'order must be either `start-first` or `stop-first`' ) self['Order'] = order class RollbackConfig(UpdateConfig): """ Used to specify the way container rollbacks should be performed by a service Args: parallelism (int): Maximum number of tasks to be rolled back in one iteration (0 means unlimited parallelism). Default: 0 delay (int): Amount of time between rollbacks, in nanoseconds. failure_action (string): Action to take if a rolled back task fails to run, or stops running during the rollback. Acceptable values are ``continue``, ``pause`` or ``rollback``. Default: ``continue`` monitor (int): Amount of time to monitor each rolled back task for failures, in nanoseconds. max_failure_ratio (float): The fraction of tasks that may fail during a rollback before the failure action is invoked, specified as a floating point number between 0 and 1. Default: 0 order (string): Specifies the order of operations when rolling out a rolled back task. Either ``start-first`` or ``stop-first`` are accepted. """ pass class RestartConditionTypesEnum: _values = ( 'none', 'on-failure', 'any', ) NONE, ON_FAILURE, ANY = _values class RestartPolicy(dict): """ Used when creating a :py:class:`~docker.types.ContainerSpec`, dictates whether a container should restart after stopping or failing. Args: condition (string): Condition for restart (``none``, ``on-failure``, or ``any``). Default: `none`. delay (int): Delay between restart attempts. Default: 0 max_attempts (int): Maximum attempts to restart a given container before giving up. Default value is 0, which is ignored. window (int): Time window used to evaluate the restart policy. Default value is 0, which is unbounded. """ condition_types = RestartConditionTypesEnum def __init__(self, condition=RestartConditionTypesEnum.NONE, delay=0, max_attempts=0, window=0): if condition not in self.condition_types._values: raise TypeError( f'Invalid RestartPolicy condition {condition}' ) self['Condition'] = condition self['Delay'] = delay self['MaxAttempts'] = max_attempts self['Window'] = window class DriverConfig(dict): """ Indicates which driver to use, as well as its configuration. Can be used as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`, for the `driver_config` in a volume :py:class:`~docker.types.Mount`, or as the driver object in :py:meth:`create_secret`. Args: name (string): Name of the driver to use. options (dict): Driver-specific options. Default: ``None``. """ def __init__(self, name, options=None): self['Name'] = name if options: self['Options'] = options class EndpointSpec(dict): """ Describes properties to access and load-balance a service. Args: mode (string): The mode of resolution to use for internal load balancing between tasks (``'vip'`` or ``'dnsrr'``). Defaults to ``'vip'`` if not provided. ports (dict): Exposed ports that this service is accessible on from the outside, in the form of ``{ published_port: target_port }`` or ``{ published_port: <port_config_tuple> }``. Port config tuple format is ``(target_port [, protocol [, publish_mode]])``. Ports can only be provided if the ``vip`` resolution mode is used. """ def __init__(self, mode=None, ports=None): if ports: self['Ports'] = convert_service_ports(ports) if mode: self['Mode'] = mode def convert_service_ports(ports): if isinstance(ports, list): return ports if not isinstance(ports, dict): raise TypeError( 'Invalid type for ports, expected dict or list' ) result = [] for k, v in ports.items(): port_spec = { 'Protocol': 'tcp', 'PublishedPort': k } if isinstance(v, tuple): port_spec['TargetPort'] = v[0] if len(v) >= 2 and v[1] is not None: port_spec['Protocol'] = v[1] if len(v) == 3: port_spec['PublishMode'] = v[2] if len(v) > 3: raise ValueError( 'Service port configuration can have at most 3 elements: ' '(target_port, protocol, mode)' ) else: port_spec['TargetPort'] = v result.append(port_spec) return result class ServiceMode(dict): """ Indicate whether a service or a job should be deployed as a replicated or global service, and associated parameters Args: mode (string): Can be either ``replicated``, ``global``, ``replicated-job`` or ``global-job`` replicas (int): Number of replicas. For replicated services only. concurrency (int): Number of concurrent jobs. For replicated job services only. """ def __init__(self, mode, replicas=None, concurrency=None): replicated_modes = ('replicated', 'replicated-job') supported_modes = replicated_modes + ('global', 'global-job') if mode not in supported_modes: raise errors.InvalidArgument( 'mode must be either "replicated", "global", "replicated-job"' ' or "global-job"' ) if mode not in replicated_modes: if replicas is not None: raise errors.InvalidArgument( 'replicas can only be used for "replicated" or' ' "replicated-job" mode' ) if concurrency is not None: raise errors.InvalidArgument( 'concurrency can only be used for "replicated-job" mode' ) service_mode = self._convert_mode(mode) self.mode = service_mode self[service_mode] = {} if replicas is not None: if mode == 'replicated': self[service_mode]['Replicas'] = replicas if mode == 'replicated-job': self[service_mode]['MaxConcurrent'] = concurrency or 1 self[service_mode]['TotalCompletions'] = replicas @staticmethod def _convert_mode(original_mode): if original_mode == 'global-job': return 'GlobalJob' if original_mode == 'replicated-job': return 'ReplicatedJob' return original_mode @property def replicas(self): if 'replicated' in self: return self['replicated'].get('Replicas') if 'ReplicatedJob' in self: return self['ReplicatedJob'].get('TotalCompletions') return None class SecretReference(dict): """ Secret reference to be used as part of a :py:class:`ContainerSpec`. Describes how a secret is made accessible inside the service's containers. Args: secret_id (string): Secret's ID secret_name (string): Secret's name as defined at its creation. filename (string): Name of the file containing the secret. Defaults to the secret's name if not specified. uid (string): UID of the secret file's owner. Default: 0 gid (string): GID of the secret file's group. Default: 0 mode (int): File access mode inside the container. Default: 0o444 """ @check_resource('secret_id') def __init__(self, secret_id, secret_name, filename=None, uid=None, gid=None, mode=0o444): self['SecretName'] = secret_name self['SecretID'] = secret_id self['File'] = { 'Name': filename or secret_name, 'UID': uid or '0', 'GID': gid or '0', 'Mode': mode } class ConfigReference(dict): """ Config reference to be used as part of a :py:class:`ContainerSpec`. Describes how a config is made accessible inside the service's containers. Args: config_id (string): Config's ID config_name (string): Config's name as defined at its creation. filename (string): Name of the file containing the config. Defaults to the config's name if not specified. uid (string): UID of the config file's owner. Default: 0 gid (string): GID of the config file's group. Default: 0 mode (int): File access mode inside the container. Default: 0o444 """ @check_resource('config_id') def __init__(self, config_id, config_name, filename=None, uid=None, gid=None, mode=0o444): self['ConfigName'] = config_name self['ConfigID'] = config_id self['File'] = { 'Name': filename or config_name, 'UID': uid or '0', 'GID': gid or '0', 'Mode': mode } class Placement(dict): """ Placement constraints to be used as part of a :py:class:`TaskTemplate` Args: constraints (:py:class:`list` of str): A list of constraints preferences (:py:class:`list` of tuple): Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence and are expressed as ``(strategy, descriptor)`` tuples. See :py:class:`PlacementPreference` for details. maxreplicas (int): Maximum number of replicas per node platforms (:py:class:`list` of tuple): A list of platforms expressed as ``(arch, os)`` tuples """ def __init__(self, constraints=None, preferences=None, platforms=None, maxreplicas=None): if constraints is not None: self['Constraints'] = constraints if preferences is not None: self['Preferences'] = [] for pref in preferences: if isinstance(pref, tuple): pref = PlacementPreference(*pref) self['Preferences'].append(pref) if maxreplicas is not None: self['MaxReplicas'] = maxreplicas if platforms: self['Platforms'] = [] for plat in platforms: self['Platforms'].append({ 'Architecture': plat[0], 'OS': plat[1] }) class PlacementPreference(dict): """ Placement preference to be used as an element in the list of preferences for :py:class:`Placement` objects. Args: strategy (string): The placement strategy to implement. Currently, the only supported strategy is ``spread``. descriptor (string): A label descriptor. For the spread strategy, the scheduler will try to spread tasks evenly over groups of nodes identified by this label. """ def __init__(self, strategy, descriptor): if strategy != 'spread': raise errors.InvalidArgument( f'PlacementPreference strategy value is invalid ({strategy}): ' 'must be "spread".' ) self['Spread'] = {'SpreadDescriptor': descriptor} class DNSConfig(dict): """ Specification for DNS related configurations in resolver configuration file (``resolv.conf``). Part of a :py:class:`ContainerSpec` definition. Args: nameservers (:py:class:`list`): The IP addresses of the name servers. search (:py:class:`list`): A search list for host-name lookup. options (:py:class:`list`): A list of internal resolver variables to be modified (e.g., ``debug``, ``ndots:3``, etc.). """ def __init__(self, nameservers=None, search=None, options=None): self['Nameservers'] = nameservers self['Search'] = search self['Options'] = options class Privileges(dict): r""" Security options for a service's containers. Part of a :py:class:`ContainerSpec` definition. Args: credentialspec_file (str): Load credential spec from this file. The file is read by the daemon, and must be present in the CredentialSpecs subdirectory in the docker data directory, which defaults to ``C:\ProgramData\Docker\`` on Windows. Can not be combined with credentialspec_registry. credentialspec_registry (str): Load credential spec from this value in the Windows registry. The specified registry value must be located in: ``HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion \Virtualization\Containers\CredentialSpecs``. Can not be combined with credentialspec_file. selinux_disable (boolean): Disable SELinux selinux_user (string): SELinux user label selinux_role (string): SELinux role label selinux_type (string): SELinux type label selinux_level (string): SELinux level label """ def __init__(self, credentialspec_file=None, credentialspec_registry=None, selinux_disable=None, selinux_user=None, selinux_role=None, selinux_type=None, selinux_level=None): credential_spec = {} if credentialspec_registry is not None: credential_spec['Registry'] = credentialspec_registry if credentialspec_file is not None: credential_spec['File'] = credentialspec_file if len(credential_spec) > 1: raise errors.InvalidArgument( 'credentialspec_file and credentialspec_registry are mutually' ' exclusive' ) selinux_context = { 'Disable': selinux_disable, 'User': selinux_user, 'Role': selinux_role, 'Type': selinux_type, 'Level': selinux_level, } if len(credential_spec) > 0: self['CredentialSpec'] = credential_spec if len(selinux_context) > 0: self['SELinuxContext'] = selinux_context class NetworkAttachmentConfig(dict): """ Network attachment options for a service. Args: target (str): The target network for attachment. Can be a network name or ID. aliases (:py:class:`list`): A list of discoverable alternate names for the service. options (:py:class:`dict`): Driver attachment options for the network target. """ def __init__(self, target, aliases=None, options=None): self['Target'] = target self['Aliases'] = aliases self['DriverOpts'] = options types/healthcheck.py 0000644 00000005330 15027665106 0010536 0 ustar 00 from .base import DictType class Healthcheck(DictType): """ Defines a healthcheck configuration for a container or service. Args: test (:py:class:`list` or str): Test to perform to determine container health. Possible values: - Empty list: Inherit healthcheck from parent image - ``["NONE"]``: Disable healthcheck - ``["CMD", args...]``: exec arguments directly. - ``["CMD-SHELL", command]``: Run command in the system's default shell. If a string is provided, it will be used as a ``CMD-SHELL`` command. interval (int): The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). timeout (int): The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). retries (int): The number of consecutive failures needed to consider a container as unhealthy. start_period (int): Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms). """ def __init__(self, **kwargs): test = kwargs.get('test', kwargs.get('Test')) if isinstance(test, str): test = ["CMD-SHELL", test] interval = kwargs.get('interval', kwargs.get('Interval')) timeout = kwargs.get('timeout', kwargs.get('Timeout')) retries = kwargs.get('retries', kwargs.get('Retries')) start_period = kwargs.get('start_period', kwargs.get('StartPeriod')) super().__init__({ 'Test': test, 'Interval': interval, 'Timeout': timeout, 'Retries': retries, 'StartPeriod': start_period }) @property def test(self): return self['Test'] @test.setter def test(self, value): if isinstance(value, str): value = ["CMD-SHELL", value] self['Test'] = value @property def interval(self): return self['Interval'] @interval.setter def interval(self, value): self['Interval'] = value @property def timeout(self): return self['Timeout'] @timeout.setter def timeout(self, value): self['Timeout'] = value @property def retries(self): return self['Retries'] @retries.setter def retries(self, value): self['Retries'] = value @property def start_period(self): return self['StartPeriod'] @start_period.setter def start_period(self, value): self['StartPeriod'] = value types/networks.py 0000644 00000010220 15027665106 0010141 0 ustar 00 from .. import errors from ..utils import normalize_links, version_lt class EndpointConfig(dict): def __init__(self, version, aliases=None, links=None, ipv4_address=None, ipv6_address=None, link_local_ips=None, driver_opt=None, mac_address=None): if version_lt(version, '1.22'): raise errors.InvalidVersion( 'Endpoint config is not supported for API version < 1.22' ) if aliases: self["Aliases"] = aliases if links: self["Links"] = normalize_links(links) ipam_config = {} if ipv4_address: ipam_config['IPv4Address'] = ipv4_address if ipv6_address: ipam_config['IPv6Address'] = ipv6_address if mac_address: if version_lt(version, '1.25'): raise errors.InvalidVersion( 'mac_address is not supported for API version < 1.25' ) self['MacAddress'] = mac_address if link_local_ips is not None: if version_lt(version, '1.24'): raise errors.InvalidVersion( 'link_local_ips is not supported for API version < 1.24' ) ipam_config['LinkLocalIPs'] = link_local_ips if ipam_config: self['IPAMConfig'] = ipam_config if driver_opt: if version_lt(version, '1.32'): raise errors.InvalidVersion( 'DriverOpts is not supported for API version < 1.32' ) if not isinstance(driver_opt, dict): raise TypeError('driver_opt must be a dictionary') self['DriverOpts'] = driver_opt class NetworkingConfig(dict): def __init__(self, endpoints_config=None): if endpoints_config: self["EndpointsConfig"] = endpoints_config class IPAMConfig(dict): """ Create an IPAM (IP Address Management) config dictionary to be used with :py:meth:`~docker.api.network.NetworkApiMixin.create_network`. Args: driver (str): The IPAM driver to use. Defaults to ``default``. pool_configs (:py:class:`list`): A list of pool configurations (:py:class:`~docker.types.IPAMPool`). Defaults to empty list. options (dict): Driver options as a key-value dictionary. Defaults to `None`. Example: >>> ipam_config = docker.types.IPAMConfig(driver='default') >>> network = client.create_network('network1', ipam=ipam_config) """ def __init__(self, driver='default', pool_configs=None, options=None): self.update({ 'Driver': driver, 'Config': pool_configs or [] }) if options: if not isinstance(options, dict): raise TypeError('IPAMConfig options must be a dictionary') self['Options'] = options class IPAMPool(dict): """ Create an IPAM pool config dictionary to be added to the ``pool_configs`` parameter of :py:class:`~docker.types.IPAMConfig`. Args: subnet (str): Custom subnet for this IPAM pool using the CIDR notation. Defaults to ``None``. iprange (str): Custom IP range for endpoints in this IPAM pool using the CIDR notation. Defaults to ``None``. gateway (str): Custom IP address for the pool's gateway. aux_addresses (dict): A dictionary of ``key -> ip_address`` relationships specifying auxiliary addresses that need to be allocated by the IPAM driver. Example: >>> ipam_pool = docker.types.IPAMPool( subnet='124.42.0.0/16', iprange='124.42.0.0/24', gateway='124.42.0.254', aux_addresses={ 'reserved1': '124.42.1.1' } ) >>> ipam_config = docker.types.IPAMConfig( pool_configs=[ipam_pool]) """ def __init__(self, subnet=None, iprange=None, gateway=None, aux_addresses=None): self.update({ 'Subnet': subnet, 'IPRange': iprange, 'Gateway': gateway, 'AuxiliaryAddresses': aux_addresses }) types/__init__.py 0000644 00000001161 15027665106 0010030 0 ustar 00 from .containers import ContainerConfig, DeviceRequest, HostConfig, LogConfig, Ulimit from .daemon import CancellableStream from .healthcheck import Healthcheck from .networks import EndpointConfig, IPAMConfig, IPAMPool, NetworkingConfig from .services import ( ConfigReference, ContainerSpec, DNSConfig, DriverConfig, EndpointSpec, Mount, NetworkAttachmentConfig, Placement, PlacementPreference, Privileges, Resources, RestartPolicy, RollbackConfig, SecretReference, ServiceMode, TaskTemplate, UpdateConfig, ) from .swarm import SwarmExternalCA, SwarmSpec client.py 0000644 00000017030 15027665106 0006405 0 ustar 00 from .api.client import APIClient from .constants import DEFAULT_MAX_POOL_SIZE, DEFAULT_TIMEOUT_SECONDS from .models.configs import ConfigCollection from .models.containers import ContainerCollection from .models.images import ImageCollection from .models.networks import NetworkCollection from .models.nodes import NodeCollection from .models.plugins import PluginCollection from .models.secrets import SecretCollection from .models.services import ServiceCollection from .models.swarm import Swarm from .models.volumes import VolumeCollection from .utils import kwargs_from_env class DockerClient: """ A client for communicating with a Docker server. Example: >>> import docker >>> client = docker.DockerClient(base_url='unix://var/run/docker.sock') Args: base_url (str): URL to the Docker server. For example, ``unix:///var/run/docker.sock`` or ``tcp://127.0.0.1:1234``. version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``1.35`` timeout (int): Default timeout for API calls, in seconds. tls (bool or :py:class:`~docker.tls.TLSConfig`): Enable TLS. Pass ``True`` to enable it with default options, or pass a :py:class:`~docker.tls.TLSConfig` object to use custom configuration. user_agent (str): Set a custom user agent for requests to the server. credstore_env (dict): Override environment variables when calling the credential store process. use_ssh_client (bool): If set to `True`, an ssh connection is made via shelling out to the ssh client. Ensure the ssh client is installed and configured on the host. max_pool_size (int): The maximum number of connections to save in the pool. """ def __init__(self, *args, **kwargs): self.api = APIClient(*args, **kwargs) @classmethod def from_env(cls, **kwargs): """ Return a client configured from environment variables. The environment variables used are the same as those used by the Docker command-line client. They are: .. envvar:: DOCKER_HOST The URL to the Docker host. .. envvar:: DOCKER_TLS_VERIFY Verify the host against a CA certificate. .. envvar:: DOCKER_CERT_PATH A path to a directory containing TLS certificates to use when connecting to the Docker host. Args: version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``auto`` timeout (int): Default timeout for API calls, in seconds. max_pool_size (int): The maximum number of connections to save in the pool. environment (dict): The environment to read environment variables from. Default: the value of ``os.environ`` credstore_env (dict): Override environment variables when calling the credential store process. use_ssh_client (bool): If set to `True`, an ssh connection is made via shelling out to the ssh client. Ensure the ssh client is installed and configured on the host. Example: >>> import docker >>> client = docker.from_env() .. _`SSL version`: https://docs.python.org/3.5/library/ssl.html#ssl.PROTOCOL_TLSv1 """ timeout = kwargs.pop('timeout', DEFAULT_TIMEOUT_SECONDS) max_pool_size = kwargs.pop('max_pool_size', DEFAULT_MAX_POOL_SIZE) version = kwargs.pop('version', None) use_ssh_client = kwargs.pop('use_ssh_client', False) return cls( timeout=timeout, max_pool_size=max_pool_size, version=version, use_ssh_client=use_ssh_client, **kwargs_from_env(**kwargs) ) # Resources @property def configs(self): """ An object for managing configs on the server. See the :doc:`configs documentation <configs>` for full details. """ return ConfigCollection(client=self) @property def containers(self): """ An object for managing containers on the server. See the :doc:`containers documentation <containers>` for full details. """ return ContainerCollection(client=self) @property def images(self): """ An object for managing images on the server. See the :doc:`images documentation <images>` for full details. """ return ImageCollection(client=self) @property def networks(self): """ An object for managing networks on the server. See the :doc:`networks documentation <networks>` for full details. """ return NetworkCollection(client=self) @property def nodes(self): """ An object for managing nodes on the server. See the :doc:`nodes documentation <nodes>` for full details. """ return NodeCollection(client=self) @property def plugins(self): """ An object for managing plugins on the server. See the :doc:`plugins documentation <plugins>` for full details. """ return PluginCollection(client=self) @property def secrets(self): """ An object for managing secrets on the server. See the :doc:`secrets documentation <secrets>` for full details. """ return SecretCollection(client=self) @property def services(self): """ An object for managing services on the server. See the :doc:`services documentation <services>` for full details. """ return ServiceCollection(client=self) @property def swarm(self): """ An object for managing a swarm on the server. See the :doc:`swarm documentation <swarm>` for full details. """ return Swarm(client=self) @property def volumes(self): """ An object for managing volumes on the server. See the :doc:`volumes documentation <volumes>` for full details. """ return VolumeCollection(client=self) # Top-level methods def events(self, *args, **kwargs): return self.api.events(*args, **kwargs) events.__doc__ = APIClient.events.__doc__ def df(self): return self.api.df() df.__doc__ = APIClient.df.__doc__ def info(self, *args, **kwargs): return self.api.info(*args, **kwargs) info.__doc__ = APIClient.info.__doc__ def login(self, *args, **kwargs): return self.api.login(*args, **kwargs) login.__doc__ = APIClient.login.__doc__ def ping(self, *args, **kwargs): return self.api.ping(*args, **kwargs) ping.__doc__ = APIClient.ping.__doc__ def version(self, *args, **kwargs): return self.api.version(*args, **kwargs) version.__doc__ = APIClient.version.__doc__ def close(self): return self.api.close() close.__doc__ = APIClient.close.__doc__ def __getattr__(self, name): s = [f"'DockerClient' object has no attribute '{name}'"] # If a user calls a method on APIClient, they if hasattr(APIClient, name): s.append("In Docker SDK for Python 2.0, this method is now on the " "object APIClient. See the low-level API section of the " "documentation for more details.") raise AttributeError(' '.join(s)) from_env = DockerClient.from_env transport/__pycache__/unixconn.cpython-310.pyc 0000644 00000006040 15027665106 0015362 0 ustar 00 o �hc � @ s| d dl Z d dlZd dlZd dlZddlmZ ddlmZ ej j Z G dd� dej j �Z G dd � d ejj�ZG d d � d e�ZdS ) � N� )� constants� )�BaseHTTPAdapterc s& e Zd Zd� fdd� Zdd� Z� ZS )�UnixHTTPConnection�< c s& t � jd|d� || _|| _|| _d S )N� localhost)�timeout)�super�__init__�base_url� unix_socketr )�selfr r r �� __class__� �O/usr/local/CyberPanel/lib/python3.10/site-packages/docker/transport/unixconn.pyr s � zUnixHTTPConnection.__init__c C s2 t � t jt j�}|�| j� |�| j� || _d S �N)�socket�AF_UNIX� SOCK_STREAM� settimeoutr �connectr �sock)r r r r r r s zUnixHTTPConnection.connect)r )�__name__� __module__� __qualname__r r � __classcell__r r r r r s r c s& e Zd Zd� fdd� Zdd� Z� ZS )�UnixHTTPConnectionPoolr � c s( t � jd||d� || _|| _|| _d S )Nr )r �maxsize)r r r � socket_pathr )r r r! r r r r r r s � z UnixHTTPConnectionPool.__init__c C s t | j| j| j�S r )r r r! r )r r r r � _new_conn' s �z UnixHTTPConnectionPool._new_conn)r r )r r r r r" r r r r r r s r c sL e Zd Zejjjg d� Zdejej f� fdd� Z d dd�Z dd � Z � Z S ) �UnixHTTPAdapter)�poolsr! r � max_pool_sizer c sR |� dd�}|�d�sd|� �}|| _|| _|| _t|dd� d�| _t� �� d S )Nz http+unix://� �/c S s | � � S r )�close)�pr r r �<lambda>> s z*UnixHTTPAdapter.__init__.<locals>.<lambda>)� dispose_func) �replace� startswithr! r r% �RecentlyUsedContainerr$ r r )r � socket_urlr �pool_connectionsr% r! r r r r 4 s �zUnixHTTPAdapter.__init__Nc C sp | j j�* | j �|�}|r|W d � S t|| j| j| jd�}|| j |< W d � |S 1 s1w Y |S )N)r )r$ �lock�getr r! r r% )r �url�proxies�poolr r r �get_connectionB s � � � � z UnixHTTPAdapter.get_connectionc C s |j S r )�path_url)r �requestr4 r r r � request_urlP s zUnixHTTPAdapter.request_urlr )r r r �requests�adapters� HTTPAdapter� __attrs__r �DEFAULT_NUM_POOLS�DEFAULT_MAX_POOL_SIZEr r6 r9 r r r r r r# - s � r# )r �requests.adaptersr: �urllib3�urllib3.connectionr& r �basehttpadapterr � _collectionsr. � connection�HTTPConnectionr �connectionpool�HTTPConnectionPoolr r# r r r r �<module> s transport/__pycache__/npipeconn.cpython-310.pyc 0000644 00000006635 15027665106 0015524 0 ustar 00 o �h� � @ s� d dl Z d dlZd dlZd dlZddlmZ ddlmZ ddl m Z ej j Z G dd� dej j�ZG d d � d ejj�ZG d d � d e�ZdS ) � N� )� constants� )�BaseHTTPAdapter)� NpipeSocketc s& e Zd Zd� fdd� Zdd� Z� ZS )�NpipeHTTPConnection�< c s t � jd|d� || _|| _d S )N� localhost)�timeout��super�__init__� npipe_pathr )�selfr r �� __class__� �P/usr/local/CyberPanel/lib/python3.10/site-packages/docker/transport/npipeconn.pyr s � z NpipeHTTPConnection.__init__c C s( t � }|�| j� |�| j� || _d S �N)r � settimeoutr �connectr �sock)r r r r r r s zNpipeHTTPConnection.connect)r )�__name__� __module__� __qualname__r r � __classcell__r r r r r s r c s. e Zd Zd � fdd� Zdd� Zdd� Z� ZS ) �NpipeHTTPConnectionPoolr � c s" t � jd||d� || _|| _d S )Nr )r �maxsizer )r r r r r r r r s � z NpipeHTTPConnectionPool.__init__c C s t | j| j�S r )r r r )r r r r � _new_conn% s �z!NpipeHTTPConnectionPool._new_connc C sx d }z | j j| j|d�}W n( ty! } ztj�| d�|�d }~w tjy5 | jr3tj� | d�d �Y nw |p;| � � S )N)�blockr zPool is closed.z>Pool reached maximum size and no more connections are allowed.) �pool�getr �AttributeError�urllib3� exceptions�ClosedPoolError�queue�Empty�EmptyPoolErrorr )r r �conn�aer r r � _get_conn- s" ����� z!NpipeHTTPConnectionPool._get_conn)r r )r r r r r r, r r r r r r s r c sL e Zd Zejjjg d� Zdejej f� fdd� Z d dd�Z dd � Z � Z S ) �NpipeHTTPAdapter)r �poolsr � max_pool_sizer c s: |� dd�| _|| _|| _t|dd� d�| _t� �� d S )Nznpipe://� c S s | � � S r )�close)�pr r r �<lambda>N s z+NpipeHTTPAdapter.__init__.<locals>.<lambda>)� dispose_func)�replacer r r/ �RecentlyUsedContainerr. r r )r �base_urlr �pool_connectionsr/ r r r r G s �zNpipeHTTPAdapter.__init__Nc C sn | j j�) | j �|�}|r|W d � S t| j| j| jd�}|| j |< W d � |S 1 s0w Y |S )N)r )r. �lockr" r r r r/ )r �url�proxiesr! r r r �get_connectionR s �� � � z NpipeHTTPAdapter.get_connectionc C s |j S r )�path_url)r �requestr; r r r � request_url` s z NpipeHTTPAdapter.request_urlr )r r r �requests�adapters� HTTPAdapter� __attrs__r �DEFAULT_NUM_POOLS�DEFAULT_MAX_POOL_SIZEr r< r? r r r r r r- @ s � r- )r' �requests.adaptersr@ r$ �urllib3.connectionr0 r �basehttpadapterr � npipesocketr � _collectionsr6 � connection�HTTPConnectionr �connectionpool�HTTPConnectionPoolr r- r r r r �<module> s # transport/__pycache__/__init__.cpython-310.pyc 0000644 00000000670 15027665106 0015263 0 ustar 00 o �h� � @ sd d dl mZ zd dlmZ d dlmZ W n ey Y nw z d dlmZ W dS ey1 Y dS w )� )�UnixHTTPAdapter)�NpipeHTTPAdapter)� NpipeSocket)�SSHHTTPAdapterN) �unixconnr � npipeconnr � npipesocketr � ImportError�sshconnr � r r �O/usr/local/CyberPanel/lib/python3.10/site-packages/docker/transport/__init__.py�<module> s � � transport/__pycache__/npipesocket.cpython-310.pyc 0000644 00000017070 15027665106 0016052 0 ustar 00 o �h� � @ s| d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZdZdZ d Z dZ dd� Z G dd� d�Z G d d � d ej�ZdS ) � N�� i � c s t �� �� fdd��}|S )Nc s$ | j rtd��� | g|�R i |��S )Nz1Can not reuse socket after connection was closed.)�_closed� RuntimeError)�self�args�kwargs��f� �R/usr/local/CyberPanel/lib/python3.10/site-packages/docker/transport/npipesocket.py�wrapped s �z check_closed.<locals>.wrapped)� functools�wraps)r r r r r � check_closed s r c @ s$ e Zd ZdZd8dd�Zdd� Zdd� Zd d � Zed9d d ��Z edd� �Z edd� �Z edd� �Z dd� Z dd� Zd8dd�Zdd� Zd d � Zd:d d �Zed9d d!��Zed9d"d#��Zed;d$d%��Zed9d&d'��Zed9d(d)��Zed9d*d+��Zed,d-� �Zd.d/� Zd0d1� Zd2d3� Z d4d5� Z ed6d7� �Z dS )<� NpipeSocketz� Partial implementation of the socket API over windows named pipes. This implementation is only designed to be used as a client socket, and server-specific methods (bind, listen, accept...) are not implemented. Nc C s t j| _|| _d| _d S �NF)� win32pipe�NMPWAIT_USE_DEFAULT_WAIT�_timeout�_handler )r �handler r r �__init__$ s zNpipeSocket.__init__c C � t � ��N��NotImplementedError�r r r r �accept) � zNpipeSocket.acceptc C r r r �r �addressr r r �bind, r zNpipeSocket.bindc C s | j �� d| _d S �NT)r �Closer r r r r �close/ � zNpipeSocket.closer c C s� zt �|t jt jB dd t jttB t jB d�}W n- tj yD } z |j t kr>|d }|t k r>t �d� | �||�W Y d }~S |�d }~ww t�|�d | _|| _|| _d S )Nr � )� win32file� CreateFile� GENERIC_READ� GENERIC_WRITE� OPEN_EXISTING�cSECURITY_ANONYMOUS�cSECURITY_SQOS_PRESENT�FILE_FLAG_OVERLAPPEDr �error�winerror�cERROR_PIPE_BUSY�MAXIMUM_RETRY_COUNT�time�sleep�connect�GetNamedPipeInfo�flagsr �_address)r r! � retry_countr �er r r r6 3 s4 ��� �� zNpipeSocket.connectc C s | � |�S r )r6 r r r r � connect_exS � zNpipeSocket.connect_exc C s d| _ | jS r# )r r r r r r �detachW s zNpipeSocket.detachc C s t | j�S r )r r r r r r �dup\ r= zNpipeSocket.dupc C � | j S r �r9 r r r r � getpeername` r zNpipeSocket.getpeernamec C r@ r rA r r r r � getsocknamec r zNpipeSocket.getsocknamec C r r r )r �level�optname�buflenr r r � getsockoptf r zNpipeSocket.getsockoptc C r r r )r �control�optionr r r �ioctli r zNpipeSocket.ioctlc C r r r )r �backlogr r r �listenl r zNpipeSocket.listenc C s@ |� d�dkr t� �t| �}|d u s|dkrtj}tj||d�S )N�b�rr )� buffer_size)�stripr �NpipeFileIOBase�io�DEFAULT_BUFFER_SIZE�BufferedReader)r �mode�bufsize�rawior r r �makefileo s zNpipeSocket.makefilec C s t �| j|�\}}|S r )r( �ReadFiler )r rV r8 �err�datar r r �recvw s zNpipeSocket.recvc C s | � ||�}|| jfS r )r\ r9 )r rV r8 r[ r r r �recvfrom| s zNpipeSocket.recvfromc C s | � |||�| jfS r )� recv_intor9 )r �buf�nbytesr8 r r r � recvfrom_into� s zNpipeSocket.recvfrom_intoc C s� |}t |t�s t|�}t�d ddd �}z;t�� }||_t�| j |r'|d |� n||�\}}t� || j �}|tj krAt� | j � t�t�| j |d�W t�|� S t�|� w �NTr )� isinstance� memoryview� win32event� CreateEvent� pywintypes� OVERLAPPED�hEventr( rY r �WaitForSingleObjectr � WAIT_TIMEOUT�CancelIo� TimeoutError�GetOverlappedResult�win32api� CloseHandle) r r_ r` �readbuf�event� overlappedrZ r[ � wait_resultr r r r^ � s$ � zNpipeSocket.recv_intoc C s� t �d ddd �}z1t�� }||_t�| j||� t �|| j �}|t j kr,t� | j� t �t� | j|d�W t�|� S t�|� w rb )re rf rg rh ri r( � WriteFiler rj r rk rl rm rn ro rp )r �stringr8 rr rs rt r r r �send� s zNpipeSocket.sendc C s | � ||�S r )rw )r rv r8 r r r �sendall� s zNpipeSocket.sendallc C s | � |� | �|�S r )r6 rw )r rv r! r r r �sendto� s zNpipeSocket.sendtoc C s |r| � d �S | � d�S )Nr )� settimeout)r �flagr r r � setblocking� s zNpipeSocket.setblockingc C sD |d u r t j| _d S t|ttf�r|dk rtd��t|d �| _d S )Nr zTimeout value out of rangei� )re �INFINITEr rc �float�int� ValueError)r �valuer r r rz � s zNpipeSocket.settimeoutc C r@ r )r r r r r � gettimeout� r zNpipeSocket.gettimeoutc C r r r )r rD rE r� r r r � setsockopt� r zNpipeSocket.setsockoptc C s | � � S r )r% )r �howr r r �shutdown� s zNpipeSocket.shutdownr )r )NN)r r ) �__name__� __module__� __qualname__�__doc__r r r" r% r r6 r< r> r? rB rC rG rJ rL rX r\ r] ra r^ rw rx ry r| rz r� r� r� r r r r r sP r c sT e Zd Zdd� Z� fdd�Zdd� Zdd� Zd d � Zd d � Zd d� Z dd� Z � Z S )rQ c C s || _ d S r )�sock)r � npipe_socketr r r r � � zNpipeFileIOBase.__init__c s t � �� d | _d S r )�superr% r� r �� __class__r r r% � r& zNpipeFileIOBase.closec C s | j �� S r )r� �filenor r r r r� � r� zNpipeFileIOBase.filenoc C � dS r r r r r r �isatty� � zNpipeFileIOBase.isattyc C r� r# r r r r r �readable� r� zNpipeFileIOBase.readablec C s | j �|�S r )r� r^ )r r_ r r r �readinto� s zNpipeFileIOBase.readintoc C r� r r r r r r �seekable� r� zNpipeFileIOBase.seekablec C r� r r r r r r �writable� r� zNpipeFileIOBase.writable) r� r� r� r r% r� r� r� r� r� r� � __classcell__r r r� r rQ � s rQ )r rR r4 rg ro re r( r r2 r. r- r3 r r � RawIOBaserQ r r r r �<module> s 2 transport/__pycache__/sshconn.cpython-310.pyc 0000644 00000016205 15027665106 0015200 0 ustar 00 o �h� � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl Z d dl Z d dl Z ddl mZ ddlmZ e jjZG dd� dej�ZG dd � d e jj�ZG d d � d e jj�ZG d d � d e�ZdS )� N� )� constants� )�BaseHTTPAdapterc sT e Zd Z� fdd�Zdd� Zdd� Zdd� Zd d � Zd d � Zd d� Z dd� Z � Z S )� SSHSocketc sj t � �tjtj� || _d | _d | _d| jv r!| j�d�\| _| _d| jv r0| j�d�\| _| _d | _ d S )N�:�@) �super�__init__�socket�AF_INET� SOCK_STREAM�host�port�user�split�proc)�selfr �� __class__� �N/usr/local/CyberPanel/lib/python3.10/site-packages/docker/transport/sshconn.pyr s � zSSHSocket.__init__c K s� dg}| j r |d| j g }| jr|d| jg }|d| jdg }d }tjs*dd� }|}ttj�}|�dd � |�d d � t j ||t j t j |d �| _ d S ) N�sshz-lz-pz--�docker system dial-stdioc S s t � t jt j� d S �N)�signal�SIGINT�SIG_IGNr r r r �f. s z SSHSocket.connect.<locals>.f�LD_LIBRARY_PATH� SSL_CERT_FILE)�env�stdout�stdin� preexec_fn) r r r r �IS_WINDOWS_PLATFORM�dict�os�environ�pop� subprocess�Popen�PIPEr )r �kwargs�args� preexec_funcr r! r r r �connect" s( �zSSHSocket.connectc C s6 | j r| j jjr td��| j j�|�}| j j�� |S �Nz<SSH subprocess not initiated.connect() must be called first.)r r# �closed� Exception�write�flush)r �data�writtenr r r �_write? s zSSHSocket._writec C s | � |� d S r �r8 �r r6 r r r �sendallG s zSSHSocket.sendallc C s | � |�S r r9 r: r r r �sendJ s zSSHSocket.sendc C s | j std��| j j�|�S r1 )r r3 r" �read)r �nr r r �recvM s zSSHSocket.recvc C s | j s| �� | | j j_| j jS r )r r0 r" �channel)r �moder r r �makefileS s zSSHSocket.makefilec C s< | j r| j jjr d S | j j�d� | j j�� | j �� d S )Ns )r r# r2 r4 r5 � terminate�r r r r �closeZ s zSSHSocket.close) �__name__� __module__� __qualname__r r0 r8 r; r< r? rB rE � __classcell__r r r r r s r c s& e Zd Zd� fdd� Zdd� Z� ZS )� SSHConnectionN�< c s& t � jd|d� || _|| _|| _d S )N� localhost)�timeout)r r � ssh_transportrM �ssh_host)r rN rM r r r r r c s � zSSHConnection.__init__c C sP | j r| j �� }|�| j� |�d� nt| j�}|�| j� |�� || _d S )Nr ) rN � open_session� settimeoutrM � exec_commandr rO r0 �sock)r rS r r r r0 k s zSSHConnection.connect)NrK N)rF rG rH r r0 rI r r r r rJ b s rJ c s2 e Zd ZdZd � fdd� Zdd� Zd d � Z� ZS ) �SSHConnectionPoolr NrK � c s6 t � jd||d� d | _|| _|r|�� | _|| _d S )NrL )rM �maxsize)r r rN rM � get_transportrO )r � ssh_clientrM rV r r r r r { s � zSSHConnectionPool.__init__c C s t | j| j| j�S r )rJ rN rM rO rD r r r � _new_conn� s zSSHConnectionPool._new_connc C sx d }z | j j| j|d�}W n( ty! } ztj�| d�|�d }~w tjy5 | jr3tj� | d�d �Y nw |p;| � � S )N)�blockrM zPool is closed.z>Pool reached maximum size and no more connections are allowed.) �pool�getrZ �AttributeError�urllib3� exceptions�ClosedPoolError�queue�Empty�EmptyPoolErrorrY )r rM �conn�aer r r � _get_conn� s" ����� zSSHConnectionPool._get_conn)NrK rU N)rF rG rH �schemer rY rf rI r r r r rT x s rT c sb e Zd Zejjjg d� Zdejej df� fdd� Z dd� Z dd � Z dd d �Z � fd d�Z� ZS )�SSHHTTPAdapter)�poolsrM rX � ssh_params� max_pool_sizerK Fc sj d | _ |s| �|� | �� || _|�d�r |td�d � | _|| _|| _t|dd� d�| _ t � � � d S )Nzssh://c S s | � � S r )rE )�pr r r �<lambda>� s z)SSHHTTPAdapter.__init__.<locals>.<lambda>)� dispose_func) rX �_create_paramiko_client�_connectrO � startswith�lenrM rk �RecentlyUsedContainerri r r )r �base_urlrM �pool_connectionsrk � shell_outr r r r � s �zSSHHTTPAdapter.__init__c C s@ t �d��t j� t�� | _tj� |�}|j |j |j d�| _ tj�d�}tj�|�r�t�� }t|�� }|�|� W d � n1 sBw Y |�|j �}d|v r[t�|d �| j d< d|v rf|d | j d< |j d u rvd|v rv|d | j d< |j d u r�d|v r�|d | j d < d |v r�|d | j d < | j�� | j�t�� � d S ) N�paramiko)�hostnamer �usernamez ~/.ssh/config� proxycommandrS rx r r ry � identityfile� key_filename)�logging� getLogger�setLevel�WARNINGrw � SSHClientrX �urllib�parse�urlparserx r ry rj r' �path� expanduser�exists� SSHConfig�open�lookup� ProxyCommand�load_system_host_keys�set_missing_host_key_policy� RejectPolicy)r rt �ssh_config_file�confr � host_configr r r ro � s8 � � � z&SSHHTTPAdapter._create_paramiko_clientc C s" | j r| j jdi | j�� d S d S )Nr )rX r0 rj rD r r r rp � s �zSSHHTTPAdapter._connectNc C s� | j st| j | j| j| jd�S | jj�7 | j�|�}|r%|W d � S | j r1| j �� s1| � � t| j | j| j| jd�}|| j|< W d � |S 1 sMw Y |S )N)rX rM rV r ) rX rT rM rk rO ri �lockr\ rW rp )r �url�proxiesr[ r r r �get_connection� s2 � �� ��z SSHHTTPAdapter.get_connectionc s" t � �� | jr| j�� d S d S r )r rE rX rD r r r rE � s �zSSHHTTPAdapter.closer )rF rG rH �requests�adapters� HTTPAdapter� __attrs__r �DEFAULT_NUM_POOLS�DEFAULT_MAX_POOL_SIZEr ro rp r� rE rI r r r r rh � s � rh )r} r' ra r r r* � urllib.parser� rw �requests.adaptersr� r^ �urllib3.connection� r �basehttpadapterr � _collectionsrs r � connection�HTTPConnectionrJ �connectionpool�HTTPConnectionPoolrT rh r r r r �<module> s$ N' transport/__pycache__/basehttpadapter.cpython-310.pyc 0000644 00000001554 15027665106 0016701 0 ustar 00 o �h� � @ s d dl ZG dd� dejj�ZdS )� Nc s& e Zd Z� fdd�Zddd�Z� ZS )�BaseHTTPAdapterc s& t � �� t| d�r| j�� d S d S )N�pools)�super�close�hasattrr �clear)�self�� __class__� �V/usr/local/CyberPanel/lib/python3.10/site-packages/docker/transport/basehttpadapter.pyr s �zBaseHTTPAdapter.closeNc C s | � |j|�S )N)�get_connection�url)r �request�verify�proxies�certr r r � get_connection_with_tls_context s z/BaseHTTPAdapter.get_connection_with_tls_context)NN)�__name__� __module__� __qualname__r r � __classcell__r r r r r s r )�requests.adapters�requests�adapters� HTTPAdapterr r r r r �<module> s transport/npipeconn.py 0000644 00000006705 15027665106 0011163 0 ustar 00 import queue import requests.adapters import urllib3 import urllib3.connection from .. import constants from .basehttpadapter import BaseHTTPAdapter from .npipesocket import NpipeSocket RecentlyUsedContainer = urllib3._collections.RecentlyUsedContainer class NpipeHTTPConnection(urllib3.connection.HTTPConnection): def __init__(self, npipe_path, timeout=60): super().__init__( 'localhost', timeout=timeout ) self.npipe_path = npipe_path self.timeout = timeout def connect(self): sock = NpipeSocket() sock.settimeout(self.timeout) sock.connect(self.npipe_path) self.sock = sock class NpipeHTTPConnectionPool(urllib3.connectionpool.HTTPConnectionPool): def __init__(self, npipe_path, timeout=60, maxsize=10): super().__init__( 'localhost', timeout=timeout, maxsize=maxsize ) self.npipe_path = npipe_path self.timeout = timeout def _new_conn(self): return NpipeHTTPConnection( self.npipe_path, self.timeout ) # When re-using connections, urllib3 tries to call select() on our # NpipeSocket instance, causing a crash. To circumvent this, we override # _get_conn, where that check happens. def _get_conn(self, timeout): conn = None try: conn = self.pool.get(block=self.block, timeout=timeout) except AttributeError as ae: # self.pool is None raise urllib3.exceptions.ClosedPoolError(self, "Pool is closed.") from ae except queue.Empty: if self.block: raise urllib3.exceptions.EmptyPoolError( self, "Pool reached maximum size and no more " "connections are allowed." ) from None # Oh well, we'll create a new connection then return conn or self._new_conn() class NpipeHTTPAdapter(BaseHTTPAdapter): __attrs__ = requests.adapters.HTTPAdapter.__attrs__ + ['npipe_path', 'pools', 'timeout', 'max_pool_size'] def __init__(self, base_url, timeout=60, pool_connections=constants.DEFAULT_NUM_POOLS, max_pool_size=constants.DEFAULT_MAX_POOL_SIZE): self.npipe_path = base_url.replace('npipe://', '') self.timeout = timeout self.max_pool_size = max_pool_size self.pools = RecentlyUsedContainer( pool_connections, dispose_func=lambda p: p.close() ) super().__init__() def get_connection(self, url, proxies=None): with self.pools.lock: pool = self.pools.get(url) if pool: return pool pool = NpipeHTTPConnectionPool( self.npipe_path, self.timeout, maxsize=self.max_pool_size ) self.pools[url] = pool return pool def request_url(self, request, proxies): # The select_proxy utility in requests errors out when the provided URL # doesn't have a hostname, like is the case when using a UNIX socket. # Since proxies are an irrelevant notion in the case of UNIX sockets # anyway, we simply return the path URL directly. # See also: https://github.com/docker/docker-sdk-python/issues/811 return request.path_url transport/sshconn.py 0000644 00000017363 15027665106 0010647 0 ustar 00 import logging import os import queue import signal import socket import subprocess import urllib.parse import paramiko import requests.adapters import urllib3 import urllib3.connection from .. import constants from .basehttpadapter import BaseHTTPAdapter RecentlyUsedContainer = urllib3._collections.RecentlyUsedContainer class SSHSocket(socket.socket): def __init__(self, host): super().__init__( socket.AF_INET, socket.SOCK_STREAM) self.host = host self.port = None self.user = None if ':' in self.host: self.host, self.port = self.host.split(':') if '@' in self.host: self.user, self.host = self.host.split('@') self.proc = None def connect(self, **kwargs): args = ['ssh'] if self.user: args = args + ['-l', self.user] if self.port: args = args + ['-p', self.port] args = args + ['--', self.host, 'docker system dial-stdio'] preexec_func = None if not constants.IS_WINDOWS_PLATFORM: def f(): signal.signal(signal.SIGINT, signal.SIG_IGN) preexec_func = f env = dict(os.environ) # drop LD_LIBRARY_PATH and SSL_CERT_FILE env.pop('LD_LIBRARY_PATH', None) env.pop('SSL_CERT_FILE', None) self.proc = subprocess.Popen( args, env=env, stdout=subprocess.PIPE, stdin=subprocess.PIPE, preexec_fn=preexec_func) def _write(self, data): if not self.proc or self.proc.stdin.closed: raise Exception('SSH subprocess not initiated.' 'connect() must be called first.') written = self.proc.stdin.write(data) self.proc.stdin.flush() return written def sendall(self, data): self._write(data) def send(self, data): return self._write(data) def recv(self, n): if not self.proc: raise Exception('SSH subprocess not initiated.' 'connect() must be called first.') return self.proc.stdout.read(n) def makefile(self, mode): if not self.proc: self.connect() self.proc.stdout.channel = self return self.proc.stdout def close(self): if not self.proc or self.proc.stdin.closed: return self.proc.stdin.write(b'\n\n') self.proc.stdin.flush() self.proc.terminate() class SSHConnection(urllib3.connection.HTTPConnection): def __init__(self, ssh_transport=None, timeout=60, host=None): super().__init__( 'localhost', timeout=timeout ) self.ssh_transport = ssh_transport self.timeout = timeout self.ssh_host = host def connect(self): if self.ssh_transport: sock = self.ssh_transport.open_session() sock.settimeout(self.timeout) sock.exec_command('docker system dial-stdio') else: sock = SSHSocket(self.ssh_host) sock.settimeout(self.timeout) sock.connect() self.sock = sock class SSHConnectionPool(urllib3.connectionpool.HTTPConnectionPool): scheme = 'ssh' def __init__(self, ssh_client=None, timeout=60, maxsize=10, host=None): super().__init__( 'localhost', timeout=timeout, maxsize=maxsize ) self.ssh_transport = None self.timeout = timeout if ssh_client: self.ssh_transport = ssh_client.get_transport() self.ssh_host = host def _new_conn(self): return SSHConnection(self.ssh_transport, self.timeout, self.ssh_host) # When re-using connections, urllib3 calls fileno() on our # SSH channel instance, quickly overloading our fd limit. To avoid this, # we override _get_conn def _get_conn(self, timeout): conn = None try: conn = self.pool.get(block=self.block, timeout=timeout) except AttributeError as ae: # self.pool is None raise urllib3.exceptions.ClosedPoolError(self, "Pool is closed.") from ae except queue.Empty: if self.block: raise urllib3.exceptions.EmptyPoolError( self, "Pool reached maximum size and no more " "connections are allowed." ) from None # Oh well, we'll create a new connection then return conn or self._new_conn() class SSHHTTPAdapter(BaseHTTPAdapter): __attrs__ = requests.adapters.HTTPAdapter.__attrs__ + [ 'pools', 'timeout', 'ssh_client', 'ssh_params', 'max_pool_size' ] def __init__(self, base_url, timeout=60, pool_connections=constants.DEFAULT_NUM_POOLS, max_pool_size=constants.DEFAULT_MAX_POOL_SIZE, shell_out=False): self.ssh_client = None if not shell_out: self._create_paramiko_client(base_url) self._connect() self.ssh_host = base_url if base_url.startswith('ssh://'): self.ssh_host = base_url[len('ssh://'):] self.timeout = timeout self.max_pool_size = max_pool_size self.pools = RecentlyUsedContainer( pool_connections, dispose_func=lambda p: p.close() ) super().__init__() def _create_paramiko_client(self, base_url): logging.getLogger("paramiko").setLevel(logging.WARNING) self.ssh_client = paramiko.SSHClient() base_url = urllib.parse.urlparse(base_url) self.ssh_params = { "hostname": base_url.hostname, "port": base_url.port, "username": base_url.username } ssh_config_file = os.path.expanduser("~/.ssh/config") if os.path.exists(ssh_config_file): conf = paramiko.SSHConfig() with open(ssh_config_file) as f: conf.parse(f) host_config = conf.lookup(base_url.hostname) if 'proxycommand' in host_config: self.ssh_params["sock"] = paramiko.ProxyCommand( host_config['proxycommand'] ) if 'hostname' in host_config: self.ssh_params['hostname'] = host_config['hostname'] if base_url.port is None and 'port' in host_config: self.ssh_params['port'] = host_config['port'] if base_url.username is None and 'user' in host_config: self.ssh_params['username'] = host_config['user'] if 'identityfile' in host_config: self.ssh_params['key_filename'] = host_config['identityfile'] self.ssh_client.load_system_host_keys() self.ssh_client.set_missing_host_key_policy(paramiko.RejectPolicy()) def _connect(self): if self.ssh_client: self.ssh_client.connect(**self.ssh_params) def get_connection(self, url, proxies=None): if not self.ssh_client: return SSHConnectionPool( ssh_client=self.ssh_client, timeout=self.timeout, maxsize=self.max_pool_size, host=self.ssh_host ) with self.pools.lock: pool = self.pools.get(url) if pool: return pool # Connection is closed try a reconnect if self.ssh_client and not self.ssh_client.get_transport(): self._connect() pool = SSHConnectionPool( ssh_client=self.ssh_client, timeout=self.timeout, maxsize=self.max_pool_size, host=self.ssh_host ) self.pools[url] = pool return pool def close(self): super().close() if self.ssh_client: self.ssh_client.close() transport/unixconn.py 0000644 00000005543 15027665106 0011032 0 ustar 00 import socket import requests.adapters import urllib3 import urllib3.connection from .. import constants from .basehttpadapter import BaseHTTPAdapter RecentlyUsedContainer = urllib3._collections.RecentlyUsedContainer class UnixHTTPConnection(urllib3.connection.HTTPConnection): def __init__(self, base_url, unix_socket, timeout=60): super().__init__( 'localhost', timeout=timeout ) self.base_url = base_url self.unix_socket = unix_socket self.timeout = timeout def connect(self): sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) sock.settimeout(self.timeout) sock.connect(self.unix_socket) self.sock = sock class UnixHTTPConnectionPool(urllib3.connectionpool.HTTPConnectionPool): def __init__(self, base_url, socket_path, timeout=60, maxsize=10): super().__init__( 'localhost', timeout=timeout, maxsize=maxsize ) self.base_url = base_url self.socket_path = socket_path self.timeout = timeout def _new_conn(self): return UnixHTTPConnection( self.base_url, self.socket_path, self.timeout ) class UnixHTTPAdapter(BaseHTTPAdapter): __attrs__ = requests.adapters.HTTPAdapter.__attrs__ + ['pools', 'socket_path', 'timeout', 'max_pool_size'] def __init__(self, socket_url, timeout=60, pool_connections=constants.DEFAULT_NUM_POOLS, max_pool_size=constants.DEFAULT_MAX_POOL_SIZE): socket_path = socket_url.replace('http+unix://', '') if not socket_path.startswith('/'): socket_path = f"/{socket_path}" self.socket_path = socket_path self.timeout = timeout self.max_pool_size = max_pool_size self.pools = RecentlyUsedContainer( pool_connections, dispose_func=lambda p: p.close() ) super().__init__() def get_connection(self, url, proxies=None): with self.pools.lock: pool = self.pools.get(url) if pool: return pool pool = UnixHTTPConnectionPool( url, self.socket_path, self.timeout, maxsize=self.max_pool_size ) self.pools[url] = pool return pool def request_url(self, request, proxies): # The select_proxy utility in requests errors out when the provided URL # doesn't have a hostname, like is the case when using a UNIX socket. # Since proxies are an irrelevant notion in the case of UNIX sockets # anyway, we simply return the path URL directly. # See also: https://github.com/docker/docker-py/issues/811 return request.path_url transport/npipesocket.py 0000644 00000014671 15027665106 0011517 0 ustar 00 import functools import io import time import pywintypes import win32api import win32event import win32file import win32pipe cERROR_PIPE_BUSY = 0xe7 cSECURITY_SQOS_PRESENT = 0x100000 cSECURITY_ANONYMOUS = 0 MAXIMUM_RETRY_COUNT = 10 def check_closed(f): @functools.wraps(f) def wrapped(self, *args, **kwargs): if self._closed: raise RuntimeError( 'Can not reuse socket after connection was closed.' ) return f(self, *args, **kwargs) return wrapped class NpipeSocket: """ Partial implementation of the socket API over windows named pipes. This implementation is only designed to be used as a client socket, and server-specific methods (bind, listen, accept...) are not implemented. """ def __init__(self, handle=None): self._timeout = win32pipe.NMPWAIT_USE_DEFAULT_WAIT self._handle = handle self._closed = False def accept(self): raise NotImplementedError() def bind(self, address): raise NotImplementedError() def close(self): self._handle.Close() self._closed = True @check_closed def connect(self, address, retry_count=0): try: handle = win32file.CreateFile( address, win32file.GENERIC_READ | win32file.GENERIC_WRITE, 0, None, win32file.OPEN_EXISTING, (cSECURITY_ANONYMOUS | cSECURITY_SQOS_PRESENT | win32file.FILE_FLAG_OVERLAPPED), 0 ) except win32pipe.error as e: # See Remarks: # https://msdn.microsoft.com/en-us/library/aa365800.aspx if e.winerror == cERROR_PIPE_BUSY: # Another program or thread has grabbed our pipe instance # before we got to it. Wait for availability and attempt to # connect again. retry_count = retry_count + 1 if (retry_count < MAXIMUM_RETRY_COUNT): time.sleep(1) return self.connect(address, retry_count) raise e self.flags = win32pipe.GetNamedPipeInfo(handle)[0] self._handle = handle self._address = address @check_closed def connect_ex(self, address): return self.connect(address) @check_closed def detach(self): self._closed = True return self._handle @check_closed def dup(self): return NpipeSocket(self._handle) def getpeername(self): return self._address def getsockname(self): return self._address def getsockopt(self, level, optname, buflen=None): raise NotImplementedError() def ioctl(self, control, option): raise NotImplementedError() def listen(self, backlog): raise NotImplementedError() def makefile(self, mode=None, bufsize=None): if mode.strip('b') != 'r': raise NotImplementedError() rawio = NpipeFileIOBase(self) if bufsize is None or bufsize <= 0: bufsize = io.DEFAULT_BUFFER_SIZE return io.BufferedReader(rawio, buffer_size=bufsize) @check_closed def recv(self, bufsize, flags=0): err, data = win32file.ReadFile(self._handle, bufsize) return data @check_closed def recvfrom(self, bufsize, flags=0): data = self.recv(bufsize, flags) return (data, self._address) @check_closed def recvfrom_into(self, buf, nbytes=0, flags=0): return self.recv_into(buf, nbytes, flags), self._address @check_closed def recv_into(self, buf, nbytes=0): readbuf = buf if not isinstance(buf, memoryview): readbuf = memoryview(buf) event = win32event.CreateEvent(None, True, True, None) try: overlapped = pywintypes.OVERLAPPED() overlapped.hEvent = event err, data = win32file.ReadFile( self._handle, readbuf[:nbytes] if nbytes else readbuf, overlapped ) wait_result = win32event.WaitForSingleObject(event, self._timeout) if wait_result == win32event.WAIT_TIMEOUT: win32file.CancelIo(self._handle) raise TimeoutError return win32file.GetOverlappedResult(self._handle, overlapped, 0) finally: win32api.CloseHandle(event) @check_closed def send(self, string, flags=0): event = win32event.CreateEvent(None, True, True, None) try: overlapped = pywintypes.OVERLAPPED() overlapped.hEvent = event win32file.WriteFile(self._handle, string, overlapped) wait_result = win32event.WaitForSingleObject(event, self._timeout) if wait_result == win32event.WAIT_TIMEOUT: win32file.CancelIo(self._handle) raise TimeoutError return win32file.GetOverlappedResult(self._handle, overlapped, 0) finally: win32api.CloseHandle(event) @check_closed def sendall(self, string, flags=0): return self.send(string, flags) @check_closed def sendto(self, string, address): self.connect(address) return self.send(string) def setblocking(self, flag): if flag: return self.settimeout(None) return self.settimeout(0) def settimeout(self, value): if value is None: # Blocking mode self._timeout = win32event.INFINITE elif not isinstance(value, (float, int)) or value < 0: raise ValueError('Timeout value out of range') else: # Timeout mode - Value converted to milliseconds self._timeout = int(value * 1000) def gettimeout(self): return self._timeout def setsockopt(self, level, optname, value): raise NotImplementedError() @check_closed def shutdown(self, how): return self.close() class NpipeFileIOBase(io.RawIOBase): def __init__(self, npipe_socket): self.sock = npipe_socket def close(self): super().close() self.sock = None def fileno(self): return self.sock.fileno() def isatty(self): return False def readable(self): return True def readinto(self, buf): return self.sock.recv_into(buf) def seekable(self): return False def writable(self): return False transport/basehttpadapter.py 0000644 00000000711 15027665106 0012334 0 ustar 00 import requests.adapters class BaseHTTPAdapter(requests.adapters.HTTPAdapter): def close(self): super().close() if hasattr(self, 'pools'): self.pools.clear() # Fix for requests 2.32.2+: # https://github.com/psf/requests/commit/c98e4d133ef29c46a9b68cd783087218a8075e05 def get_connection_with_tls_context(self, request, verify, proxies=None, cert=None): return self.get_connection(request.url, proxies) transport/__init__.py 0000644 00000000351 15027665106 0010720 0 ustar 00 from .unixconn import UnixHTTPAdapter try: from .npipeconn import NpipeHTTPAdapter from .npipesocket import NpipeSocket except ImportError: pass try: from .sshconn import SSHHTTPAdapter except ImportError: pass credentials/constants.py 0000644 00000000216 15027665106 0011436 0 ustar 00 PROGRAM_PREFIX = 'docker-credential-' DEFAULT_LINUX_STORE = 'secretservice' DEFAULT_OSX_STORE = 'osxkeychain' DEFAULT_WIN32_STORE = 'wincred' credentials/__pycache__/store.cpython-310.pyc 0000644 00000005622 15027665106 0015123 0 ustar 00 o �h� � @ sV d dl Z d dlZd dlZd dlZd dlZddlmZmZ ddlm Z G dd� d�Z dS )� N� )� constants�errors)�create_environment_dictc @ s> e Zd Zddd�Zdd� Zdd� Zdd � Zd d � Zd d � ZdS )�StoreNc C sH t j| | _t�| j�| _|| _| jdu r"tj| j� d�dd� dS dS )z� Create a store object that acts as an interface to perform the basic operations for storing, retrieving and erasing credentials using `program`. N�' not installed or not available in PATHr )� stacklevel) r �PROGRAM_PREFIX�program�shutil�which�exe� environment�warnings�warn)�selfr r � r �N/usr/local/CyberPanel/lib/python3.10/site-packages/docker/credentials/store.py�__init__ s ��zStore.__init__c C s^ t |t�s |�d�}| �d|�}t�|�d��}|d dkr-|d dkr-t�d| j � ���|S )zt Retrieve credentials for `server`. If no credentials are found, a `StoreError` will be raised. �utf-8�get�Username� �SecretzNo matching credentials in ) � isinstance�bytes�encode�_execute�json�loads�decoder �CredentialsNotFoundr )r �server�data�resultr r r r s �z Store.getc C s$ t �|||d���d�}| �d|�S )z_ Store credentials for `server`. Raises a `StoreError` if an error occurs. )� ServerURLr r r �store)r �dumpsr r )r r" �username�secret� data_inputr r r r& . s �� z Store.storec C s$ t |t�s |�d�}| �d|� dS )z_ Erase credentials for `server`. Raises a `StoreError` if an error occurs. r �eraseN)r r r r )r r" r r r r+ 9 s z Store.erasec C s | � dd�}t�|�d��S )zB List stored credentials. Requires v0.4.0+ of the helper. �listNr )r r r r )r r# r r r r, A s z Store.listc C s� | j d u rt�| j� d���d }t| j�}ztj| j |g||d�}W |S tjy8 } zt� || j�|�d }~w t ya } z |j t j krOt�| j� d��|�t�d|j � d|j � ��|�d }~ww )Nr )�input�envzUnexpected OS error "z ", errno=)r r � StoreErrorr r r � subprocess� check_output�CalledProcessError�process_store_error�OSError�errno�ENOENT�strerror)r �subcmdr* �outputr. �er r r r G s8 � ��� ������zStore._execute)N) �__name__� __module__� __qualname__r r r& r+ r, r r r r r r s r ) r5 r r r0 r r r r �utilsr r r r r r �<module> s credentials/__pycache__/__init__.cpython-310.pyc 0000644 00000000640 15027665106 0015521 0 ustar 00 o �h� � @ s8 d dl mZmZmZmZ d dlmZmZ d dlm Z dS )� )�DEFAULT_LINUX_STORE�DEFAULT_OSX_STORE�DEFAULT_WIN32_STORE�PROGRAM_PREFIX)�CredentialsNotFound� StoreError)�StoreN) � constantsr r r r �errorsr r �storer � r r �Q/usr/local/CyberPanel/lib/python3.10/site-packages/docker/credentials/__init__.py�<module> s credentials/__pycache__/constants.cpython-310.pyc 0000644 00000000510 15027665106 0015772 0 ustar 00 o �h� � @ s d Z dZdZdZdS )zdocker-credential-� secretservice� osxkeychain�wincredN)�PROGRAM_PREFIX�DEFAULT_LINUX_STORE�DEFAULT_OSX_STORE�DEFAULT_WIN32_STORE� r r �R/usr/local/CyberPanel/lib/python3.10/site-packages/docker/credentials/constants.py�<module> s credentials/__pycache__/errors.cpython-310.pyc 0000644 00000001625 15027665106 0015302 0 ustar 00 o �h� � @ s< G d d� de �ZG dd� de�ZG dd� de�Zdd� ZdS ) c @ � e Zd ZdS )� StoreErrorN��__name__� __module__� __qualname__� r r �O/usr/local/CyberPanel/lib/python3.10/site-packages/docker/credentials/errors.pyr � r c @ r )�CredentialsNotFoundNr r r r r r r r c @ r )�InitializationErrorNr r r r r r r r c C s8 | j �d�}d|v rtd|� ��S td|� d|� d��S )Nzutf-8z(credentials not found in native keychainzNo matching credentials in zCredentials store z exited with "z".)�output�decoder r )�cpe�program�messager r r �process_store_error s r N)� RuntimeErrorr r r r r r r r �<module> s credentials/__pycache__/utils.cpython-310.pyc 0000644 00000000702 15027665106 0015121 0 ustar 00 o �h� � @ s d dl Z dd� ZdS )� Nc C s t j�� }|�| p i � |S )zM Create and return a copy of os.environ with the specified overrides )�os�environ�copy�update)� overrides�result� r �N/usr/local/CyberPanel/lib/python3.10/site-packages/docker/credentials/utils.py�create_environment_dict s r )r r r r r r �<module> s credentials/store.py 0000644 00000006276 15027665106 0010572 0 ustar 00 import errno import json import shutil import subprocess import warnings from . import constants, errors from .utils import create_environment_dict class Store: def __init__(self, program, environment=None): """ Create a store object that acts as an interface to perform the basic operations for storing, retrieving and erasing credentials using `program`. """ self.program = constants.PROGRAM_PREFIX + program self.exe = shutil.which(self.program) self.environment = environment if self.exe is None: warnings.warn( f'{self.program} not installed or not available in PATH', stacklevel=1, ) def get(self, server): """ Retrieve credentials for `server`. If no credentials are found, a `StoreError` will be raised. """ if not isinstance(server, bytes): server = server.encode('utf-8') data = self._execute('get', server) result = json.loads(data.decode('utf-8')) # docker-credential-pass will return an object for inexistent servers # whereas other helpers will exit with returncode != 0. For # consistency, if no significant data is returned, # raise CredentialsNotFound if result['Username'] == '' and result['Secret'] == '': raise errors.CredentialsNotFound( f'No matching credentials in {self.program}' ) return result def store(self, server, username, secret): """ Store credentials for `server`. Raises a `StoreError` if an error occurs. """ data_input = json.dumps({ 'ServerURL': server, 'Username': username, 'Secret': secret }).encode('utf-8') return self._execute('store', data_input) def erase(self, server): """ Erase credentials for `server`. Raises a `StoreError` if an error occurs. """ if not isinstance(server, bytes): server = server.encode('utf-8') self._execute('erase', server) def list(self): """ List stored credentials. Requires v0.4.0+ of the helper. """ data = self._execute('list', None) return json.loads(data.decode('utf-8')) def _execute(self, subcmd, data_input): if self.exe is None: raise errors.StoreError( f'{self.program} not installed or not available in PATH' ) output = None env = create_environment_dict(self.environment) try: output = subprocess.check_output( [self.exe, subcmd], input=data_input, env=env, ) except subprocess.CalledProcessError as e: raise errors.process_store_error(e, self.program) from e except OSError as e: if e.errno == errno.ENOENT: raise errors.StoreError( f'{self.program} not installed or not available in PATH' ) from e else: raise errors.StoreError( f'Unexpected OS error "{e.strerror}", errno={e.errno}' ) from e return output credentials/__init__.py 0000644 00000000305 15027665106 0011160 0 ustar 00 from .constants import ( DEFAULT_LINUX_STORE, DEFAULT_OSX_STORE, DEFAULT_WIN32_STORE, PROGRAM_PREFIX, ) from .errors import CredentialsNotFound, StoreError from .store import Store credentials/utils.py 0000644 00000000340 15027665106 0010560 0 ustar 00 import os def create_environment_dict(overrides): """ Create and return a copy of os.environ with the specified overrides """ result = os.environ.copy() result.update(overrides or {}) return result credentials/errors.py 0000644 00000000670 15027665106 0010742 0 ustar 00 class StoreError(RuntimeError): pass class CredentialsNotFound(StoreError): pass class InitializationError(StoreError): pass def process_store_error(cpe, program): message = cpe.output.decode('utf-8') if 'credentials not found in native keychain' in message: return CredentialsNotFound(f'No matching credentials in {program}') return StoreError(f'Credentials store {program} exited with "{message}".') _version.py 0000644 00000000633 15027665106 0006754 0 ustar 00 # file generated by setuptools_scm # don't change, don't track in version control TYPE_CHECKING = False if TYPE_CHECKING: from typing import Tuple, Union VERSION_TUPLE = Tuple[Union[int, str], ...] else: VERSION_TUPLE = object version: str __version__: str __version_tuple__: VERSION_TUPLE version_tuple: VERSION_TUPLE __version__ = version = '7.1.0' __version_tuple__ = version_tuple = (7, 1, 0) api/secret.py 0000644 00000005465 15027665106 0007176 0 ustar 00 import base64 from .. import errors, utils class SecretApiMixin: @utils.minimum_version('1.25') def create_secret(self, name, data, labels=None, driver=None): """ Create a secret Args: name (string): Name of the secret data (bytes): Secret data to be stored labels (dict): A mapping of labels to assign to the secret driver (DriverConfig): A custom driver configuration. If unspecified, the default ``internal`` driver will be used Returns (dict): ID of the newly created secret """ if not isinstance(data, bytes): data = data.encode('utf-8') data = base64.b64encode(data) data = data.decode('ascii') body = { 'Data': data, 'Name': name, 'Labels': labels } if driver is not None: if utils.version_lt(self._version, '1.31'): raise errors.InvalidVersion( 'Secret driver is only available for API version > 1.31' ) body['Driver'] = driver url = self._url('/secrets/create') return self._result( self._post_json(url, data=body), True ) @utils.minimum_version('1.25') @utils.check_resource('id') def inspect_secret(self, id): """ Retrieve secret metadata Args: id (string): Full ID of the secret to inspect Returns (dict): A dictionary of metadata Raises: :py:class:`docker.errors.NotFound` if no secret with that ID exists """ url = self._url('/secrets/{0}', id) return self._result(self._get(url), True) @utils.minimum_version('1.25') @utils.check_resource('id') def remove_secret(self, id): """ Remove a secret Args: id (string): Full ID of the secret to remove Returns (boolean): True if successful Raises: :py:class:`docker.errors.NotFound` if no secret with that ID exists """ url = self._url('/secrets/{0}', id) res = self._delete(url) self._raise_for_status(res) return True @utils.minimum_version('1.25') def secrets(self, filters=None): """ List secrets Args: filters (dict): A map of filters to process on the secrets list. Available filters: ``names`` Returns (list): A list of secrets """ url = self._url('/secrets') params = {} if filters: params['filters'] = utils.convert_filters(filters) return self._result(self._get(url, params=params), True) api/service.py 0000644 00000045417 15027665106 0007352 0 ustar 00 from .. import auth, errors, utils from ..types import ServiceMode def _check_api_features(version, task_template, update_config, endpoint_spec, rollback_config): def raise_version_error(param, min_version): raise errors.InvalidVersion( f'{param} is not supported in API version < {min_version}' ) if update_config is not None: if utils.version_lt(version, '1.25'): if 'MaxFailureRatio' in update_config: raise_version_error('UpdateConfig.max_failure_ratio', '1.25') if 'Monitor' in update_config: raise_version_error('UpdateConfig.monitor', '1.25') if utils.version_lt(version, '1.28'): if update_config.get('FailureAction') == 'rollback': raise_version_error( 'UpdateConfig.failure_action rollback', '1.28' ) if utils.version_lt(version, '1.29'): if 'Order' in update_config: raise_version_error('UpdateConfig.order', '1.29') if rollback_config is not None: if utils.version_lt(version, '1.28'): raise_version_error('rollback_config', '1.28') if utils.version_lt(version, '1.29'): if 'Order' in update_config: raise_version_error('RollbackConfig.order', '1.29') if endpoint_spec is not None: if utils.version_lt(version, '1.32') and 'Ports' in endpoint_spec: if any(p.get('PublishMode') for p in endpoint_spec['Ports']): raise_version_error('EndpointSpec.Ports[].mode', '1.32') if task_template is not None: if 'ForceUpdate' in task_template and utils.version_lt( version, '1.25'): raise_version_error('force_update', '1.25') if task_template.get('Placement'): if utils.version_lt(version, '1.30'): if task_template['Placement'].get('Platforms'): raise_version_error('Placement.platforms', '1.30') if utils.version_lt(version, '1.27'): if task_template['Placement'].get('Preferences'): raise_version_error('Placement.preferences', '1.27') if task_template.get('ContainerSpec'): container_spec = task_template.get('ContainerSpec') if utils.version_lt(version, '1.25'): if container_spec.get('TTY'): raise_version_error('ContainerSpec.tty', '1.25') if container_spec.get('Hostname') is not None: raise_version_error('ContainerSpec.hostname', '1.25') if container_spec.get('Hosts') is not None: raise_version_error('ContainerSpec.hosts', '1.25') if container_spec.get('Groups') is not None: raise_version_error('ContainerSpec.groups', '1.25') if container_spec.get('DNSConfig') is not None: raise_version_error('ContainerSpec.dns_config', '1.25') if container_spec.get('Healthcheck') is not None: raise_version_error('ContainerSpec.healthcheck', '1.25') if utils.version_lt(version, '1.28'): if container_spec.get('ReadOnly') is not None: raise_version_error('ContainerSpec.dns_config', '1.28') if container_spec.get('StopSignal') is not None: raise_version_error('ContainerSpec.stop_signal', '1.28') if utils.version_lt(version, '1.30'): if container_spec.get('Configs') is not None: raise_version_error('ContainerSpec.configs', '1.30') if container_spec.get('Privileges') is not None: raise_version_error('ContainerSpec.privileges', '1.30') if utils.version_lt(version, '1.35'): if container_spec.get('Isolation') is not None: raise_version_error('ContainerSpec.isolation', '1.35') if utils.version_lt(version, '1.38'): if container_spec.get('Init') is not None: raise_version_error('ContainerSpec.init', '1.38') if task_template.get('Resources'): if utils.version_lt(version, '1.32'): if task_template['Resources'].get('GenericResources'): raise_version_error('Resources.generic_resources', '1.32') def _merge_task_template(current, override): merged = current.copy() if override is not None: for ts_key, ts_value in override.items(): if ts_key == 'ContainerSpec': if 'ContainerSpec' not in merged: merged['ContainerSpec'] = {} for cs_key, cs_value in override['ContainerSpec'].items(): if cs_value is not None: merged['ContainerSpec'][cs_key] = cs_value elif ts_value is not None: merged[ts_key] = ts_value return merged class ServiceApiMixin: @utils.minimum_version('1.24') def create_service( self, task_template, name=None, labels=None, mode=None, update_config=None, networks=None, endpoint_config=None, endpoint_spec=None, rollback_config=None ): """ Create a service. Args: task_template (TaskTemplate): Specification of the task to start as part of the new service. name (string): User-defined name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (ServiceMode): Scheduling mode for the service (replicated or global). Defaults to replicated. update_config (UpdateConfig): Specification for the update strategy of the service. Default: ``None`` rollback_config (RollbackConfig): Specification for the rollback strategy of the service. Default: ``None`` networks (:py:class:`list`): List of network names or IDs or :py:class:`~docker.types.NetworkAttachmentConfig` to attach the service to. Default: ``None``. endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. Returns: A dictionary containing an ``ID`` key for the newly created service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ _check_api_features( self._version, task_template, update_config, endpoint_spec, rollback_config ) url = self._url('/services/create') headers = {} image = task_template.get('ContainerSpec', {}).get('Image', None) if image is None: raise errors.DockerException( 'Missing mandatory Image key in ContainerSpec' ) if mode and not isinstance(mode, dict): mode = ServiceMode(mode) registry, repo_name = auth.resolve_repository_name(image) auth_header = auth.get_config_header(self, registry) if auth_header: headers['X-Registry-Auth'] = auth_header if utils.version_lt(self._version, '1.25'): networks = networks or task_template.pop('Networks', None) data = { 'Name': name, 'Labels': labels, 'TaskTemplate': task_template, 'Mode': mode, 'Networks': utils.convert_service_networks(networks), 'EndpointSpec': endpoint_spec } if update_config is not None: data['UpdateConfig'] = update_config if rollback_config is not None: data['RollbackConfig'] = rollback_config return self._result( self._post_json(url, data=data, headers=headers), True ) @utils.minimum_version('1.24') @utils.check_resource('service') def inspect_service(self, service, insert_defaults=None): """ Return information about a service. Args: service (str): Service name or ID. insert_defaults (boolean): If true, default values will be merged into the service inspect output. Returns: (dict): A dictionary of the server-side representation of the service, including all relevant properties. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/services/{0}', service) params = {} if insert_defaults is not None: if utils.version_lt(self._version, '1.29'): raise errors.InvalidVersion( 'insert_defaults is not supported in API version < 1.29' ) params['insertDefaults'] = insert_defaults return self._result(self._get(url, params=params), True) @utils.minimum_version('1.24') @utils.check_resource('task') def inspect_task(self, task): """ Retrieve information about a task. Args: task (str): Task ID Returns: (dict): Information about the task. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/tasks/{0}', task) return self._result(self._get(url), True) @utils.minimum_version('1.24') @utils.check_resource('service') def remove_service(self, service): """ Stop and remove a service. Args: service (str): Service name or ID Returns: ``True`` if successful. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/services/{0}', service) resp = self._delete(url) self._raise_for_status(resp) return True @utils.minimum_version('1.24') def services(self, filters=None, status=None): """ List services. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name`` , ``label`` and ``mode``. Default: ``None``. status (bool): Include the service task count of running and desired tasks. Default: ``None``. Returns: A list of dictionaries containing data about each service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = { 'filters': utils.convert_filters(filters) if filters else None } if status is not None: if utils.version_lt(self._version, '1.41'): raise errors.InvalidVersion( 'status is not supported in API version < 1.41' ) params['status'] = status url = self._url('/services') return self._result(self._get(url, params=params), True) @utils.minimum_version('1.25') @utils.check_resource('service') def service_logs(self, service, details=False, follow=False, stdout=False, stderr=False, since=0, timestamps=False, tail='all', is_tty=None): """ Get log stream for a service. Note: This endpoint works only for services with the ``json-file`` or ``journald`` logging drivers. Args: service (str): ID or name of the service details (bool): Show extra details provided to logs. Default: ``False`` follow (bool): Keep connection open to read logs as they are sent by the Engine. Default: ``False`` stdout (bool): Return logs from ``stdout``. Default: ``False`` stderr (bool): Return logs from ``stderr``. Default: ``False`` since (int): UNIX timestamp for the logs staring point. Default: 0 timestamps (bool): Add timestamps to every log line. tail (string or int): Number of log lines to be returned, counting from the current end of the logs. Specify an integer or ``'all'`` to output all log lines. Default: ``all`` is_tty (bool): Whether the service's :py:class:`ContainerSpec` enables the TTY option. If omitted, the method will query the Engine for the information, causing an additional roundtrip. Returns (generator): Logs for the service. """ params = { 'details': details, 'follow': follow, 'stdout': stdout, 'stderr': stderr, 'since': since, 'timestamps': timestamps, 'tail': tail } url = self._url('/services/{0}/logs', service) res = self._get(url, params=params, stream=True) if is_tty is None: is_tty = self.inspect_service( service )['Spec']['TaskTemplate']['ContainerSpec'].get('TTY', False) return self._get_result_tty(True, res, is_tty) @utils.minimum_version('1.24') def tasks(self, filters=None): """ Retrieve a list of tasks. Args: filters (dict): A map of filters to process on the tasks list. Valid filters: ``id``, ``name``, ``service``, ``node``, ``label`` and ``desired-state``. Returns: (:py:class:`list`): List of task dictionaries. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = { 'filters': utils.convert_filters(filters) if filters else None } url = self._url('/tasks') return self._result(self._get(url, params=params), True) @utils.minimum_version('1.24') @utils.check_resource('service') def update_service(self, service, version, task_template=None, name=None, labels=None, mode=None, update_config=None, networks=None, endpoint_config=None, endpoint_spec=None, fetch_current_spec=False, rollback_config=None): """ Update a service. Args: service (string): A service identifier (either its name or service ID). version (int): The version number of the service object being updated. This is required to avoid conflicting writes. task_template (TaskTemplate): Specification of the updated task to start as part of the service. name (string): New name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (ServiceMode): Scheduling mode for the service (replicated or global). Defaults to replicated. update_config (UpdateConfig): Specification for the update strategy of the service. Default: ``None``. rollback_config (RollbackConfig): Specification for the rollback strategy of the service. Default: ``None`` networks (:py:class:`list`): List of network names or IDs or :py:class:`~docker.types.NetworkAttachmentConfig` to attach the service to. Default: ``None``. endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. fetch_current_spec (boolean): Use the undefined settings from the current specification of the service. Default: ``False`` Returns: A dictionary containing a ``Warnings`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ _check_api_features( self._version, task_template, update_config, endpoint_spec, rollback_config ) if fetch_current_spec: inspect_defaults = True if utils.version_lt(self._version, '1.29'): inspect_defaults = None current = self.inspect_service( service, insert_defaults=inspect_defaults )['Spec'] else: current = {} url = self._url('/services/{0}/update', service) data = {} headers = {} data['Name'] = current.get('Name') if name is None else name data['Labels'] = current.get('Labels') if labels is None else labels if mode is not None: if not isinstance(mode, dict): mode = ServiceMode(mode) data['Mode'] = mode else: data['Mode'] = current.get('Mode') data['TaskTemplate'] = _merge_task_template( current.get('TaskTemplate', {}), task_template ) container_spec = data['TaskTemplate'].get('ContainerSpec', {}) image = container_spec.get('Image', None) if image is not None: registry, repo_name = auth.resolve_repository_name(image) auth_header = auth.get_config_header(self, registry) if auth_header: headers['X-Registry-Auth'] = auth_header if update_config is not None: data['UpdateConfig'] = update_config else: data['UpdateConfig'] = current.get('UpdateConfig') if rollback_config is not None: data['RollbackConfig'] = rollback_config else: data['RollbackConfig'] = current.get('RollbackConfig') if networks is not None: converted_networks = utils.convert_service_networks(networks) if utils.version_lt(self._version, '1.25'): data['Networks'] = converted_networks else: data['TaskTemplate']['Networks'] = converted_networks elif utils.version_lt(self._version, '1.25'): data['Networks'] = current.get('Networks') elif data['TaskTemplate'].get('Networks') is None: current_task_template = current.get('TaskTemplate', {}) current_networks = current_task_template.get('Networks') if current_networks is None: current_networks = current.get('Networks') if current_networks is not None: data['TaskTemplate']['Networks'] = current_networks if endpoint_spec is not None: data['EndpointSpec'] = endpoint_spec else: data['EndpointSpec'] = current.get('EndpointSpec') resp = self._post_json( url, data=data, params={'version': version}, headers=headers ) return self._result(resp, json=True) api/swarm.py 0000644 00000043251 15027665106 0007035 0 ustar 00 import http.client as http_client import logging from .. import errors, types, utils from ..constants import DEFAULT_SWARM_ADDR_POOL, DEFAULT_SWARM_SUBNET_SIZE log = logging.getLogger(__name__) class SwarmApiMixin: def create_swarm_spec(self, *args, **kwargs): """ Create a :py:class:`docker.types.SwarmSpec` instance that can be used as the ``swarm_spec`` argument in :py:meth:`~docker.api.swarm.SwarmApiMixin.init_swarm`. Args: task_history_retention_limit (int): Maximum number of tasks history stored. snapshot_interval (int): Number of logs entries between snapshot. keep_old_snapshots (int): Number of snapshots to keep beyond the current snapshot. log_entries_for_slow_followers (int): Number of log entries to keep around to sync up slow followers after a snapshot is created. heartbeat_tick (int): Amount of ticks (in seconds) between each heartbeat. election_tick (int): Amount of ticks (in seconds) needed without a leader to trigger a new election. dispatcher_heartbeat_period (int): The delay for an agent to send a heartbeat to the dispatcher. node_cert_expiry (int): Automatic expiry for nodes certificates. external_cas (:py:class:`list`): Configuration for forwarding signing requests to an external certificate authority. Use a list of :py:class:`docker.types.SwarmExternalCA`. name (string): Swarm's name labels (dict): User-defined key/value metadata. signing_ca_cert (str): The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. signing_ca_key (str): The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. ca_force_rotate (int): An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified. autolock_managers (boolean): If set, generate a key and use it to lock data stored on the managers. log_driver (DriverConfig): The default log driver to use for tasks created in the orchestrator. Returns: :py:class:`docker.types.SwarmSpec` Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> spec = client.api.create_swarm_spec( snapshot_interval=5000, log_entries_for_slow_followers=1200 ) >>> client.api.init_swarm( advertise_addr='eth0', listen_addr='0.0.0.0:5000', force_new_cluster=False, swarm_spec=spec ) """ ext_ca = kwargs.pop('external_ca', None) if ext_ca: kwargs['external_cas'] = [ext_ca] return types.SwarmSpec(self._version, *args, **kwargs) @utils.minimum_version('1.24') def get_unlock_key(self): """ Get the unlock key for this Swarm manager. Returns: A ``dict`` containing an ``UnlockKey`` member """ return self._result(self._get(self._url('/swarm/unlockkey')), True) @utils.minimum_version('1.24') def init_swarm(self, advertise_addr=None, listen_addr='0.0.0.0:2377', force_new_cluster=False, swarm_spec=None, default_addr_pool=None, subnet_size=None, data_path_addr=None, data_path_port=None): """ Initialize a new Swarm using the current connected engine as the first node. Args: advertise_addr (string): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If ``advertise_addr`` is not specified, it will be automatically detected when possible. Default: None listen_addr (string): Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the default swarm listening port is used. Default: '0.0.0.0:2377' force_new_cluster (bool): Force creating a new Swarm, even if already part of one. Default: False swarm_spec (dict): Configuration settings of the new Swarm. Use ``APIClient.create_swarm_spec`` to generate a valid configuration. Default: None default_addr_pool (list of strings): Default Address Pool specifies default subnet pools for global scope networks. Each pool should be specified as a CIDR block, like '10.0.0.0/8'. Default: None subnet_size (int): SubnetSize specifies the subnet size of the networks created from the default subnet pool. Default: None data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. data_path_port (int): Port number to use for data path traffic. Acceptable port range is 1024 to 49151. If set to ``None`` or 0, the default port 4789 will be used. Default: None Returns: (str): The ID of the created node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/swarm/init') if swarm_spec is not None and not isinstance(swarm_spec, dict): raise TypeError('swarm_spec must be a dictionary') if default_addr_pool is not None: if utils.version_lt(self._version, '1.39'): raise errors.InvalidVersion( 'Address pool is only available for API version >= 1.39' ) # subnet_size becomes 0 if not set with default_addr_pool if subnet_size is None: subnet_size = DEFAULT_SWARM_SUBNET_SIZE if subnet_size is not None: if utils.version_lt(self._version, '1.39'): raise errors.InvalidVersion( 'Subnet size is only available for API version >= 1.39' ) # subnet_size is ignored if set without default_addr_pool if default_addr_pool is None: default_addr_pool = DEFAULT_SWARM_ADDR_POOL data = { 'AdvertiseAddr': advertise_addr, 'ListenAddr': listen_addr, 'DefaultAddrPool': default_addr_pool, 'SubnetSize': subnet_size, 'ForceNewCluster': force_new_cluster, 'Spec': swarm_spec, } if data_path_addr is not None: if utils.version_lt(self._version, '1.30'): raise errors.InvalidVersion( 'Data address path is only available for ' 'API version >= 1.30' ) data['DataPathAddr'] = data_path_addr if data_path_port is not None: if utils.version_lt(self._version, '1.40'): raise errors.InvalidVersion( 'Data path port is only available for ' 'API version >= 1.40' ) data['DataPathPort'] = data_path_port response = self._post_json(url, data=data) return self._result(response, json=True) @utils.minimum_version('1.24') def inspect_swarm(self): """ Retrieve low-level information about the current swarm. Returns: A dictionary containing data about the swarm. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/swarm') return self._result(self._get(url), True) @utils.check_resource('node_id') @utils.minimum_version('1.24') def inspect_node(self, node_id): """ Retrieve low-level information about a swarm node Args: node_id (string): ID of the node to be inspected. Returns: A dictionary containing data about this node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/nodes/{0}', node_id) return self._result(self._get(url), True) @utils.minimum_version('1.24') def join_swarm(self, remote_addrs, join_token, listen_addr='0.0.0.0:2377', advertise_addr=None, data_path_addr=None): """ Make this Engine join a swarm that has already been created. Args: remote_addrs (:py:class:`list`): Addresses of one or more manager nodes already participating in the Swarm to join. join_token (string): Secret token for joining this Swarm. listen_addr (string): Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). Default: ``'0.0.0.0:2377`` advertise_addr (string): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If AdvertiseAddr is not specified, it will be automatically detected when possible. Default: ``None`` data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ data = { 'RemoteAddrs': remote_addrs, 'ListenAddr': listen_addr, 'JoinToken': join_token, 'AdvertiseAddr': advertise_addr, } if data_path_addr is not None: if utils.version_lt(self._version, '1.30'): raise errors.InvalidVersion( 'Data address path is only available for ' 'API version >= 1.30' ) data['DataPathAddr'] = data_path_addr url = self._url('/swarm/join') response = self._post_json(url, data=data) self._raise_for_status(response) return True @utils.minimum_version('1.24') def leave_swarm(self, force=False): """ Leave a swarm. Args: force (bool): Leave the swarm even if this node is a manager. Default: ``False`` Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/swarm/leave') response = self._post(url, params={'force': force}) # Ignore "this node is not part of a swarm" error if force and response.status_code == http_client.NOT_ACCEPTABLE: return True # FIXME: Temporary workaround for 1.13.0-rc bug # https://github.com/docker/docker/issues/29192 if force and response.status_code == http_client.SERVICE_UNAVAILABLE: return True self._raise_for_status(response) return True @utils.minimum_version('1.24') def nodes(self, filters=None): """ List swarm nodes. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name``, ``membership`` and ``role``. Default: ``None`` Returns: A list of dictionaries containing data about each swarm node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/nodes') params = {} if filters: params['filters'] = utils.convert_filters(filters) return self._result(self._get(url, params=params), True) @utils.check_resource('node_id') @utils.minimum_version('1.24') def remove_node(self, node_id, force=False): """ Remove a node from the swarm. Args: node_id (string): ID of the node to be removed. force (bool): Force remove an active node. Default: `False` Raises: :py:class:`docker.errors.NotFound` If the node referenced doesn't exist in the swarm. :py:class:`docker.errors.APIError` If the server returns an error. Returns: `True` if the request was successful. """ url = self._url('/nodes/{0}', node_id) params = { 'force': force } res = self._delete(url, params=params) self._raise_for_status(res) return True @utils.minimum_version('1.24') def unlock_swarm(self, key): """ Unlock a locked swarm. Args: key (string): The unlock key as provided by :py:meth:`get_unlock_key` Raises: :py:class:`docker.errors.InvalidArgument` If the key argument is in an incompatible format :py:class:`docker.errors.APIError` If the server returns an error. Returns: `True` if the request was successful. Example: >>> key = client.api.get_unlock_key() >>> client.unlock_swarm(key) """ if isinstance(key, dict): if 'UnlockKey' not in key: raise errors.InvalidArgument('Invalid unlock key format') else: key = {'UnlockKey': key} url = self._url('/swarm/unlock') res = self._post_json(url, data=key) self._raise_for_status(res) return True @utils.minimum_version('1.24') def update_node(self, node_id, version, node_spec=None): """ Update the node's configuration Args: node_id (string): ID of the node to be updated. version (int): The version number of the node object being updated. This is required to avoid conflicting writes. node_spec (dict): Configuration settings to update. Any values not provided will be removed. Default: ``None`` Returns: `True` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> node_spec = {'Availability': 'active', 'Name': 'node-name', 'Role': 'manager', 'Labels': {'foo': 'bar'} } >>> client.api.update_node(node_id='24ifsmvkjbyhk', version=8, node_spec=node_spec) """ url = self._url('/nodes/{0}/update?version={1}', node_id, str(version)) res = self._post_json(url, data=node_spec) self._raise_for_status(res) return True @utils.minimum_version('1.24') def update_swarm(self, version, swarm_spec=None, rotate_worker_token=False, rotate_manager_token=False, rotate_manager_unlock_key=False): """ Update the Swarm's configuration Args: version (int): The version number of the swarm object being updated. This is required to avoid conflicting writes. swarm_spec (dict): Configuration settings to update. Use :py:meth:`~docker.api.swarm.SwarmApiMixin.create_swarm_spec` to generate a valid configuration. Default: ``None``. rotate_worker_token (bool): Rotate the worker join token. Default: ``False``. rotate_manager_token (bool): Rotate the manager join token. Default: ``False``. rotate_manager_unlock_key (bool): Rotate the manager unlock key. Default: ``False``. Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/swarm/update') params = { 'rotateWorkerToken': rotate_worker_token, 'rotateManagerToken': rotate_manager_token, 'version': version } if rotate_manager_unlock_key: if utils.version_lt(self._version, '1.25'): raise errors.InvalidVersion( 'Rotate manager unlock key ' 'is only available for API version >= 1.25' ) params['rotateManagerUnlockKey'] = rotate_manager_unlock_key response = self._post_json(url, data=swarm_spec, params=params) self._raise_for_status(response) return True api/__pycache__/network.cpython-310.pyc 0000644 00000022157 15027665106 0013736 0 ustar 00 o �h�) � @ s> d dl mZ d dlmZ d dlmZmZmZ G dd� d�ZdS )� )�utils)�InvalidVersion)�check_resource�minimum_version� version_ltc @ s� e Zd Zddd�Z ddd�Zed�ddd ��Zed �d d � �Zed �dd d��Z ed� ddd��Z ed� ddd��Z dS )�NetworkApiMixinNc C sX |du ri }|r ||d< |r||d< dt �|�i}| �d�}| j||d�}| j|dd�S ) a� List networks. Similar to the ``docker network ls`` command. Args: names (:py:class:`list`): List of names to filter by ids (:py:class:`list`): List of ids to filter by filters (dict): Filters to be processed on the network list. Available filters: - ``driver=[<driver-name>]`` Matches a network's driver. - ``label=[<key>]``, ``label=[<key>=<value>]`` or a list of such. - ``type=["custom"|"builtin"]`` Filters networks by type. Returns: (dict): List of network objects. Raises: :py:class:`docker.errors.APIError` If the server returns an error. N�name�id�filtersz /networks��paramsT��json)r �convert_filters�_url�_get�_result)�self�names�idsr r �url�res� r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/network.py�networks s zNetworkApiMixin.networksFc C s2 |dur t |t�s td��|||||d�} |dur0t| jd�r#td��t |t�s,td��|| d< |r@t| jd�r<td��d | d < |rPt| jd �rLtd ��d | d < | durbt| jd�r^td��| | d< | durtt| jd�rptd��| | d< | dur�t| jd�r�td��| | d< | �d�} | j| | d�}| j|d d�S )a� Create a network. Similar to the ``docker network create``. Args: name (str): Name of the network driver (str): Name of the driver used to create the network options (dict): Driver options as a key-value dictionary ipam (IPAMConfig): Optional custom IP scheme for the network. check_duplicate (bool): Request daemon to check for networks with same name. Default: ``None``. internal (bool): Restrict external access to the network. Default ``False``. labels (dict): Map of labels to set on the network. Default ``None``. enable_ipv6 (bool): Enable IPv6 on the network. Default ``False``. attachable (bool): If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network. scope (str): Specify the network's scope (``local``, ``global`` or ``swarm``) ingress (bool): If set, create an ingress network which provides the routing-mesh in swarm mode. Returns: (dict): The created network reference object Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: A network using the bridge driver: >>> client.api.create_network("network1", driver="bridge") You can also create more advanced networks with custom IPAM configurations. For example, setting the subnet to ``192.168.52.0/24`` and gateway address to ``192.168.52.254``. .. code-block:: python >>> ipam_pool = docker.types.IPAMPool( subnet='192.168.52.0/24', gateway='192.168.52.254' ) >>> ipam_config = docker.types.IPAMConfig( pool_configs=[ipam_pool] ) >>> client.api.create_network("network1", driver="bridge", ipam=ipam_config) Nz options must be a dictionary)�Name�Driver�Options�IPAM�CheckDuplicatez1.23z*network labels were introduced in API 1.23zlabels must be a dictionary�Labelsz&enable_ipv6 was introduced in API 1.23T� EnableIPv6�1.22z9Internal networks are not supported in API version < 1.22�Internalz1.24z1attachable is not supported in API version < 1.24� Attachablez1.29z.ingress is not supported in API version < 1.29�Ingressz1.30z,scope is not supported in API version < 1.30�Scopez/networks/create��datar ) � isinstance�dict� TypeErrorr �_versionr r � _post_jsonr )r r �driver�options�ipam�check_duplicate�internal�labels� enable_ipv6� attachable�scope�ingressr( r r r r r �create_network( s^ 7� � � � � � z NetworkApiMixin.create_networkz1.25c C s6 i }|r t �|�|d< | �d�}| �| j||d�d�S )a� Delete unused networks Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted network names and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. r z/networks/pruner T)r r r r �_post)r r r r r r r �prune_networks� s z NetworkApiMixin.prune_networks�net_idc C s$ | � d|�}| �|�}| �|� dS )z� Remove a network. Similar to the ``docker network rm`` command. Args: net_id (str): The network's id � /networks/{0}N)r �_delete�_raise_for_status)r r; r r r r r �remove_network� s z NetworkApiMixin.remove_networkc C st i }|durt | jd�rtd��||d< |dur&t | jd�r"td��||d< | �d|�}| j||d �}| j|d d �S ) aD Get detailed information about a network. Args: net_id (str): ID of network verbose (bool): Show the service details across the cluster in swarm mode. scope (str): Filter the network by scope (``swarm``, ``global`` or ``local``). Nz1.28z"verbose was introduced in API 1.28�verbosez1.31z scope was introduced in API 1.31r6 r< r Tr )r r, r r r r )r r; r@ r6 r r r r r r �inspect_network� s z NetworkApiMixin.inspect_network� containerc C sF || j ||||||| d�d�} | �d|�} | j| | d�} | �| � dS )aF Connect a container to a network. Args: container (str): container-id/name to be connected to the network net_id (str): network id aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. links (:py:class:`list`): A list of links for this endpoint. Containers declared in this list will be linked to this container. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. mac_address (str): The MAC address of this container on the network. Defaults to ``None``. )�aliases�links� ipv4_address� ipv6_address�link_local_ips� driver_opt� mac_address)� Container�EndpointConfigz/networks/{0}/connectr' N)�create_endpoint_configr r- r> ) r rB r; rE rF rC rD rG rH rI r( r r r r r � connect_container_to_network� s �� z,NetworkApiMixin.connect_container_to_networkc C sP d|i}|rt | jd�rtd��||d< | �d|�}| j||d�}| �|� dS )aA Disconnect a container from a network. Args: container (str): container ID or name to be disconnected from the network net_id (str): network ID force (bool): Force the container to disconnect from a network. Default: ``False`` rJ r" z,Forced disconnect was introduced in API 1.22�Forcez/networks/{0}/disconnectr' N)r r, r r r- r> )r rB r; �forcer( r r r r r �!disconnect_container_from_network� s � z1NetworkApiMixin.disconnect_container_from_network)NNN) NNNNFNFNNN)N)NN)NNNNNNN)F) �__name__� __module__� __qualname__r r8 r r: r r? rA rM rP r r r r r s, ! �r �(�r N)� r �errorsr r r r r r r r r �<module> s api/__pycache__/__init__.cpython-310.pyc 0000644 00000000316 15027665106 0013775 0 ustar 00 o �h � @ s d dl mZ dS )� )� APIClientN)�clientr � r r �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/__init__.py�<module> s api/__pycache__/client.cpython-310.pyc 0000644 00000035514 15027665106 0013524 0 ustar 00 o �h�K � @ s� d dl Z d dlZd dlZd dlmZ d dlZd dlZd dlZddlm Z ddl m Z m Z m Z mZmZmZmZmZ ddlmZmZmZmZ ddlmZ ddlmZ dd l m Z m Z m Z m Z dd l m!Z! dd l"m#Z# dd l$m%Z%m&Z&m'Z' d dl(m)Z) d dl m*Z* d dl+m,Z, d dl-m.Z. d dl/m0Z0 d dl1m2Z2 d dl3m4Z4 d dl5m6Z6 d dl7m8Z8 d dl9m:Z: d dl;m<Z< d dl=m>Z> zddlm?Z? W n e@y� Y nw zddlmAZA W n e@y� Y nw G d d � d ejBe)e*e,e.e0e2e4e6e8e:e<e>�ZCdS ) � N)�partial� )�auth)�DEFAULT_MAX_POOL_SIZE�DEFAULT_NUM_POOLS�DEFAULT_NUM_POOLS_SSH�DEFAULT_TIMEOUT_SECONDS�DEFAULT_USER_AGENT�IS_WINDOWS_PLATFORM�MINIMUM_DOCKER_API_VERSION�STREAM_HEADER_SIZE_BYTES)�DockerException�InvalidVersion�TLSParameterError�$create_api_error_from_http_exception)� TLSConfig)�UnixHTTPAdapter)�check_resource�config�update_headers�utils)� json_stream)� ProxyConfig)�consume_socket_output� demux_adaptor� frames_iter� )� BuildApiMixin)�ConfigApiMixin)�ContainerApiMixin)�DaemonApiMixin)� ExecApiMixin)� ImageApiMixin)�NetworkApiMixin)�PluginApiMixin)�SecretApiMixin)�ServiceApiMixin)� SwarmApiMixin)�VolumeApiMixin)�NpipeHTTPAdapter)�SSHHTTPAdapterc sR e Zd ZdZejjg d� Zddededdde f � fdd� Z dd� Z d d � Z e d d � �Ze d d� �Ze dd� �Ze dd� �Zdd� Zdd� Zd@dd�Zdd� ZdAdd �Zed �dAd d ��Zd d!� Zd"d#� ZdBd$d%�Zd&d'� Z d(d)� Z dCd,d-�Z dDd.d/�Z d0d1� Z ed �d2d3� �Z!d4d5� Z"d6d7� Z#d8d9� Z$� fd:d;�Z%e&d<d=� �Z'dAd>d?�Z(� Z)S )E� APIClientaW A low-level client for the Docker Engine API. Example: >>> import docker >>> client = docker.APIClient(base_url='unix://var/run/docker.sock') >>> client.version() {u'ApiVersion': u'1.33', u'Arch': u'amd64', u'BuildTime': u'2017-11-19T18:46:37.000000000+00:00', u'GitCommit': u'f4ffd2511c', u'GoVersion': u'go1.9.2', u'KernelVersion': u'4.14.3-1-ARCH', u'MinAPIVersion': u'1.12', u'Os': u'linux', u'Version': u'17.10.0-ce'} Args: base_url (str): URL to the Docker server. For example, ``unix:///var/run/docker.sock`` or ``tcp://127.0.0.1:1234``. version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``1.35`` timeout (int): Default timeout for API calls, in seconds. tls (bool or :py:class:`~docker.tls.TLSConfig`): Enable TLS. Pass ``True`` to enable it with default options, or pass a :py:class:`~docker.tls.TLSConfig` object to use custom configuration. user_agent (str): Set a custom user agent for requests to the server. credstore_env (dict): Override environment variables when calling the credential store process. use_ssh_client (bool): If set to `True`, an ssh connection is made via shelling out to the ssh client. Ensure the ssh client is installed and configured on the host. max_pool_size (int): The maximum number of connections to save in the pool. )� _auth_configs�_general_configs�_version�base_url�timeoutNFc s� t � �� |r |s td��|| _|| _|| jd< t�� | _| j� di �} z| | } W n t y9 | � di �} Y nw t � | �| _ tj| j|d�| _|| _tj|tt|�d�}|�d�r_|p^tnt}|�d�r�t|||| d �| _| �d | j� | � d d � d | _n�|�d�r�ts�t d��z t |||| d �| _W n t y� } zt d�| �d } ~ ww | �d | j� d| _nT|�d�r�z t |||| |d�| _W n t y� } zt d�| �d } ~ ww | �d| j� | � d d � d| _n t!|t"�r�|�#| � n|�rt$j%j&|d�| _| �d | j� || _|d u �st!|t'��r |�(� dk�r | �)� | _*n|| _*t!| j*t'��s3t dt+|�j,� ���t�-| j*t.��rCt/dt.� d���d S )Nz5If using TLS, the base_url argument must be provided.z User-Agent�proxies�default)� config_dict� credstore_env)�tlszssh://z http+unix://)�pool_connections� max_pool_sizezhttp+docker://�http://�https://zhttp+docker://localhostznpipe://z2The npipe:// protocol is only supported on Windowsz4Install pypiwin32 package to enable npipe:// support�http+docker://localnpipe)r6 r7 � shell_outz1Install paramiko package to enable ssh:// support�http+docker://ssh)r6 �autoz2Version parameter must be a string or None. Found zAPI versions below z) are no longer supported by this library.)0�super�__init__r r/ r0 �headersr �load_general_configr- �get�KeyErrorr � from_dict�_proxy_configsr � load_configr, r4 r � parse_hostr �bool� startswithr r r �_custom_adapter�mount�_unmountr r) � NameErrorr* � isinstancer �configure_client�requests�adapters� HTTPAdapter�str�lower�_retrieve_server_versionr. �type�__name__� version_ltr r ) �selfr/ �versionr0 r5 � user_agent� num_poolsr4 �use_ssh_clientr7 � proxy_configr1 �err�� __class__� �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/client.pyr? s s� � � � ���� � � ����� ����� � � �� ��zAPIClient.__init__c C s\ z | j dd�d W S ty } ztd�|�d }~w ty- } ztd|� ��|�d }~ww )NF)� api_version� ApiVersionzAInvalid response from docker daemon: key "ApiVersion" is missing.z)Error while fetching server API version: )rZ rC r � Exception)rY �ke�erb rb rc rU � s" �������z"APIClient._retrieve_server_versionc C s |� d| j� |S )zjPrepare the kwargs for an HTTP request by inserting the timeout parameter, if not already present.r0 )� setdefaultr0 )rY �kwargsrb rb rc �_set_request_timeout� s z APIClient._set_request_timeoutc K � | j |fi | �|���S �N)�postrk �rY �urlrj rb rb rc �_post� � zAPIClient._postc K rl rm )rB rk ro rb rb rc �_get� rr zAPIClient._getc K rl rm )�putrk ro rb rb rc �_put� rr zAPIClient._putc K rl rm )�deleterk ro rb rb rc �_delete� rr zAPIClient._deletec O s� |D ]}t |t�std|� dt|�� d���qttjjdd�}t||�}|j |� }|� dd�r:| j � d| j � |� �S | j � |� �S ) Nz Expected a string but found z (z ) insteadz/:)�safe� versioned_apiTz/v) rN rS � ValueErrorrV r �urllib�parse�quote�map�formatrB r/ r. )rY �pathfmt�argsrj �arg�quote_f�formatted_pathrb rb rc �_url s �� zAPIClient._urlc C s6 z|� � W dS tjjy } zt|�|�d}~ww )z1Raises stored :class:`APIError`, if one occurred.N)�raise_for_statusrP � exceptions� HTTPErrorr )rY �responserh rb rb rc �_raise_for_status s ��zAPIClient._raise_for_statusc C s2 |r|rJ �| � |� |r|�� S |r|jS |jS rm )r� �json�content�text)rY r� r� �binaryrb rb rc �_result s zAPIClient._resultc K s� i }|d ur t |t�r t|�� �D ] \}}|d ur |||< qn|d ur%|}d|vr-i |d< d|d d< | j|fdt�|�i|��S )Nr@ zapplication/jsonz Content-Type�data)rN �dict�iter�itemsrq r� �dumps)rY rp r� rj �data2�k�vrb rb rc � _post_json! s �� zAPIClient._post_jsonc C s |pdddd�S )Nr )�stdout�stderr�streamrb )rY �overriderb rb rc �_attach_params1 s �zAPIClient._attach_params� containerc C sR | � d|�}tjd|| �|�d�}|�� j}|�ddd�}|�ddd�}| �|�S ) Nz/containers/{0}/attach/ws�POST)�paramsr8 zws://r r9 zwss://)r� rP �Requestr� �preparerp �replace� _create_websocket_connection)rY r� r� rp �req�full_urlrb rb rc �_attach_websocket8 s zAPIClient._attach_websocketc C s8 z dd l }|�|�W S ty } ztd�|�d }~ww )Nr z�The `websocket-client` library is required for using websocket connections. You can install the `docker` library with the [websocket] extra to install it.)� websocket�create_connection� ImportErrorr )rY rp r� �ierb rb rc r� A s ����z&APIClient._create_websocket_connectionc C s~ | � |� | jdkr|jjjjj}n | j�d�r |jjjj}n|jjjj}| j�d�r.|j}z||_ W |S t y> Y |S w )Nr: r< r9 ) r� r/ �raw�_fp�fp�sockrI �channel�_sock� _response�AttributeError)rY r� r� rb rb rc �_get_raw_response_socketM s ��z"APIClient._get_raw_response_socketc c s� � |j jjr;|rt| �|d��E dH dS |j }|js9|�d�}|s$dS |jjr1||�|jj�7 }|V |jrdS dS | j||d�V dS )z?Generator for data coming from a chunked-encoded HTTP response.FNr )r� ) r� r� �chunkedr �_stream_helper�closed�read� chunk_leftr� )rY r� �decode�readerr� rb rb rc r� c s � � zAPIClient._stream_helperc c sr � | j |dd�}t|�}d} || tk rdS |||t � }t�d|�\}}|t }|| } | }||| � V q)zMA generator of multiplexed data blocks read from a buffered response.T�r� r �>BxxxLN)r� �lenr �struct� unpack_from) rY r� �buf� buf_length�walker�header�_�length�start�endrb rb rc �_multiplexed_buffer_helperx s � �z$APIClient._multiplexed_buffer_helperc c s^ � | � |�}| �|� |j�t�}|sdS t�d|�\}}|s!q |j�|�}|s+dS |V q )zMA generator of multiplexed data blocks coming from a response stream.Tr� N)r� �_disable_socket_timeoutr� r� r r� �unpack)rY r� �socketr� r� r� r� rb rb rc �#_multiplexed_response_stream_helper� s � �z-APIClient._multiplexed_response_stream_helperr Tc c s6 � | � |� | �|�}| �|� |�||�E dH dS )z< Stream result for TTY-enabled container and raw binary dataN)r� r� r� � iter_content)rY r� � chunk_sizer� r� rb rb rc �_stream_raw_result� s � z APIClient._stream_raw_resultc C s` | � |�}t||�}|rdd� |D �}ndd� |D �}|r |S z t||d�W |�� S |�� w )z�Consume all data from the socket, close the response and return the data. If stream=True, then a generator is returned instead and the caller is responsible for closing the response. c s s � | ]}t |� V qd S rm )r )�.0�framerb rb rc � <genexpr>� � � z.APIClient._read_from_socket.<locals>.<genexpr>c s s � | ]\}}|V qd S rm rb )r� r� r� rb rb rc r� � r� )�demux)r� r r �close)rY r� r� �ttyr� r� �genrb rb rc �_read_from_socket� s zAPIClient._read_from_socketc C s\ |t |dd�g}|D ]!}t|d�sq d}t|d�r |�� }|du s%|dkr&q |�d� q dS )a Depending on the combination of python version and whether we're connecting over http or https, we might need to access _sock, which may or may not exist; or we may need to just settimeout on socket itself, which also may or may not have settimeout on it. To avoid missing the correct one, we try both. We also do not want to set the timeout if it is already disabled, as you run the risk of changing a socket that was non-blocking to blocking, for example when using gevent. r� N� settimeout���� gettimeoutg )�getattr�hasattrr� r� )rY r� �sockets�sr0 rb rb rc r� � s �z!APIClient._disable_socket_timeoutc C s | � |�}|d d S )N�Config�Tty)�inspect_container)rY r� �contrb rb rc � _check_is_tty� s zAPIClient._check_is_ttyc C s | � ||| �|��S rm )�_get_result_ttyr� )rY r� r� �resrb rb rc � _get_result� s zAPIClient._get_resultc C sP |r|r | � |�S | j|dd�S | �|� d}|r | �|�S |�t| �|���S )NTr� � )r� r� r� r� �join�listr� )rY r� r� �is_tty�seprb rb rc r� � s � �zAPIClient._get_result_ttyc G s |D ]}| j �|� qd S rm )rQ �pop)rY r� �protorb rb rc rL � s �zAPIClient._unmountc sH zt � �|�W S tjjy# } z| jr | jW Y d }~S |�d }~ww rm )r> � get_adapterrP r� � InvalidSchemarJ )rY rp rh r` rb rc r� � s ��zAPIClient.get_adapterc C s | j S rm )r. )rY rb rb rc rd s zAPIClient.api_versionc C s t j|| jd�| _dS )a. Force a reload of the auth configuration Args: dockercfg_path (str): Use a custom path for the Docker config file (default ``$HOME/.docker/config.json`` if present, otherwise ``$HOME/.dockercfg``) Returns: None )r4 N)r rF r4 r, )rY �dockercfg_pathrb rb rc � reload_config s �zAPIClient.reload_config)FFrm )F)r T)TF)*rW � __module__� __qualname__�__doc__rP �Session� __attrs__r r r r? rU rk r rq rs ru rw r� r� r� r� r� r r� r� r� r� r� r� r� r� r� r� r� r� rL r� �propertyrd r� � __classcell__rb rb r` rc r+ 9 sV &�j r+ )Dr� r� r{ � functoolsr rP �requests.adapters�requests.exceptions� r � constantsr r r r r r r r �errorsr r r r r5 r � transportr r r r r �utils.json_streamr � utils.proxyr � utils.socketr r r �buildr r r� r �daemonr �exec_apir! �imager" �networkr# �pluginr$ �secretr% �servicer& �swarmr' �volumer( r) r� r* r� r+ rb rb rb rc �<module> sj ( � � � api/__pycache__/volume.cpython-310.pyc 0000644 00000012133 15027665106 0013545 0 ustar 00 o �h� � @ s" d dl mZmZ G dd� d�ZdS )� )�errors�utilsc @ sJ e Zd Zddd�Z ddd�Zdd� Ze�d�dd d ��Zdd d �Z dS )�VolumeApiMixinNc C s6 d|rt �|�ndi}| �d�}| �| j||d�d�S )a List volumes currently registered by the docker daemon. Similar to the ``docker volume ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (dict): Dictionary with list of volume objects as value of the ``Volumes`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.volumes() {u'Volumes': [{u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar'}, {u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/baz/_data', u'Name': u'baz'}]} �filtersNz/volumes��paramsT)r �convert_filters�_url�_result�_get��selfr r �url� r �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/volume.py�volumes s � zVolumeApiMixin.volumesc C s� | � d�}|durt|t�std��|||d�}|dur7t�d| j�dk r*t�d��t|t�s3td��||d < | � | j ||d �d �S ) a� Create and register a named volume Args: name (str): Name of the volume driver (str): Name of the driver used to create the volume driver_opts (dict): Driver options as a key-value dictionary labels (dict): Labels to set on the volume Returns: (dict): The created volume reference object Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> volume = client.api.create_volume( ... name='foobar', ... driver='local', ... driver_opts={'foo': 'bar', 'baz': 'false'}, ... labels={"key": "value"}, ... ) ... print(volume) {u'Driver': u'local', u'Labels': {u'key': u'value'}, u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar', u'Scope': u'local'} z/volumes/createNz driver_opts must be a dictionary)�Name�Driver� DriverOptsz1.23� z)volume labels were introduced in API 1.23zlabels must be a dictionary�Labels)�dataT) r � isinstance�dict� TypeErrorr �compare_version�_versionr �InvalidVersionr � _post_json)r �name�driver� driver_opts�labelsr r r r r � create_volume& s "�� z VolumeApiMixin.create_volumec C s | � d|�}| �| �|�d�S )a� Retrieve volume info by name. Args: name (str): volume name Returns: (dict): Volume information dictionary Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.inspect_volume('foobar') {u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar'} � /volumes/{0}T)r r r )r r r r r r �inspect_volume] s z VolumeApiMixin.inspect_volume�1.25c C s6 i }|r t �|�|d< | �d�}| �| j||d�d�S )a� Delete unused volumes Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted volume names and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. r z/volumes/pruner T)r r r r �_postr r r r � prune_volumesv s z VolumeApiMixin.prune_volumesFc C sP i }|rt �| jd�rt�d��d|i}| jd||d�}| �|�}| �|� dS )az Remove a volume. Similar to the ``docker volume rm`` command. Args: name (str): The volume's name force (bool): Force removal of volumes that were already removed out of band by the volume driver plugin. Raises: :py:class:`docker.errors.APIError` If volume failed to remove. r& z(force removal was introduced in API 1.25�forcer$ r N)r � version_ltr r r r �_delete�_raise_for_status)r r r) r r �respr r r � remove_volume� s � z VolumeApiMixin.remove_volume)N)NNNN)F) �__name__� __module__� __qualname__r r# r% r �minimum_versionr( r. r r r r r s ! �7 r N)� r r r r r r r �<module> s api/__pycache__/swarm.cpython-310.pyc 0000644 00000037670 15027665106 0013404 0 ustar 00 o �h�F � @ sT d dl mZ d dlZddlmZmZmZ ddlm Z m Z e� e �Z G dd� d�ZdS )� N� )�errors�types�utils)�DEFAULT_SWARM_ADDR_POOL�DEFAULT_SWARM_SUBNET_SIZEc @ s e Zd Zdd� Ze�d�dd� �Ze�d� d d d ��Ze�d�d d � �Ze� d �e�d�dd� ��Z e�d� d dd��Z e�d�d dd��Z e�d�d!dd��Z e� d �e�d�d dd���Ze�d�dd� �Ze�d�d!dd��Ze�d� d"d d ��ZdS )#� SwarmApiMixinc O s4 |� dd�}|r |g|d< tj| jg|�R i |��S )a^ Create a :py:class:`docker.types.SwarmSpec` instance that can be used as the ``swarm_spec`` argument in :py:meth:`~docker.api.swarm.SwarmApiMixin.init_swarm`. Args: task_history_retention_limit (int): Maximum number of tasks history stored. snapshot_interval (int): Number of logs entries between snapshot. keep_old_snapshots (int): Number of snapshots to keep beyond the current snapshot. log_entries_for_slow_followers (int): Number of log entries to keep around to sync up slow followers after a snapshot is created. heartbeat_tick (int): Amount of ticks (in seconds) between each heartbeat. election_tick (int): Amount of ticks (in seconds) needed without a leader to trigger a new election. dispatcher_heartbeat_period (int): The delay for an agent to send a heartbeat to the dispatcher. node_cert_expiry (int): Automatic expiry for nodes certificates. external_cas (:py:class:`list`): Configuration for forwarding signing requests to an external certificate authority. Use a list of :py:class:`docker.types.SwarmExternalCA`. name (string): Swarm's name labels (dict): User-defined key/value metadata. signing_ca_cert (str): The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. signing_ca_key (str): The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. ca_force_rotate (int): An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified. autolock_managers (boolean): If set, generate a key and use it to lock data stored on the managers. log_driver (DriverConfig): The default log driver to use for tasks created in the orchestrator. Returns: :py:class:`docker.types.SwarmSpec` Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> spec = client.api.create_swarm_spec( snapshot_interval=5000, log_entries_for_slow_followers=1200 ) >>> client.api.init_swarm( advertise_addr='eth0', listen_addr='0.0.0.0:5000', force_new_cluster=False, swarm_spec=spec ) � external_caN� external_cas)�popr � SwarmSpec�_version)�self�args�kwargs�ext_ca� r �F/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/swarm.py�create_swarm_spec s 8 z SwarmApiMixin.create_swarm_specz1.24c C s | � | �| �d��d�S )z� Get the unlock key for this Swarm manager. Returns: A ``dict`` containing an ``UnlockKey`` member z/swarm/unlockkeyT)�_result�_get�_url)r r r r �get_unlock_keyI s z SwarmApiMixin.get_unlock_keyN� 0.0.0.0:2377Fc C s� | � d�} |durt|t�std��|dur(t�| jd�r"t�d��|du r(t }|dur>t�| jd�r8t�d��|du r>t }||||||d�} |dur[t�| jd�rWt�d ��|| d < |durot�| jd �rkt�d ��|| d < | j | | d�} | j | dd�S )a} Initialize a new Swarm using the current connected engine as the first node. Args: advertise_addr (string): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If ``advertise_addr`` is not specified, it will be automatically detected when possible. Default: None listen_addr (string): Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the default swarm listening port is used. Default: '0.0.0.0:2377' force_new_cluster (bool): Force creating a new Swarm, even if already part of one. Default: False swarm_spec (dict): Configuration settings of the new Swarm. Use ``APIClient.create_swarm_spec`` to generate a valid configuration. Default: None default_addr_pool (list of strings): Default Address Pool specifies default subnet pools for global scope networks. Each pool should be specified as a CIDR block, like '10.0.0.0/8'. Default: None subnet_size (int): SubnetSize specifies the subnet size of the networks created from the default subnet pool. Default: None data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. data_path_port (int): Port number to use for data path traffic. Acceptable port range is 1024 to 49151. If set to ``None`` or 0, the default port 4789 will be used. Default: None Returns: (str): The ID of the created node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /swarm/initNz swarm_spec must be a dictionaryz1.39z6Address pool is only available for API version >= 1.39z5Subnet size is only available for API version >= 1.39)� AdvertiseAddr� ListenAddr�DefaultAddrPool� SubnetSize�ForceNewCluster�Spec�1.30�;Data address path is only available for API version >= 1.30� DataPathAddrz1.40z8Data path port is only available for API version >= 1.40� DataPathPort��dataT)�json) r � isinstance�dict� TypeErrorr � version_ltr r �InvalidVersionr r � _post_jsonr ) r �advertise_addr� listen_addr�force_new_cluster� swarm_spec�default_addr_pool� subnet_size�data_path_addr�data_path_port�urlr% �responser r r � init_swarmS sL 1��� ��zSwarmApiMixin.init_swarmc C s | � d�}| �| �|�d�S )a Retrieve low-level information about the current swarm. Returns: A dictionary containing data about the swarm. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/swarmT�r r r )r r5 r r r � inspect_swarm� s zSwarmApiMixin.inspect_swarm�node_idc C s | � d|�}| �| �|�d�S )aL Retrieve low-level information about a swarm node Args: node_id (string): ID of the node to be inspected. Returns: A dictionary containing data about this node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. � /nodes/{0}Tr8 )r r: r5 r r r � inspect_node� s zSwarmApiMixin.inspect_nodec C s\ ||||d�}|durt �| jd�rt�d��||d< | �d�}| j||d�}| �|� dS ) a� Make this Engine join a swarm that has already been created. Args: remote_addrs (:py:class:`list`): Addresses of one or more manager nodes already participating in the Swarm to join. join_token (string): Secret token for joining this Swarm. listen_addr (string): Listen address used for inter-manager communication if the node gets promoted to manager, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). Default: ``'0.0.0.0:2377`` advertise_addr (string): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If AdvertiseAddr is not specified, it will be automatically detected when possible. Default: ``None`` data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )� RemoteAddrsr � JoinTokenr Nr r! r" z /swarm/joinr$ T)r r* r r r+ r r, �_raise_for_status) r � remote_addrs� join_tokenr. r- r3 r% r5 r6 r r r � join_swarm� s �� zSwarmApiMixin.join_swarmc C sR | � d�}| j|d|id�}|r|jtjkrdS |r"|jtjkr"dS | �|� dS )aP Leave a swarm. Args: force (bool): Leave the swarm even if this node is a manager. Default: ``False`` Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /swarm/leave�force��paramsT)r �_post� status_code� http_client�NOT_ACCEPTABLE�SERVICE_UNAVAILABLEr? )r rC r5 r6 r r r � leave_swarm s zSwarmApiMixin.leave_swarmc C s6 | � d�}i }|rt�|�|d< | �| j||d�d�S )a� List swarm nodes. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name``, ``membership`` and ``role``. Default: ``None`` Returns: A list of dictionaries containing data about each swarm node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/nodes�filtersrD T)r r �convert_filtersr r )r rL r5 rE r r r �nodes' s zSwarmApiMixin.nodesc C s0 | � d|�}d|i}| j||d�}| �|� dS )a� Remove a node from the swarm. Args: node_id (string): ID of the node to be removed. force (bool): Force remove an active node. Default: `False` Raises: :py:class:`docker.errors.NotFound` If the node referenced doesn't exist in the swarm. :py:class:`docker.errors.APIError` If the server returns an error. Returns: `True` if the request was successful. r; rC rD T)r �_deleter? )r r: rC r5 rE �resr r r � remove_node? s � zSwarmApiMixin.remove_nodec C sL t |t�rd|vrt�d��nd|i}| �d�}| j||d�}| �|� dS )al Unlock a locked swarm. Args: key (string): The unlock key as provided by :py:meth:`get_unlock_key` Raises: :py:class:`docker.errors.InvalidArgument` If the key argument is in an incompatible format :py:class:`docker.errors.APIError` If the server returns an error. Returns: `True` if the request was successful. Example: >>> key = client.api.get_unlock_key() >>> client.unlock_swarm(key) � UnlockKeyzInvalid unlock key formatz /swarm/unlockr$ T)r' r( r �InvalidArgumentr r, r? )r �keyr5 rP r r r � unlock_swarmZ s � zSwarmApiMixin.unlock_swarmc C s. | � d|t|��}| j||d�}| �|� dS )a� Update the node's configuration Args: node_id (string): ID of the node to be updated. version (int): The version number of the node object being updated. This is required to avoid conflicting writes. node_spec (dict): Configuration settings to update. Any values not provided will be removed. Default: ``None`` Returns: `True` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> node_spec = {'Availability': 'active', 'Name': 'node-name', 'Role': 'manager', 'Labels': {'foo': 'bar'} } >>> client.api.update_node(node_id='24ifsmvkjbyhk', version=8, node_spec=node_spec) z /nodes/{0}/update?version={1}r$ T)r �strr, r? )r r: �version� node_specr5 rP r r r � update_node~ s zSwarmApiMixin.update_nodec C sX | � d�}|||d�}|r t�| jd�rt�d��||d< | j|||d�}| �|� dS )a� Update the Swarm's configuration Args: version (int): The version number of the swarm object being updated. This is required to avoid conflicting writes. swarm_spec (dict): Configuration settings to update. Use :py:meth:`~docker.api.swarm.SwarmApiMixin.create_swarm_spec` to generate a valid configuration. Default: ``None``. rotate_worker_token (bool): Rotate the worker join token. Default: ``False``. rotate_manager_token (bool): Rotate the manager join token. Default: ``False``. rotate_manager_unlock_key (bool): Rotate the manager unlock key. Default: ``False``. Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /swarm/update)�rotateWorkerToken�rotateManagerTokenrW z1.25zCRotate manager unlock key is only available for API version >= 1.25�rotateManagerUnlockKey)r% rE T)r r r* r r r+ r, r? ) r rW r0 �rotate_worker_token�rotate_manager_token�rotate_manager_unlock_keyr5 rE r6 r r r � update_swarm� s �� zSwarmApiMixin.update_swarm)Nr FNNNNN)r NN)F)N)NFFF)�__name__� __module__� __qualname__r r �minimum_versionr r7 r9 �check_resourcer< rB rK rN rQ rU rY r` r r r r r sH = �b �2 # #�r )� http.client�clientrH �logging� r r r � constantsr r � getLoggerra �logr r r r r �<module> s api/__pycache__/plugin.cpython-310.pyc 0000644 00000020735 15027665106 0013543 0 ustar 00 o �h# � @ s" d dl mZmZ G dd� d�ZdS )� )�auth�utilsc @ s e Zd Ze�d�e�d�dd� ��Ze�d�d dd��Ze�d�d dd ��Ze�d�d d d ��Z e�d�d d� �Z e�d�d dd��Z e�d�dd� �Z e�d�dd� �Z e�d�e�d�dd� ��Ze�d�e�d�d dd���Ze�d�e�d�dd � ��ZdS ) �PluginApiMixinz1.25�namec C sH | � d|�}|}t|t�rdd� |�� D �}| j||d�}| �|� dS )aC Configure a plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. options (dict): A key-value mapping of options Returns: ``True`` if successful z/plugins/{0}/setc S s g | ] \}}|� d |� ��qS )�=� )�.0�k�vr r �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/plugin.py� <listcomp> s z3PluginApiMixin.configure_plugin.<locals>.<listcomp>)�dataT)�_url� isinstance�dict�items� _post_json�_raise_for_status)�selfr �options�urlr �resr r r �configure_plugin s z PluginApiMixin.configure_pluginFc C sj | � d�}tj||ttj�|g ��d��}| j|d|i|d�}W d � n1 s)w Y | �|� dS )a* 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: ``True`` if successful z/plugins/create)�root�gzip�filesr )�paramsr NT)r r �create_archive�set�build�walk�_postr )r r �plugin_data_dirr r �archvr r r r � create_plugin s � � z PluginApiMixin.create_pluginc C �, | � d|�}| j|d|id�}| �|� dS )aP Disable an installed plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. force (bool): To enable the force query parameter. Returns: ``True`` if successful z/plugins/{0}/disable�force�r T�r r! r �r r r& r r r r r �disable_plugin5 s z PluginApiMixin.disable_plugin� c C s0 | � d|�}d|i}| j||d�}| �|� dS )aV Enable an installed plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. timeout (int): Operation timeout (in seconds). Default: 0 Returns: ``True`` if successful z/plugins/{0}/enable�timeoutr' Tr( )r r r, r r r r r r � enable_pluginG s z PluginApiMixin.enable_pluginc C s | � d|�}| �| �|�d�S )a Retrieve plugin metadata. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. Returns: A dict containing plugin info z/plugins/{0}/jsonT�r �_result�_get)r r r r r r �inspect_pluginZ s z PluginApiMixin.inspect_pluginNc C st | � d�}d|i}|r||d< i }t�|�\}}t�| |�} | r$| |d< | j||||dd�} | �| � | j| dd�S )a Pull and install a plugin. After the plugin is installed, it can be enabled using :py:meth:`~enable_plugin`. Args: remote (string): Remote reference for the plugin to install. The ``:latest`` tag is optional, and is the default if omitted. privileges (:py:class:`list`): A list of privileges the user consents to grant to the plugin. Can be retrieved using :py:meth:`~plugin_privileges`. name (string): Local name for the pulled plugin. The ``:latest`` tag is optional, and is the default if omitted. Returns: An iterable object streaming the decoded API logs z /plugins/pull�remoter �X-Registry-AuthT�r �headersr �stream��decode�r r �resolve_repository_name�get_config_headerr r �_stream_helper) r r2 � privilegesr r r r5 �registry� repo_name�header�responser r r � pull_plugini s � � zPluginApiMixin.pull_pluginc C s | � d�}| �| �|�d�S )z� Retrieve a list of installed plugins. Returns: A list of dicts, one per plugin z/pluginsTr. )r r r r r �plugins� s zPluginApiMixin.pluginsc C sT d|i}i }t �|�\}}t �| |�}|r||d< | �d�}| �| j|||d�d�S )al Retrieve list of privileges to be granted to a plugin. Args: name (string): Name of the remote plugin to examine. The ``:latest`` tag is optional, and is the default if omitted. Returns: A list of dictionaries representing the plugin's permissions r2 r3 z/plugins/privileges)r r5 T)r r: r; r r/ r0 )r r r r5 r> r? r@ r r r r �plugin_privileges� s � �z PluginApiMixin.plugin_privilegesc C s\ | � d|�}i }t�|�\}}t�| |�}|r||d< | j||d�}| �|� | j|dd�S )a Push a plugin to the registry. Args: name (string): Name of the plugin to upload. The ``:latest`` tag is optional, and is the default if omitted. Returns: ``True`` if successful z/plugins/{0}/pullr3 )r5 Tr7 )r r r: r; r! r r< )r r r r5 r> r? r@ r r r r � push_plugin� s zPluginApiMixin.push_pluginc C r% )a� Remove an installed plugin. Args: name (string): Name of the plugin to remove. The ``:latest`` tag is optional, and is the default if omitted. force (bool): Disable the plugin before removing. This may result in issues if the plugin is in use by a container. Returns: ``True`` if successful z /plugins/{0}r& r' T)r �_deleter r) r r r � remove_plugin� s z PluginApiMixin.remove_pluginz1.26c C sj | � d|�}d|i}i }t�|�\}}t�| |�} | r | |d< | j||||dd�} | �| � | j| dd�S )a� Upgrade an installed plugin. Args: name (string): Name of the plugin to upgrade. The ``:latest`` tag is optional and is the default if omitted. remote (string): Remote reference to upgrade to. The ``:latest`` tag is optional and is the default if omitted. privileges (:py:class:`list`): A list of privileges the user consents to grant to the plugin. Can be retrieved using :py:meth:`~plugin_privileges`. Returns: An iterable object streaming the decoded API logs z/plugins/{0}/upgrader2 r3 Tr4 r7 r9 ) r r r2 r= r r r5 r> r? r@ rA r r r �upgrade_plugin� s � � z PluginApiMixin.upgrade_plugin)F)r+ )N)�__name__� __module__� __qualname__r �minimum_version�check_resourcer r$ r* r- r1 rB rC rD rE rG rH r r r r r s6 % r N)� r r r r r r r �<module> s api/__pycache__/service.cpython-310.pyc 0000644 00000033502 15027665106 0013701 0 ustar 00 o �hK � @ sB d dl mZmZmZ d dlmZ dd� Zdd� ZG dd� d�Zd S ) � )�auth�errors�utils)� ServiceModec C sD dd� }|d urAt �| d�r d|v r|dd� d|v r |dd� t �| d�r2|�d �d kr2|d d� t �| d �rAd |v rA|dd � |d ur_t �| d�rP|dd� t �| d �r_d |v r_|dd � |d ur}t �| d�r}d|v r}tdd� |d D ��r}|dd� |d u�r�d|v r�t �| d�r�|dd� |�d�r�t �| d�r�|d �d�r�|dd� t �| d �r�|d �d �r�|d d � |�d ��r~|�d �}t �| d��r|�d �r�|d!d� |�d"�d ur�|d#d� |�d$�d ur�|d%d� |�d&�d ur�|d'd� |�d(�d u�r|d)d� |�d*�d u�r|d+d� t �| d��r5|�d,�d u�r(|d)d� |�d-�d u�r5|d.d� t �| d��rV|�d/�d u�rI|d0d� |�d1�d u�rV|d2d� t �| d3��rj|�d4�d u�rj|d5d3� t �| d6��r~|�d7�d u�r~|d8d6� |�d9��r�t �| d��r�|d9 �d:��r�|d;d� d S d S d S d S d S )<Nc S s t �| � d|� ���)Nz# is not supported in API version < )r �InvalidVersion)�param� min_version� r �H/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/service.py�raise_version_error s �z0_check_api_features.<locals>.raise_version_error�1.25�MaxFailureRatioz UpdateConfig.max_failure_ratio�MonitorzUpdateConfig.monitorz1.28� FailureAction�rollbackz$UpdateConfig.failure_action rollback�1.29�OrderzUpdateConfig.order�rollback_configzRollbackConfig.orderz1.32�Portsc s s � | ]}|� d �V qdS )� PublishModeN)�get)�.0�pr r r � <genexpr>( s � z&_check_api_features.<locals>.<genexpr>zEndpointSpec.Ports[].mode� ForceUpdate� force_update� Placementz1.30� PlatformszPlacement.platformsz1.27� PreferenceszPlacement.preferences� ContainerSpec�TTYzContainerSpec.tty�HostnamezContainerSpec.hostname�HostszContainerSpec.hosts�GroupszContainerSpec.groups� DNSConfigzContainerSpec.dns_config� HealthcheckzContainerSpec.healthcheck�ReadOnly� StopSignalzContainerSpec.stop_signal�ConfigszContainerSpec.configs� PrivilegeszContainerSpec.privilegesz1.35� IsolationzContainerSpec.isolationz1.38�InitzContainerSpec.init� Resources�GenericResourceszResources.generic_resources)r � version_ltr �any)�version� task_template� update_config� endpoint_specr r �container_specr r r �_check_api_features s� � � �2r5 c C sz | � � }|d ur;|�� D ].\}}|dkr2d|vr i |d< |d �� D ]\}}|d ur0||d |< q"q |d ur:|||< q |S )Nr )�copy�items)�current�override�merged�ts_key�ts_value�cs_key�cs_valuer r r �_merge_task_templatec s ���r? c @ s� e Zd Ze�d� ddd��Ze�d�e�d�ddd���Ze�d�e�d�d d � ��Ze�d�e�d�d d � ��Z e�d�dd d��Z e�d�e�d� d dd���Z e�d�ddd��Z e�d�e�d� d dd���Z dS ) �ServiceApiMixinz1.24Nc C s� t | j|||| � | �d�} i } |�di ��dd�} | du r#t�d��|r.t|t�s.t|�}t � | �\} }t � | | �}|rA|| d< t � | jd�rP|pO|�dd�}||||t �|�|d �}|durd||d < | durl| |d < | �| j| || d �d �S )a Create a service. Args: task_template (TaskTemplate): Specification of the task to start as part of the new service. name (string): User-defined name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (ServiceMode): Scheduling mode for the service (replicated or global). Defaults to replicated. update_config (UpdateConfig): Specification for the update strategy of the service. Default: ``None`` rollback_config (RollbackConfig): Specification for the rollback strategy of the service. Default: ``None`` networks (:py:class:`list`): List of network names or IDs or :py:class:`~docker.types.NetworkAttachmentConfig` to attach the service to. Default: ``None``. endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. Returns: A dictionary containing an ``ID`` key for the newly created service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/services/creater �ImageNz,Missing mandatory Image key in ContainerSpec�X-Registry-Authr �Networks)�Name�Labels� TaskTemplate�ModerC � EndpointSpec� UpdateConfig�RollbackConfig)�data�headersT)r5 �_version�_urlr r �DockerException� isinstance�dictr r �resolve_repository_name�get_config_headerr r. �pop�convert_service_networks�_result� _post_json)�selfr1 �name�labels�moder2 �networks�endpoint_configr3 r �urlrL �image�registry� repo_name� auth_headerrK r r r �create_services sB $ � � � �z ServiceApiMixin.create_service�servicec C sN | � d|�}i }|dur t�| jd�rt�d��||d< | �| j||d�d�S )a� Return information about a service. Args: service (str): Service name or ID. insert_defaults (boolean): If true, default values will be merged into the service inspect output. Returns: (dict): A dictionary of the server-side representation of the service, including all relevant properties. Raises: :py:class:`docker.errors.APIError` If the server returns an error. � /services/{0}Nr z6insert_defaults is not supported in API version < 1.29�insertDefaults��paramsT)rN r r. rM r r rV �_get)rX rd �insert_defaultsr^ rh r r r �inspect_service� s �z ServiceApiMixin.inspect_service�taskc C s | � d|�}| �| �|�d�S )a Retrieve information about a task. Args: task (str): Task ID Returns: (dict): Information about the task. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /tasks/{0}T)rN rV ri )rX rl r^ r r r � inspect_task� s z ServiceApiMixin.inspect_taskc C s$ | � d|�}| �|�}| �|� dS )a Stop and remove a service. Args: service (str): Service name or ID Returns: ``True`` if successful. Raises: :py:class:`docker.errors.APIError` If the server returns an error. re T)rN �_delete�_raise_for_status)rX rd r^ �respr r r �remove_service� s z ServiceApiMixin.remove_servicec C s^ d|rt �|�ndi}|dur t �| jd�rt�d��||d< | �d�}| �| j||d�d�S ) a" List services. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name`` , ``label`` and ``mode``. Default: ``None``. status (bool): Include the service task count of running and desired tasks. Default: ``None``. Returns: A list of dictionaries containing data about each service. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �filtersNz1.41z-status is not supported in API version < 1.41�statusz /servicesrg T) r �convert_filtersr. rM r r rN rV ri )rX rr rs rh r^ r r r �services s �� zServiceApiMixin.servicesr F� �allc C sd |||||||d�} | � d|�} | j| | dd�} | du r+| �|�d d d �d d �} | �d| | �S ) ar Get log stream for a service. Note: This endpoint works only for services with the ``json-file`` or ``journald`` logging drivers. Args: service (str): ID or name of the service details (bool): Show extra details provided to logs. Default: ``False`` follow (bool): Keep connection open to read logs as they are sent by the Engine. Default: ``False`` stdout (bool): Return logs from ``stdout``. Default: ``False`` stderr (bool): Return logs from ``stderr``. Default: ``False`` since (int): UNIX timestamp for the logs staring point. Default: 0 timestamps (bool): Add timestamps to every log line. tail (string or int): Number of log lines to be returned, counting from the current end of the logs. Specify an integer or ``'all'`` to output all log lines. Default: ``all`` is_tty (bool): Whether the service's :py:class:`ContainerSpec` enables the TTY option. If omitted, the method will query the Engine for the information, causing an additional roundtrip. Returns (generator): Logs for the service. )�details�follow�stdout�stderr�since� timestamps�tailz/services/{0}/logsT)rh �streamN�SpecrF r r F)rN ri rk r �_get_result_tty) rX rd rx ry rz r{ r| r} r~ �is_ttyrh r^ �resr r r � service_logs% s. !� �����z ServiceApiMixin.service_logsc C s6 d|rt �|�ndi}| �d�}| �| j||d�d�S )a� Retrieve a list of tasks. Args: filters (dict): A map of filters to process on the tasks list. Valid filters: ``id``, ``name``, ``service``, ``node``, ``label`` and ``desired-state``. Returns: (:py:class:`list`): List of task dictionaries. Raises: :py:class:`docker.errors.APIError` If the server returns an error. rr Nz/tasksrg T)r rt rN rV ri )rX rr rh r^ r r r �tasksW s � zServiceApiMixin.tasksc C sL t | j||| | � | r d} t�| jd�rd} | j|| d�d }ni }| �d|�}i }i }|du r5|�d�n||d< |du rB|�d�n||d< |durXt|t�sSt |�}||d < n|�d �|d < t |�d i �|�|d < |d �d i �}|�d d�}|dur�t � |�\}}t � | |�}|r�||d < |dur�||d< n|�d�|d< | dur�| |d< n|�d�|d< |dur�t�|�}t�| jd�r�||d< n?||d d< n8t�| jd�r�|�d�|d< n)|d �d�du �r|�d i �}|�d�}|du r�|�d�}|du�r||d d< | du�r | |d< n|�d�|d< | j||d|i|d�}| j|dd�S )a� Update a service. Args: service (string): A service identifier (either its name or service ID). version (int): The version number of the service object being updated. This is required to avoid conflicting writes. task_template (TaskTemplate): Specification of the updated task to start as part of the service. name (string): New name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (ServiceMode): Scheduling mode for the service (replicated or global). Defaults to replicated. update_config (UpdateConfig): Specification for the update strategy of the service. Default: ``None``. rollback_config (RollbackConfig): Specification for the rollback strategy of the service. Default: ``None`` networks (:py:class:`list`): List of network names or IDs or :py:class:`~docker.types.NetworkAttachmentConfig` to attach the service to. Default: ``None``. endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. fetch_current_spec (boolean): Use the undefined settings from the current specification of the service. Default: ``False`` Returns: A dictionary containing a ``Warnings`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Tr N)rj r� z/services/{0}/updaterD rE rG rF r rA rB rI rJ r rC rH r0 )rK rh rL )�json)r5 rM r r. rk rN r rP rQ r r? r rR rS rU rW rV )rX rd r0 r1 rY rZ r[ r2 r\ r] r3 �fetch_current_specr �inspect_defaultsr8 r^ rK rL r4 r_ r` ra rb �converted_networks�current_task_template�current_networksrp r r r �update_serviceo sz * ��� � �z ServiceApiMixin.update_service)NNNNNNNN)N)NN)FFFFrv Frw N) NNNNNNNNFN)�__name__� __module__� __qualname__r �minimum_versionrc �check_resourcerk rm rq ru r� r� r� r r r r r@ r sB �K �0 �r@ N) � r r r �typesr r5 r? r@ r r r r �<module> s ^ api/__pycache__/secret.cpython-310.pyc 0000644 00000006012 15027665106 0013522 0 ustar 00 o �h5 � @ s* d dl Z ddlmZmZ G dd� d�ZdS )� N� )�errors�utilsc @ sl e Zd Ze�d�d dd��Ze�d�e�d�dd� ��Ze�d�e�d�dd � ��Ze�d�d d d ��Z dS )�SecretApiMixinz1.25Nc C s| t |t�s |�d�}t�|�}|�d�}|||d�}|dur.t�| jd�r*t � d��||d< | � d�}| � | j ||d �d �S ) a� Create a secret Args: name (string): Name of the secret data (bytes): Secret data to be stored labels (dict): A mapping of labels to assign to the secret driver (DriverConfig): A custom driver configuration. If unspecified, the default ``internal`` driver will be used Returns (dict): ID of the newly created secret zutf-8�ascii)�Data�Name�LabelsNz1.31z6Secret driver is only available for API version > 1.31�Driverz/secrets/create)�dataT)� isinstance�bytes�encode�base64� b64encode�decoder � version_lt�_versionr �InvalidVersion�_url�_result� _post_json)�self�namer �labels�driver�body�url� r �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/secret.py� create_secret s$ �� �z SecretApiMixin.create_secret�idc C s | � d|�}| �| �|�d�S )a2 Retrieve secret metadata Args: id (string): Full ID of the secret to inspect Returns (dict): A dictionary of metadata Raises: :py:class:`docker.errors.NotFound` if no secret with that ID exists � /secrets/{0}T)r r �_get)r r! r r r r �inspect_secret- s z SecretApiMixin.inspect_secretc C s$ | � d|�}| �|�}| �|� dS )a% Remove a secret Args: id (string): Full ID of the secret to remove Returns (boolean): True if successful Raises: :py:class:`docker.errors.NotFound` if no secret with that ID exists r" T)r �_delete�_raise_for_status)r r! r �resr r r � remove_secret? s z SecretApiMixin.remove_secretc C s6 | � d�}i }|rt�|�|d< | �| j||d�d�S )z� List secrets Args: filters (dict): A map of filters to process on the secrets list. Available filters: ``names`` Returns (list): A list of secrets z/secrets�filters)�paramsT)r r �convert_filtersr r# )r r) r r* r r r �secretsS s zSecretApiMixin.secrets)NN)N) �__name__� __module__� __qualname__r �minimum_versionr �check_resourcer$ r( r, r r r r r s % r )r � r r r r r r r �<module> s api/__pycache__/exec_api.cpython-310.pyc 0000644 00000012717 15027665106 0014023 0 ustar 00 o �hB � @ s. d dl mZmZ d dlmZ G dd� d�ZdS )� )�errors�utils)�CancellableStreamc @ sP e Zd Ze�d� ddd��Zdd � Zdd d �Ze�d � dd d��ZdS )� ExecApiMixin� containerTF� Nc C s� | durt �| jd�rt�d��t|t�rt �|�}t| t�r%t j � | �} ||||||||| d� } | durEt �| jd�rAt�d��| | d< | rL| | d< n d| j v rX| j d | d< | � d |�} | j | | d �}| � |d �S ) aC Sets up an exec instance in a running container. Args: container (str): Target container where exec instance will be created cmd (str or list): Command to be executed stdout (bool): Attach to stdout. Default: ``True`` stderr (bool): Attach to stderr. Default: ``True`` stdin (bool): Attach to stdin. Default: ``False`` tty (bool): Allocate a pseudo-TTY. Default: False privileged (bool): Run as privileged. user (str): User to execute command as. Default: root environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. workdir (str): Path to working directory for this exec session detach_keys (str): Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. ~/.docker/config.json is used by default. Returns: (dict): A dictionary with an exec ``Id`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Nz1.25z;Setting environment for exec is not supported in API < 1.25) � Container�User� Privileged�Tty� AttachStdin� AttachStdout� AttachStderr�Cmd�Envz1.35z/workdir is not supported for API version < 1.35� WorkingDir� detachKeysz/containers/{0}/exec)�dataT)r � version_lt�_versionr �InvalidVersion� isinstance�str� split_command�dict�format_environment�_general_configs�_url� _post_json�_result)�selfr �cmd�stdout�stderr�stdin�tty� privileged�user� environment�workdir� detach_keysr �url�res� r- �I/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/exec_api.py� exec_create s> #� � � zExecApiMixin.exec_createc C s2 t |t�r |�d�}| �| �d|��}| �|d�S )aL Return low-level information about an exec command. Args: exec_id (str): ID of the exec instance Returns: (dict): Dictionary of values returned by the endpoint. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �Idz/exec/{0}/jsonT)r r �get�_getr r )r �exec_idr, r- r- r. � exec_inspectP s zExecApiMixin.exec_inspectc C sF t |t�r |�d�}||d�}| �d|�}| j||d�}| �|� dS )z� Resize the tty session used by the specified exec command. Args: exec_id (str): ID of the exec instance height (int): Height of tty session width (int): Width of tty session r0 )�h�wz/exec/{0}/resize)�paramsN)r r r1 r �_post�_raise_for_status)r r3 �height�widthr7 r+ r, r- r- r. � exec_resizec s zExecApiMixin.exec_resizer3 c C s� ||d�}|r i nddd�}| j | �d|�||dd�} |r-z | �| �W | �� S | �� w |r4| �| �S | j| |||d�} |rDt| | �S | S ) a? Start a previously set up exec instance. Args: exec_id (str): ID of the exec instance detach (bool): If true, detach from the exec command. Default: False tty (bool): Allocate a pseudo-TTY. Default: False stream (bool): Return response data progressively as an iterator of strings, rather than a single string. socket (bool): Return the connection socket to allow custom read/write operations. Must be closed by the caller when done. demux (bool): Return stdout and stderr separately Returns: (generator or str or tuple): If ``stream=True``, a generator yielding response chunks. If ``socket=True``, a socket object for the connection. A string containing response data otherwise. If ``demux=True``, a tuple with two elements of type byte: stdout and stderr. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r �Detach�Upgrade�tcp)� Connectionr> z/exec/{0}/startT)�headersr �stream)r% �demux)r r r �close�_get_raw_response_socket�_read_from_socketr ) r r3 �detachr% rB �socketrC r rA r, �outputr- r- r. � exec_startu s. �� � zExecApiMixin.exec_start) TTFFFr NNN)NN)FFFFF) �__name__� __module__� __qualname__r �check_resourcer/ r4 r< rJ r- r- r- r. r s �I �r N)r r r �typesr r r- r- r- r. �<module> s api/__pycache__/daemon.cpython-310.pyc 0000644 00000012612 15027665106 0013503 0 ustar 00 o �hx � @ s: d dl Z d dlmZ ddlmZmZmZ G dd� d�ZdS )� N)�datetime� )�auth�types�utilsc @ sP e Zd Ze�d�dd� �Zddd�Zdd� Z dd d �Zd d � Z ddd�Z dS )�DaemonApiMixinz1.25c C s | � d�}| �| �|�d�S )a( Get data usage information. Returns: (dict): A dictionary representing different resource categories and their respective data usage. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /system/dfT��_url�_result�_get)�self�url� r �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/daemon.py�df s zDaemonApiMixin.dfNc C sx t |t�r t�|�}t |t�rt�|�}|rt�|�}|||d�}| �d�}| j||ddd�}| j||d�}t� ||�S )ar Get real-time events from the server. Similar to the ``docker events`` command. Args: since (UTC datetime or int): Get events from this point until (UTC datetime or int): Get events until this point filters (dict): Filter the events by event time, container or image decode (bool): If set to true, stream will be decoded into dicts on the fly. False by default. Returns: A :py:class:`docker.types.daemon.CancellableStream` generator Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> for event in client.events(decode=True) ... print(event) {u'from': u'image/with:tag', u'id': u'container-id', u'status': u'start', u'time': 1423339459} ... or >>> events = client.events() >>> for event in events: ... print(event) >>> # and cancel from another thread >>> events.close() )�since�until�filtersz/eventsTN)�params�stream�timeout)�decode) � isinstancer r �datetime_to_timestamp�convert_filtersr r �_stream_helperr �CancellableStream) r r r r r r r �responser r r r �events s & � zDaemonApiMixin.eventsc C s | � | �| �d��d�S )a Display system-wide information. Identical to the ``docker info`` command. Returns: (dict): The info as a dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/infoT�r r r �r r r r �infoS s zDaemonApiMixin.infoFc C s� |rt j�|�rtj|| jd�| _n| jr| jjr!tj| jd�| _| j�|�}|r5|� dd�|kr5|s5|S ||||d�}| j | � d�|d�} | j dkrU| j� |pRtj|� | j| dd �S ) a^ Authenticate with a registry. Similar to the ``docker login`` command. Args: username (str): The registry username password (str): The plaintext password email (str): The email for the registry account registry (str): URL to the registry. E.g. ``https://index.docker.io/v1/`` reauth (bool): Whether or not to refresh existing authentication on the Docker server. dockercfg_path (str): Use a custom path for the Docker config file (default ``$HOME/.docker/config.json`` if present, otherwise ``$HOME/.dockercfg``) Returns: (dict): The response from the login request Raises: :py:class:`docker.errors.APIError` If the server returns an error. )� credstore_env�usernameN)r# �password�email� serveraddressz/auth)�data�� T��json)�os�path�existsr � load_configr" � _auth_configs�is_empty�resolve_authconfig�get� _post_jsonr � status_code�add_auth� INDEX_NAMEr ) r r# r$ r% �registry�reauth�dockercfg_path�authcfg�req_datar r r r �logina s, �� �� zDaemonApiMixin.loginc C s | � | �| �d���dkS )a! Checks the server is responsive. An exception will be raised if it isn't responding. Returns: (bool) The response from the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/_ping�OKr r r r r �ping� s zDaemonApiMixin.pingTc C s" | j d|d�}| j| �|�dd�S )a& Returns version information from the server. Similar to the ``docker version`` command. Returns: (dict): The server version information Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/version)� versioned_apiTr) r )r � api_versionr r r r �version� s zDaemonApiMixin.version)NNNN)NNNFN)T) �__name__� __module__� __qualname__r �minimum_versionr r r! r< r> rA r r r r r s ; �9r )r+ r � r r r r r r r r �<module> s api/__pycache__/build.cpython-310.pyc 0000644 00000027760 15027665106 0013351 0 ustar 00 o �h�> � @ s\ d dl Z d dlZd dlZd dlZddlmZmZmZmZ e� e �Z G dd� d�Z dd� Z dS )� N� )�auth� constants�errors�utilsc @ sB e Zd Z d dd�Ze�d�d dd��Zd d � ZdS ) � BuildApiMixinNFTc ( C s d }} i } | p i } |p i }|du r|du rt d��|r%| dur%t�d��|dur7t�|�s7t�d|� d���| �� D ]} | tjvrKt�d|� d���q;|rW|sTt d��|} ne|durat�|�} n[|� d�ri|}nSt j � |�sst d��t j � |d �} d} t j �| �r�t| ��}!ttd d � d d � |!�� �� D ���} W d � n1 s�w Y t| |�} tj|| | |d�} |r�dn| } | �d�}"|||||| | | d�}#|#�| � |r�| j�� }$|$�� D ] \}%}&|�|%|&� q�|r�|#�dt � |�i� |�r t� | j d��r|#�d|i� nt� d��|�r&t� | j d��r!|#�dt � |�i� nt� d��|�rAt� | j d��r<|#�dt � |�i� nt� d��|�rYt� | j d ��rT|#�d |i� nt� d ��|�rqt� | j d��rl|#�d |i� nt� d ��|�r�t� | j d��r�|#�d!|i� nt� d"��|du�r�t�!| j d#��r�t� d$��t"|t#��r�t�$|�}|#�d%|i� |du�r�t�!| j d&��r�t� d'��||#d(< |du�r�t�!| j d)��r�t� d*��||#d+< | du�r�d,d-i} | �r�| | d.< | �%| � | j&|"| |#| d/|d0�}'| du�r|�s| �'� | j(|'|d1�S )2a� Similar to the ``docker build`` command. Either ``path`` or ``fileobj`` needs to be set. ``path`` can be a local path (to a directory containing a Dockerfile) or a remote URL. ``fileobj`` must be a readable file-like object to a Dockerfile. If you have a tar file for the Docker build context (including a Dockerfile) already, pass a readable file-like object to ``fileobj`` and also pass ``custom_context=True``. If the stream is compressed also, set ``encoding`` to the correct value (e.g ``gzip``). Example: >>> from io import BytesIO >>> from docker import APIClient >>> dockerfile = ''' ... # Shared Volume ... FROM busybox:buildroot-2014.02 ... VOLUME /data ... CMD ["/bin/sh"] ... ''' >>> f = BytesIO(dockerfile.encode('utf-8')) >>> cli = APIClient(base_url='tcp://127.0.0.1:2375') >>> response = [line for line in cli.build( ... fileobj=f, rm=True, tag='yourname/volume' ... )] >>> response ['{"stream":" ---\u003e a9eb17255234\n"}', '{"stream":"Step 1 : VOLUME /data\n"}', '{"stream":" ---\u003e Running in abdc1e6896c6\n"}', '{"stream":" ---\u003e 713bca62012e\n"}', '{"stream":"Removing intermediate container abdc1e6896c6\n"}', '{"stream":"Step 2 : CMD [\"/bin/sh\"]\n"}', '{"stream":" ---\u003e Running in dba30f2a1a7e\n"}', '{"stream":" ---\u003e 032b8b2855fc\n"}', '{"stream":"Removing intermediate container dba30f2a1a7e\n"}', '{"stream":"Successfully built 032b8b2855fc\n"}'] Args: path (str): Path to the directory containing the Dockerfile fileobj: A file object to use as the Dockerfile. (Or a file-like object) tag (str): A tag to add to the final image quiet (bool): Whether to return the status nocache (bool): Don't use the cache when set to ``True`` rm (bool): Remove intermediate containers. The ``docker build`` command now defaults to ``--rm=true``, but we have kept the old default of `False` to preserve backward compatibility timeout (int): HTTP timeout custom_context (bool): Optional if using ``fileobj`` encoding (str): The encoding for a stream. Set to ``gzip`` for compressing pull (bool): Downloads any updates to the FROM image in Dockerfiles forcerm (bool): Always remove intermediate containers, even after unsuccessful builds dockerfile (str): path within the build context to the Dockerfile gzip (bool): If set to ``True``, gzip compression/encoding is used buildargs (dict): A dictionary of build arguments container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys: - memory (int): set memory limit for build - memswap (int): Total memory (memory + swap), -1 to disable swap - cpushares (int): CPU shares (relative weight) - cpusetcpus (str): CPUs in which to allow execution, e.g., ``"0-3"``, ``"0,1"`` decode (bool): If set to ``True``, the returned stream will be decoded into dicts on the fly. Default ``False`` shmsize (int): Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB labels (dict): A dictionary of labels to set on the image cache_from (:py:class:`list`): A list of images used for build cache resolution target (str): Name of the build-stage to build in a multi-stage Dockerfile network_mode (str): networking mode for the run commands during build squash (bool): Squash the resulting images layers into a single layer. extra_hosts (dict): Extra hosts to add to /etc/hosts in building containers, as a mapping of hostname to IP address. platform (str): Platform in the format ``os[/arch[/variant]]`` isolation (str): Isolation technology used during build. Default: `None`. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. Returns: A generator for the build output. Raises: :py:class:`docker.errors.APIError` If the server returns an error. ``TypeError`` If neither ``path`` nor ``fileobj`` is specified. Nz,Either path or fileobj needs to be provided.z.Can not use custom encoding if gzip is enabledz invalid tag 'z': invalid reference formatz,You must specify fileobj with custom_context)zhttp://zhttps://zgit://z github.com/zgit@z-You must specify a directory to build in pathz .dockerignorec S s | dko | d dkS )N� r �#� )�xr r �F/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/build.py�<lambda>� � z%BuildApiMixin.build.<locals>.<lambda>c S s g | ]}|� � �qS r )�strip)�.0�liner r r � <listcomp>� r z'BuildApiMixin.build.<locals>.<listcomp>)�exclude� dockerfile�gzipr z/build)�t�remote�q�nocache�rm�forcerm�pullr � buildargsz1.22�shmsizez/shmsize was only introduced in API version 1.22z1.23�labelsz.labels was only introduced in API version 1.23z1.25� cachefromz2cache_from was only introduced in API version 1.25z1.29�targetz.target was only introduced in API version 1.29� networkmodez4network_mode was only introduced in API version 1.25�squashz.squash was only introduced in API version 1.25z1.27z3extra_hosts was only introduced in API version 1.27� extrahostsz1.32z0platform was only introduced in API version 1.32�platformz1.24z1isolation was only introduced in API version 1.24� isolationz Content-Typezapplication/tarzContent-EncodingT)�data�params�headers�stream�timeout)�decode))� TypeErrorr �DockerExceptionr � match_tag�keysr �CONTAINER_LIMITS_KEYS�mkbuildcontext� startswith�os�path�isdir�join�exists�open�list�filter�read� splitlines�process_dockerfile�tar�_url�update�_proxy_configs�get_environment�items� setdefault�json�dumps� version_gte�_version�InvalidVersion� version_lt� isinstance�dict�format_extra_hosts�_set_auth_headers�_post�close�_stream_helper)(�selfr5 �tag�quiet�fileobjr r r+ �custom_context�encodingr r r �container_limitsr, r r r r � cache_fromr! � network_moder# � extra_hostsr% r& �use_config_proxyr �contextr) �key� dockerignorer �f�ur( � proxy_args�k�v�responser r r �build s j � � �� � � � � ������ � � � � zBuildApiMixin.buildz1.31c C s� | � d�}|||fdkrt�| jd�rt�d��i }|dur%t�|�|d< |dur-||d< |dur5||d< | �| j||d �d �S ) a/ Delete the builder cache Args: filters (dict): Filters to process on the prune list. Needs Docker API v1.39+ Available filters: - dangling (bool): When set to true (or 1), prune only unused and untagged images. - until (str): Can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the daemon's local time. keep_storage (int): Amount of disk space in bytes to keep for cache. Needs Docker API v1.39+ all (bool): Remove all types of build cache. Needs Docker API v1.39+ Returns: (dict): A dictionary containing information about the operation's result. The ``SpaceReclaimed`` key indicates the amount of bytes of disk space reclaimed. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /build/prune�NNNz1.39zS`filters`, `keep_storage`, and `all` args are only available for API version > 1.38N�filtersz keep-storage�all)r( T) r@ r rK rI r rJ �convert_filters�_resultrP )rS ri � keep_storagerj �urlr( r r r � prune_builds s ��zBuildApiMixin.prune_buildsc C s� t �d� | jr | jjrt �d� tj| jd�| _| jrP| j�� }tj|vr5tj |v r5|� tj i �|tj< t �dd� dd� |D ��� |rNt� |�|d< d S d S t �d � d S ) NzLooking for auth configz2No auth config in memory - loading from filesystem)� credstore_envzSending auth config (%s)z, c s s � | ]}t |�V qd S )N)�repr)r rd r r r � <genexpr>X s � z2BuildApiMixin._set_auth_headers.<locals>.<genexpr>zX-Registry-ConfigzNo auth config found) �log�debug� _auth_configs�is_emptyr � load_configrp �get_all_credentials� INDEX_URL� INDEX_NAME�getr7 � encode_header)rS r) � auth_datar r r rO A s* � � ��z BuildApiMixin._set_auth_headers)NNFNFFNFNFFNNFNFNNNNNNNNNTrh )�__name__� __module__� __qualname__rg r �minimum_versionro rO r r r r r s � +r c C s� | sdS | }t j�| �s0t j�|| �}tjr0|�tj�r0t j�|t tj�d � �}tj� |� �}t j� |�d t j� |�d ksJt j� ||��d�rkt |��}dt �d�d��|�� fW d � S 1 sfw Y | |krvt j� ||�} | d fS )N)NNr z..z .dockerfile.� r )r4 r5 �isabsr7 r �IS_WINDOWS_PLATFORMr3 �WINDOWS_LONGPATH_PREFIX�normpath�len� splitdrive�relpathr9 �random� getrandbitsr< )r r5 �abs_dockerfiler� �dfr r r r> c s. �� � � �r> )rF �loggingr4 r� r r r r r � getLoggerr~ rs r r> r r r r �<module> s Z api/__pycache__/config.cpython-310.pyc 0000644 00000005646 15027665106 0013516 0 ustar 00 o �h� � @ s& d dl Z ddlmZ G dd� d�ZdS )� N� )�utilsc @ sl e Zd Ze�d�d dd��Ze�d�e�d�dd� ��Ze�d�e�d�dd � ��Ze�d�d d d ��Z dS )�ConfigApiMixinz1.30Nc C sV t |t�s |�d�}t�|�}|�d�}||||d�}| �d�}| �| j||d�d�S )a Create a config Args: name (string): Name of the config data (bytes): Config data to be stored labels (dict): A mapping of labels to assign to the config templating (dict): dictionary containing the name of the templating driver to be used expressed as { name: <templating_driver_name>} Returns (dict): ID of the newly created config zutf-8�ascii)�Data�Name�Labels� Templatingz/configs/create)�dataT) � isinstance�bytes�encode�base64� b64encode�decode�_url�_result� _post_json)�self�namer �labels� templating�body�url� r �G/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/config.py� create_config s � �z ConfigApiMixin.create_config�idc C s | � d|�}| �| �|�d�S )a2 Retrieve config metadata Args: id (string): Full ID of the config to inspect Returns (dict): A dictionary of metadata Raises: :py:class:`docker.errors.NotFound` if no config with that ID exists � /configs/{0}T)r r �_get)r r r r r r �inspect_config' s z ConfigApiMixin.inspect_configc C s$ | � d|�}| �|�}| �|� dS )a% Remove a config Args: id (string): Full ID of the config to remove Returns (boolean): True if successful Raises: :py:class:`docker.errors.NotFound` if no config with that ID exists r T)r �_delete�_raise_for_status)r r r �resr r r � remove_config9 s z ConfigApiMixin.remove_configc C s6 | � d�}i }|rt�|�|d< | �| j||d�d�S )z� List configs Args: filters (dict): A map of filters to process on the configs list. Available filters: ``names`` Returns (list): A list of configs z/configs�filters)�paramsT)r r �convert_filtersr r )r r% r r& r r r �configsM s zConfigApiMixin.configs)NN)N) �__name__� __module__� __qualname__r �minimum_versionr �check_resourcer r$ r( r r r r r s r )r � r r r r r r �<module> s api/__pycache__/container.cpython-310.pyc 0000644 00000135641 15027665106 0014232 0 ustar 00 o �hj� � @ sV d dl m Z ddlmZmZ ddlmZ ddlmZmZm Z m Z m Z G dd� d�Z dS ) � )�datetime� )�errors�utils)�DEFAULT_DATA_CHUNK_SIZE)�CancellableStream�ContainerConfig�EndpointConfig� HostConfig�NetworkingConfigc @ sV e Zd Ze�d� dHdd��Ze�d�dIdd��Ze�d� dJd d ��Z dKd d �Z dLdd�Z dd� Z dMdd�Z dd� Z dd� Z dd� Ze�d�dd� �Ze�d�efd d ��Ze�d�edfd d ��Ze�d�d d!� �Ze�d�dNd"d#��Ze�d� dOd%d&��Ze�d�d'd(� �Ze�d�d)d*� �Ze�d�d+d,� �Ze�d-�dNd.d/��Ze�d�dPd0d1��Ze�d�d2d3� �Z e�d�d4d5� �Z e�d�dQd7d8��Z e�d�d9d:� �Z e�d�dRd;d<��Z e�d�dNd=d>��Z!e�d�dNd?d@��Z"e�d�dAdB� �Z#e�dC�e�d� dSdDdE���Z$e�d�dMdFdG��Z%dS )T�ContainerApiMixin� containerTFc C s� |rdpd|r dp d|rdpd|rdpdd�}ddd�}| � d|�} | j| ||dd �} | j| || �|�|d �} |r>t| | �S | S ) aI Attach to a container. The ``.logs()`` function is a wrapper around this method, which you can use instead if you want to fetch/stream container output without first retrieving the entire backlog. Args: container (str): The container to attach to. stdout (bool): Include stdout. stderr (bool): Include stderr. stream (bool): Return container output progressively as an iterator of strings, rather than a single string. logs (bool): Include the container's previous output. demux (bool): Keep stdout and stderr separate. Returns: By default, the container's output as a single string (two if ``demux=True``: one for stdout and one for stderr). If ``stream=True``, an iterator of output strings. If ``demux=True``, two iterators are returned: one for stdout and one for stderr. Raises: :py:class:`docker.errors.APIError` If the server returns an error. � r )�logs�stdout�stderr�stream�Upgrade�tcp�� Connectionr �/containers/{0}/attachT)�headers�paramsr )�demux)�_url�_post�_read_from_socket� _check_is_ttyr ) �selfr r r r r r r r �u�response�output� r# �J/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/container.py�attach s �� � zContainerApiMixin.attachNc C sz |du r dddd�}d|vrd| j v r| j d |d< |r"| �||�S ddd�}| �d|�}| �| j|d| �|�d |d ��S ) a& Like ``attach``, but returns the underlying socket-like object for the HTTP request. Args: container (str): The container to attach to. params (dict): Dictionary of request parameters (e.g. ``stdout``, ``stderr``, ``stream``). For ``detachKeys``, ~/.docker/config.json is used by default. ws (bool): Use websockets instead of raw HTTP. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Nr )r r r � detachKeysr r r r T�r r r )�_general_configs�_attach_websocketr �_get_raw_response_socket�post�_attach_params)r r r �wsr r r# r# r$ � attach_socketE s( � � ��z ContainerApiMixin.attach_socketc C s8 |||||||d�} | � d�} | j| j| || d�dd�S )a\ Commit a container to an image. Similar to the ``docker commit`` command. Args: container (str): The image hash of the container repository (str): The repository to push the image to tag (str): The tag to push message (str): A commit message author (str): The name of the author pause (bool): Whether to pause the container before committing changes (str): Dockerfile instructions to apply while committing conf (dict): The configuration for the container. See the `Engine API documentation <https://docs.docker.com/reference/api/docker_remote_api/>`_ for full details. Raises: :py:class:`docker.errors.APIError` If the server returns an error. )r �repo�tag�comment�author�pause�changesz/commit��datar T��json)r �_result� _post_json) r r � repositoryr0 �messager2 r3 r4 �confr r r# r# r$ �commitr s � �zContainerApiMixin.commit���c C s� |rdn||r dnd|rdnd|rdnd||d�} | r"t �| �| d< | �d�} | �| j| | d�d�} |r;dd � | D �S |rL| D ] } | d d d � | d < q?| S ) a6 List containers. Similar to the ``docker ps`` command. Args: quiet (bool): Only display numeric Ids all (bool): Show all containers. Only running containers are shown by default trunc (bool): Truncate output latest (bool): Show only the latest created container, include non-running ones. since (str): Show only containers created since Id or Name, include non-running ones before (str): Show only container created before Id or Name, include non-running ones limit (int): Show `limit` last created containers, include non-running ones size (bool): Display sizes filters (dict): Filters to be processed on the image list. Available filters: - `exited` (int): Only containers with specified exit code - `status` (str): One of ``restarting``, ``running``, ``paused``, ``exited`` - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. - `id` (str): The id of the container. - `name` (str): The name of the container. - `ancestor` (str): Filter by container ancestor. Format of ``<image-name>[:tag]``, ``<image-id>``, or ``<image@digest>``. - `before` (str): Only containers created before a particular container. Give the container name or id. - `since` (str): Only containers created after a particular container. Give container name or id. A comprehensive list can be found in the documentation for `docker ps <https://docs.docker.com/engine/reference/commandline/ps>`_. Returns: A list of dicts, one per container Raises: :py:class:`docker.errors.APIError` If the server returns an error. r r )�limit�all�size� trunc_cmd�since�before�filtersz/containers/json�r Tc S s g | ]}d |d i�qS )�Idr# )�.0�xr# r# r$ � <listcomp>� s z0ContainerApiMixin.containers.<locals>.<listcomp>rH N� )r �convert_filtersr r9 �_get)r �quietrA �trunc�latestrD rE r@ rB rF r r �resrJ r# r# r$ � containers� s" 2 � z ContainerApiMixin.containersc C s| t | t�r| g} t | t�rtj�| �} |r | j�| �p d} | �||||||||| | | | ||||||||||�}| �|| |�S )ar Creates a container. Parameters are similar to those for the ``docker run`` command except it doesn't support the attach options (``-a``). The arguments that are passed directly to this function are host-independent configuration options. Host-specific configuration is passed with the `host_config` argument. You'll normally want to use this method in combination with the :py:meth:`create_host_config` method to generate ``host_config``. **Port bindings** Port binding is done in two parts: first, provide a list of ports to open inside the container with the ``ports`` parameter, then declare bindings with the ``host_config`` parameter. For example: .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', ports=[1111, 2222], host_config=client.api.create_host_config(port_bindings={ 1111: 4567, 2222: None }) ) You can limit the host address on which the port will be exposed like such: .. code-block:: python client.api.create_host_config( port_bindings={1111: ('127.0.0.1', 4567)} ) Or without host port assignment: .. code-block:: python client.api.create_host_config(port_bindings={1111: ('127.0.0.1',)}) If you wish to use UDP instead of TCP (default), you need to declare ports as such in both the config and host config: .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', ports=[(1111, 'udp'), 2222], host_config=client.api.create_host_config(port_bindings={ '1111/udp': 4567, 2222: None }) ) To bind multiple host ports to a single container port, use the following syntax: .. code-block:: python client.api.create_host_config(port_bindings={ 1111: [1234, 4567] }) You can also bind multiple IPs to a single container port: .. code-block:: python client.api.create_host_config(port_bindings={ 1111: [ ('192.168.0.100', 1234), ('192.168.0.101', 1234) ] }) **Using volumes** Volume declaration is done in two parts. Provide a list of paths to use as mountpoints inside the container with the ``volumes`` parameter, and declare mappings from paths on the host in the ``host_config`` section. .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2'], host_config=client.api.create_host_config(binds={ '/home/user1/': { 'bind': '/mnt/vol2', 'mode': 'rw', }, '/var/www': { 'bind': '/mnt/vol1', 'mode': 'ro', }, '/autofs/user1': { 'bind': '/mnt/vol3', 'mode': 'rw', 'propagation': 'shared' } }) ) You can alternatively specify binds as a list. This code is equivalent to the example above: .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2', '/mnt/vol3'], host_config=client.api.create_host_config(binds=[ '/home/user1/:/mnt/vol2', '/var/www:/mnt/vol1:ro', '/autofs/user1:/mnt/vol3:rw,shared', ]) ) **Networking** You can specify networks to connect the container to by using the ``networking_config`` parameter. At the time of creation, you can only connect a container to a single networking, but you can create more connections by using :py:meth:`~connect_container_to_network`. For example: .. code-block:: python networking_config = client.api.create_networking_config({ 'network1': client.api.create_endpoint_config( ipv4_address='172.28.0.124', aliases=['foo', 'bar'], links=['container2'] ) }) ctnr = client.api.create_container( img, command, networking_config=networking_config ) Args: image (str): The image to run command (str or list): The command to be run in the container hostname (str): Optional hostname for the container user (str or int): Username or UID detach (bool): Detached mode: run container in the background and return container ID stdin_open (bool): Keep STDIN open even if not attached tty (bool): Allocate a pseudo-TTY ports (list of ints): A list of port numbers environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. volumes (str or list): List of paths inside the container to use as volumes. network_disabled (bool): Disable networking name (str): A name for the container entrypoint (str or list): An entrypoint working_dir (str): Path to the working directory domainname (str): The domain name to use for the container host_config (dict): A dictionary created with :py:meth:`create_host_config`. mac_address (str): The Mac Address to assign the container labels (dict or list): A dictionary of name-value labels (e.g. ``{"label1": "value1", "label2": "value2"}``) or a list of names of labels to set with empty values (e.g. ``["label1", "label2"]``) stop_signal (str): The stop signal to use to stop the container (e.g. ``SIGINT``). stop_timeout (int): Timeout to stop the container, in seconds. Default: 10 networking_config (dict): A networking configuration generated by :py:meth:`create_networking_config`. runtime (str): Runtime to use with this container. healthcheck (dict): Specify a test to perform to check that the container is healthy. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being created. platform (str): Platform in the format ``os[/arch[/variant]]``. Returns: A dictionary with an image 'Id' key and a 'Warnings' key. Raises: :py:class:`docker.errors.ImageNotFound` If the specified image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. N) � isinstance�str�dictr �format_environment�_proxy_configs�inject_proxy_environment�create_container_config� create_container_from_config)r �image�command�hostname�user�detach� stdin_open�tty�ports� environment�volumes�network_disabled�name� entrypoint� working_dir� domainname� host_config� mac_address�labels� stop_signal�networking_config� healthcheck� stop_timeout�runtime�use_config_proxy�platform�configr# r# r$ �create_container� s( I ���z"ContainerApiMixin.create_containerc O � t | jg|�R i |��S �N)r �_version�r �args�kwargsr# r# r$ rZ � s z)ContainerApiMixin.create_container_configc C sR | � d�}d|i}|rt�| jd�rt�d��||d< | j|||d�}| �|d�S )Nz/containers/createrg �1.41z0platform is not supported for API version < 1.41rt r5 T)r r � version_ltry r �InvalidVersionr: r9 )r ru rg rt r r rR r# r# r$ r[ � s �� z.ContainerApiMixin.create_container_from_configc O s0 |si }d|v r t d��| j|d< t|i |��S )a| Create a dictionary for the ``host_config`` argument to :py:meth:`create_container`. Args: auto_remove (bool): enable auto-removal of the container on daemon side when the container's process exits. binds (dict): Volumes to bind. See :py:meth:`create_container` for more information. blkio_weight_device: Block IO weight (relative device weight) in the form of: ``[{"Path": "device_path", "Weight": weight}]``. blkio_weight: Block IO weight (relative weight), accepts a weight value between 10 and 1000. cap_add (list of str): Add kernel capabilities. For example, ``["SYS_ADMIN", "MKNOD"]``. cap_drop (list of str): Drop kernel capabilities. cpu_period (int): The length of a CPU period in microseconds. cpu_quota (int): Microseconds of CPU time that the container can get in a CPU period. cpu_shares (int): CPU shares (relative weight). cpuset_cpus (str): CPUs in which to allow execution (``0-3``, ``0,1``). cpuset_mems (str): Memory nodes (MEMs) in which to allow execution (``0-3``, ``0,1``). Only effective on NUMA systems. device_cgroup_rules (:py:class:`list`): A list of cgroup rules to apply to the container. device_read_bps: Limit read rate (bytes per second) from a device in the form of: `[{"Path": "device_path", "Rate": rate}]` device_read_iops: Limit read rate (IO per second) from a device. device_write_bps: Limit write rate (bytes per second) from a device. device_write_iops: Limit write rate (IO per second) from a device. devices (:py:class:`list`): Expose host devices to the container, as a list of strings in the form ``<path_on_host>:<path_in_container>:<cgroup_permissions>``. For example, ``/dev/sda:/dev/xvda:rwm`` allows the container to have read-write access to the host's ``/dev/sda`` via a node named ``/dev/xvda`` inside the container. device_requests (:py:class:`list`): Expose host resources such as GPUs to the container, as a list of :py:class:`docker.types.DeviceRequest` instances. dns (:py:class:`list`): Set custom DNS servers. dns_opt (:py:class:`list`): Additional options to be added to the container's ``resolv.conf`` file dns_search (:py:class:`list`): DNS search domains. extra_hosts (dict): Additional hostnames to resolve inside the container, as a mapping of hostname to IP address. group_add (:py:class:`list`): List of additional group names and/or IDs that the container process will run as. init (bool): Run an init inside the container that forwards signals and reaps processes ipc_mode (str): Set the IPC mode for the container. isolation (str): Isolation technology to use. Default: ``None``. links (dict): Mapping of links using the ``{'container': 'alias'}`` format. The alias is optional. Containers declared in this dict will be linked to the new container using the provided alias. Default: ``None``. log_config (LogConfig): Logging configuration lxc_conf (dict): LXC config. mem_limit (float or str): Memory limit. Accepts float values (which represent the memory limit of the created container in bytes) or a string with a units identification char (``100000b``, ``1000k``, ``128m``, ``1g``). If a string is specified without a units character, bytes are assumed as an mem_reservation (float or str): Memory soft limit. mem_swappiness (int): Tune a container's memory swappiness behavior. Accepts number between 0 and 100. memswap_limit (str or int): Maximum amount of memory + swap a container is allowed to consume. mounts (:py:class:`list`): Specification for mounts to be added to the container. More powerful alternative to ``binds``. Each item in the list is expected to be a :py:class:`docker.types.Mount` object. network_mode (str): One of: - ``bridge`` Create a new network stack for the container on the bridge network. - ``none`` No networking for this container. - ``container:<name|id>`` Reuse another container's network stack. - ``host`` Use the host network stack. This mode is incompatible with ``port_bindings``. oom_kill_disable (bool): Whether to disable OOM killer. oom_score_adj (int): An integer value containing the score given to the container in order to tune OOM killer preferences. pid_mode (str): If set to ``host``, use the host PID namespace inside the container. pids_limit (int): Tune a container's pids limit. Set ``-1`` for unlimited. port_bindings (dict): See :py:meth:`create_container` for more information. Imcompatible with ``host`` in ``network_mode``. privileged (bool): Give extended privileges to this container. publish_all_ports (bool): Publish all ports to the host. read_only (bool): Mount the container's root filesystem as read only. restart_policy (dict): Restart the container when it exits. Configured as a dictionary with keys: - ``Name`` One of ``on-failure``, or ``always``. - ``MaximumRetryCount`` Number of times to restart the container on failure. security_opt (:py:class:`list`): A list of string values to customize labels for MLS systems, such as SELinux. shm_size (str or int): Size of /dev/shm (e.g. ``1G``). storage_opt (dict): Storage driver options per container as a key-value mapping. sysctls (dict): Kernel parameters to set in the container. tmpfs (dict): Temporary filesystems to mount, as a dictionary mapping a path inside the container to options for that path. For example: .. code-block:: python { '/mnt/vol2': '', '/mnt/vol1': 'size=3G,uid=1000' } ulimits (:py:class:`list`): Ulimits to set inside the container, as a list of :py:class:`docker.types.Ulimit` instances. userns_mode (str): Sets the user namespace mode for the container when user namespace remapping option is enabled. Supported values are: ``host`` uts_mode (str): Sets the UTS namespace mode for the container. Supported values are: ``host`` volumes_from (:py:class:`list`): List of container names or IDs to get volumes from. runtime (str): Runtime to use with this container. Returns: (dict) A dictionary which can be passed to the ``host_config`` argument to :py:meth:`create_container`. Example: >>> client.api.create_host_config( ... privileged=True, ... cap_drop=['MKNOD'], ... volumes_from=['nostalgic_newton'], ... ) {'CapDrop': ['MKNOD'], 'LxcConf': None, 'Privileged': True, 'VolumesFrom': ['nostalgic_newton'], 'PublishAllPorts': False} �versionzAcreate_host_config() got an unexpected keyword argument 'version')� TypeErrorry r rz r# r# r$ �create_host_config� s � z$ContainerApiMixin.create_host_configc O s t |i |��S )a� Create a networking config dictionary to be used as the ``networking_config`` parameter in :py:meth:`create_container`. Args: endpoints_config (dict): A dictionary mapping network names to endpoint configurations generated by :py:meth:`create_endpoint_config`. Returns: (dict) A networking config. Example: >>> client.api.create_network('network1') >>> networking_config = client.api.create_networking_config({ 'network1': client.api.create_endpoint_config() }) >>> container = client.api.create_container( img, command, networking_config=networking_config ) )r rz r# r# r$ �create_networking_configk s z*ContainerApiMixin.create_networking_configc O rw )a� Create an endpoint config dictionary to be used with :py:meth:`create_networking_config`. Args: aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. links (dict): Mapping of links for this endpoint using the ``{'container': 'alias'}`` format. The alias is optional. Containers declared in this dict will be linked to this container using the provided alias. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. driver_opt (dict): A dictionary of options to provide to the network driver. Defaults to ``None``. Returns: (dict) An endpoint config. Example: >>> endpoint_config = client.api.create_endpoint_config( aliases=['web', 'app'], links={'app_db': 'db', 'another': None}, ipv4_address='132.65.0.123' ) )r ry rz r# r# r$ �create_endpoint_config� s "z(ContainerApiMixin.create_endpoint_configc C � | � | �| �d|��d�S )ai Inspect changes on a container's filesystem. Args: container (str): The container to diff Returns: (list) A list of dictionaries containing the attributes `Path` and `Kind`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/changesT�r9 rN r �r r r# r# r$ �diff� � �zContainerApiMixin.diffc C s$ | j | �d|�dd�}| �||d�S )a Export the contents of a filesystem as a tar archive. Args: container (str): The container to export chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (generator): The archived filesystem data stream Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/exportT)r F)rN r �_stream_raw_result)r r � chunk_sizerR r# r# r$ �export� s �zContainerApiMixin.exportc C sr d|i}|r ddinddi}| � d|�}| j||d|d�}| �|� |j�d�} | �||d �| r6t�| �fS d fS ) a Retrieve a file or folder from a container in the form of a tar archive. Args: container (str): The container where the file is located path (str): Path to the file or folder to retrieve chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB encode_stream (bool): Determines if data should be encoded (gzip-compressed) during transmission. Default: False Returns: (tuple): First element is a raw tar data stream. Second element is a dict containing ``stat`` information on the specified ``path``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> c = docker.APIClient() >>> f = open('./sh_bin.tar', 'wb') >>> bits, stat = c.api.get_archive(container, '/bin/sh') >>> print(stat) {'name': 'sh', 'size': 1075464, 'mode': 493, 'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''} >>> for chunk in bits: ... f.write(chunk) >>> f.close() �pathzAccept-Encodingz gzip, deflate�identity�/containers/{0}/archiveTr' z x-docker-container-path-statFN)r rN �_raise_for_statusr �getr� r �decode_json_header) r r r� r� � encode_streamr r �urlrR � encoded_statr# r# r$ � get_archive� s$ %����� ��z ContainerApiMixin.get_archivec C r� )a| Identical to the `docker inspect` command, but only for containers. Args: container (str): The container to inspect Returns: (dict): Similar to the output of `docker inspect`, but as a single dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. �/containers/{0}/jsonTr� r� r# r# r$ �inspect_container r� z#ContainerApiMixin.inspect_containerc C sN | � d|�}i }|durt|t�st|�}||d< | j||d�}| �|� dS )aB Kill a container or send a signal to a container. Args: container (str): The container to kill signal (str or int): The signal to send. Defaults to ``SIGKILL`` Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/killN�signalrG )r rT rU �intr r� )r r r� r� r rR r# r# r$ �kill s zContainerApiMixin.killrA c C s� |du r|}|r dp d|rdpd|rdpd|rdpdd�} |dkr,t |t�r*|dk r,d}|| d< |durgt |t�rAt�|�| d< n&t |t�rO|dkrO|| d< nt |t�r]|dkr]|| d< n t�d t|�� ���| dur�t� | j d �rwt� d ��t | t�r�t�| �| d < n&t | t�r�| dkr�| | d < nt | t�r�| dkr�| | d < n t�d t| �� ���| � d|�} | j | | |d�} | �||| �} |r�t| | �S | S )a< Get logs from a container. Similar to the ``docker logs`` command. The ``stream`` parameter makes the ``logs`` function return a blocking generator you can iterate over to retrieve log output as it happens. Args: container (str): The container to get logs from stdout (bool): Get ``STDOUT``. Default ``True`` stderr (bool): Get ``STDERR``. Default ``True`` stream (bool): Stream the response. Default ``False`` timestamps (bool): Show timestamps. Default ``False`` tail (str or int): Output specified number of lines at the end of logs. Either an integer of number of lines or the string ``all``. Default ``all`` since (datetime, int, or float): Show logs since a given datetime, integer epoch (in seconds) or float (in fractional seconds) follow (bool): Follow log output. Default ``False`` until (datetime, int, or float): Show logs that occurred before the given datetime, integer epoch (in seconds), or float (in fractional seconds) Returns: (generator of bytes or bytes) Raises: :py:class:`docker.errors.APIError` If the server returns an error. Nr r )r r � timestamps�followrA �tailrD g z:since value should be datetime or positive int/float, not z1.35z-until is not supported for API version < 1.35�untilz:until value should be datetime or positive int/float, not z/containers/{0}/logs)r r )rT r� r r �datetime_to_timestamp�floatr �InvalidArgument�typer~ ry r r rN � _get_resultr )r r r r r r� r� rD r� r� r r� rR r" r# r# r$ r 4 sX ! � ��� �� zContainerApiMixin.logsc C �$ | � d|�}| �|�}| �|� dS )z� Pauses all processes within a container. Args: container (str): The container to pause Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/pauseN�r r r� �r r r� rR r# r# r$ r3 � s zContainerApiMixin.pausec C s� | � | �d|��}| �|� |�� }t|�}d}|�di ��d�}|du r'dS d|v r0|�|�S dD ]}|�|� d|� ��}|rC |S q2|S )a# Lookup the public-facing port that is NAT-ed to ``private_port``. Identical to the ``docker port`` command. Args: container (str): The container to look up private_port (int): The private port to inspect Returns: (list of dict): The mapping for the host ports Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: .. code-block:: bash $ docker run -d -p 80:80 ubuntu:14.04 /bin/sleep 30 7174d6347063a83f412fad6124c99cffd25ffe1a0807eb4b7f9cec76ac8cb43b .. code-block:: python >>> client.api.port('7174d6347063', 80) [{'HostIp': '0.0.0.0', 'HostPort': '80'}] r� N�NetworkSettings�Ports�/)r �udp�sctp)rN r r� r8 rU r� )r r � private_portrR �json_�h_ports� port_settings�protocolr# r# r$ �port� s" �zContainerApiMixin.portc C s8 d|i}| � d|�}| j|||d�}| �|� |jdkS )a( Insert a file or folder in an existing container using a tar archive as source. Args: container (str): The container where the file(s) will be extracted path (str): Path inside the container where the file(s) will be extracted. Must exist. data (bytes or stream): tar data to be extracted Returns: (bool): True if the call succeeds. Raises: :py:class:`docker.errors.APIError` If the server returns an error. r� r� )r r6 �� )r �_putr� � status_code)r r r� r6 r r� rR r# r# r$ � put_archive� s z ContainerApiMixin.put_archivez1.25c C s6 i }|r t �|�|d< | �d�}| �| j||d�d�S )a� Delete stopped containers Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted container IDs and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. rF z/containers/prunerG T)r rM r r9 r )r rF r r� r# r# r$ �prune_containers� s z"ContainerApiMixin.prune_containersc C s0 |||d�}| j | �d|�|d�}| �|� dS )a Remove a container. Similar to the ``docker rm`` command. Args: container (str): The container to remove v (bool): Remove the volumes associated with the container link (bool): Remove the specified link and not the underlying container force (bool): Force the removal of a running container (uses ``SIGKILL``) Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�v�link�forcez/containers/{0}rG N)�_deleter r� )r r r� r� r� r rR r# r# r$ �remove_container� s �z"ContainerApiMixin.remove_containerc C s0 | � d|�}d|i}| j||d�}| �|� dS )a< Rename a container. Similar to the ``docker rename`` command. Args: container (str): ID of the container to rename name (str): New name for the container Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/renamerg rG Nr� )r r rg r� r rR r# r# r$ �rename s zContainerApiMixin.renamec C s2 ||d�}| � d|�}| j||d�}| �|� dS )aC Resize the tty session. Args: container (str or dict): The container to resize height (int): Height of tty session width (int): Width of tty session Raises: :py:class:`docker.errors.APIError` If the server returns an error. )�h�wz/containers/{0}/resizerG Nr� )r r �height�widthr r� rR r# r# r$ �resize! s zContainerApiMixin.resize� c C sH d|i}| � d|�}| j}|dur||7 }| j|||d�}| �|� dS )a� Restart a container. Similar to the ``docker restart`` command. Args: container (str or dict): The container to restart. If a dict, the ``Id`` key is used. timeout (int): Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �tz/containers/{0}/restartN�r �timeout�r r� r r� �r r r� r r� � conn_timeoutrR r# r# r$ �restart4 s zContainerApiMixin.restartc O s6 |s|r t �d��| �d|�}| �|�}| �|� dS )a� Start a container. Similar to the ``docker start`` command, but doesn't support attach options. **Deprecation warning:** Passing configuration options in ``start`` is no longer supported. Users are expected to provide host config options in the ``host_config`` parameter of :py:meth:`~ContainerApiMixin.create_container`. Args: container (str): The container to start Raises: :py:class:`docker.errors.APIError` If the server returns an error. :py:class:`docker.errors.DeprecatedMethod` If any argument besides ``container`` are provided. Example: >>> container = client.api.create_container( ... image='busybox:latest', ... command='/bin/sleep 30') >>> client.api.start(container=container.get('Id')) z|Providing configuration in the start() method is no longer supported. Use the host_config param in create_container instead.z/containers/{0}/startN)r �DeprecatedMethodr r r� )r r r{ r| r� rR r# r# r$ �startL s � zContainerApiMixin.startc C s� | � d|�}d|i}|dur t�| jd�rt�d��||d< |r4|r't�d��| j| j|d|d �|d �S |r;t�d ��| j | j||d �dd �S )a& Stream statistics for a specific container. Similar to the ``docker stats`` command. Args: container (str): The container to stream statistics from decode (bool): If set to true, stream will be decoded into dicts on the fly. Only applicable if ``stream`` is True. False by default. stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default. one_shot (bool): If set to true, Only get a single stat instead of waiting for 2 cycles. Must be used with stream=false. False by default. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/statsr Nr} z0one_shot is not supported for API version < 1.41zone-shotz;one_shot is only available in conjunction with stream=FalseT)r r )�decodez8decode is only available in conjunction with stream=TruerG r7 ) r r r~ ry r r r� �_stream_helperrN r9 )r r r� r �one_shotr� r r# r# r$ �statsr s, �����zContainerApiMixin.statsc C sZ |du r i }d}nd|i}| � d|�}| j}|dur ||7 }| j|||d�}| �|� dS )a� Stops a container. Similar to the ``docker stop`` command. Args: container (str): The container to stop timeout (int): Timeout in seconds to wait for the container to stop before sending a ``SIGKILL``. If None, then the StopTimeout value of the container will be used. Default: None Raises: :py:class:`docker.errors.APIError` If the server returns an error. Nr� r� z/containers/{0}/stopr� r� r� r# r# r$ �stop� s zContainerApiMixin.stopc C s6 | � d|�}i }|dur||d< | �| j||d�d�S )a| Display the running processes of a container. Args: container (str): The container to inspect ps_args (str): An optional arguments passed to ps (e.g. ``aux``) Returns: (str): The output of the top Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/topN�ps_argsrG T)r r9 rN )r r r� r r r# r# r$ �top� s zContainerApiMixin.topc C r� )z� Unpause all processes within a container. Args: container (str): The container to unpause z/containers/{0}/unpauseNr� r� r# r# r$ �unpause� s zContainerApiMixin.unpausez1.22c C s� | � d|�} i }|r||d< |r||d< |r||d< |r ||d< |r&||d< |r,||d< |r5t�|�|d< | r>t�| �|d < | rGt�| �|d < | rPt�| �|d < | rbt�| jd �r^t�d ��| |d< | j| |d�}| �|d�S )aC Update resource configs of one or more containers. Args: container (str): The container to inspect blkio_weight (int): Block IO (relative weight), between 10 and 1000 cpu_period (int): Limit CPU CFS (Completely Fair Scheduler) period cpu_quota (int): Limit CPU CFS (Completely Fair Scheduler) quota cpu_shares (int): CPU shares (relative weight) cpuset_cpus (str): CPUs in which to allow execution cpuset_mems (str): MEMs in which to allow execution mem_limit (float or str): Memory limit mem_reservation (float or str): Memory soft limit memswap_limit (int or str): Total memory (memory + swap), -1 to disable swap kernel_memory (int or str): Kernel memory limit restart_policy (dict): Restart policy dictionary Returns: (dict): Dictionary containing a ``Warnings`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/update� BlkioWeight� CpuPeriod� CpuShares�CpuQuota� CpusetCpus� CpusetMems�Memory�MemoryReservation� MemorySwap� KernelMemoryz1.23z=restart policy update is not supported for API version < 1.23� RestartPolicy)r6 T) r r � parse_bytesr~ ry r r r: r9 )r r � blkio_weight� cpu_period� cpu_quota� cpu_shares� cpuset_cpus� cpuset_mems� mem_limit�mem_reservation� memswap_limit� kernel_memory�restart_policyr� r6 rR r# r# r$ �update_container� s< !� z"ContainerApiMixin.update_containerc C sT | � d|�}i }|dur t�| jd�rt�d��||d< | j|||d�}| �|d�S )a[ Block until a container stops, then return its exit code. Similar to the ``docker wait`` command. Args: container (str or dict): The container to wait on. If a dict, the ``Id`` key is used. timeout (int): Request timeout condition (str): Wait until a container state reaches the given condition, either ``not-running`` (default), ``next-exit``, or ``removed`` Returns: (dict): The API's response as a Python dictionary, including the container's exit code under the ``StatusCode`` attribute. Raises: :py:class:`requests.exceptions.ReadTimeout` If the timeout is exceeded. :py:class:`docker.errors.APIError` If the server returns an error. z/containers/{0}/waitNz1.30z6wait condition is not supported for API version < 1.30� condition)r� r T)r r r~ ry r r r r9 )r r r� r� r� r rR r# r# r$ �wait" s � zContainerApiMixin.wait)TTFFF)NF)NNNNTNN) FFFFNNr? FN)NNNFFFNNNFNNNNNNNNNNNNTN)NNrx )TTFFrA NNN)FFF)r� )NTN) NNNNNNNNNNN)&�__name__� __module__� __qualname__r �check_resourcer% r. r> rS rv rZ r[ r� r� r� r� r r� r� r� r� r r3 r� r� �minimum_versionr� r� r� r� r� r� r� r� r� r� r� r� r# r# r# r$ r s� �5 , �% �E � ^ !$ �4 �R 1 % / �@r N) r � r r � constantsr �typesr r r r r r r# r# r# r$ �<module> s api/__pycache__/image.cpython-310.pyc 0000644 00000043211 15027665106 0013321 0 ustar 00 o �h O � @ sb d dl Z d dlZddlmZmZmZ ddlmZ e �e �Z G dd� d�Z dd� Z d d d �Z dS ) � N� )�auth�errors�utils)�DEFAULT_DATA_CHUNK_SIZEc @ s. e Zd Ze�d�efdd��Ze�d�dd� �Zd*dd �Z d+d d �Z d,d d �Z d,dd�Z d,dd�Z d,dd�Z d,dd�Ze�d�dd� �Ze�d�e�d�d-dd���Zd-dd �Ze�d �d-d d ��Z d.d d!�Z d/d"d#�Ze�d�d0d$d%��Zd-d&d'�Ze�d�d1d(d)��ZdS )2� ImageApiMixin�imagec C s$ | j | �d|�dd�}| �||d�S )a� Get a tarball of an image. Similar to the ``docker save`` command. Args: image (str): Image name to get chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> image = client.api.get_image("busybox:latest") >>> f = open('/tmp/busybox-latest.tar', 'wb') >>> for chunk in image: >>> f.write(chunk) >>> f.close() z/images/{0}/getT)�streamF)�_get�_url�_stream_raw_result)�selfr � chunk_size�res� r �F/usr/local/CyberPanel/lib/python3.10/site-packages/docker/api/image.py� get_image s zImageApiMixin.get_imagec C s | � | �d|��}| �|d�S )a$ Show the history of an image. Args: image (str): The image to show history for Returns: (list): The history of the image Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/images/{0}/historyT)r r �_result)r r r r r r �history) s zImageApiMixin.historyNFc C s� |rdnd|r dndd�}|r&t �| jd�r||d< n |r"||d< nd|i}|r/t �|�|d< | �| j| �d�|d �d �}|rFd d � |D �S |S ) a List images. Similar to the ``docker images`` command. Args: name (str): Only show images belonging to the repository ``name`` quiet (bool): Only return numeric IDs as a list. all (bool): Show intermediate image layers. By default, these are filtered out. filters (dict): Filters to be processed on the image list. Available filters: - ``dangling`` (bool) - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. Returns: (dict or list): A list if ``quiet=True``, otherwise a dict. Raises: :py:class:`docker.errors.APIError` If the server returns an error. � r )�only_ids�all�1.25�filter� reference�filtersz /images/json��paramsTc S s g | ]}|d �qS )�Idr )�.0�xr r r � <listcomp>c s z(ImageApiMixin.images.<locals>.<listcomp>)r � version_lt�_version�convert_filtersr r r )r �name�quietr r r r r r r �images; s" � �zImageApiMixin.imagesc C s� |s |s t �d��| �d�}t|||t|t�r|nd|d�}ddi} |s+|�d�dkr6| �| j|d|d ��S t|t�r_t |d ��} | �| j|| || dd ��W d � S 1 sXw Y dS |red | d < | �| j|||| d��S )ad Import an image. Similar to the ``docker import`` command. If ``src`` is a string or unicode string, it will first be treated as a path to a tarball on the local system. If there is an error reading from that file, ``src`` will be treated as a URL instead to fetch the image from. You can also pass an open file handle as ``src``, in which case the data will be read from that file. If ``src`` is unset but ``image`` is set, the ``image`` parameter will be taken as the name of an existing image to import from. Args: src (str or file): Path to tarfile, URL, or file-like object repository (str): The repository to create tag (str): The tag to apply image (str): Use another image like the ``FROM`` Dockerfile parameter z(Must specify src or image to import from�/images/createN��src�changes� Content-Type�application/tar�fromSrc�-)�datar �rb�r0 r �headers�timeout�chunkedzTransfer-Encoding)r0 r r3 ) r �DockerExceptionr �_import_image_params� isinstance�str�getr �_post�open) r r* � repository�tagr r+ � stream_src�ur r3 �fr r r � import_imagef s8 � �� ��$��zImageApiMixin.import_imagec C s< | � d�}t||d|d�}ddi}| �| j||||dd��S )a@ Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but allows importing in-memory bytes data. Args: data (bytes collection): Bytes collection containing valid tar data repository (str): The repository to create tag (str): The tag to apply r( r/ r) r, r- Nr2 )r r7 r r; )r r0 r= r> r+ r@ r r3 r r r �import_image_from_data� s � ��z$ImageApiMixin.import_image_from_datac C � | j ||||d�S )aj Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from a tar file on disk. Args: filename (str): Full path to a tar file. repository (str): The repository to create tag (str): The tag to apply Raises: IOError: File does not exist. �r* r= r> r+ �rB )r �filenamer= r> r+ r r r �import_image_from_file� s �z$ImageApiMixin.import_image_from_filec C s | j |d|||d�S )NT)r* r? r= r> r+ rF )r r r= r> r+ r r r �import_image_from_stream� s �z&ImageApiMixin.import_image_from_streamc C rD )a" Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from a URL. Args: url (str): A URL pointing to a tar file. repository (str): The repository to create tag (str): The tag to apply rE rF )r �urlr= r> r+ r r r �import_image_from_url� s �z#ImageApiMixin.import_image_from_urlc C rD )aX Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from another image, like the ``FROM`` Dockerfile parameter. Args: image (str): Image name to import from repository (str): The repository to create tag (str): The tag to apply )r r= r> r+ rF )r r r= r> r+ r r r �import_image_from_image� s �z%ImageApiMixin.import_image_from_imagec C s | � | �| �d|��d�S )a� Get detailed information about an image. Similar to the ``docker inspect`` command, but only for images. Args: image (str): The image to inspect Returns: (dict): Similar to the output of ``docker inspect``, but as a single dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/images/{0}/jsonT�r r r )r r r r r � inspect_image� s �zImageApiMixin.inspect_imagez1.30c C sn t �|�\}}i }|du rt �| |�}|r||d< n t�d� t �|�|d< | �d|�}| �| j||d�d�S )a/ Get image digest and platform information by contacting the registry. Args: image (str): The image name to inspect auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. Returns: (dict): A dict containing distribution data Raises: :py:class:`docker.errors.APIError` If the server returns an error. N�X-Registry-Auth� Sending supplied auth configz/distribution/{0}/json)r3 T) r �resolve_repository_name�get_config_header�log�debug� encode_headerr r r )r r � auth_config�registry�_r3 �headerrJ r r r �inspect_distribution� s � �z"ImageApiMixin.inspect_distributionc C sn i }|durt �| jd�rt�d��||d< | j| �d�||dd�}t �| jd�r0| j|dd�S | � |� dS ) a9 Load an image that was previously saved using :py:meth:`~docker.api.image.ImageApiMixin.get_image` (or ``docker save``). Similar to ``docker load``. Args: data (binary): Image data to be loaded. quiet (boolean): Suppress progress details in response. Returns: (generator): Progress output as JSON objects. Only available for API version >= 1.23 Raises: :py:class:`docker.errors.APIError` If the server returns an error. Nz1.23z,quiet is not supported in API version < 1.23r& z /images/loadT)r0 r r ��decode) r r" r# r �InvalidVersionr; r � version_gte�_stream_helper�_raise_for_status)r r0 r& r r r r r � load_image# s ��zImageApiMixin.load_imager c C s: | � d�}i }|durt�|�|d< | �| j||d�d�S )a Delete unused images Args: filters (dict): Filters to process on the prune list. Available filters: - dangling (bool): When set to true (or 1), prune only unused and untagged images. Returns: (dict): A dict containing a list of deleted image IDs and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /images/pruneNr r T)r r r$ r r; )r r rJ r r r r � prune_imagesF s zImageApiMixin.prune_imagesc C s� t �|�\}}|p |p d}|rd}t�|�\} } ||d�} i } |du r0t�| | �} | r/| | d< n t�d� t�|�| d< |durPt �| j d�rLt � d��|| d< | j | � d �| | |dd �}| �|� |rk| j||d �S | �|�S ) aa Pulls an image. Similar to the ``docker pull`` command. Args: repository (str): The repository to pull tag (str): The tag to pull. If ``tag`` is ``None`` or empty, it is set to ``latest``. stream (bool): Stream the output as a generator. Make sure to consume the generator, otherwise pull might get cancelled. auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` platform (str): Platform in the format ``os[/arch[/variant]]`` all_tags (bool): Pull all image tags, the ``tag`` parameter is ignored. Returns: (generator or str): The output Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> resp = client.api.pull('busybox', stream=True, decode=True) ... for line in resp: ... print(json.dumps(line, indent=4)) { "status": "Pulling image (latest) from busybox", "progressDetail": {}, "id": "e72ac664f4f0" } { "status": "Pulling image (latest) from busybox, endpoint: ...", "progressDetail": {}, "id": "e72ac664f4f0" } �latestN)r> � fromImagerO rP z1.32z0platform was only introduced in API version 1.32�platformr( )r r3 r r4 r[ )r �parse_repository_tagr rQ rR rS rT rU r" r# r r] r; r r` r_ r )r r= r> r rV r\ re �all_tags� image_tagrW � repo_namer r3 rY �responser r r �pull_ s< , � � � � zImageApiMixin.pullc C s� |s t �|�\}}t�|�\}}| �d|�}d|i} i } |du r-t�| |�} | r,| | d< n t�d� t�|�| d< | j |d| || d�} | � | � |rQ| j | |d�S | � | �S )aG Push an image or a repository to the registry. Similar to the ``docker push`` command. Args: repository (str): The repository to push to tag (str): An optional tag to push stream (bool): Stream the output as a blocking generator auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` Returns: (generator or str): The output from the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> resp = client.api.push( ... 'yourname/app', ... stream=True, ... decode=True, ... ) ... for line in resp: ... print(line) {'status': 'Pushing repository yourname/app (1 tags)'} {'status': 'Pushing','progressDetail': {}, 'id': '511136ea3c5a'} {'status': 'Image already pushed, skipping', 'progressDetail':{}, 'id': '511136ea3c5a'} ... z/images/{0}/pushr> NrO rP )r3 r r r[ ) r rf r rQ r rR rS rT rU � _post_jsonr` r_ r ) r r= r> r rV r\ rW ri r@ r r3 rY rj r r r �push� s* & � � � zImageApiMixin.pushc C s, ||d�}| j | �d|�|d�}| �|d�S )z� Remove an image. Similar to the ``docker rmi`` command. Args: image (str): The image to remove force (bool): Force removal of the image noprune (bool): Do not delete untagged parents )�force�noprunez /images/{0}r T)�_deleter r )r r rn ro r r r r r � remove_image� s zImageApiMixin.remove_imagec C s4 d|i}|dur ||d< | � | j| �d�|d�d�S )a� Search for images on Docker Hub. Similar to the ``docker search`` command. Args: term (str): A term to search for. limit (int): The maximum number of results to return. Returns: (list of dicts): The response of the search. Raises: :py:class:`docker.errors.APIError` If the server returns an error. �termN�limitz/images/searchr TrM )r rr rs r r r r �search s �zImageApiMixin.searchc C sB |||rdndd�}| � d|�}| j||d�}| �|� |jdkS )aH Tag an image into a repository. Similar to the ``docker tag`` command. Args: image (str): The image to tag repository (str): The repository to set for the tag tag (str): The tag name force (bool): Force Returns: (bool): ``True`` if successful Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.tag('ubuntu', 'localhost:5000/ubuntu', 'latest', force=True) r r )r> �reporn z/images/{0}/tagr �� )r r; r` � status_code)r r r= r> rn r rJ r r r r r> s � zImageApiMixin.tag)NFFN)NNNNNF�NNN)N)NFNFNF)NFNF)FF�NF)�__name__� __module__� __qualname__r �check_resourcer r r r' rB rC rH rI rK rL rN �minimum_versionrZ ra rb rk rm rq rt r> r r r r r sV + �4 � � � � � "# �U �B r c C s. z t | t�o tj�| �W S ty Y dS w ry )r8 r9 �os�path�isfile� TypeError)r* r r r �is_file? s � �r� c C sF | |d�}|r ||d< n|rt |�s||d< nd|d< |r!||d< |S )N)ru r> rd r. r/ r+ )r� )ru r> r r* r+ r r r r r7 I s � r7 rx )�loggingr � r r r � constantsr � getLoggerrz rS r r� r7 r r r r �<module> s 9 � api/build.py 0000644 00000037277 15027665106 0007016 0 ustar 00 import json import logging import os import random from .. import auth, constants, errors, utils log = logging.getLogger(__name__) class BuildApiMixin: def build(self, path=None, tag=None, quiet=False, fileobj=None, nocache=False, rm=False, timeout=None, custom_context=False, encoding=None, pull=False, forcerm=False, dockerfile=None, container_limits=None, decode=False, buildargs=None, gzip=False, shmsize=None, labels=None, cache_from=None, target=None, network_mode=None, squash=None, extra_hosts=None, platform=None, isolation=None, use_config_proxy=True): """ Similar to the ``docker build`` command. Either ``path`` or ``fileobj`` needs to be set. ``path`` can be a local path (to a directory containing a Dockerfile) or a remote URL. ``fileobj`` must be a readable file-like object to a Dockerfile. If you have a tar file for the Docker build context (including a Dockerfile) already, pass a readable file-like object to ``fileobj`` and also pass ``custom_context=True``. If the stream is compressed also, set ``encoding`` to the correct value (e.g ``gzip``). Example: >>> from io import BytesIO >>> from docker import APIClient >>> dockerfile = ''' ... # Shared Volume ... FROM busybox:buildroot-2014.02 ... VOLUME /data ... CMD ["/bin/sh"] ... ''' >>> f = BytesIO(dockerfile.encode('utf-8')) >>> cli = APIClient(base_url='tcp://127.0.0.1:2375') >>> response = [line for line in cli.build( ... fileobj=f, rm=True, tag='yourname/volume' ... )] >>> response ['{"stream":" ---\\u003e a9eb17255234\\n"}', '{"stream":"Step 1 : VOLUME /data\\n"}', '{"stream":" ---\\u003e Running in abdc1e6896c6\\n"}', '{"stream":" ---\\u003e 713bca62012e\\n"}', '{"stream":"Removing intermediate container abdc1e6896c6\\n"}', '{"stream":"Step 2 : CMD [\\"/bin/sh\\"]\\n"}', '{"stream":" ---\\u003e Running in dba30f2a1a7e\\n"}', '{"stream":" ---\\u003e 032b8b2855fc\\n"}', '{"stream":"Removing intermediate container dba30f2a1a7e\\n"}', '{"stream":"Successfully built 032b8b2855fc\\n"}'] Args: path (str): Path to the directory containing the Dockerfile fileobj: A file object to use as the Dockerfile. (Or a file-like object) tag (str): A tag to add to the final image quiet (bool): Whether to return the status nocache (bool): Don't use the cache when set to ``True`` rm (bool): Remove intermediate containers. The ``docker build`` command now defaults to ``--rm=true``, but we have kept the old default of `False` to preserve backward compatibility timeout (int): HTTP timeout custom_context (bool): Optional if using ``fileobj`` encoding (str): The encoding for a stream. Set to ``gzip`` for compressing pull (bool): Downloads any updates to the FROM image in Dockerfiles forcerm (bool): Always remove intermediate containers, even after unsuccessful builds dockerfile (str): path within the build context to the Dockerfile gzip (bool): If set to ``True``, gzip compression/encoding is used buildargs (dict): A dictionary of build arguments container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys: - memory (int): set memory limit for build - memswap (int): Total memory (memory + swap), -1 to disable swap - cpushares (int): CPU shares (relative weight) - cpusetcpus (str): CPUs in which to allow execution, e.g., ``"0-3"``, ``"0,1"`` decode (bool): If set to ``True``, the returned stream will be decoded into dicts on the fly. Default ``False`` shmsize (int): Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB labels (dict): A dictionary of labels to set on the image cache_from (:py:class:`list`): A list of images used for build cache resolution target (str): Name of the build-stage to build in a multi-stage Dockerfile network_mode (str): networking mode for the run commands during build squash (bool): Squash the resulting images layers into a single layer. extra_hosts (dict): Extra hosts to add to /etc/hosts in building containers, as a mapping of hostname to IP address. platform (str): Platform in the format ``os[/arch[/variant]]`` isolation (str): Isolation technology used during build. Default: `None`. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being built. Returns: A generator for the build output. Raises: :py:class:`docker.errors.APIError` If the server returns an error. ``TypeError`` If neither ``path`` nor ``fileobj`` is specified. """ remote = context = None headers = {} container_limits = container_limits or {} buildargs = buildargs or {} if path is None and fileobj is None: raise TypeError("Either path or fileobj needs to be provided.") if gzip and encoding is not None: raise errors.DockerException( 'Can not use custom encoding if gzip is enabled' ) if tag is not None: if not utils.match_tag(tag): raise errors.DockerException( f"invalid tag '{tag}': invalid reference format" ) for key in container_limits.keys(): if key not in constants.CONTAINER_LIMITS_KEYS: raise errors.DockerException( f"invalid tag '{tag}': invalid reference format" ) if custom_context: if not fileobj: raise TypeError("You must specify fileobj with custom_context") context = fileobj elif fileobj is not None: context = utils.mkbuildcontext(fileobj) elif path.startswith(('http://', 'https://', 'git://', 'github.com/', 'git@')): remote = path elif not os.path.isdir(path): raise TypeError("You must specify a directory to build in path") else: dockerignore = os.path.join(path, '.dockerignore') exclude = None if os.path.exists(dockerignore): with open(dockerignore) as f: exclude = list(filter( lambda x: x != '' and x[0] != '#', [line.strip() for line in f.read().splitlines()] )) dockerfile = process_dockerfile(dockerfile, path) context = utils.tar( path, exclude=exclude, dockerfile=dockerfile, gzip=gzip ) encoding = 'gzip' if gzip else encoding u = self._url('/build') params = { 't': tag, 'remote': remote, 'q': quiet, 'nocache': nocache, 'rm': rm, 'forcerm': forcerm, 'pull': pull, 'dockerfile': dockerfile, } params.update(container_limits) if use_config_proxy: proxy_args = self._proxy_configs.get_environment() for k, v in proxy_args.items(): buildargs.setdefault(k, v) if buildargs: params.update({'buildargs': json.dumps(buildargs)}) if shmsize: if utils.version_gte(self._version, '1.22'): params.update({'shmsize': shmsize}) else: raise errors.InvalidVersion( 'shmsize was only introduced in API version 1.22' ) if labels: if utils.version_gte(self._version, '1.23'): params.update({'labels': json.dumps(labels)}) else: raise errors.InvalidVersion( 'labels was only introduced in API version 1.23' ) if cache_from: if utils.version_gte(self._version, '1.25'): params.update({'cachefrom': json.dumps(cache_from)}) else: raise errors.InvalidVersion( 'cache_from was only introduced in API version 1.25' ) if target: if utils.version_gte(self._version, '1.29'): params.update({'target': target}) else: raise errors.InvalidVersion( 'target was only introduced in API version 1.29' ) if network_mode: if utils.version_gte(self._version, '1.25'): params.update({'networkmode': network_mode}) else: raise errors.InvalidVersion( 'network_mode was only introduced in API version 1.25' ) if squash: if utils.version_gte(self._version, '1.25'): params.update({'squash': squash}) else: raise errors.InvalidVersion( 'squash was only introduced in API version 1.25' ) if extra_hosts is not None: if utils.version_lt(self._version, '1.27'): raise errors.InvalidVersion( 'extra_hosts was only introduced in API version 1.27' ) if isinstance(extra_hosts, dict): extra_hosts = utils.format_extra_hosts(extra_hosts) params.update({'extrahosts': extra_hosts}) if platform is not None: if utils.version_lt(self._version, '1.32'): raise errors.InvalidVersion( 'platform was only introduced in API version 1.32' ) params['platform'] = platform if isolation is not None: if utils.version_lt(self._version, '1.24'): raise errors.InvalidVersion( 'isolation was only introduced in API version 1.24' ) params['isolation'] = isolation if context is not None: headers = {'Content-Type': 'application/tar'} if encoding: headers['Content-Encoding'] = encoding self._set_auth_headers(headers) response = self._post( u, data=context, params=params, headers=headers, stream=True, timeout=timeout, ) if context is not None and not custom_context: context.close() return self._stream_helper(response, decode=decode) @utils.minimum_version('1.31') def prune_builds(self, filters=None, keep_storage=None, all=None): """ Delete the builder cache Args: filters (dict): Filters to process on the prune list. Needs Docker API v1.39+ Available filters: - dangling (bool): When set to true (or 1), prune only unused and untagged images. - until (str): Can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the daemon's local time. keep_storage (int): Amount of disk space in bytes to keep for cache. Needs Docker API v1.39+ all (bool): Remove all types of build cache. Needs Docker API v1.39+ Returns: (dict): A dictionary containing information about the operation's result. The ``SpaceReclaimed`` key indicates the amount of bytes of disk space reclaimed. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/build/prune") if (filters, keep_storage, all) != (None, None, None) \ and utils.version_lt(self._version, '1.39'): raise errors.InvalidVersion( '`filters`, `keep_storage`, and `all` args are only available ' 'for API version > 1.38' ) params = {} if filters is not None: params['filters'] = utils.convert_filters(filters) if keep_storage is not None: params['keep-storage'] = keep_storage if all is not None: params['all'] = all return self._result(self._post(url, params=params), True) def _set_auth_headers(self, headers): log.debug('Looking for auth config') # If we don't have any auth data so far, try reloading the config # file one more time in case anything showed up in there. if not self._auth_configs or self._auth_configs.is_empty: log.debug("No auth config in memory - loading from filesystem") self._auth_configs = auth.load_config( credstore_env=self.credstore_env ) # Send the full auth configuration (if any exists), since the build # could use any (or all) of the registries. if self._auth_configs: auth_data = self._auth_configs.get_all_credentials() # See https://github.com/docker/docker-py/issues/1683 if (auth.INDEX_URL not in auth_data and auth.INDEX_NAME in auth_data): auth_data[auth.INDEX_URL] = auth_data.get(auth.INDEX_NAME, {}) log.debug( "Sending auth config (%s)", ', '.join(repr(k) for k in auth_data), ) if auth_data: headers['X-Registry-Config'] = auth.encode_header( auth_data ) else: log.debug('No auth config found') def process_dockerfile(dockerfile, path): if not dockerfile: return (None, None) abs_dockerfile = dockerfile if not os.path.isabs(dockerfile): abs_dockerfile = os.path.join(path, dockerfile) if constants.IS_WINDOWS_PLATFORM and path.startswith( constants.WINDOWS_LONGPATH_PREFIX): normpath = os.path.normpath( abs_dockerfile[len(constants.WINDOWS_LONGPATH_PREFIX):]) abs_dockerfile = f'{constants.WINDOWS_LONGPATH_PREFIX}{normpath}' if (os.path.splitdrive(path)[0] != os.path.splitdrive(abs_dockerfile)[0] or os.path.relpath(abs_dockerfile, path).startswith('..')): # Dockerfile not in context - read data to insert into tar later with open(abs_dockerfile) as df: return ( f'.dockerfile.{random.getrandbits(160):x}', df.read() ) # Dockerfile is inside the context - return path relative to context root if dockerfile == abs_dockerfile: # Only calculate relpath if necessary to avoid errors # on Windows client -> Linux Docker # see https://github.com/docker/compose/issues/5969 dockerfile = os.path.relpath(abs_dockerfile, path) return (dockerfile, None) api/plugin.py 0000644 00000021426 15027665106 0007202 0 ustar 00 from .. import auth, utils class PluginApiMixin: @utils.minimum_version('1.25') @utils.check_resource('name') def configure_plugin(self, name, options): """ Configure a plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. options (dict): A key-value mapping of options Returns: ``True`` if successful """ url = self._url('/plugins/{0}/set', name) data = options if isinstance(data, dict): data = [f'{k}={v}' for k, v in data.items()] res = self._post_json(url, data=data) self._raise_for_status(res) return True @utils.minimum_version('1.25') def create_plugin(self, name, plugin_data_dir, gzip=False): """ 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: ``True`` if successful """ url = self._url('/plugins/create') with utils.create_archive( root=plugin_data_dir, gzip=gzip, files=set(utils.build.walk(plugin_data_dir, [])) ) as archv: res = self._post(url, params={'name': name}, data=archv) self._raise_for_status(res) return True @utils.minimum_version('1.25') def disable_plugin(self, name, force=False): """ Disable an installed plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. force (bool): To enable the force query parameter. Returns: ``True`` if successful """ url = self._url('/plugins/{0}/disable', name) res = self._post(url, params={'force': force}) self._raise_for_status(res) return True @utils.minimum_version('1.25') def enable_plugin(self, name, timeout=0): """ Enable an installed plugin. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. timeout (int): Operation timeout (in seconds). Default: 0 Returns: ``True`` if successful """ url = self._url('/plugins/{0}/enable', name) params = {'timeout': timeout} res = self._post(url, params=params) self._raise_for_status(res) return True @utils.minimum_version('1.25') def inspect_plugin(self, name): """ Retrieve plugin metadata. Args: name (string): The name of the plugin. The ``:latest`` tag is optional, and is the default if omitted. Returns: A dict containing plugin info """ url = self._url('/plugins/{0}/json', name) return self._result(self._get(url), True) @utils.minimum_version('1.25') def pull_plugin(self, remote, privileges, name=None): """ Pull and install a plugin. After the plugin is installed, it can be enabled using :py:meth:`~enable_plugin`. Args: remote (string): Remote reference for the plugin to install. The ``:latest`` tag is optional, and is the default if omitted. privileges (:py:class:`list`): A list of privileges the user consents to grant to the plugin. Can be retrieved using :py:meth:`~plugin_privileges`. name (string): Local name for the pulled plugin. The ``:latest`` tag is optional, and is the default if omitted. Returns: An iterable object streaming the decoded API logs """ url = self._url('/plugins/pull') params = { 'remote': remote, } if name: params['name'] = name headers = {} registry, repo_name = auth.resolve_repository_name(remote) header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header response = self._post_json( url, params=params, headers=headers, data=privileges, stream=True ) self._raise_for_status(response) return self._stream_helper(response, decode=True) @utils.minimum_version('1.25') def plugins(self): """ Retrieve a list of installed plugins. Returns: A list of dicts, one per plugin """ url = self._url('/plugins') return self._result(self._get(url), True) @utils.minimum_version('1.25') def plugin_privileges(self, name): """ Retrieve list of privileges to be granted to a plugin. Args: name (string): Name of the remote plugin to examine. The ``:latest`` tag is optional, and is the default if omitted. Returns: A list of dictionaries representing the plugin's permissions """ params = { 'remote': name, } headers = {} registry, repo_name = auth.resolve_repository_name(name) header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header url = self._url('/plugins/privileges') return self._result( self._get(url, params=params, headers=headers), True ) @utils.minimum_version('1.25') @utils.check_resource('name') def push_plugin(self, name): """ Push a plugin to the registry. Args: name (string): Name of the plugin to upload. The ``:latest`` tag is optional, and is the default if omitted. Returns: ``True`` if successful """ url = self._url('/plugins/{0}/pull', name) headers = {} registry, repo_name = auth.resolve_repository_name(name) header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header res = self._post(url, headers=headers) self._raise_for_status(res) return self._stream_helper(res, decode=True) @utils.minimum_version('1.25') @utils.check_resource('name') def remove_plugin(self, name, force=False): """ Remove an installed plugin. Args: name (string): Name of the plugin to remove. The ``:latest`` tag is optional, and is the default if omitted. force (bool): Disable the plugin before removing. This may result in issues if the plugin is in use by a container. Returns: ``True`` if successful """ url = self._url('/plugins/{0}', name) res = self._delete(url, params={'force': force}) self._raise_for_status(res) return True @utils.minimum_version('1.26') @utils.check_resource('name') def upgrade_plugin(self, name, remote, privileges): """ Upgrade an installed plugin. Args: name (string): Name of the plugin to upgrade. The ``:latest`` tag is optional and is the default if omitted. remote (string): Remote reference to upgrade to. The ``:latest`` tag is optional and is the default if omitted. privileges (:py:class:`list`): A list of privileges the user consents to grant to the plugin. Can be retrieved using :py:meth:`~plugin_privileges`. Returns: An iterable object streaming the decoded API logs """ url = self._url('/plugins/{0}/upgrade', name) params = { 'remote': remote, } headers = {} registry, repo_name = auth.resolve_repository_name(remote) header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header response = self._post_json( url, params=params, headers=headers, data=privileges, stream=True ) self._raise_for_status(response) return self._stream_helper(response, decode=True) api/daemon.py 0000644 00000013570 15027665106 0007150 0 ustar 00 import os from datetime import datetime from .. import auth, types, utils class DaemonApiMixin: @utils.minimum_version('1.25') def df(self): """ Get data usage information. Returns: (dict): A dictionary representing different resource categories and their respective data usage. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/system/df') return self._result(self._get(url), True) def events(self, since=None, until=None, filters=None, decode=None): """ Get real-time events from the server. Similar to the ``docker events`` command. Args: since (UTC datetime or int): Get events from this point until (UTC datetime or int): Get events until this point filters (dict): Filter the events by event time, container or image decode (bool): If set to true, stream will be decoded into dicts on the fly. False by default. Returns: A :py:class:`docker.types.daemon.CancellableStream` generator Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> for event in client.events(decode=True) ... print(event) {u'from': u'image/with:tag', u'id': u'container-id', u'status': u'start', u'time': 1423339459} ... or >>> events = client.events() >>> for event in events: ... print(event) >>> # and cancel from another thread >>> events.close() """ if isinstance(since, datetime): since = utils.datetime_to_timestamp(since) if isinstance(until, datetime): until = utils.datetime_to_timestamp(until) if filters: filters = utils.convert_filters(filters) params = { 'since': since, 'until': until, 'filters': filters } url = self._url('/events') response = self._get(url, params=params, stream=True, timeout=None) stream = self._stream_helper(response, decode=decode) return types.CancellableStream(stream, response) def info(self): """ Display system-wide information. Identical to the ``docker info`` command. Returns: (dict): The info as a dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self._result(self._get(self._url("/info")), True) def login(self, username, password=None, email=None, registry=None, reauth=False, dockercfg_path=None): """ Authenticate with a registry. Similar to the ``docker login`` command. Args: username (str): The registry username password (str): The plaintext password email (str): The email for the registry account registry (str): URL to the registry. E.g. ``https://index.docker.io/v1/`` reauth (bool): Whether or not to refresh existing authentication on the Docker server. dockercfg_path (str): Use a custom path for the Docker config file (default ``$HOME/.docker/config.json`` if present, otherwise ``$HOME/.dockercfg``) Returns: (dict): The response from the login request Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ # If we don't have any auth data so far, try reloading the config file # one more time in case anything showed up in there. # If dockercfg_path is passed check to see if the config file exists, # if so load that config. if dockercfg_path and os.path.exists(dockercfg_path): self._auth_configs = auth.load_config( dockercfg_path, credstore_env=self.credstore_env ) elif not self._auth_configs or self._auth_configs.is_empty: self._auth_configs = auth.load_config( credstore_env=self.credstore_env ) authcfg = self._auth_configs.resolve_authconfig(registry) # If we found an existing auth config for this registry and username # combination, we can return it immediately unless reauth is requested. if authcfg and authcfg.get('username', None) == username \ and not reauth: return authcfg req_data = { 'username': username, 'password': password, 'email': email, 'serveraddress': registry, } response = self._post_json(self._url('/auth'), data=req_data) if response.status_code == 200: self._auth_configs.add_auth(registry or auth.INDEX_NAME, req_data) return self._result(response, json=True) def ping(self): """ Checks the server is responsive. An exception will be raised if it isn't responding. Returns: (bool) The response from the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self._result(self._get(self._url('/_ping'))) == 'OK' def version(self, api_version=True): """ Returns version information from the server. Similar to the ``docker version`` command. Returns: (dict): The server version information Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/version", versioned_api=api_version) return self._result(self._get(url), json=True) api/exec_api.py 0000644 00000014102 15027665106 0007452 0 ustar 00 from .. import errors, utils from ..types import CancellableStream class ExecApiMixin: @utils.check_resource('container') def exec_create(self, container, cmd, stdout=True, stderr=True, stdin=False, tty=False, privileged=False, user='', environment=None, workdir=None, detach_keys=None): """ Sets up an exec instance in a running container. Args: container (str): Target container where exec instance will be created cmd (str or list): Command to be executed stdout (bool): Attach to stdout. Default: ``True`` stderr (bool): Attach to stderr. Default: ``True`` stdin (bool): Attach to stdin. Default: ``False`` tty (bool): Allocate a pseudo-TTY. Default: False privileged (bool): Run as privileged. user (str): User to execute command as. Default: root environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. workdir (str): Path to working directory for this exec session detach_keys (str): Override the key sequence for detaching a container. Format is a single character `[a-Z]` or `ctrl-<value>` where `<value>` is one of: `a-z`, `@`, `^`, `[`, `,` or `_`. ~/.docker/config.json is used by default. Returns: (dict): A dictionary with an exec ``Id`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if environment is not None and utils.version_lt(self._version, '1.25'): raise errors.InvalidVersion( 'Setting environment for exec is not supported in API < 1.25' ) if isinstance(cmd, str): cmd = utils.split_command(cmd) if isinstance(environment, dict): environment = utils.utils.format_environment(environment) data = { 'Container': container, 'User': user, 'Privileged': privileged, 'Tty': tty, 'AttachStdin': stdin, 'AttachStdout': stdout, 'AttachStderr': stderr, 'Cmd': cmd, 'Env': environment, } if workdir is not None: if utils.version_lt(self._version, '1.35'): raise errors.InvalidVersion( 'workdir is not supported for API version < 1.35' ) data['WorkingDir'] = workdir if detach_keys: data['detachKeys'] = detach_keys elif 'detachKeys' in self._general_configs: data['detachKeys'] = self._general_configs['detachKeys'] url = self._url('/containers/{0}/exec', container) res = self._post_json(url, data=data) return self._result(res, True) def exec_inspect(self, exec_id): """ Return low-level information about an exec command. Args: exec_id (str): ID of the exec instance Returns: (dict): Dictionary of values returned by the endpoint. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if isinstance(exec_id, dict): exec_id = exec_id.get('Id') res = self._get(self._url("/exec/{0}/json", exec_id)) return self._result(res, True) def exec_resize(self, exec_id, height=None, width=None): """ Resize the tty session used by the specified exec command. Args: exec_id (str): ID of the exec instance height (int): Height of tty session width (int): Width of tty session """ if isinstance(exec_id, dict): exec_id = exec_id.get('Id') params = {'h': height, 'w': width} url = self._url("/exec/{0}/resize", exec_id) res = self._post(url, params=params) self._raise_for_status(res) @utils.check_resource('exec_id') def exec_start(self, exec_id, detach=False, tty=False, stream=False, socket=False, demux=False): """ Start a previously set up exec instance. Args: exec_id (str): ID of the exec instance detach (bool): If true, detach from the exec command. Default: False tty (bool): Allocate a pseudo-TTY. Default: False stream (bool): Return response data progressively as an iterator of strings, rather than a single string. socket (bool): Return the connection socket to allow custom read/write operations. Must be closed by the caller when done. demux (bool): Return stdout and stderr separately Returns: (generator or str or tuple): If ``stream=True``, a generator yielding response chunks. If ``socket=True``, a socket object for the connection. A string containing response data otherwise. If ``demux=True``, a tuple with two elements of type byte: stdout and stderr. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ # we want opened socket if socket == True data = { 'Tty': tty, 'Detach': detach } headers = {} if detach else { 'Connection': 'Upgrade', 'Upgrade': 'tcp' } res = self._post_json( self._url('/exec/{0}/start', exec_id), headers=headers, data=data, stream=True ) if detach: try: return self._result(res) finally: res.close() if socket: return self._get_raw_response_socket(res) output = self._read_from_socket(res, stream, tty=tty, demux=demux) if stream: return CancellableStream(output, res) else: return output api/volume.py 0000644 00000011777 15027665106 0007223 0 ustar 00 from .. import errors, utils class VolumeApiMixin: def volumes(self, filters=None): """ List volumes currently registered by the docker daemon. Similar to the ``docker volume ls`` command. Args: filters (dict): Server-side list filtering options. Returns: (dict): Dictionary with list of volume objects as value of the ``Volumes`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.volumes() {u'Volumes': [{u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar'}, {u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/baz/_data', u'Name': u'baz'}]} """ params = { 'filters': utils.convert_filters(filters) if filters else None } url = self._url('/volumes') return self._result(self._get(url, params=params), True) def create_volume(self, name=None, driver=None, driver_opts=None, labels=None): """ Create and register a named volume Args: name (str): Name of the volume driver (str): Name of the driver used to create the volume driver_opts (dict): Driver options as a key-value dictionary labels (dict): Labels to set on the volume Returns: (dict): The created volume reference object Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> volume = client.api.create_volume( ... name='foobar', ... driver='local', ... driver_opts={'foo': 'bar', 'baz': 'false'}, ... labels={"key": "value"}, ... ) ... print(volume) {u'Driver': u'local', u'Labels': {u'key': u'value'}, u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar', u'Scope': u'local'} """ url = self._url('/volumes/create') if driver_opts is not None and not isinstance(driver_opts, dict): raise TypeError('driver_opts must be a dictionary') data = { 'Name': name, 'Driver': driver, 'DriverOpts': driver_opts, } if labels is not None: if utils.compare_version('1.23', self._version) < 0: raise errors.InvalidVersion( 'volume labels were introduced in API 1.23' ) if not isinstance(labels, dict): raise TypeError('labels must be a dictionary') data["Labels"] = labels return self._result(self._post_json(url, data=data), True) def inspect_volume(self, name): """ Retrieve volume info by name. Args: name (str): volume name Returns: (dict): Volume information dictionary Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.inspect_volume('foobar') {u'Driver': u'local', u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Name': u'foobar'} """ url = self._url('/volumes/{0}', name) return self._result(self._get(url), True) @utils.minimum_version('1.25') def prune_volumes(self, filters=None): """ Delete unused volumes Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted volume names and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {} if filters: params['filters'] = utils.convert_filters(filters) url = self._url('/volumes/prune') return self._result(self._post(url, params=params), True) def remove_volume(self, name, force=False): """ Remove a volume. Similar to the ``docker volume rm`` command. Args: name (str): The volume's name force (bool): Force removal of volumes that were already removed out of band by the volume driver plugin. Raises: :py:class:`docker.errors.APIError` If volume failed to remove. """ params = {} if force: if utils.version_lt(self._version, '1.25'): raise errors.InvalidVersion( 'force removal was introduced in API 1.25' ) params = {'force': force} url = self._url('/volumes/{0}', name, params=params) resp = self._delete(url) self._raise_for_status(resp) api/image.py 0000644 00000047440 15027665106 0006772 0 ustar 00 import logging import os from .. import auth, errors, utils from ..constants import DEFAULT_DATA_CHUNK_SIZE log = logging.getLogger(__name__) class ImageApiMixin: @utils.check_resource('image') def get_image(self, image, chunk_size=DEFAULT_DATA_CHUNK_SIZE): """ Get a tarball of an image. Similar to the ``docker save`` command. Args: image (str): Image name to get chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (generator): A stream of raw archive data. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> image = client.api.get_image("busybox:latest") >>> f = open('/tmp/busybox-latest.tar', 'wb') >>> for chunk in image: >>> f.write(chunk) >>> f.close() """ res = self._get(self._url("/images/{0}/get", image), stream=True) return self._stream_raw_result(res, chunk_size, False) @utils.check_resource('image') def history(self, image): """ Show the history of an image. Args: image (str): The image to show history for Returns: (list): The history of the image Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ res = self._get(self._url("/images/{0}/history", image)) return self._result(res, True) def images(self, name=None, quiet=False, all=False, filters=None): """ List images. Similar to the ``docker images`` command. Args: name (str): Only show images belonging to the repository ``name`` quiet (bool): Only return numeric IDs as a list. all (bool): Show intermediate image layers. By default, these are filtered out. filters (dict): Filters to be processed on the image list. Available filters: - ``dangling`` (bool) - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. Returns: (dict or list): A list if ``quiet=True``, otherwise a dict. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = { 'only_ids': 1 if quiet else 0, 'all': 1 if all else 0, } if name: if utils.version_lt(self._version, '1.25'): # only use "filter" on API 1.24 and under, as it is deprecated params['filter'] = name else: if filters: filters['reference'] = name else: filters = {'reference': name} if filters: params['filters'] = utils.convert_filters(filters) res = self._result(self._get(self._url("/images/json"), params=params), True) if quiet: return [x['Id'] for x in res] return res def import_image(self, src=None, repository=None, tag=None, image=None, changes=None, stream_src=False): """ Import an image. Similar to the ``docker import`` command. If ``src`` is a string or unicode string, it will first be treated as a path to a tarball on the local system. If there is an error reading from that file, ``src`` will be treated as a URL instead to fetch the image from. You can also pass an open file handle as ``src``, in which case the data will be read from that file. If ``src`` is unset but ``image`` is set, the ``image`` parameter will be taken as the name of an existing image to import from. Args: src (str or file): Path to tarfile, URL, or file-like object repository (str): The repository to create tag (str): The tag to apply image (str): Use another image like the ``FROM`` Dockerfile parameter """ if not (src or image): raise errors.DockerException( 'Must specify src or image to import from' ) u = self._url('/images/create') params = _import_image_params( repository, tag, image, src=(src if isinstance(src, str) else None), changes=changes ) headers = {'Content-Type': 'application/tar'} if image or params.get('fromSrc') != '-': # from image or URL return self._result( self._post(u, data=None, params=params) ) elif isinstance(src, str): # from file path with open(src, 'rb') as f: return self._result( self._post( u, data=f, params=params, headers=headers, timeout=None ) ) else: # from raw data if stream_src: headers['Transfer-Encoding'] = 'chunked' return self._result( self._post(u, data=src, params=params, headers=headers) ) def import_image_from_data(self, data, repository=None, tag=None, changes=None): """ Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but allows importing in-memory bytes data. Args: data (bytes collection): Bytes collection containing valid tar data repository (str): The repository to create tag (str): The tag to apply """ u = self._url('/images/create') params = _import_image_params( repository, tag, src='-', changes=changes ) headers = {'Content-Type': 'application/tar'} return self._result( self._post( u, data=data, params=params, headers=headers, timeout=None ) ) def import_image_from_file(self, filename, repository=None, tag=None, changes=None): """ Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from a tar file on disk. Args: filename (str): Full path to a tar file. repository (str): The repository to create tag (str): The tag to apply Raises: IOError: File does not exist. """ return self.import_image( src=filename, repository=repository, tag=tag, changes=changes ) def import_image_from_stream(self, stream, repository=None, tag=None, changes=None): return self.import_image( src=stream, stream_src=True, repository=repository, tag=tag, changes=changes ) def import_image_from_url(self, url, repository=None, tag=None, changes=None): """ Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from a URL. Args: url (str): A URL pointing to a tar file. repository (str): The repository to create tag (str): The tag to apply """ return self.import_image( src=url, repository=repository, tag=tag, changes=changes ) def import_image_from_image(self, image, repository=None, tag=None, changes=None): """ Like :py:meth:`~docker.api.image.ImageApiMixin.import_image`, but only supports importing from another image, like the ``FROM`` Dockerfile parameter. Args: image (str): Image name to import from repository (str): The repository to create tag (str): The tag to apply """ return self.import_image( image=image, repository=repository, tag=tag, changes=changes ) @utils.check_resource('image') def inspect_image(self, image): """ Get detailed information about an image. Similar to the ``docker inspect`` command, but only for images. Args: image (str): The image to inspect Returns: (dict): Similar to the output of ``docker inspect``, but as a single dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self._result( self._get(self._url("/images/{0}/json", image)), True ) @utils.minimum_version('1.30') @utils.check_resource('image') def inspect_distribution(self, image, auth_config=None): """ Get image digest and platform information by contacting the registry. Args: image (str): The image name to inspect auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. Returns: (dict): A dict containing distribution data Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ registry, _ = auth.resolve_repository_name(image) headers = {} if auth_config is None: header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header else: log.debug('Sending supplied auth config') headers['X-Registry-Auth'] = auth.encode_header(auth_config) url = self._url("/distribution/{0}/json", image) return self._result( self._get(url, headers=headers), True ) def load_image(self, data, quiet=None): """ Load an image that was previously saved using :py:meth:`~docker.api.image.ImageApiMixin.get_image` (or ``docker save``). Similar to ``docker load``. Args: data (binary): Image data to be loaded. quiet (boolean): Suppress progress details in response. Returns: (generator): Progress output as JSON objects. Only available for API version >= 1.23 Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {} if quiet is not None: if utils.version_lt(self._version, '1.23'): raise errors.InvalidVersion( 'quiet is not supported in API version < 1.23' ) params['quiet'] = quiet res = self._post( self._url("/images/load"), data=data, params=params, stream=True ) if utils.version_gte(self._version, '1.23'): return self._stream_helper(res, decode=True) self._raise_for_status(res) @utils.minimum_version('1.25') def prune_images(self, filters=None): """ Delete unused images Args: filters (dict): Filters to process on the prune list. Available filters: - dangling (bool): When set to true (or 1), prune only unused and untagged images. Returns: (dict): A dict containing a list of deleted image IDs and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/images/prune") params = {} if filters is not None: params['filters'] = utils.convert_filters(filters) return self._result(self._post(url, params=params), True) def pull(self, repository, tag=None, stream=False, auth_config=None, decode=False, platform=None, all_tags=False): """ Pulls an image. Similar to the ``docker pull`` command. Args: repository (str): The repository to pull tag (str): The tag to pull. If ``tag`` is ``None`` or empty, it is set to ``latest``. stream (bool): Stream the output as a generator. Make sure to consume the generator, otherwise pull might get cancelled. auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` platform (str): Platform in the format ``os[/arch[/variant]]`` all_tags (bool): Pull all image tags, the ``tag`` parameter is ignored. Returns: (generator or str): The output Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> resp = client.api.pull('busybox', stream=True, decode=True) ... for line in resp: ... print(json.dumps(line, indent=4)) { "status": "Pulling image (latest) from busybox", "progressDetail": {}, "id": "e72ac664f4f0" } { "status": "Pulling image (latest) from busybox, endpoint: ...", "progressDetail": {}, "id": "e72ac664f4f0" } """ repository, image_tag = utils.parse_repository_tag(repository) tag = tag or image_tag or 'latest' if all_tags: tag = None registry, repo_name = auth.resolve_repository_name(repository) params = { 'tag': tag, 'fromImage': repository } headers = {} if auth_config is None: header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header else: log.debug('Sending supplied auth config') headers['X-Registry-Auth'] = auth.encode_header(auth_config) if platform is not None: if utils.version_lt(self._version, '1.32'): raise errors.InvalidVersion( 'platform was only introduced in API version 1.32' ) params['platform'] = platform response = self._post( self._url('/images/create'), params=params, headers=headers, stream=stream, timeout=None ) self._raise_for_status(response) if stream: return self._stream_helper(response, decode=decode) return self._result(response) def push(self, repository, tag=None, stream=False, auth_config=None, decode=False): """ Push an image or a repository to the registry. Similar to the ``docker push`` command. Args: repository (str): The repository to push to tag (str): An optional tag to push stream (bool): Stream the output as a blocking generator auth_config (dict): Override the credentials that are found in the config for this request. ``auth_config`` should contain the ``username`` and ``password`` keys to be valid. decode (bool): Decode the JSON data from the server into dicts. Only applies with ``stream=True`` Returns: (generator or str): The output from the server. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> resp = client.api.push( ... 'yourname/app', ... stream=True, ... decode=True, ... ) ... for line in resp: ... print(line) {'status': 'Pushing repository yourname/app (1 tags)'} {'status': 'Pushing','progressDetail': {}, 'id': '511136ea3c5a'} {'status': 'Image already pushed, skipping', 'progressDetail':{}, 'id': '511136ea3c5a'} ... """ if not tag: repository, tag = utils.parse_repository_tag(repository) registry, repo_name = auth.resolve_repository_name(repository) u = self._url("/images/{0}/push", repository) params = { 'tag': tag } headers = {} if auth_config is None: header = auth.get_config_header(self, registry) if header: headers['X-Registry-Auth'] = header else: log.debug('Sending supplied auth config') headers['X-Registry-Auth'] = auth.encode_header(auth_config) response = self._post_json( u, None, headers=headers, stream=stream, params=params ) self._raise_for_status(response) if stream: return self._stream_helper(response, decode=decode) return self._result(response) @utils.check_resource('image') def remove_image(self, image, force=False, noprune=False): """ Remove an image. Similar to the ``docker rmi`` command. Args: image (str): The image to remove force (bool): Force removal of the image noprune (bool): Do not delete untagged parents """ params = {'force': force, 'noprune': noprune} res = self._delete(self._url("/images/{0}", image), params=params) return self._result(res, True) def search(self, term, limit=None): """ Search for images on Docker Hub. Similar to the ``docker search`` command. Args: term (str): A term to search for. limit (int): The maximum number of results to return. Returns: (list of dicts): The response of the search. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {'term': term} if limit is not None: params['limit'] = limit return self._result( self._get(self._url("/images/search"), params=params), True ) @utils.check_resource('image') def tag(self, image, repository, tag=None, force=False): """ Tag an image into a repository. Similar to the ``docker tag`` command. Args: image (str): The image to tag repository (str): The repository to set for the tag tag (str): The tag name force (bool): Force Returns: (bool): ``True`` if successful Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> client.api.tag('ubuntu', 'localhost:5000/ubuntu', 'latest', force=True) """ params = { 'tag': tag, 'repo': repository, 'force': 1 if force else 0 } url = self._url("/images/{0}/tag", image) res = self._post(url, params=params) self._raise_for_status(res) return res.status_code == 201 def is_file(src): try: return ( isinstance(src, str) and os.path.isfile(src) ) except TypeError: # a data string will make isfile() raise a TypeError return False def _import_image_params(repo, tag, image=None, src=None, changes=None): params = { 'repo': repo, 'tag': tag, } if image: params['fromImage'] = image elif src and not is_file(src): params['fromSrc'] = src else: params['fromSrc'] = '-' if changes: params['changes'] = changes return params api/config.py 0000644 00000005222 15027665106 0007145 0 ustar 00 import base64 from .. import utils class ConfigApiMixin: @utils.minimum_version('1.30') def create_config(self, name, data, labels=None, templating=None): """ Create a config Args: name (string): Name of the config data (bytes): Config data to be stored labels (dict): A mapping of labels to assign to the config templating (dict): dictionary containing the name of the templating driver to be used expressed as { name: <templating_driver_name>} Returns (dict): ID of the newly created config """ if not isinstance(data, bytes): data = data.encode('utf-8') data = base64.b64encode(data) data = data.decode('ascii') body = { 'Data': data, 'Name': name, 'Labels': labels, 'Templating': templating } url = self._url('/configs/create') return self._result( self._post_json(url, data=body), True ) @utils.minimum_version('1.30') @utils.check_resource('id') def inspect_config(self, id): """ Retrieve config metadata Args: id (string): Full ID of the config to inspect Returns (dict): A dictionary of metadata Raises: :py:class:`docker.errors.NotFound` if no config with that ID exists """ url = self._url('/configs/{0}', id) return self._result(self._get(url), True) @utils.minimum_version('1.30') @utils.check_resource('id') def remove_config(self, id): """ Remove a config Args: id (string): Full ID of the config to remove Returns (boolean): True if successful Raises: :py:class:`docker.errors.NotFound` if no config with that ID exists """ url = self._url('/configs/{0}', id) res = self._delete(url) self._raise_for_status(res) return True @utils.minimum_version('1.30') def configs(self, filters=None): """ List configs Args: filters (dict): A map of filters to process on the configs list. Available filters: ``names`` Returns (list): A list of configs """ url = self._url('/configs') params = {} if filters: params['filters'] = utils.convert_filters(filters) return self._result(self._get(url, params=params), True) api/container.py 0000644 00000147152 15027665106 0007673 0 ustar 00 from datetime import datetime from .. import errors, utils from ..constants import DEFAULT_DATA_CHUNK_SIZE from ..types import ( CancellableStream, ContainerConfig, EndpointConfig, HostConfig, NetworkingConfig, ) class ContainerApiMixin: @utils.check_resource('container') def attach(self, container, stdout=True, stderr=True, stream=False, logs=False, demux=False): """ Attach to a container. The ``.logs()`` function is a wrapper around this method, which you can use instead if you want to fetch/stream container output without first retrieving the entire backlog. Args: container (str): The container to attach to. stdout (bool): Include stdout. stderr (bool): Include stderr. stream (bool): Return container output progressively as an iterator of strings, rather than a single string. logs (bool): Include the container's previous output. demux (bool): Keep stdout and stderr separate. Returns: By default, the container's output as a single string (two if ``demux=True``: one for stdout and one for stderr). If ``stream=True``, an iterator of output strings. If ``demux=True``, two iterators are returned: one for stdout and one for stderr. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = { 'logs': logs and 1 or 0, 'stdout': stdout and 1 or 0, 'stderr': stderr and 1 or 0, 'stream': stream and 1 or 0 } headers = { 'Connection': 'Upgrade', 'Upgrade': 'tcp' } u = self._url("/containers/{0}/attach", container) response = self._post(u, headers=headers, params=params, stream=True) output = self._read_from_socket( response, stream, self._check_is_tty(container), demux=demux) if stream: return CancellableStream(output, response) else: return output @utils.check_resource('container') def attach_socket(self, container, params=None, ws=False): """ Like ``attach``, but returns the underlying socket-like object for the HTTP request. Args: container (str): The container to attach to. params (dict): Dictionary of request parameters (e.g. ``stdout``, ``stderr``, ``stream``). For ``detachKeys``, ~/.docker/config.json is used by default. ws (bool): Use websockets instead of raw HTTP. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if params is None: params = { 'stdout': 1, 'stderr': 1, 'stream': 1 } if 'detachKeys' not in params \ and 'detachKeys' in self._general_configs: params['detachKeys'] = self._general_configs['detachKeys'] if ws: return self._attach_websocket(container, params) headers = { 'Connection': 'Upgrade', 'Upgrade': 'tcp' } u = self._url("/containers/{0}/attach", container) return self._get_raw_response_socket( self.post( u, None, params=self._attach_params(params), stream=True, headers=headers ) ) @utils.check_resource('container') def commit(self, container, repository=None, tag=None, message=None, author=None, pause=True, changes=None, conf=None): """ Commit a container to an image. Similar to the ``docker commit`` command. Args: container (str): The image hash of the container repository (str): The repository to push the image to tag (str): The tag to push message (str): A commit message author (str): The name of the author pause (bool): Whether to pause the container before committing changes (str): Dockerfile instructions to apply while committing conf (dict): The configuration for the container. See the `Engine API documentation <https://docs.docker.com/reference/api/docker_remote_api/>`_ for full details. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = { 'container': container, 'repo': repository, 'tag': tag, 'comment': message, 'author': author, 'pause': pause, 'changes': changes } u = self._url("/commit") return self._result( self._post_json(u, data=conf, params=params), json=True ) def containers(self, quiet=False, all=False, trunc=False, latest=False, since=None, before=None, limit=-1, size=False, filters=None): """ List containers. Similar to the ``docker ps`` command. Args: quiet (bool): Only display numeric Ids all (bool): Show all containers. Only running containers are shown by default trunc (bool): Truncate output latest (bool): Show only the latest created container, include non-running ones. since (str): Show only containers created since Id or Name, include non-running ones before (str): Show only container created before Id or Name, include non-running ones limit (int): Show `limit` last created containers, include non-running ones size (bool): Display sizes filters (dict): Filters to be processed on the image list. Available filters: - `exited` (int): Only containers with specified exit code - `status` (str): One of ``restarting``, ``running``, ``paused``, ``exited`` - `label` (str|list): format either ``"key"``, ``"key=value"`` or a list of such. - `id` (str): The id of the container. - `name` (str): The name of the container. - `ancestor` (str): Filter by container ancestor. Format of ``<image-name>[:tag]``, ``<image-id>``, or ``<image@digest>``. - `before` (str): Only containers created before a particular container. Give the container name or id. - `since` (str): Only containers created after a particular container. Give container name or id. A comprehensive list can be found in the documentation for `docker ps <https://docs.docker.com/engine/reference/commandline/ps>`_. Returns: A list of dicts, one per container Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = { 'limit': 1 if latest else limit, 'all': 1 if all else 0, 'size': 1 if size else 0, 'trunc_cmd': 1 if trunc else 0, 'since': since, 'before': before } if filters: params['filters'] = utils.convert_filters(filters) u = self._url("/containers/json") res = self._result(self._get(u, params=params), True) if quiet: return [{'Id': x['Id']} for x in res] if trunc: for x in res: x['Id'] = x['Id'][:12] return res def create_container(self, image, command=None, hostname=None, user=None, detach=False, stdin_open=False, tty=False, ports=None, environment=None, volumes=None, network_disabled=False, name=None, entrypoint=None, working_dir=None, domainname=None, host_config=None, mac_address=None, labels=None, stop_signal=None, networking_config=None, healthcheck=None, stop_timeout=None, runtime=None, use_config_proxy=True, platform=None): """ Creates a container. Parameters are similar to those for the ``docker run`` command except it doesn't support the attach options (``-a``). The arguments that are passed directly to this function are host-independent configuration options. Host-specific configuration is passed with the `host_config` argument. You'll normally want to use this method in combination with the :py:meth:`create_host_config` method to generate ``host_config``. **Port bindings** Port binding is done in two parts: first, provide a list of ports to open inside the container with the ``ports`` parameter, then declare bindings with the ``host_config`` parameter. For example: .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', ports=[1111, 2222], host_config=client.api.create_host_config(port_bindings={ 1111: 4567, 2222: None }) ) You can limit the host address on which the port will be exposed like such: .. code-block:: python client.api.create_host_config( port_bindings={1111: ('127.0.0.1', 4567)} ) Or without host port assignment: .. code-block:: python client.api.create_host_config(port_bindings={1111: ('127.0.0.1',)}) If you wish to use UDP instead of TCP (default), you need to declare ports as such in both the config and host config: .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', ports=[(1111, 'udp'), 2222], host_config=client.api.create_host_config(port_bindings={ '1111/udp': 4567, 2222: None }) ) To bind multiple host ports to a single container port, use the following syntax: .. code-block:: python client.api.create_host_config(port_bindings={ 1111: [1234, 4567] }) You can also bind multiple IPs to a single container port: .. code-block:: python client.api.create_host_config(port_bindings={ 1111: [ ('192.168.0.100', 1234), ('192.168.0.101', 1234) ] }) **Using volumes** Volume declaration is done in two parts. Provide a list of paths to use as mountpoints inside the container with the ``volumes`` parameter, and declare mappings from paths on the host in the ``host_config`` section. .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2'], host_config=client.api.create_host_config(binds={ '/home/user1/': { 'bind': '/mnt/vol2', 'mode': 'rw', }, '/var/www': { 'bind': '/mnt/vol1', 'mode': 'ro', }, '/autofs/user1': { 'bind': '/mnt/vol3', 'mode': 'rw', 'propagation': 'shared' } }) ) You can alternatively specify binds as a list. This code is equivalent to the example above: .. code-block:: python container_id = client.api.create_container( 'busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2', '/mnt/vol3'], host_config=client.api.create_host_config(binds=[ '/home/user1/:/mnt/vol2', '/var/www:/mnt/vol1:ro', '/autofs/user1:/mnt/vol3:rw,shared', ]) ) **Networking** You can specify networks to connect the container to by using the ``networking_config`` parameter. At the time of creation, you can only connect a container to a single networking, but you can create more connections by using :py:meth:`~connect_container_to_network`. For example: .. code-block:: python networking_config = client.api.create_networking_config({ 'network1': client.api.create_endpoint_config( ipv4_address='172.28.0.124', aliases=['foo', 'bar'], links=['container2'] ) }) ctnr = client.api.create_container( img, command, networking_config=networking_config ) Args: image (str): The image to run command (str or list): The command to be run in the container hostname (str): Optional hostname for the container user (str or int): Username or UID detach (bool): Detached mode: run container in the background and return container ID stdin_open (bool): Keep STDIN open even if not attached tty (bool): Allocate a pseudo-TTY ports (list of ints): A list of port numbers environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. volumes (str or list): List of paths inside the container to use as volumes. network_disabled (bool): Disable networking name (str): A name for the container entrypoint (str or list): An entrypoint working_dir (str): Path to the working directory domainname (str): The domain name to use for the container host_config (dict): A dictionary created with :py:meth:`create_host_config`. mac_address (str): The Mac Address to assign the container labels (dict or list): A dictionary of name-value labels (e.g. ``{"label1": "value1", "label2": "value2"}``) or a list of names of labels to set with empty values (e.g. ``["label1", "label2"]``) stop_signal (str): The stop signal to use to stop the container (e.g. ``SIGINT``). stop_timeout (int): Timeout to stop the container, in seconds. Default: 10 networking_config (dict): A networking configuration generated by :py:meth:`create_networking_config`. runtime (str): Runtime to use with this container. healthcheck (dict): Specify a test to perform to check that the container is healthy. use_config_proxy (bool): If ``True``, and if the docker client configuration file (``~/.docker/config.json`` by default) contains a proxy configuration, the corresponding environment variables will be set in the container being created. platform (str): Platform in the format ``os[/arch[/variant]]``. Returns: A dictionary with an image 'Id' key and a 'Warnings' key. Raises: :py:class:`docker.errors.ImageNotFound` If the specified image does not exist. :py:class:`docker.errors.APIError` If the server returns an error. """ if isinstance(volumes, str): volumes = [volumes, ] if isinstance(environment, dict): environment = utils.utils.format_environment(environment) if use_config_proxy: environment = self._proxy_configs.inject_proxy_environment( environment ) or None config = self.create_container_config( image, command, hostname, user, detach, stdin_open, tty, ports, environment, volumes, network_disabled, entrypoint, working_dir, domainname, host_config, mac_address, labels, stop_signal, networking_config, healthcheck, stop_timeout, runtime ) return self.create_container_from_config(config, name, platform) def create_container_config(self, *args, **kwargs): return ContainerConfig(self._version, *args, **kwargs) def create_container_from_config(self, config, name=None, platform=None): u = self._url("/containers/create") params = { 'name': name } if platform: if utils.version_lt(self._version, '1.41'): raise errors.InvalidVersion( 'platform is not supported for API version < 1.41' ) params['platform'] = platform res = self._post_json(u, data=config, params=params) return self._result(res, True) def create_host_config(self, *args, **kwargs): """ Create a dictionary for the ``host_config`` argument to :py:meth:`create_container`. Args: auto_remove (bool): enable auto-removal of the container on daemon side when the container's process exits. binds (dict): Volumes to bind. See :py:meth:`create_container` for more information. blkio_weight_device: Block IO weight (relative device weight) in the form of: ``[{"Path": "device_path", "Weight": weight}]``. blkio_weight: Block IO weight (relative weight), accepts a weight value between 10 and 1000. cap_add (list of str): Add kernel capabilities. For example, ``["SYS_ADMIN", "MKNOD"]``. cap_drop (list of str): Drop kernel capabilities. cpu_period (int): The length of a CPU period in microseconds. cpu_quota (int): Microseconds of CPU time that the container can get in a CPU period. cpu_shares (int): CPU shares (relative weight). cpuset_cpus (str): CPUs in which to allow execution (``0-3``, ``0,1``). cpuset_mems (str): Memory nodes (MEMs) in which to allow execution (``0-3``, ``0,1``). Only effective on NUMA systems. device_cgroup_rules (:py:class:`list`): A list of cgroup rules to apply to the container. device_read_bps: Limit read rate (bytes per second) from a device in the form of: `[{"Path": "device_path", "Rate": rate}]` device_read_iops: Limit read rate (IO per second) from a device. device_write_bps: Limit write rate (bytes per second) from a device. device_write_iops: Limit write rate (IO per second) from a device. devices (:py:class:`list`): Expose host devices to the container, as a list of strings in the form ``<path_on_host>:<path_in_container>:<cgroup_permissions>``. For example, ``/dev/sda:/dev/xvda:rwm`` allows the container to have read-write access to the host's ``/dev/sda`` via a node named ``/dev/xvda`` inside the container. device_requests (:py:class:`list`): Expose host resources such as GPUs to the container, as a list of :py:class:`docker.types.DeviceRequest` instances. dns (:py:class:`list`): Set custom DNS servers. dns_opt (:py:class:`list`): Additional options to be added to the container's ``resolv.conf`` file dns_search (:py:class:`list`): DNS search domains. extra_hosts (dict): Additional hostnames to resolve inside the container, as a mapping of hostname to IP address. group_add (:py:class:`list`): List of additional group names and/or IDs that the container process will run as. init (bool): Run an init inside the container that forwards signals and reaps processes ipc_mode (str): Set the IPC mode for the container. isolation (str): Isolation technology to use. Default: ``None``. links (dict): Mapping of links using the ``{'container': 'alias'}`` format. The alias is optional. Containers declared in this dict will be linked to the new container using the provided alias. Default: ``None``. log_config (LogConfig): Logging configuration lxc_conf (dict): LXC config. mem_limit (float or str): Memory limit. Accepts float values (which represent the memory limit of the created container in bytes) or a string with a units identification char (``100000b``, ``1000k``, ``128m``, ``1g``). If a string is specified without a units character, bytes are assumed as an mem_reservation (float or str): Memory soft limit. mem_swappiness (int): Tune a container's memory swappiness behavior. Accepts number between 0 and 100. memswap_limit (str or int): Maximum amount of memory + swap a container is allowed to consume. mounts (:py:class:`list`): Specification for mounts to be added to the container. More powerful alternative to ``binds``. Each item in the list is expected to be a :py:class:`docker.types.Mount` object. network_mode (str): One of: - ``bridge`` Create a new network stack for the container on the bridge network. - ``none`` No networking for this container. - ``container:<name|id>`` Reuse another container's network stack. - ``host`` Use the host network stack. This mode is incompatible with ``port_bindings``. oom_kill_disable (bool): Whether to disable OOM killer. oom_score_adj (int): An integer value containing the score given to the container in order to tune OOM killer preferences. pid_mode (str): If set to ``host``, use the host PID namespace inside the container. pids_limit (int): Tune a container's pids limit. Set ``-1`` for unlimited. port_bindings (dict): See :py:meth:`create_container` for more information. Imcompatible with ``host`` in ``network_mode``. privileged (bool): Give extended privileges to this container. publish_all_ports (bool): Publish all ports to the host. read_only (bool): Mount the container's root filesystem as read only. restart_policy (dict): Restart the container when it exits. Configured as a dictionary with keys: - ``Name`` One of ``on-failure``, or ``always``. - ``MaximumRetryCount`` Number of times to restart the container on failure. security_opt (:py:class:`list`): A list of string values to customize labels for MLS systems, such as SELinux. shm_size (str or int): Size of /dev/shm (e.g. ``1G``). storage_opt (dict): Storage driver options per container as a key-value mapping. sysctls (dict): Kernel parameters to set in the container. tmpfs (dict): Temporary filesystems to mount, as a dictionary mapping a path inside the container to options for that path. For example: .. code-block:: python { '/mnt/vol2': '', '/mnt/vol1': 'size=3G,uid=1000' } ulimits (:py:class:`list`): Ulimits to set inside the container, as a list of :py:class:`docker.types.Ulimit` instances. userns_mode (str): Sets the user namespace mode for the container when user namespace remapping option is enabled. Supported values are: ``host`` uts_mode (str): Sets the UTS namespace mode for the container. Supported values are: ``host`` volumes_from (:py:class:`list`): List of container names or IDs to get volumes from. runtime (str): Runtime to use with this container. Returns: (dict) A dictionary which can be passed to the ``host_config`` argument to :py:meth:`create_container`. Example: >>> client.api.create_host_config( ... privileged=True, ... cap_drop=['MKNOD'], ... volumes_from=['nostalgic_newton'], ... ) {'CapDrop': ['MKNOD'], 'LxcConf': None, 'Privileged': True, 'VolumesFrom': ['nostalgic_newton'], 'PublishAllPorts': False} """ if not kwargs: kwargs = {} if 'version' in kwargs: raise TypeError( "create_host_config() got an unexpected " "keyword argument 'version'" ) kwargs['version'] = self._version return HostConfig(*args, **kwargs) def create_networking_config(self, *args, **kwargs): """ Create a networking config dictionary to be used as the ``networking_config`` parameter in :py:meth:`create_container`. Args: endpoints_config (dict): A dictionary mapping network names to endpoint configurations generated by :py:meth:`create_endpoint_config`. Returns: (dict) A networking config. Example: >>> client.api.create_network('network1') >>> networking_config = client.api.create_networking_config({ 'network1': client.api.create_endpoint_config() }) >>> container = client.api.create_container( img, command, networking_config=networking_config ) """ return NetworkingConfig(*args, **kwargs) def create_endpoint_config(self, *args, **kwargs): """ Create an endpoint config dictionary to be used with :py:meth:`create_networking_config`. Args: aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. links (dict): Mapping of links for this endpoint using the ``{'container': 'alias'}`` format. The alias is optional. Containers declared in this dict will be linked to this container using the provided alias. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. driver_opt (dict): A dictionary of options to provide to the network driver. Defaults to ``None``. Returns: (dict) An endpoint config. Example: >>> endpoint_config = client.api.create_endpoint_config( aliases=['web', 'app'], links={'app_db': 'db', 'another': None}, ipv4_address='132.65.0.123' ) """ return EndpointConfig(self._version, *args, **kwargs) @utils.check_resource('container') def diff(self, container): """ Inspect changes on a container's filesystem. Args: container (str): The container to diff Returns: (list) A list of dictionaries containing the attributes `Path` and `Kind`. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self._result( self._get(self._url("/containers/{0}/changes", container)), True ) @utils.check_resource('container') def export(self, container, chunk_size=DEFAULT_DATA_CHUNK_SIZE): """ Export the contents of a filesystem as a tar archive. Args: container (str): The container to export chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB Returns: (generator): The archived filesystem data stream Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ res = self._get( self._url("/containers/{0}/export", container), stream=True ) return self._stream_raw_result(res, chunk_size, False) @utils.check_resource('container') def get_archive(self, container, path, chunk_size=DEFAULT_DATA_CHUNK_SIZE, encode_stream=False): """ Retrieve a file or folder from a container in the form of a tar archive. Args: container (str): The container where the file is located path (str): Path to the file or folder to retrieve chunk_size (int): The number of bytes returned by each iteration of the generator. If ``None``, data will be streamed as it is received. Default: 2 MB encode_stream (bool): Determines if data should be encoded (gzip-compressed) during transmission. Default: False Returns: (tuple): First element is a raw tar data stream. Second element is a dict containing ``stat`` information on the specified ``path``. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> c = docker.APIClient() >>> f = open('./sh_bin.tar', 'wb') >>> bits, stat = c.api.get_archive(container, '/bin/sh') >>> print(stat) {'name': 'sh', 'size': 1075464, 'mode': 493, 'mtime': '2018-10-01T15:37:48-07:00', 'linkTarget': ''} >>> for chunk in bits: ... f.write(chunk) >>> f.close() """ params = { 'path': path } headers = { "Accept-Encoding": "gzip, deflate" } if encode_stream else { "Accept-Encoding": "identity" } url = self._url('/containers/{0}/archive', container) res = self._get(url, params=params, stream=True, headers=headers) self._raise_for_status(res) encoded_stat = res.headers.get('x-docker-container-path-stat') return ( self._stream_raw_result(res, chunk_size, False), utils.decode_json_header(encoded_stat) if encoded_stat else None ) @utils.check_resource('container') def inspect_container(self, container): """ Identical to the `docker inspect` command, but only for containers. Args: container (str): The container to inspect Returns: (dict): Similar to the output of `docker inspect`, but as a single dict Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ return self._result( self._get(self._url("/containers/{0}/json", container)), True ) @utils.check_resource('container') def kill(self, container, signal=None): """ Kill a container or send a signal to a container. Args: container (str): The container to kill signal (str or int): The signal to send. Defaults to ``SIGKILL`` Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/containers/{0}/kill", container) params = {} if signal is not None: if not isinstance(signal, str): signal = int(signal) params['signal'] = signal res = self._post(url, params=params) self._raise_for_status(res) @utils.check_resource('container') def logs(self, container, stdout=True, stderr=True, stream=False, timestamps=False, tail='all', since=None, follow=None, until=None): """ Get logs from a container. Similar to the ``docker logs`` command. The ``stream`` parameter makes the ``logs`` function return a blocking generator you can iterate over to retrieve log output as it happens. Args: container (str): The container to get logs from stdout (bool): Get ``STDOUT``. Default ``True`` stderr (bool): Get ``STDERR``. Default ``True`` stream (bool): Stream the response. Default ``False`` timestamps (bool): Show timestamps. Default ``False`` tail (str or int): Output specified number of lines at the end of logs. Either an integer of number of lines or the string ``all``. Default ``all`` since (datetime, int, or float): Show logs since a given datetime, integer epoch (in seconds) or float (in fractional seconds) follow (bool): Follow log output. Default ``False`` until (datetime, int, or float): Show logs that occurred before the given datetime, integer epoch (in seconds), or float (in fractional seconds) Returns: (generator of bytes or bytes) Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if follow is None: follow = stream params = {'stderr': stderr and 1 or 0, 'stdout': stdout and 1 or 0, 'timestamps': timestamps and 1 or 0, 'follow': follow and 1 or 0, } if tail != 'all' and (not isinstance(tail, int) or tail < 0): tail = 'all' params['tail'] = tail if since is not None: if isinstance(since, datetime): params['since'] = utils.datetime_to_timestamp(since) elif (isinstance(since, int) and since > 0): params['since'] = since elif (isinstance(since, float) and since > 0.0): params['since'] = since else: raise errors.InvalidArgument( 'since value should be datetime or positive int/float,' f' not {type(since)}' ) if until is not None: if utils.version_lt(self._version, '1.35'): raise errors.InvalidVersion( 'until is not supported for API version < 1.35' ) if isinstance(until, datetime): params['until'] = utils.datetime_to_timestamp(until) elif (isinstance(until, int) and until > 0): params['until'] = until elif (isinstance(until, float) and until > 0.0): params['until'] = until else: raise errors.InvalidArgument( f'until value should be datetime or positive int/float, ' f'not {type(until)}' ) url = self._url("/containers/{0}/logs", container) res = self._get(url, params=params, stream=stream) output = self._get_result(container, stream, res) if stream: return CancellableStream(output, res) else: return output @utils.check_resource('container') def pause(self, container): """ Pauses all processes within a container. Args: container (str): The container to pause Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/containers/{0}/pause', container) res = self._post(url) self._raise_for_status(res) @utils.check_resource('container') def port(self, container, private_port): """ Lookup the public-facing port that is NAT-ed to ``private_port``. Identical to the ``docker port`` command. Args: container (str): The container to look up private_port (int): The private port to inspect Returns: (list of dict): The mapping for the host ports Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: .. code-block:: bash $ docker run -d -p 80:80 ubuntu:14.04 /bin/sleep 30 7174d6347063a83f412fad6124c99cffd25ffe1a0807eb4b7f9cec76ac8cb43b .. code-block:: python >>> client.api.port('7174d6347063', 80) [{'HostIp': '0.0.0.0', 'HostPort': '80'}] """ res = self._get(self._url("/containers/{0}/json", container)) self._raise_for_status(res) json_ = res.json() private_port = str(private_port) h_ports = None # Port settings is None when the container is running with # network_mode=host. port_settings = json_.get('NetworkSettings', {}).get('Ports') if port_settings is None: return None if '/' in private_port: return port_settings.get(private_port) for protocol in ['tcp', 'udp', 'sctp']: h_ports = port_settings.get(f"{private_port}/{protocol}") if h_ports: break return h_ports @utils.check_resource('container') def put_archive(self, container, path, data): """ Insert a file or folder in an existing container using a tar archive as source. Args: container (str): The container where the file(s) will be extracted path (str): Path inside the container where the file(s) will be extracted. Must exist. data (bytes or stream): tar data to be extracted Returns: (bool): True if the call succeeds. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {'path': path} url = self._url('/containers/{0}/archive', container) res = self._put(url, params=params, data=data) self._raise_for_status(res) return res.status_code == 200 @utils.minimum_version('1.25') def prune_containers(self, filters=None): """ Delete stopped containers Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted container IDs and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {} if filters: params['filters'] = utils.convert_filters(filters) url = self._url('/containers/prune') return self._result(self._post(url, params=params), True) @utils.check_resource('container') def remove_container(self, container, v=False, link=False, force=False): """ Remove a container. Similar to the ``docker rm`` command. Args: container (str): The container to remove v (bool): Remove the volumes associated with the container link (bool): Remove the specified link and not the underlying container force (bool): Force the removal of a running container (uses ``SIGKILL``) Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {'v': v, 'link': link, 'force': force} res = self._delete( self._url("/containers/{0}", container), params=params ) self._raise_for_status(res) @utils.check_resource('container') def rename(self, container, name): """ Rename a container. Similar to the ``docker rename`` command. Args: container (str): ID of the container to rename name (str): New name for the container Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/containers/{0}/rename", container) params = {'name': name} res = self._post(url, params=params) self._raise_for_status(res) @utils.check_resource('container') def resize(self, container, height, width): """ Resize the tty session. Args: container (str or dict): The container to resize height (int): Height of tty session width (int): Width of tty session Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {'h': height, 'w': width} url = self._url("/containers/{0}/resize", container) res = self._post(url, params=params) self._raise_for_status(res) @utils.check_resource('container') def restart(self, container, timeout=10): """ Restart a container. Similar to the ``docker restart`` command. Args: container (str or dict): The container to restart. If a dict, the ``Id`` key is used. timeout (int): Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {'t': timeout} url = self._url("/containers/{0}/restart", container) conn_timeout = self.timeout if conn_timeout is not None: conn_timeout += timeout res = self._post(url, params=params, timeout=conn_timeout) self._raise_for_status(res) @utils.check_resource('container') def start(self, container, *args, **kwargs): """ Start a container. Similar to the ``docker start`` command, but doesn't support attach options. **Deprecation warning:** Passing configuration options in ``start`` is no longer supported. Users are expected to provide host config options in the ``host_config`` parameter of :py:meth:`~ContainerApiMixin.create_container`. Args: container (str): The container to start Raises: :py:class:`docker.errors.APIError` If the server returns an error. :py:class:`docker.errors.DeprecatedMethod` If any argument besides ``container`` are provided. Example: >>> container = client.api.create_container( ... image='busybox:latest', ... command='/bin/sleep 30') >>> client.api.start(container=container.get('Id')) """ if args or kwargs: raise errors.DeprecatedMethod( 'Providing configuration in the start() method is no longer ' 'supported. Use the host_config param in create_container ' 'instead.' ) url = self._url("/containers/{0}/start", container) res = self._post(url) self._raise_for_status(res) @utils.check_resource('container') def stats(self, container, decode=None, stream=True, one_shot=None): """ Stream statistics for a specific container. Similar to the ``docker stats`` command. Args: container (str): The container to stream statistics from decode (bool): If set to true, stream will be decoded into dicts on the fly. Only applicable if ``stream`` is True. False by default. stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default. one_shot (bool): If set to true, Only get a single stat instead of waiting for 2 cycles. Must be used with stream=false. False by default. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/containers/{0}/stats", container) params = { 'stream': stream } if one_shot is not None: if utils.version_lt(self._version, '1.41'): raise errors.InvalidVersion( 'one_shot is not supported for API version < 1.41' ) params['one-shot'] = one_shot if stream: if one_shot: raise errors.InvalidArgument( 'one_shot is only available in conjunction with ' 'stream=False' ) return self._stream_helper( self._get(url, stream=True, params=params), decode=decode ) else: if decode: raise errors.InvalidArgument( "decode is only available in conjunction with stream=True" ) return self._result(self._get(url, params=params), json=True) @utils.check_resource('container') def stop(self, container, timeout=None): """ Stops a container. Similar to the ``docker stop`` command. Args: container (str): The container to stop timeout (int): Timeout in seconds to wait for the container to stop before sending a ``SIGKILL``. If None, then the StopTimeout value of the container will be used. Default: None Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if timeout is None: params = {} timeout = 10 else: params = {'t': timeout} url = self._url("/containers/{0}/stop", container) conn_timeout = self.timeout if conn_timeout is not None: conn_timeout += timeout res = self._post(url, params=params, timeout=conn_timeout) self._raise_for_status(res) @utils.check_resource('container') def top(self, container, ps_args=None): """ Display the running processes of a container. Args: container (str): The container to inspect ps_args (str): An optional arguments passed to ps (e.g. ``aux``) Returns: (str): The output of the top Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ u = self._url("/containers/{0}/top", container) params = {} if ps_args is not None: params['ps_args'] = ps_args return self._result(self._get(u, params=params), True) @utils.check_resource('container') def unpause(self, container): """ Unpause all processes within a container. Args: container (str): The container to unpause """ url = self._url('/containers/{0}/unpause', container) res = self._post(url) self._raise_for_status(res) @utils.minimum_version('1.22') @utils.check_resource('container') def update_container( self, container, blkio_weight=None, cpu_period=None, cpu_quota=None, cpu_shares=None, cpuset_cpus=None, cpuset_mems=None, mem_limit=None, mem_reservation=None, memswap_limit=None, kernel_memory=None, restart_policy=None ): """ Update resource configs of one or more containers. Args: container (str): The container to inspect blkio_weight (int): Block IO (relative weight), between 10 and 1000 cpu_period (int): Limit CPU CFS (Completely Fair Scheduler) period cpu_quota (int): Limit CPU CFS (Completely Fair Scheduler) quota cpu_shares (int): CPU shares (relative weight) cpuset_cpus (str): CPUs in which to allow execution cpuset_mems (str): MEMs in which to allow execution mem_limit (float or str): Memory limit mem_reservation (float or str): Memory soft limit memswap_limit (int or str): Total memory (memory + swap), -1 to disable swap kernel_memory (int or str): Kernel memory limit restart_policy (dict): Restart policy dictionary Returns: (dict): Dictionary containing a ``Warnings`` key. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url('/containers/{0}/update', container) data = {} if blkio_weight: data['BlkioWeight'] = blkio_weight if cpu_period: data['CpuPeriod'] = cpu_period if cpu_shares: data['CpuShares'] = cpu_shares if cpu_quota: data['CpuQuota'] = cpu_quota if cpuset_cpus: data['CpusetCpus'] = cpuset_cpus if cpuset_mems: data['CpusetMems'] = cpuset_mems if mem_limit: data['Memory'] = utils.parse_bytes(mem_limit) if mem_reservation: data['MemoryReservation'] = utils.parse_bytes(mem_reservation) if memswap_limit: data['MemorySwap'] = utils.parse_bytes(memswap_limit) if kernel_memory: data['KernelMemory'] = utils.parse_bytes(kernel_memory) if restart_policy: if utils.version_lt(self._version, '1.23'): raise errors.InvalidVersion( 'restart policy update is not supported ' 'for API version < 1.23' ) data['RestartPolicy'] = restart_policy res = self._post_json(url, data=data) return self._result(res, True) @utils.check_resource('container') def wait(self, container, timeout=None, condition=None): """ Block until a container stops, then return its exit code. Similar to the ``docker wait`` command. Args: container (str or dict): The container to wait on. If a dict, the ``Id`` key is used. timeout (int): Request timeout condition (str): Wait until a container state reaches the given condition, either ``not-running`` (default), ``next-exit``, or ``removed`` Returns: (dict): The API's response as a Python dictionary, including the container's exit code under the ``StatusCode`` attribute. Raises: :py:class:`requests.exceptions.ReadTimeout` If the timeout is exceeded. :py:class:`docker.errors.APIError` If the server returns an error. """ url = self._url("/containers/{0}/wait", container) params = {} if condition is not None: if utils.version_lt(self._version, '1.30'): raise errors.InvalidVersion( 'wait condition is not supported for API version < 1.30' ) params['condition'] = condition res = self._post(url, timeout=timeout, params=params) return self._result(res, True) api/network.py 0000644 00000024660 15027665106 0007400 0 ustar 00 from .. import utils from ..errors import InvalidVersion from ..utils import check_resource, minimum_version, version_lt class NetworkApiMixin: def networks(self, names=None, ids=None, filters=None): """ List networks. Similar to the ``docker network ls`` command. Args: names (:py:class:`list`): List of names to filter by ids (:py:class:`list`): List of ids to filter by filters (dict): Filters to be processed on the network list. Available filters: - ``driver=[<driver-name>]`` Matches a network's driver. - ``label=[<key>]``, ``label=[<key>=<value>]`` or a list of such. - ``type=["custom"|"builtin"]`` Filters networks by type. Returns: (dict): List of network objects. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ if filters is None: filters = {} if names: filters['name'] = names if ids: filters['id'] = ids params = {'filters': utils.convert_filters(filters)} url = self._url("/networks") res = self._get(url, params=params) return self._result(res, json=True) def create_network(self, name, driver=None, options=None, ipam=None, check_duplicate=None, internal=False, labels=None, enable_ipv6=False, attachable=None, scope=None, ingress=None): """ Create a network. Similar to the ``docker network create``. Args: name (str): Name of the network driver (str): Name of the driver used to create the network options (dict): Driver options as a key-value dictionary ipam (IPAMConfig): Optional custom IP scheme for the network. check_duplicate (bool): Request daemon to check for networks with same name. Default: ``None``. internal (bool): Restrict external access to the network. Default ``False``. labels (dict): Map of labels to set on the network. Default ``None``. enable_ipv6 (bool): Enable IPv6 on the network. Default ``False``. attachable (bool): If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network. scope (str): Specify the network's scope (``local``, ``global`` or ``swarm``) ingress (bool): If set, create an ingress network which provides the routing-mesh in swarm mode. Returns: (dict): The created network reference object Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: A network using the bridge driver: >>> client.api.create_network("network1", driver="bridge") You can also create more advanced networks with custom IPAM configurations. For example, setting the subnet to ``192.168.52.0/24`` and gateway address to ``192.168.52.254``. .. code-block:: python >>> ipam_pool = docker.types.IPAMPool( subnet='192.168.52.0/24', gateway='192.168.52.254' ) >>> ipam_config = docker.types.IPAMConfig( pool_configs=[ipam_pool] ) >>> client.api.create_network("network1", driver="bridge", ipam=ipam_config) """ if options is not None and not isinstance(options, dict): raise TypeError('options must be a dictionary') data = { 'Name': name, 'Driver': driver, 'Options': options, 'IPAM': ipam, 'CheckDuplicate': check_duplicate, } if labels is not None: if version_lt(self._version, '1.23'): raise InvalidVersion( 'network labels were introduced in API 1.23' ) if not isinstance(labels, dict): raise TypeError('labels must be a dictionary') data["Labels"] = labels if enable_ipv6: if version_lt(self._version, '1.23'): raise InvalidVersion( 'enable_ipv6 was introduced in API 1.23' ) data['EnableIPv6'] = True if internal: if version_lt(self._version, '1.22'): raise InvalidVersion('Internal networks are not ' 'supported in API version < 1.22') data['Internal'] = True if attachable is not None: if version_lt(self._version, '1.24'): raise InvalidVersion( 'attachable is not supported in API version < 1.24' ) data['Attachable'] = attachable if ingress is not None: if version_lt(self._version, '1.29'): raise InvalidVersion( 'ingress is not supported in API version < 1.29' ) data['Ingress'] = ingress if scope is not None: if version_lt(self._version, '1.30'): raise InvalidVersion( 'scope is not supported in API version < 1.30' ) data['Scope'] = scope url = self._url("/networks/create") res = self._post_json(url, data=data) return self._result(res, json=True) @minimum_version('1.25') def prune_networks(self, filters=None): """ Delete unused networks Args: filters (dict): Filters to process on the prune list. Returns: (dict): A dict containing a list of deleted network names and the amount of disk space reclaimed in bytes. Raises: :py:class:`docker.errors.APIError` If the server returns an error. """ params = {} if filters: params['filters'] = utils.convert_filters(filters) url = self._url('/networks/prune') return self._result(self._post(url, params=params), True) @check_resource('net_id') def remove_network(self, net_id): """ Remove a network. Similar to the ``docker network rm`` command. Args: net_id (str): The network's id """ url = self._url("/networks/{0}", net_id) res = self._delete(url) self._raise_for_status(res) @check_resource('net_id') def inspect_network(self, net_id, verbose=None, scope=None): """ Get detailed information about a network. Args: net_id (str): ID of network verbose (bool): Show the service details across the cluster in swarm mode. scope (str): Filter the network by scope (``swarm``, ``global`` or ``local``). """ params = {} if verbose is not None: if version_lt(self._version, '1.28'): raise InvalidVersion('verbose was introduced in API 1.28') params['verbose'] = verbose if scope is not None: if version_lt(self._version, '1.31'): raise InvalidVersion('scope was introduced in API 1.31') params['scope'] = scope url = self._url("/networks/{0}", net_id) res = self._get(url, params=params) return self._result(res, json=True) @check_resource('container') def connect_container_to_network(self, container, net_id, ipv4_address=None, ipv6_address=None, aliases=None, links=None, link_local_ips=None, driver_opt=None, mac_address=None): """ Connect a container to a network. Args: container (str): container-id/name to be connected to the network net_id (str): network id aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. links (:py:class:`list`): A list of links for this endpoint. Containers declared in this list will be linked to this container. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to ``None``. link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. mac_address (str): The MAC address of this container on the network. Defaults to ``None``. """ data = { "Container": container, "EndpointConfig": self.create_endpoint_config( aliases=aliases, links=links, ipv4_address=ipv4_address, ipv6_address=ipv6_address, link_local_ips=link_local_ips, driver_opt=driver_opt, mac_address=mac_address ), } url = self._url("/networks/{0}/connect", net_id) res = self._post_json(url, data=data) self._raise_for_status(res) @check_resource('container') def disconnect_container_from_network(self, container, net_id, force=False): """ Disconnect a container from a network. Args: container (str): container ID or name to be disconnected from the network net_id (str): network ID force (bool): Force the container to disconnect from a network. Default: ``False`` """ data = {"Container": container} if force: if version_lt(self._version, '1.22'): raise InvalidVersion( 'Forced disconnect was introduced in API 1.22' ) data['Force'] = force url = self._url("/networks/{0}/disconnect", net_id) res = self._post_json(url, data=data) self._raise_for_status(res) api/client.py 0000644 00000045745 15027665106 0007174 0 ustar 00 import json import struct import urllib from functools import partial import requests import requests.adapters import requests.exceptions from .. import auth from ..constants import ( DEFAULT_MAX_POOL_SIZE, DEFAULT_NUM_POOLS, DEFAULT_NUM_POOLS_SSH, DEFAULT_TIMEOUT_SECONDS, DEFAULT_USER_AGENT, IS_WINDOWS_PLATFORM, MINIMUM_DOCKER_API_VERSION, STREAM_HEADER_SIZE_BYTES, ) from ..errors import ( DockerException, InvalidVersion, TLSParameterError, create_api_error_from_http_exception, ) from ..tls import TLSConfig from ..transport import UnixHTTPAdapter from ..utils import check_resource, config, update_headers, utils from ..utils.json_stream import json_stream from ..utils.proxy import ProxyConfig from ..utils.socket import consume_socket_output, demux_adaptor, frames_iter from .build import BuildApiMixin from .config import ConfigApiMixin from .container import ContainerApiMixin from .daemon import DaemonApiMixin from .exec_api import ExecApiMixin from .image import ImageApiMixin from .network import NetworkApiMixin from .plugin import PluginApiMixin from .secret import SecretApiMixin from .service import ServiceApiMixin from .swarm import SwarmApiMixin from .volume import VolumeApiMixin try: from ..transport import NpipeHTTPAdapter except ImportError: pass try: from ..transport import SSHHTTPAdapter except ImportError: pass class APIClient( requests.Session, BuildApiMixin, ConfigApiMixin, ContainerApiMixin, DaemonApiMixin, ExecApiMixin, ImageApiMixin, NetworkApiMixin, PluginApiMixin, SecretApiMixin, ServiceApiMixin, SwarmApiMixin, VolumeApiMixin): """ A low-level client for the Docker Engine API. Example: >>> import docker >>> client = docker.APIClient(base_url='unix://var/run/docker.sock') >>> client.version() {u'ApiVersion': u'1.33', u'Arch': u'amd64', u'BuildTime': u'2017-11-19T18:46:37.000000000+00:00', u'GitCommit': u'f4ffd2511c', u'GoVersion': u'go1.9.2', u'KernelVersion': u'4.14.3-1-ARCH', u'MinAPIVersion': u'1.12', u'Os': u'linux', u'Version': u'17.10.0-ce'} Args: base_url (str): URL to the Docker server. For example, ``unix:///var/run/docker.sock`` or ``tcp://127.0.0.1:1234``. version (str): The version of the API to use. Set to ``auto`` to automatically detect the server's version. Default: ``1.35`` timeout (int): Default timeout for API calls, in seconds. tls (bool or :py:class:`~docker.tls.TLSConfig`): Enable TLS. Pass ``True`` to enable it with default options, or pass a :py:class:`~docker.tls.TLSConfig` object to use custom configuration. user_agent (str): Set a custom user agent for requests to the server. credstore_env (dict): Override environment variables when calling the credential store process. use_ssh_client (bool): If set to `True`, an ssh connection is made via shelling out to the ssh client. Ensure the ssh client is installed and configured on the host. max_pool_size (int): The maximum number of connections to save in the pool. """ __attrs__ = requests.Session.__attrs__ + ['_auth_configs', '_general_configs', '_version', 'base_url', 'timeout'] def __init__(self, base_url=None, version=None, timeout=DEFAULT_TIMEOUT_SECONDS, tls=False, user_agent=DEFAULT_USER_AGENT, num_pools=None, credstore_env=None, use_ssh_client=False, max_pool_size=DEFAULT_MAX_POOL_SIZE): super().__init__() if tls and not base_url: raise TLSParameterError( 'If using TLS, the base_url argument must be provided.' ) self.base_url = base_url self.timeout = timeout self.headers['User-Agent'] = user_agent self._general_configs = config.load_general_config() proxy_config = self._general_configs.get('proxies', {}) try: proxies = proxy_config[base_url] except KeyError: proxies = proxy_config.get('default', {}) self._proxy_configs = ProxyConfig.from_dict(proxies) self._auth_configs = auth.load_config( config_dict=self._general_configs, credstore_env=credstore_env, ) self.credstore_env = credstore_env base_url = utils.parse_host( base_url, IS_WINDOWS_PLATFORM, tls=bool(tls) ) # SSH has a different default for num_pools to all other adapters num_pools = num_pools or DEFAULT_NUM_POOLS_SSH if \ base_url.startswith('ssh://') else DEFAULT_NUM_POOLS if base_url.startswith('http+unix://'): self._custom_adapter = UnixHTTPAdapter( base_url, timeout, pool_connections=num_pools, max_pool_size=max_pool_size ) self.mount('http+docker://', self._custom_adapter) self._unmount('http://', 'https://') # host part of URL should be unused, but is resolved by requests # module in proxy_bypass_macosx_sysconf() self.base_url = 'http+docker://localhost' elif base_url.startswith('npipe://'): if not IS_WINDOWS_PLATFORM: raise DockerException( 'The npipe:// protocol is only supported on Windows' ) try: self._custom_adapter = NpipeHTTPAdapter( base_url, timeout, pool_connections=num_pools, max_pool_size=max_pool_size ) except NameError as err: raise DockerException( 'Install pypiwin32 package to enable npipe:// support' ) from err self.mount('http+docker://', self._custom_adapter) self.base_url = 'http+docker://localnpipe' elif base_url.startswith('ssh://'): try: self._custom_adapter = SSHHTTPAdapter( base_url, timeout, pool_connections=num_pools, max_pool_size=max_pool_size, shell_out=use_ssh_client ) except NameError as err: raise DockerException( 'Install paramiko package to enable ssh:// support' ) from err self.mount('http+docker://ssh', self._custom_adapter) self._unmount('http://', 'https://') self.base_url = 'http+docker://ssh' else: # Use SSLAdapter for the ability to specify SSL version if isinstance(tls, TLSConfig): tls.configure_client(self) elif tls: self._custom_adapter = requests.adapters.HTTPAdapter( pool_connections=num_pools) self.mount('https://', self._custom_adapter) self.base_url = base_url # version detection needs to be after unix adapter mounting if version is None or (isinstance( version, str ) and version.lower() == 'auto'): self._version = self._retrieve_server_version() else: self._version = version if not isinstance(self._version, str): raise DockerException( 'Version parameter must be a string or None. ' f'Found {type(version).__name__}' ) if utils.version_lt(self._version, MINIMUM_DOCKER_API_VERSION): raise InvalidVersion( f'API versions below {MINIMUM_DOCKER_API_VERSION} are ' f'no longer supported by this library.' ) def _retrieve_server_version(self): try: return self.version(api_version=False)["ApiVersion"] except KeyError as ke: raise DockerException( 'Invalid response from docker daemon: key "ApiVersion"' ' is missing.' ) from ke except Exception as e: raise DockerException( f'Error while fetching server API version: {e}' ) from e def _set_request_timeout(self, kwargs): """Prepare the kwargs for an HTTP request by inserting the timeout parameter, if not already present.""" kwargs.setdefault('timeout', self.timeout) return kwargs @update_headers def _post(self, url, **kwargs): return self.post(url, **self._set_request_timeout(kwargs)) @update_headers def _get(self, url, **kwargs): return self.get(url, **self._set_request_timeout(kwargs)) @update_headers def _put(self, url, **kwargs): return self.put(url, **self._set_request_timeout(kwargs)) @update_headers def _delete(self, url, **kwargs): return self.delete(url, **self._set_request_timeout(kwargs)) def _url(self, pathfmt, *args, **kwargs): for arg in args: if not isinstance(arg, str): raise ValueError( f'Expected a string but found {arg} ({type(arg)}) instead' ) quote_f = partial(urllib.parse.quote, safe="/:") args = map(quote_f, args) formatted_path = pathfmt.format(*args) if kwargs.get('versioned_api', True): return f'{self.base_url}/v{self._version}{formatted_path}' else: return f'{self.base_url}{formatted_path}' def _raise_for_status(self, response): """Raises stored :class:`APIError`, if one occurred.""" try: response.raise_for_status() except requests.exceptions.HTTPError as e: raise create_api_error_from_http_exception(e) from e def _result(self, response, json=False, binary=False): assert not (json and binary) self._raise_for_status(response) if json: return response.json() if binary: return response.content return response.text def _post_json(self, url, data, **kwargs): # Go <1.1 can't unserialize null to a string # so we do this disgusting thing here. data2 = {} if data is not None and isinstance(data, dict): for k, v in iter(data.items()): if v is not None: data2[k] = v elif data is not None: data2 = data if 'headers' not in kwargs: kwargs['headers'] = {} kwargs['headers']['Content-Type'] = 'application/json' return self._post(url, data=json.dumps(data2), **kwargs) def _attach_params(self, override=None): return override or { 'stdout': 1, 'stderr': 1, 'stream': 1 } @check_resource('container') def _attach_websocket(self, container, params=None): url = self._url("/containers/{0}/attach/ws", container) req = requests.Request("POST", url, params=self._attach_params(params)) full_url = req.prepare().url full_url = full_url.replace("http://", "ws://", 1) full_url = full_url.replace("https://", "wss://", 1) return self._create_websocket_connection(full_url) def _create_websocket_connection(self, url): try: import websocket return websocket.create_connection(url) except ImportError as ie: raise DockerException( 'The `websocket-client` library is required ' 'for using websocket connections. ' 'You can install the `docker` library ' 'with the [websocket] extra to install it.' ) from ie def _get_raw_response_socket(self, response): self._raise_for_status(response) if self.base_url == "http+docker://localnpipe": sock = response.raw._fp.fp.raw.sock elif self.base_url.startswith('http+docker://ssh'): sock = response.raw._fp.fp.channel else: sock = response.raw._fp.fp.raw if self.base_url.startswith("https://"): sock = sock._sock try: # Keep a reference to the response to stop it being garbage # collected. If the response is garbage collected, it will # close TLS sockets. sock._response = response except AttributeError: # UNIX sockets can't have attributes set on them, but that's # fine because we won't be doing TLS over them pass return sock def _stream_helper(self, response, decode=False): """Generator for data coming from a chunked-encoded HTTP response.""" if response.raw._fp.chunked: if decode: yield from json_stream(self._stream_helper(response, False)) else: reader = response.raw while not reader.closed: # this read call will block until we get a chunk data = reader.read(1) if not data: break if reader._fp.chunk_left: data += reader.read(reader._fp.chunk_left) yield data else: # Response isn't chunked, meaning we probably # encountered an error immediately yield self._result(response, json=decode) def _multiplexed_buffer_helper(self, response): """A generator of multiplexed data blocks read from a buffered response.""" buf = self._result(response, binary=True) buf_length = len(buf) walker = 0 while True: if buf_length - walker < STREAM_HEADER_SIZE_BYTES: break header = buf[walker:walker + STREAM_HEADER_SIZE_BYTES] _, length = struct.unpack_from('>BxxxL', header) start = walker + STREAM_HEADER_SIZE_BYTES end = start + length walker = end yield buf[start:end] def _multiplexed_response_stream_helper(self, response): """A generator of multiplexed data blocks coming from a response stream.""" # Disable timeout on the underlying socket to prevent # Read timed out(s) for long running processes socket = self._get_raw_response_socket(response) self._disable_socket_timeout(socket) while True: header = response.raw.read(STREAM_HEADER_SIZE_BYTES) if not header: break _, length = struct.unpack('>BxxxL', header) if not length: continue data = response.raw.read(length) if not data: break yield data def _stream_raw_result(self, response, chunk_size=1, decode=True): ''' Stream result for TTY-enabled container and raw binary data''' self._raise_for_status(response) # Disable timeout on the underlying socket to prevent # Read timed out(s) for long running processes socket = self._get_raw_response_socket(response) self._disable_socket_timeout(socket) yield from response.iter_content(chunk_size, decode) def _read_from_socket(self, response, stream, tty=True, demux=False): """Consume all data from the socket, close the response and return the data. If stream=True, then a generator is returned instead and the caller is responsible for closing the response. """ socket = self._get_raw_response_socket(response) gen = frames_iter(socket, tty) if demux: # The generator will output tuples (stdout, stderr) gen = (demux_adaptor(*frame) for frame in gen) else: # The generator will output strings gen = (data for (_, data) in gen) if stream: return gen else: try: # Wait for all frames, concatenate them, and return the result return consume_socket_output(gen, demux=demux) finally: response.close() def _disable_socket_timeout(self, socket): """ Depending on the combination of python version and whether we're connecting over http or https, we might need to access _sock, which may or may not exist; or we may need to just settimeout on socket itself, which also may or may not have settimeout on it. To avoid missing the correct one, we try both. We also do not want to set the timeout if it is already disabled, as you run the risk of changing a socket that was non-blocking to blocking, for example when using gevent. """ sockets = [socket, getattr(socket, '_sock', None)] for s in sockets: if not hasattr(s, 'settimeout'): continue timeout = -1 if hasattr(s, 'gettimeout'): timeout = s.gettimeout() # Don't change the timeout if it is already disabled. if timeout is None or timeout == 0.0: continue s.settimeout(None) @check_resource('container') def _check_is_tty(self, container): cont = self.inspect_container(container) return cont['Config']['Tty'] def _get_result(self, container, stream, res): return self._get_result_tty(stream, res, self._check_is_tty(container)) def _get_result_tty(self, stream, res, is_tty): # We should also use raw streaming (without keep-alives) # if we're dealing with a tty-enabled container. if is_tty: return self._stream_raw_result(res) if stream else \ self._result(res, binary=True) self._raise_for_status(res) sep = b'' if stream: return self._multiplexed_response_stream_helper(res) else: return sep.join( list(self._multiplexed_buffer_helper(res)) ) def _unmount(self, *args): for proto in args: self.adapters.pop(proto) def get_adapter(self, url): try: return super().get_adapter(url) except requests.exceptions.InvalidSchema as e: if self._custom_adapter: return self._custom_adapter else: raise e @property def api_version(self): return self._version def reload_config(self, dockercfg_path=None): """ Force a reload of the auth configuration Args: dockercfg_path (str): Use a custom path for the Docker config file (default ``$HOME/.docker/config.json`` if present, otherwise ``$HOME/.dockercfg``) Returns: None """ self._auth_configs = auth.load_config( dockercfg_path, credstore_env=self.credstore_env ) api/__init__.py 0000644 00000000036 15027665106 0007435 0 ustar 00 from .client import APIClient __init__.py 0000644 00000000301 15027665106 0006657 0 ustar 00 from .api import APIClient from .client import DockerClient, from_env from .context import Context, ContextAPI from .tls import TLSConfig from .version import __version__ __title__ = 'docker' errors.py 0000644 00000012334 15027665106 0006445 0 ustar 00 import requests _image_not_found_explanation_fragments = frozenset( fragment.lower() for fragment in [ 'no such image', 'not found: does not exist or no pull access', 'repository does not exist', 'was found but does not match the specified platform', ] ) class DockerException(Exception): """ A base class from which all other exceptions inherit. If you want to catch all errors that the Docker SDK might raise, catch this base exception. """ def create_api_error_from_http_exception(e): """ Create a suitable APIError from requests.exceptions.HTTPError. """ response = e.response try: explanation = response.json()['message'] except ValueError: explanation = (response.text or '').strip() cls = APIError if response.status_code == 404: explanation_msg = (explanation or '').lower() if any(fragment in explanation_msg for fragment in _image_not_found_explanation_fragments): cls = ImageNotFound else: cls = NotFound raise cls(e, response=response, explanation=explanation) from e class APIError(requests.exceptions.HTTPError, DockerException): """ An HTTP error from the API. """ def __init__(self, message, response=None, explanation=None): # requests 1.2 supports response as a keyword argument, but # requests 1.1 doesn't super().__init__(message) self.response = response self.explanation = explanation def __str__(self): message = super().__str__() if self.is_client_error(): message = ( f'{self.response.status_code} Client Error for ' f'{self.response.url}: {self.response.reason}' ) elif self.is_server_error(): message = ( f'{self.response.status_code} Server Error for ' f'{self.response.url}: {self.response.reason}' ) if self.explanation: message = f'{message} ("{self.explanation}")' return message @property def status_code(self): if self.response is not None: return self.response.status_code def is_error(self): return self.is_client_error() or self.is_server_error() def is_client_error(self): if self.status_code is None: return False return 400 <= self.status_code < 500 def is_server_error(self): if self.status_code is None: return False return 500 <= self.status_code < 600 class NotFound(APIError): pass class ImageNotFound(NotFound): pass class InvalidVersion(DockerException): pass class InvalidRepository(DockerException): pass class InvalidConfigFile(DockerException): pass class InvalidArgument(DockerException): pass class DeprecatedMethod(DockerException): pass class TLSParameterError(DockerException): def __init__(self, msg): self.msg = msg def __str__(self): return self.msg + (". TLS configurations should map the Docker CLI " "client configurations. See " "https://docs.docker.com/engine/articles/https/ " "for API details.") class NullResource(DockerException, ValueError): pass class ContainerError(DockerException): """ Represents a container that has exited with a non-zero exit code. """ def __init__(self, container, exit_status, command, image, stderr): self.container = container self.exit_status = exit_status self.command = command self.image = image self.stderr = stderr err = f": {stderr}" if stderr is not None else "" super().__init__( f"Command '{command}' in image '{image}' " f"returned non-zero exit status {exit_status}{err}" ) class StreamParseError(RuntimeError): def __init__(self, reason): self.msg = reason class BuildError(DockerException): def __init__(self, reason, build_log): super().__init__(reason) self.msg = reason self.build_log = build_log class ImageLoadError(DockerException): pass def create_unexpected_kwargs_error(name, kwargs): quoted_kwargs = [f"'{k}'" for k in sorted(kwargs)] text = [f"{name}() "] if len(quoted_kwargs) == 1: text.append("got an unexpected keyword argument ") else: text.append("got unexpected keyword arguments ") text.append(', '.join(quoted_kwargs)) return TypeError(''.join(text)) class MissingContextParameter(DockerException): def __init__(self, param): self.param = param def __str__(self): return (f"missing parameter: {self.param}") class ContextAlreadyExists(DockerException): def __init__(self, name): self.name = name def __str__(self): return (f"context {self.name} already exists") class ContextException(DockerException): def __init__(self, msg): self.msg = msg def __str__(self): return (self.msg) class ContextNotFound(DockerException): def __init__(self, name): self.name = name def __str__(self): return (f"context '{self.name}' not found")
| ver. 1.4 |
Github
|
.
| PHP 8.2.28 | Generation time: 0.04 |
proxy
|
phpinfo
|
Settings