5i/dZddlZddlmZddlmZddlmZddlm Z m Z ddl m Z m Z mZmZmZmZddlZddlZddlmZdd lmZmZmZmZdd lmZGd d eZGd deZGddeZGddeZ GddeZ!eGddZ"eGddZ#GddeZ$GddeZ%GddejLjNZ(Gdd Z)Gd!d"Z*d#e+d$e fd%Z,d&Z-d'Z.d(Z/d)ee0fd*Z1y)+z S3 client N)Future)NativeResource) HttpRequest)ClientBootstrapTlsConnectionOptions)AwsCredentialsProviderAwsSignatureTypeAwsSignedBodyHeaderTypeAwsSignedBodyValueAwsSigningAlgorithmAwsSigningConfig) dataclass)ListOptionalTupleSequence)IntEnumc:eZdZdZfdZdZdZdZdZxZ S)CrossProcessLockaU Class representing an exclusive cross-process lock, scoped by `lock_scope_name` Recommended usage is to either explicitly call acquire() followed by release() when the lock is no longer required, or use this in a 'with' statement. acquire() will throw a RuntimeError with AWS_MUTEX_CALLER_NOT_OWNER as the error code, if the lock could not be acquired. If the lock has not been explicitly released when the process exits, it will be released by the operating system. Keyword Args: lock_scope_name (str): Unique string identifying the caller holding the lock. cVt|tj||_yN)super__init___awscrts3_cross_process_lock_new_binding)selflock_scope_name __class__s k/home/marpiech/ifpan-abm-pgxpred/analysis/marpiech-gwas-test/venv/lib/python3.12/site-packages/awscrt/s3.pyrzCrossProcessLock.__init__$s  99/J cBtj|jyr)rs3_cross_process_lock_acquirerrs r acquirezCrossProcessLock.acquire(--dmmr!r r@r@Js!GHr!r@c,eZdZdZdZ dZ dZ dZ dZy)S3ChecksumAlgorithmz Checksum algorithm used to verify object integrity. https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html r9r:N) r1r2r3r4CRC32CCRC32SHA1SHA256 CRC64NVMEr>r!r rDrDXs1 F E D FIr!rDceZdZdZdZ dZy)S3ChecksumLocationzWhere to put the checksum.r9r:N)r1r2r3r4HEADERTRAILERr>r!r rNrNns$ F Gr!rNcLeZdZUdZdZeeed< dZee ed< dZ e ed<y)S3ChecksumConfigz>Configures how the S3Client calculates and verifies checksums.N algorithmlocationFvalidate_response) r1r2r3r4rSrrD__annotations__rTrNrUboolr>r!r rRrRs=H/3Ix+,3 .2Hh)*1,#t#>r!rRcFeZdZUdZdZeed< dZee ed< dZ eed<y)S3FileIoOptionsa WARNING: experimental/unstable, the default behavior is subjected to change in the future. Controls how client performance file I/O operations. Only applies to the file based workload. Notes: only applies when `send_filepath` is set from the request. F should_streamdisk_throughput_gbps direct_ioN) r1r2r3r4rZrWrVr\rfloatr]r>r!r rYrYs? M4 /28E?1 Itr!rYceZdZdZdZdddddddddddddd deeededd eeffd Z ddddddddddddddd d Z xZ S) S3ClientaS3 client Keyword Args: bootstrap (Optional [ClientBootstrap]): Client bootstrap to use when initiating socket connection. If None is provided, the default singleton is used. region (str): Region that the S3 bucket lives in. tls_mode (Optional[S3RequestTlsMode]): How TLS should be used while performing the request If this is :attr:`S3RequestTlsMode.ENABLED`: If `tls_connection_options` is set, then those TLS options will be used If `tls_connection_options` is unset, then default TLS options will be used If this is :attr:`S3RequestTlsMode.DISABLED`: No TLS options will be used, regardless of `tls_connection_options` value. signing_config (Optional[AwsSigningConfig]): Configuration for signing of the client. Use :func:`create_default_s3_signing_config()` to create the default config. If not set, a default config will be used with anonymous credentials and skip signing the request. If set: Credentials provider is required. Other configs are all optional, and will be default to what needs to sign the request for S3, only overrides when Non-zero/Not-empty is set. S3 Client will derive the right config for signing process based on this. Notes: 1. For SIGV4_S3EXPRESS, S3 client will use the credentials in the config to derive the S3 Express credentials that are used in the signing process. 2. Client may make modifications to signing config before passing it on to signer. credential_provider (Optional[AwsCredentialsProvider]): Deprecated, prefer `signing_config` instead. Credentials providers source the :class:`~awscrt.auth.AwsCredentials` needed to sign an authenticated AWS request. If None is provided, the request will not be signed. tls_connection_options (Optional[TlsConnectionOptions]): Optional TLS Options to be used for each connection, unless `tls_mode` is :attr:`S3RequestTlsMode.DISABLED` part_size (Optional[int]): Size, in bytes, of parts that files will be downloaded or uploaded in. If not set, a dynamic default part size will be used based on the throughput target, memory_limit_in_bytes. Note: for :attr:`S3RequestType.PUT_OBJECT` request, client will adjust the part size to meet the service limits. (max number of parts per upload is 10,000, minimum upload part size is 5 MiB) multipart_upload_threshold (Optional[int]): The size threshold in bytes, for when to use multipart uploads. This only affects :attr:`S3RequestType.PUT_OBJECT` request. Uploads over this size will use the multipart upload strategy. Uploads this size or less will use a single request. If not set, maximal of `part_size` and 5 MiB will be used. throughput_target_gbps (Optional[float]): Throughput target in Gigabits per second (Gbps) that we are trying to reach. You can also use `get_recommended_throughput_target_gbps()` to get recommended value for your system. 10.0 Gbps by default (may change in future) enable_s3express (Optional[bool]): To enable S3 Express support for the client. The typical usage for a S3 Express request is to set this to true and let the request to be signed with `AwsSigningAlgorithm.V4_S3EXPRESS`, either from the client-level `signing_config` or the request-level override. memory_limit (Optional[int]): Memory limit, in bytes, of how much memory client can use for buffering data for requests. If not set, client will try to pick up from environment variable before chose the default. Default values scale with target throughput and are currently between 2GiB and 24GiB (may change in future) network_interface_names (Optional[Sequence(str)]): **THIS IS AN EXPERIMENTAL AND UNSTABLE API.** A sequence of network interface names. The client will distribute the connections across network interfaces. If any interface name is invalid, goes down, or has any issues like network access, you will see connection failures. This option is only supported on Linux, MacOS, and platforms that have either SO_BINDTODEVICE or IP_BOUND_IF. It is not supported on Windows. `AWS_ERROR_PLATFORM_NOT_SUPPORTED` will be raised on unsupported platforms. On Linux, SO_BINDTODEVICE is used and requires kernel version >= 5.7 or root privileges. fio_options (Optional[S3FileIoOptions]): If set, this controls how the client interact with file I/O. If not set, a default options will be created to avoid memory issue based on the size of file. Note: Only applies when the request created with `send_filepath` max_active_connections_override (Optional[int]): When set, this will cap the number of active connections for the meta request. When not set, the client will determine this value based on `throughput_target_gbps`. (Recommended) )shutdown_event_regionNF) bootstraptls_modesigning_configcredential_providertls_connection_options part_sizemultipart_upload_thresholdthroughput_target_gbpsenable_s3express memory_limitnetwork_interface_names fio_optionsmax_active_connections_overridermrnrYroct|ts|Jt|tsJt|ts|Jt|ts|Jt|t s|Jt|t s|Jt| t st| ts| Jt| ts| Jt| ts| Jt| ts| Jt|t s|J|r |r tdt|5tjfd}||_|_|stj$}t'||||}|d}|d}|d}| d} | d} | t| t(s t)| } |d}d}d}d}d}| &d}| j*}| j,}| j.}t1j2|||||||||| | | | |||||||_y)Nzh'credential_provider' has been deprecated in favor of 'signing_config'. Both parameters may not be set.c&jyr)set)rasr on_shutdownz&S3Client.__init__..on_shutdown;s    r!rFr[T) isinstancerstrr rrintr^rWrrY ValueErrorrr threadingEventrbraget_or_create_static_default _S3ClientCorelistrZr\r]r s3_client_newr)rrcregionrdrerfrgrhrirjrkrlrmrnrorss3_client_corefio_options_setrZr\r]rars @r rzS3Client.__init__sm")_59JJJ&#&&&.*:;~?UUU-/EFJ]Jeee02FGKaKiii)S)Y->>> "  " ,4  55 *D15E5MMM18<@W@___+7;;NNN93?CbCjjj >?@ @ "* ! ,'DDFI&    " $  H  I % -)* & ! )%& "  L " .5t<*./F*G' * 2./ + "  ""O'55M#.#C#C #--I--    "     & "   #    + ' r!)operation_name recv_filepath send_filepathrerfchecksum_configrhrirnro on_headerson_bodyon_done on_progressctdid|d|d|d|d|d|d|d|d |d | d | d | d | d| d|d|d|d|jS)a&Create the Request to the the S3 server, :attr:`~S3RequestType.GET_OBJECT`/:attr:`~S3RequestType.PUT_OBJECT` requests are split it into multi-part requests under the hood for acceleration. Keyword Args: type (S3RequestType): The type of S3 request passed in, :attr:`~S3RequestType.GET_OBJECT`/:attr:`~S3RequestType.PUT_OBJECT` can be accelerated request (HttpRequest): The overall outgoing API request for S3 operation. If the request body is a file, set send_filepath for better performance. operation_name(Optional[str]): S3 operation name (e.g. "CreateBucket"). This MUST be set when `type` is :attr:`~S3RequestType.DEFAULT`. It is ignored for other types, since the operation is implicitly known. See `S3 API documentation `_ for the canonical list of names. This name is used to fill out details in metrics and error reports. It also drives some operation-specific behavior. If you pass the wrong name, you risk getting the wrong behavior. For example, every operation except "GetObject" has its response checked for error, even if the HTTP status-code was 200 OK (see `knowledge center `_). If you used the :attr:`~S3RequestType.DEFAULT` type to do `GetObject `_, but mis-named it "Download", and the object looked like XML with an error code, then the request would fail. You risk logging the full response body, and leaking sensitive data. recv_filepath (Optional[str]): Optional file path. If set, the response body is written directly to a file and the `on_body` callback is not invoked. This should give better performance than writing to file from the `on_body` callback. send_filepath (Optional[str]): Optional file path. If set, the request body is read directly from a file and the request's `body_stream` is ignored. This should give better performance than reading a file from a stream. signing_config (Optional[AwsSigningConfig]): Configuration for signing of the request to override the configuration from client. Use :func:`create_default_s3_signing_config()` to create the default config. If None is provided, the client configuration will be used. If set: All fields are optional. The credentials will be resolve from client if not set. S3 Client will derive the right config for signing process based on this. Notes: 1. For SIGV4_S3EXPRESS, S3 client will use the credentials in the config to derive the S3 Express credentials that are used in the signing process. 2. Client may make modifications to signing config before passing it on to signer. credential_provider (Optional[AwsCredentialsProvider]): Deprecated, prefer `signing_config` instead. Credentials providers source the :class:`~awscrt.auth.AwsCredentials` needed to sign an authenticated AWS request, for this request only. If None is provided, the client configuration will be used. checksum_config (Optional[S3ChecksumConfig]): Optional checksum settings. part_size (Optional[int]): Size, in bytes, of parts that files will be downloaded or uploaded in. If not set, the part size configured for the client will be used, which defaults to a dynamic value based on the throughput target, memory_limit_in_bytes and the requested object size. Note: for :attr:`S3RequestType.PUT_OBJECT` request, client will adjust the part size to meet the service limits. (max number of parts per upload is 10,000, minimum upload part size is 5 MiB) multipart_upload_threshold (Optional[int]): The size threshold in bytes, for when to use multipart uploads. This only affects :attr:`S3RequestType.PUT_OBJECT` request. Uploads over this size will use the multipart upload strategy. Uploads this size or less will use a single request. If set, this should be at least `part_size`. If not set, `part_size` adjusted by client will be used as the threshold. If both `part_size` and `multipart_upload_threshold` are not set, the values from `aws_s3_client_config` are used. fio_options (Optional[S3FileIoOptions]): If set, this overrides the client fio_options to control how this request interact with file I/O. If not set, a default options will be created to avoid memory issue based on the size of file. Note: Only applies when the request created with `send_filepath` max_active_connections_override (Optional[int]): When set, this will cap the number of active connections for the meta request. When not set, the client will determine it based on client side settings. (Recommended) on_headers: Optional callback invoked as the response received, and even the API request has been split into multiple parts, this callback will only be invoked once as it's just making one API request to S3. The function should take the following arguments and return nothing: * `status_code` (int): Response status code. * `headers` (List[Tuple[str, str]]): Response headers as a list of (name,value) pairs. * `**kwargs` (dict): Forward-compatibility kwargs. on_body: Optional callback invoked 0+ times as the response body received from S3 server. If simply writing to a file, use `recv_filepath` instead of `on_body` for better performance. The function should take the following arguments and return nothing: * `chunk` (buffer): Response body data (not necessarily a whole "chunk" of chunked encoding). * `offset` (int): The offset of the chunk started in the whole body. * `**kwargs` (dict): Forward-compatibility kwargs. on_done: Optional callback invoked when the request has finished the job. The function should take the following arguments and return nothing: * `error` (Optional[Exception]): None if the request was successfully sent and valid response received, or an Exception if it failed. * `error_headers` (Optional[List[Tuple[str, str]]]): If request failed because server side sent an unsuccessful response, the headers of the response is provided here. Else None will be returned. * `error_body` (Optional[bytes]): If request failed because server side sent an unsuccessful response, the body of the response is provided here. Else None will be returned. * `error_operation_name` (Optional[str]): If request failed because server side sent and unsuccessful response, this is the name of the S3 operation it was responding to. For example, if a :attr:`~S3RequestType.PUT_OBJECT` fails this could be "PutObject", "CreateMultipartUpload", "UploadPart", "CompleteMultipartUpload", or others. For :attr:`~S3RequestType.DEFAULT`, this is the `operation_name` passed to :meth:`S3Client.make_request()`. This will be None if the request failed for another reason, or the S3 operation name is unknown. * `status_code` (Optional[int]): HTTP response status code (if available). If request failed because server side sent an unsuccessful response, this is its status code. If the operation was successful, this is the final response's status code. If the operation failed for another reason, None is returned. * `did_validate_checksum` (bool): Was the server side checksum compared against a calculated checksum of the response body. This may be false even if :attr:`S3ChecksumConfig.validate_response` was set because the object was uploaded without a checksum, or downloaded differently from how it's uploaded. * `checksum_validation_algorithm` (Optional[S3ChecksumAlgorithm]): The checksum algorithm used to validate the response. * `**kwargs` (dict): Forward-compatibility kwargs. on_progress: Optional callback invoked when part of the transfer is done to report the progress. The function should take the following arguments and return nothing: * `progress` (int): Number of bytes of data that just get transferred * `**kwargs` (dict): Forward-compatibility kwargs. Returns: S3Request clienttyperequestrrrrerfrrhrirnrorrrrr~r>) S3Requestrb)rrrrrrrerfrrhrirnrorrrrs r make_requestzS3Client.make_requestzsd!!!!* ! ( ! ( !*!!4!,! !(B!$!-L!"!! !!"$#!$<<%! !r!) r1r2r3r4 __slots__rrrurvrrr5r6s@r r`r`sUn.I  $#''+#'"?C7;=A!f&.hsm%<f""34f .6c]!fZ  $ '+,0%D!D!r!r`c^eZdZdZdZddddddddddddddddfd ZedZdZxZ S)raNS3 request Create a new S3Request with :meth:`S3Client.make_request()` Attributes: finished_future (concurrent.futures.Future): Future that will resolve when the s3 request has finished successfully. If the error happens, the Future will contain an exception indicating why it failed. Note: Future will set before on_done invoked shutdown_event (threading.Event): Signals when underlying threads and structures have all finished shutting down. Shutdown begins when the S3Request object is destroyed. )_finished_futureraN)rrrrerfrrhrirnrorrrrr~ct|tsJt|tsJt|s|Jt|s|Jt|s|Jt| ts| Jt| ts| Jt| t s| Jt| ts| J|t jk(r |s tdt|)t|_ tj|_| d} | d} d}d}d}| P| j | j j"}| j$| j$j"}| j&}d}d}d}d}| &d}| j(}| j*}| j,}| d} t/||j|j|||||| }t1j2|||||||||||||| | ||||| ||_y)Nz='operation_name' must be set when using S3RequestType.DEFAULTrFr[T)rtr`rcallablervrYr8r;rwrrrrrxryrarSvaluerTrUrZr\r]_S3RequestCorers3_client_make_meta_requestr)rrrrrrrrerfrrhrirnrorrrrr~checksum_algorithmchecksum_locationvalidate_response_checksumrrZr\r]s3_request_corers r rzS3Request.__init__Qs?*&(+++';/// #z'999 GO33 GO33)S)Y->>>4c:>X>```+7;;NNN93?CbCjjj =(( (\] ]  &'oo/  I % -)* &%*"  &((4%4%>%>%D%D"''3$3$<$<$B$B!)8)J)J & "  ""O'55M#.#C#C #--I * 2./ +(   ! !           ;;             &  &    + + r!c|jSr)rr$s r finished_futurezS3Request.finished_futures$$$r!c.tj|yr)rs3_meta_request_cancelr$s r cancelzS3Request.cancels&&t,r!) r1r2r3r4rrpropertyrrr5r6s@r rrAs^ 7I  $ '+,0)aF%%-r!rcxeZdZdZddddddedededeeeefdeeeefd ee d eeffd Z xZ S) S3ResponseErroraf An error response from S3. Subclasses :class:`awscrt.exceptions.AwsCrtError`. Attributes: status_code (int): HTTP response status code. headers (list[tuple[str, str]]): Headers from HTTP response. body (Optional[bytes]): Body of HTTP response (if any). This is usually XML. It may be None in the case of a HEAD response. operation_name: Name of the S3 operation that failed. For example, if a :attr:`~S3RequestType.PUT_OBJECT` fails this could be "PutObject", "CreateMultipartUpload", "UploadPart", "CompleteMultipartUpload", or others. For :attr:`~S3RequestType.DEFAULT`, this is the `operation_name` passed to :meth:`S3Client.make_request()`. code (int): CRT error code. name (str): CRT error name. message (str): CRT error message. N) status_codeheadersbodyrcodenamemessagerrrrc`t||||||_||_||_||_yr)rrrrrr) rrrrrrrrrs r rzS3ResponseError.__init__s4 tW-&  ,r!) r1r2r3r4rvrurrrbytesrr5r6s@r rrs07;26)-15 - - - -#5c?3 - uS#X/ -   -"*# - -r!rceZdZdZ ddZy)r{zf Private class to keep all the related Python object alive until C land clean up for S3Client Nc<||_||_||_||_yr) _bootstrap_credential_provider_signing_config_tls_connection_options)rrcrfrergs r rz_S3ClientCore.__init__s#$$7!-'=$r!)NNN)r1r2r3r4rr>r!r r{r{s &* $(,>r!r{cBeZdZdZ d dZdZdZdZdZdZ y) rzg Private class to keep all the related Python object alive until C land clean up for S3Request Nc d|_||_||_||_||_||_||_| |_||_||_ yr) _python_callback_exception_requestrr_on_headers_cb _on_body_cb _on_done_cb_on_progress_cbr_shutdown_event) rr finish_futurerarerfrrrrs r rz_S3RequestCore.__init__sS+/' -$7!(""* --r!c|jr |j||yy#t$r}||_Yd}~yd}~wwxYw)N)rrTF)r BaseExceptionr)rrres r _on_headersz_S3RequestCore._on_headerssH    ## W#M ! 23/ # =8=c|jr |j||yy#t$r}||_Yd}~yd}~wwxYw)N)chunkoffsetTF)rrr)rrrrs r _on_bodyz_S3RequestCore._on_bodysH      uV < ! 23/ rc8|jjyr)rrrr$s r _on_shutdownz_S3RequestCore._on_shutdown s   "r!c 0|dk(rd}d}|rtjj|}t|tjjr\|j dk(r|j |j }n4|2|0t|j|j |j||||}|jj|n|jjd|r t|}nd}|jr|j|||||||yy)Nr AWS_ERROR_CRT_CALLBACK_EXCEPTION)rrrrrrr)error error_headers error_bodyerror_operation_namerdid_validate_checksumchecksum_validation_algorithm)awscrt exceptions from_codert AwsCrtErrorrrrrrr set_exception set_resultrDr) r error_coderrrrrrrs r _on_finishz_S3RequestCore._on_finish#s ! K %%// ;E%!2!2!>!>?JJ"DD ;;G ;;E!,)5+"ZZ"ZZ % $/ -'';=E  ! ! / / 6  ! ! , ,T 2 (,?@],^ ),0 )      +%%9'&;.K  M r!c@|jr|j|yyr)r)rprogresss r _on_progressz_S3RequestCore._on_progressVs      * r!)NNNNNN) r1r2r3r4rrrrrrr>r!r rrs; $.4#1Mf+r!rr~rfc ttjtjdt j tj||dd S)alCreate a default `AwsSigningConfig` for S3 service. Attributes: region (str): The region to sign against. credential_provider (AwsCredentialsProvider): Credentials provider to fetch signing credentials with. `**kwargs`: Forward compatibility kwargs. Returns: AwsSigningConfig s3F) rSsignature_typeservicesigned_body_header_typesigned_body_valuer~credentials_provideruse_double_uri_encodeshould_normalize_uri_path) r r V4r HTTP_REQUEST_HEADERSr X_AMZ_CONTENT_SHA_256r UNSIGNED_PAYLOAD)r~rfkwargss r create_default_s3_signing_configr[sD %(('<< 7 M M,==0#"'  r!c*tjS)a First this function will check it's running on EC2 via. attempting to read DMI info to avoid making IMDS calls. If the function detects it's on EC2, and it was able to detect the instance type without a call to IMDS it will return it. Finally, it will call IMDS and return the instance type from there. Note that in the case of the IMDS call, a new client stack is spun up using 1 background thread. The call is made synchronously with a 1 second timeout: It's not cheap. To make this easier, the underlying result is cached internally and will be freed when this module is unloaded is called. Returns: A string indicating the instance type or None if it could not be determined. )rs3_get_ec2_instance_typer>r!r get_ec2_instance_typervs  + + --r!c*tjS)z Returns: true if the current build of this module has an optimized configuration for the current system. )r!s3_is_crt_s3_optimized_for_systemr>r!r is_optimized_for_systemrs  4 4 66r!c*tjS)a< Returns: A list[str] of platform identifiers, such as EC2 instance types, for which S3 client is pre-optimized and have a recommended throughput_target_gbps. You can use `get_recommended_throughput_target_gbps()` to obtain the recommended throughput_target_gbps for those platforms. )rs3_get_optimized_platformsr>r!r get_optimized_platformsrs  - - //r!returnc:tj}|dkDr|Sy)z Returns: Recommended throughput, in gigabits per second, based on detected system configuration. If the best throughput configuration is unknown, returns None. Use this as the S3Client's `throughput_target_gbps`. rN)r)s3_get_recommended_throughput_target_gbps) max_values r &get_recommended_throughput_target_gbpsrs"AACI1}r!)2r4rconcurrent.futuresrrr awscrt.httpr awscrt.iorr awscrt.authrr r r r r awscrt.exceptionsrx dataclassesrtypingrrrrenumrrr8r@rDrNrRrYr`rrrrr{rrurrrrr^rr>r!r rs(%!#;**!22~@G( w ',$  ? ?  ?  ## #LF!~F!R x-x-v!-f''33!-H > >i+i+XJ`6.$70r!