a !f @sLdZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z eddZdZd Zd ZiZd d Zed dddd eefddZedddd eefddZeddd ddddd eef ddZeddddddd eef ddZeddeefddZddZddZddZd d!Zd"d#ZGd$d%d%ZdS)&zGConcurrent media operations. This is a PREVIEW FEATURE: API may change.N) exceptions)Client)BlobzThe module `transfer_manager` is a preview feature. Functionality and API may change. This warning will be removed in a future release.iprocessthreadcsfdd}|S)Ncstj|i|}|jd}|r|jd}|jd}|sF|rNtdtd|j}|j }t |d<||d<|i|S|i|SdS)Nthreads worker_type max_workerszuThe `threads` parameter is deprecated and conflicts with its replacement parameters, `worker_type` and `max_workers`.zeThe `threads` parameter is deprecated. Please use `worker_type` and `max_workers` parameters instead.) inspect signaturebind argumentsget ValueErrorwarningswarnargskwargsTHREAD)rrZbindingrr r funcf/var/www/html/python-backend/venv/lib/python3.9/site-packages/google/cloud/storage/transfer_manager.pyconvert_threads_or_raise1s$   z:_deprecate_threads_param..convert_threads_or_raiser)rrrrr_deprecate_threads_param0s rFc Cs.|dur i}|r |}d|d<t|\}} ||d} g} |D]V\} } | r^t| ts^td| | jt| rtt| n| t| trdnd| fi|q@t j j | |t j j dWdn1s0Yg}| D]T}| }|r|s||q|r|rt|tjr||q||q|S) axUpload many files concurrently via a worker pool. This function is a PREVIEW FEATURE: the API may change in a future version. :type file_blob_pairs: List(Tuple(IOBase or str, 'google.cloud.storage.blob.Blob')) :param file_blob_pairs: A list of tuples of a file or filename and a blob. Each file will be uploaded to the corresponding blob by using blob.upload_from_file() or blob.upload_from_filename() as appropriate. File handlers are only supported if worker_type is set to THREAD. If worker_type is set to PROCESS, please use filenames only. :type skip_if_exists: bool :param skip_if_exists: If True, blobs that already have a live version will not be overwritten. This is accomplished by setting "if_generation_match = 0" on uploads. Uploads so skipped will result in a 412 Precondition Failed response code, which will be included in the return value but not raised as an exception regardless of the value of raise_exception. :type upload_kwargs: dict :param upload_kwargs: A dictionary of keyword arguments to pass to the upload method. Refer to the documentation for blob.upload_from_file() or blob.upload_from_filename() for more information. The dict is directly passed into the upload methods and is not validated by this function. :type threads: int :param threads: ***DEPRECATED*** Sets `worker_type` to THREAD and `max_workers` to the number specified. If `worker_type` or `max_workers` are set explicitly, this parameter should be set to None. Please use `worker_type` and `max_workers` instead of this parameter. :type deadline: int :param deadline: The number of seconds to wait for all threads to resolve. If the deadline is reached, all threads will be terminated regardless of their progress and concurrent.futures.TimeoutError will be raised. This can be left as the default of None (no deadline) for most use cases. :type raise_exception: bool :param raise_exception: If True, instead of adding exceptions to the list of return values, instead they will be raised. Note that encountering an exception on one operation will not prevent other operations from starting. Exceptions are only processed and potentially raised after all operations are complete in success or failure. If skip_if_exists is True, 412 Precondition Failed responses are considered part of normal operation and are not raised as an exception. :type worker_type: str :param worker_type: The worker type to use; one of google.cloud.storage.transfer_manager.PROCESS or google.cloud.storage.transfer_manager.THREAD. Although the exact performance impact depends on the use case, in most situations the PROCESS worker type will use more system resources (both memory and CPU) and result in faster operations than THREAD workers. Because the subprocesses of the PROCESS worker type can't access memory from the main process, Client objects have to be serialized and then recreated in each subprocess. The serialization of the Client object for use in subprocesses is an approximation and may not capture every detail of the Client object, especially if the Client was modified after its initial creation or if `Client._http` was modified in any way. THREAD worker types are observed to be relatively efficient for operations with many small files, but not for operations with large files. PROCESS workers are recommended for large file operations. PROCESS workers do not support writing to file handlers. Please refer to files by filename only when using PROCESS workers. :type max_workers: int :param max_workers: The maximum number of workers to create to handle the workload. With PROCESS workers, a larger number of workers will consume more system resources (memory and CPU) at once. How many workers is optimal depends heavily on the specific use case, and the default is a conservative number that should work okay in most cases without consuming excessive resources. :raises: :exc:`concurrent.futures.TimeoutError` if deadline is exceeded. :rtype: list :returns: A list of results corresponding to, in order, each item in the input list. If an exception was received, it will be the result for that operation. Otherwise, the return value from the successful upload method is used (typically, None). NrZif_generation_matchr Passing in a file object is only supported by the THREAD worker type. Please either select THREAD workers, or pass in filenames only.Zupload_from_filenameZupload_from_filetimeout return_when)copy _get_pool_class_and_requirements isinstancestrrappendsubmit"_call_method_on_maybe_pickled_blob _pickle_blob concurrentfutureswait ALL_COMPLETED exceptionrZPreconditionFailedresult)file_blob_pairsskip_if_exists upload_kwargsrdeadlineraise_exceptionr r pool_classneeds_picklingexecutorr* path_or_fileblobresultsfutureexprrr upload_manyJsJj     $  r<c Cs|dur i}t|\}}||d} g} |D]V\} } |rJt| tsJtd| | jt|r`t| n| t| trpdnd| fi|q,tj j | |tj j dWdn1s0Yg} | D].}|s| }|r| |q| | q| S)aDownload many blobs concurrently via a worker pool. This function is a PREVIEW FEATURE: the API may change in a future version. :type blob_file_pairs: List(Tuple('google.cloud.storage.blob.Blob', IOBase or str)) :param blob_file_pairs: A list of tuples of blob and a file or filename. Each blob will be downloaded to the corresponding blob by using blob.download_to_file() or blob.download_to_filename() as appropriate. Note that blob.download_to_filename() does not delete the destination file if the download fails. File handlers are only supported if worker_type is set to THREAD. If worker_type is set to PROCESS, please use filenames only. :type download_kwargs: dict :param download_kwargs: A dictionary of keyword arguments to pass to the download method. Refer to the documentation for blob.download_to_file() or blob.download_to_filename() for more information. The dict is directly passed into the download methods and is not validated by this function. :type threads: int :param threads: ***DEPRECATED*** Sets `worker_type` to THREAD and `max_workers` to the number specified. If `worker_type` or `max_workers` are set explicitly, this parameter should be set to None. Please use `worker_type` and `max_workers` instead of this parameter. :type deadline: int :param deadline: The number of seconds to wait for all threads to resolve. If the deadline is reached, all threads will be terminated regardless of their progress and concurrent.futures.TimeoutError will be raised. This can be left as the default of None (no deadline) for most use cases. :type raise_exception: bool :param raise_exception: If True, instead of adding exceptions to the list of return values, instead they will be raised. Note that encountering an exception on one operation will not prevent other operations from starting. Exceptions are only processed and potentially raised after all operations are complete in success or failure. :type worker_type: str :param worker_type: The worker type to use; one of google.cloud.storage.transfer_manager.PROCESS or google.cloud.storage.transfer_manager.THREAD. Although the exact performance impact depends on the use case, in most situations the PROCESS worker type will use more system resources (both memory and CPU) and result in faster operations than THREAD workers. Because the subprocesses of the PROCESS worker type can't access memory from the main process, Client objects have to be serialized and then recreated in each subprocess. The serialization of the Client object for use in subprocesses is an approximation and may not capture every detail of the Client object, especially if the Client was modified after its initial creation or if `Client._http` was modified in any way. THREAD worker types are observed to be relatively efficient for operations with many small files, but not for operations with large files. PROCESS workers are recommended for large file operations. PROCESS workers do not support writing to file handlers. Please refer to files by filename only when using PROCESS workers. :type max_workers: int :param max_workers: The maximum number of workers to create to handle the workload. With PROCESS workers, a larger number of workers will consume more system resources (memory and CPU) at once. How many workers is optimal depends heavily on the specific use case, and the default is a conservative number that should work okay in most cases without consuming excessive resources. :raises: :exc:`concurrent.futures.TimeoutError` if deadline is exceeded. :rtype: list :returns: A list of results corresponding to, in order, each item in the input list. If an exception was received, it will be the result for that operation. Otherwise, the return value from the successful download method is used (typically, None). NrrZdownload_to_filenamedownload_to_filer)r"r#r$rr%r&r'r(r)r*r+r,r-r.)blob_file_pairsdownload_kwargsrr2r3r r r4r5r6r*r8r7r9r:r;rrr download_manysDb     $ r@c  Csf|dur i}g} |D]:} tj|| }|| }|j|fi|}| ||fqt| |||| | | dS)aVUpload many files concurrently by their filenames. This function is a PREVIEW FEATURE: the API may change in a future version. The destination blobs are automatically created, with blob names based on the source filenames and the blob_name_prefix. For example, if the `filenames` include "images/icon.jpg", `source_directory` is "/home/myuser/", and `blob_name_prefix` is "myfiles/", then the file at "/home/myuser/images/icon.jpg" will be uploaded to a blob named "myfiles/images/icon.jpg". :type bucket: 'google.cloud.storage.bucket.Bucket' :param bucket: The bucket which will contain the uploaded blobs. :type filenames: list(str) :param filenames: A list of filenames to be uploaded. This may include part of the path. The full path to the file must be source_directory + filename. :type source_directory: str :param source_directory: A string that will be prepended (with os.path.join()) to each filename in the input list, in order to find the source file for each blob. Unlike the filename itself, the source_directory does not affect the name of the uploaded blob. For instance, if the source_directory is "/tmp/img/" and a filename is "0001.jpg", with an empty blob_name_prefix, then the file uploaded will be "/tmp/img/0001.jpg" and the destination blob will be "0001.jpg". This parameter can be an empty string. Note that this parameter allows directory traversal (e.g. "/", "../") and is not intended for unsanitized end user input. :type blob_name_prefix: str :param blob_name_prefix: A string that will be prepended to each filename in the input list, in order to determine the name of the destination blob. Unlike the filename itself, the prefix string does not affect the location the library will look for the source data on the local filesystem. For instance, if the source_directory is "/tmp/img/", the blob_name_prefix is "myuser/mystuff-" and a filename is "0001.jpg" then the file uploaded will be "/tmp/img/0001.jpg" and the destination blob will be "myuser/mystuff-0001.jpg". The blob_name_prefix can be blank (an empty string). :type skip_if_exists: bool :param skip_if_exists: If True, blobs that already have a live version will not be overwritten. This is accomplished by setting "if_generation_match = 0" on uploads. Uploads so skipped will result in a 412 Precondition Failed response code, which will be included in the return value, but not raised as an exception regardless of the value of raise_exception. :type blob_constructor_kwargs: dict :param blob_constructor_kwargs: A dictionary of keyword arguments to pass to the blob constructor. Refer to the documentation for blob.Blob() for more information. The dict is directly passed into the constructor and is not validated by this function. `name` and `bucket` keyword arguments are reserved by this function and will result in an error if passed in here. :type upload_kwargs: dict :param upload_kwargs: A dictionary of keyword arguments to pass to the upload method. Refer to the documentation for blob.upload_from_file() or blob.upload_from_filename() for more information. The dict is directly passed into the upload methods and is not validated by this function. :type threads: int :param threads: ***DEPRECATED*** Sets `worker_type` to THREAD and `max_workers` to the number specified. If `worker_type` or `max_workers` are set explicitly, this parameter should be set to None. Please use `worker_type` and `max_workers` instead of this parameter. :type deadline: int :param deadline: The number of seconds to wait for all threads to resolve. If the deadline is reached, all threads will be terminated regardless of their progress and concurrent.futures.TimeoutError will be raised. This can be left as the default of None (no deadline) for most use cases. :type raise_exception: bool :param raise_exception: If True, instead of adding exceptions to the list of return values, instead they will be raised. Note that encountering an exception on one operation will not prevent other operations from starting. Exceptions are only processed and potentially raised after all operations are complete in success or failure. If skip_if_exists is True, 412 Precondition Failed responses are considered part of normal operation and are not raised as an exception. :type worker_type: str :param worker_type: The worker type to use; one of google.cloud.storage.transfer_manager.PROCESS or google.cloud.storage.transfer_manager.THREAD. Although the exact performance impact depends on the use case, in most situations the PROCESS worker type will use more system resources (both memory and CPU) and result in faster operations than THREAD workers. Because the subprocesses of the PROCESS worker type can't access memory from the main process, Client objects have to be serialized and then recreated in each subprocess. The serialization of the Client object for use in subprocesses is an approximation and may not capture every detail of the Client object, especially if the Client was modified after its initial creation or if `Client._http` was modified in any way. THREAD worker types are observed to be relatively efficient for operations with many small files, but not for operations with large files. PROCESS workers are recommended for large file operations. :type max_workers: int :param max_workers: The maximum number of workers to create to handle the workload. With PROCESS workers, a larger number of workers will consume more system resources (memory and CPU) at once. How many workers is optimal depends heavily on the specific use case, and the default is a conservative number that should work okay in most cases without consuming excessive resources. :raises: :exc:`concurrent.futures.TimeoutError` if deadline is exceeded. :rtype: list :returns: A list of results corresponding to, in order, each item in the input list. If an exception was received, it will be the result for that operation. Otherwise, the return value from the successful upload method is used (typically, None). N)r0r1r2r3r r )ospathjoinr8r%r<)bucket filenamesZsource_directoryblob_name_prefixr0Zblob_constructor_kwargsr1rr2r3r r r/filenamerC blob_namer8rrrupload_many_from_filenamesss$rJTc Csng} |D]P} || } tj|| }|rDtj|\}}tj|dd| || |fqt| |||| | dS)aDownload many files concurrently by their blob names. This function is a PREVIEW FEATURE: the API may change in a future version. The destination files are automatically created, with paths based on the source blob_names and the destination_directory. The destination files are not automatically deleted if their downloads fail, so please check the return value of this function for any exceptions, or enable `raise_exception=True`, and process the files accordingly. For example, if the `blob_names` include "icon.jpg", `destination_directory` is "/home/myuser/", and `blob_name_prefix` is "images/", then the blob named "images/icon.jpg" will be downloaded to a file named "/home/myuser/icon.jpg". :type bucket: 'google.cloud.storage.bucket.Bucket' :param bucket: The bucket which contains the blobs to be downloaded :type blob_names: list(str) :param blob_names: A list of blobs to be downloaded. The blob name in this string will be used to determine the destination file path as well. The full name to the blob must be blob_name_prefix + blob_name. The blob_name is separate from the blob_name_prefix because the blob_name will also determine the name of the destination blob. Any shared part of the blob names that need not be part of the destination path should be included in the blob_name_prefix. :type destination_directory: str :param destination_directory: A string that will be prepended (with os.path.join()) to each blob_name in the input list, in order to determine the destination path for that blob. For instance, if the destination_directory string is "/tmp/img" and a blob_name is "0001.jpg", with an empty blob_name_prefix, then the source blob "0001.jpg" will be downloaded to destination "/tmp/img/0001.jpg" . This parameter can be an empty string. Note that this parameter allows directory traversal (e.g. "/", "../") and is not intended for unsanitized end user input. :type blob_name_prefix: str :param blob_name_prefix: A string that will be prepended to each blob_name in the input list, in order to determine the name of the source blob. Unlike the blob_name itself, the prefix string does not affect the destination path on the local filesystem. For instance, if the destination_directory is "/tmp/img/", the blob_name_prefix is "myuser/mystuff-" and a blob_name is "0001.jpg" then the source blob "myuser/mystuff-0001.jpg" will be downloaded to "/tmp/img/0001.jpg". The blob_name_prefix can be blank (an empty string). :type download_kwargs: dict :param download_kwargs: A dictionary of keyword arguments to pass to the download method. Refer to the documentation for blob.download_to_file() or blob.download_to_filename() for more information. The dict is directly passed into the download methods and is not validated by this function. :type threads: int :param threads: ***DEPRECATED*** Sets `worker_type` to THREAD and `max_workers` to the number specified. If `worker_type` or `max_workers` are set explicitly, this parameter should be set to None. Please use `worker_type` and `max_workers` instead of this parameter. :type deadline: int :param deadline: The number of seconds to wait for all threads to resolve. If the deadline is reached, all threads will be terminated regardless of their progress and concurrent.futures.TimeoutError will be raised. This can be left as the default of None (no deadline) for most use cases. :type create_directories: bool :param create_directories: If True, recursively create any directories that do not exist. For instance, if downloading object "images/img001.png", create the directory "images" before downloading. :type raise_exception: bool :param raise_exception: If True, instead of adding exceptions to the list of return values, instead they will be raised. Note that encountering an exception on one operation will not prevent other operations from starting. Exceptions are only processed and potentially raised after all operations are complete in success or failure. If skip_if_exists is True, 412 Precondition Failed responses are considered part of normal operation and are not raised as an exception. :type worker_type: str :param worker_type: The worker type to use; one of google.cloud.storage.transfer_manager.PROCESS or google.cloud.storage.transfer_manager.THREAD. Although the exact performance impact depends on the use case, in most situations the PROCESS worker type will use more system resources (both memory and CPU) and result in faster operations than THREAD workers. Because the subprocesses of the PROCESS worker type can't access memory from the main process, Client objects have to be serialized and then recreated in each subprocess. The serialization of the Client object for use in subprocesses is an approximation and may not capture every detail of the Client object, especially if the Client was modified after its initial creation or if `Client._http` was modified in any way. THREAD worker types are observed to be relatively efficient for operations with many small files, but not for operations with large files. PROCESS workers are recommended for large file operations. :type max_workers: int :param max_workers: The maximum number of workers to create to handle the workload. With PROCESS workers, a larger number of workers will consume more system resources (memory and CPU) at once. How many workers is optimal depends heavily on the specific use case, and the default is a conservative number that should work okay in most cases without consuming excessive resources. :raises: :exc:`concurrent.futures.TimeoutError` if deadline is exceeded. :rtype: list :returns: A list of results corresponding to, in order, each item in the input list. If an exception was received, it will be the result for that operation. Otherwise, the return value from the successful download method is used (typically, None). T)exist_ok)r?r2r3r r )rBrCrDsplitmakedirsr%r8r@)rEZ blob_namesZdestination_directoryrGr?rr2Zcreate_directoriesr3r r r>rIZfull_blob_namerC directory_rrrdownload_many_to_path"s"rPc Cs |dur i}d|vsd|vr$td|jr0|js8|t|\}}|rPt|n|} g} t|d} Wdn1sx0Y||dl} d} |j}| |kr| }t| ||} | | j t | ||| d|d qt j j | |t j jd Wdn1s0Y| D]}|q dS) ax Download a single file in chunks, concurrently. This function is a PREVIEW FEATURE: the API may change in a future version. In some environments, using this feature with mutiple processes will result in faster downloads of large files. Using this feature with multiple threads is unlikely to improve download performance under normal circumstances due to Python interpreter threading behavior. The default is therefore to use processes instead of threads. Checksumming (md5 or crc32c) is not supported for chunked operations. Any `checksum` parameter passed in to download_kwargs will be ignored. :type bucket: 'google.cloud.storage.bucket.Bucket' :param bucket: The bucket which contains the blobs to be downloaded :type blob: `google.cloud.storage.Blob` :param blob: The blob to be downloaded. :type filename: str :param filename: The destination filename or path. :type download_kwargs: dict :param download_kwargs: A dictionary of keyword arguments to pass to the download method. Refer to the documentation for blob.download_to_file() or blob.download_to_filename() for more information. The dict is directly passed into the download methods and is not validated by this function. Keyword arguments "start" and "end" which are not supported and will cause a ValueError if present. :type deadline: int :param deadline: The number of seconds to wait for all threads to resolve. If the deadline is reached, all threads will be terminated regardless of their progress and concurrent.futures.TimeoutError will be raised. This can be left as the default of None (no deadline) for most use cases. :type worker_type: str :param worker_type: The worker type to use; one of google.cloud.storage.transfer_manager.PROCESS or google.cloud.storage.transfer_manager.THREAD. Although the exact performance impact depends on the use case, in most situations the PROCESS worker type will use more system resources (both memory and CPU) and result in faster operations than THREAD workers. Because the subprocesses of the PROCESS worker type can't access memory from the main process, Client objects have to be serialized and then recreated in each subprocess. The serialization of the Client object for use in subprocesses is an approximation and may not capture every detail of the Client object, especially if the Client was modified after its initial creation or if `Client._http` was modified in any way. THREAD worker types are observed to be relatively efficient for operations with many small files, but not for operations with large files. PROCESS workers are recommended for large file operations. :type max_workers: int :param max_workers: The maximum number of workers to create to handle the workload. With PROCESS workers, a larger number of workers will consume more system resources (memory and CPU) at once. How many workers is optimal depends heavily on the specific use case, and the default is a conservative number that should work okay in most cases without consuming excessive resources. :raises: :exc:`concurrent.futures.TimeoutError` if deadline is exceeded. NstartendzWDownload arguments 'start' and 'end' are not supported by download_chunks_concurrently.wbrr)rQrRr?r)rsizeZ generationreloadr"r(openminr%r&"_download_and_write_chunk_in_placer)r*r+r,r.)r8rH chunk_sizer?r2r r r4r5maybe_pickled_blobr*rOr6cursorrRrQr:rrrdownload_chunks_concurrentlysFV      $ r]cCsjt|tr|}n t|}t|d2}|||j|f||d|WdS1s\0YdS)Nzrb+)rQrR)r#rpickleloadsrWseekr=)r[rHrQrRr?r8frrrrYOs   rYcOs.t|tr|}n t|}t|||i|S)zHelper function that runs inside a thread or subprocess. `maybe_pickled_blob` is either a blob (for threads) or a specially pickled blob (for processes) because the default pickling mangles clients which are attached to blobs.)r#rr^r_getattr)r[ method_namerrr8rrrr']s  r'cCs8t|}|j}|j}d}|j}|j}t||||||ffS)zBReplicate a Client by constructing a new one with the same params.N)idprojectZ_initial_credentialsZ_initial_client_infoZ_initial_client_options _LazyClient)clZclient_object_idre credentialsZ_httpZ client_infoZclient_optionsrrr_reduce_clientmsricCs:t}t|}tj|_t|jt<| || S)zBPickle a Blob (and its Bucket and Client) and return a bytestring.) ioBytesIOr^Picklercopyregdispatch_tabler!rirdumpgetvalue)r8raprrrr(s     r(cCs4|tkrtjjdfS|tkr(tjjdfStddS)zDReturns the pool class, and whether the pool requires pickled Blobs.TFzuThe worker_type must be google.cloud.storage.transfer_manager.PROCESS or google.cloud.storage.transfer_manager.THREADN)PROCESSr)r*ProcessPoolExecutorrThreadPoolExecutorr)r rrrr"s  r"c@seZdZdZddZdS)rfzBAn object that will transform into either a cached or a new ClientcOs0t|}|r|St|i|}|t|<|SdS)N)_cached_clientsrr)clsrdrrZ cached_clientrrr__new__s  z_LazyClient.__new__N)__name__ __module__ __qualname____doc__rwrrrrrfsrf) r{concurrent.futuresr)rjr rBrr^rmZgoogle.api_corerZgoogle.cloud.storagerrrZTM_DEFAULT_CHUNK_SIZEZDEFAULT_MAX_WORKERSrrrrurr<r@rJrPr]rYr'rir(r"rfrrrrs       / *