httpx 0.24.7 → 1.0.0

data/sig/plugins/brotli.rbs

@@ -0,0 +1,22 @@
+module HTTPX
+  module Plugins
+    module Brotli
+      def self?.load_dependencies: (singleton(Session)) -> void
+
+      def self?.encode: (body_encoder body) -> Deflater
+
+      def self?.decode: (HTTPX::Response response, ?bytesize: Integer) -> Transcoder::_Decoder
+
+      class Deflater < Transcoder::Deflater
+      end
+
+      module RequestBodyClassMethods
+        def initialize_deflater_body: (body_encoder body, Encoding | String encoding) -> body_encoder
+      end
+
+      module ResponseBodyClassMethods
+        def initialize_inflater_by_encoding: (Encoding | String encoding, Response response, ?bytesize: Integer) -> (Transcoder::_Decoder | Transcoder::GZIP::Inflater)
+      end
+    end
+  end
+end

data/sig/plugins/circuit_breaker.rbs

@@ -3,15 +3,17 @@ module HTTPX
     module CircuitBreaker
 
       class CircuitStore
-        @circuits: Hash[String, Circuit]
+        @circuits: Hash[String, Circuit] & Mutex_m
 
-        def try_open: (generic_uri uri, response response) -> response?
+        def try_open: (uri uri, response response) -> response?
 
         def try_respond: (Request request) -> response?
 
+        def try_close: (http_uri uri) -> void
+
         private
 
-        def get_circuit_for_uri: (generic_uri uri) -> Circuit
+        def get_circuit_for_uri: (uri uri) -> Circuit
 
         def initialize: (Options & _CircuitOptions options) -> void
       end
@@ -23,6 +25,8 @@ module HTTPX
         @break_in: Float
         @circuit_breaker_half_open_drip_rate: Float
         @attempts: Integer
+        @real_attempts: Integer
+        @drip_factor: Integer
 
         @response: response?
         @opened_at: Float?

data/sig/plugins/compression.rbs

@@ -23,8 +23,6 @@ module HTTPX
       def self.configure: (singleton(Session)) -> void
 
       interface _CompressionOptions
-        def compression_threshold_size: () -> Integer?
-
         def encodings: () -> Hash[String, _Compressor]
       end
 

data/sig/plugins/{digest_authentication.rbs → digest_auth.rbs}

@@ -12,10 +12,10 @@ module HTTPX
       def self.load_dependencies: (*untyped) -> void
 
       module InstanceMethods
-        def digest_authentication: (string user, string password, ?hashed: bool) -> instance
+        def digest_auth: (string user, string password, ?hashed: bool) -> instance
       end
     end
 
-    type sessionDigestAuth = sessionAuthentication & DigestAuth::InstanceMethods
+    type sessionDigestAuth = sessionAuthorization & DigestAuth::InstanceMethods
   end
 end

data/sig/plugins/follow_redirects.rbs

@@ -17,7 +17,6 @@ module HTTPX
       module InstanceMethods
         def max_redirects: (_ToI) -> instance
 
-        def build_redirect_request: (Request, Response, Options) -> Request
         def __get_location_from_response: (Response) -> (URI::HTTP | URI::HTTPS)
       end
 

data/sig/plugins/grpc/call.rbs

@@ -0,0 +1,19 @@
+module HTTPX
+  module Plugins
+    module GRPC
+      class Call
+        attr_writer decoder: _Callable
+
+        def metadata: () -> headers
+
+        def trailing_metadata: () -> headers?
+
+        private
+
+        def initialize: (Response | StreamResponse response) -> untyped
+
+        def grpc_response: () -> grpc_response
+      end
+    end
+  end
+end

data/sig/plugins/grpc/grpc_encoding.rbs

@@ -0,0 +1,33 @@
+module HTTPX
+  module Transcoder
+    module GRPCEncoding
+
+      def self?.encode: (body_encoder body, compressed: bool) -> Deflater
+
+      def self?.decode: (Response | StreamResponse response) -> Inflater
+
+      class Deflater
+        attr_reader content_type: String
+
+        @body: BodyReader
+        @compressed: bool
+
+        def initialize: (body_encoder body, compressed: bool) -> void
+
+        def bytesize: () -> (Integer | Float)
+
+        def read: (?int? length, ?string outbuf) -> String?
+      end
+
+      class Inflater
+        @response: Response
+        @encodings: Array[String]
+
+        def initialize: (Response | StreamResponse response) -> void
+
+        def call: (String message) ?{ (String) -> void } -> String
+      end
+
+    end
+  end
+end

data/sig/plugins/grpc/message.rbs

@@ -0,0 +1,17 @@
+
+module HTTPX
+  module Plugins
+    module GRPC
+      module Message
+        def self?.unary: (response) -> grpc_message
+
+        def self?.stream: (StreamResponse) { (String) -> void } -> void
+                        | (StreamResponse) -> Enumerable[String]
+
+        def self?.cancel: (Request) -> void
+
+        def self?.verify_status: (StreamResponse | response) -> void
+      end
+    end
+  end
+end

data/sig/plugins/grpc.rbs

@@ -17,36 +17,6 @@ module HTTPX
 
       type credentials = Proc
 
-      class Call
-        attr_writer decoder: _Callable
-
-        def metadata: () -> headers
-
-        def trailing_metadata: () -> headers?
-
-        private
-
-        def initialize: (Response | StreamResponse response) -> untyped
-
-        def grpc_response: () -> grpc_response
-      end
-
-      module Message
-        def self?.unary: (response) -> grpc_message
-
-        def self?.stream: (StreamResponse) { (String) -> void } -> void
-                        | (StreamResponse) -> Enumerable[String]
-
-        def self?.encode: (String bytes, ?deflater: Compression::_Deflater?) -> String
-
-        def self?.decode: (String message, encodings: Array[String], encoders: Hash[String, Compression::_Compressor]) -> String
-                        | (String message, encodings: Array[String], encoders: Hash[String, Compression::_Compressor]) { (String) -> void } -> void
-
-        def self?.cancel: (Request) -> void
-
-        def self?.verify_status: (StreamResponse | response) -> void
-      end
-
       interface _GRPCOptions
         def grpc_service: () -> String?
 
@@ -63,9 +33,9 @@ module HTTPX
       def self.load_dependencies: (singleton(Session)) -> void
 
       module ResponseMethods
-        def merge_headers: (headers_input trailers) -> void
+        attr_reader trailing_metadata: Hash[String, untyped]
 
-        def encoders: () -> Hash[String, Compression::_Compressor]
+        def encoders: () -> Array[String | Encoding]
       end
 
       module InstanceMethods

data/sig/plugins/{ntlm_authentication.rbs → ntlm_auth.rbs}

@@ -11,11 +11,11 @@ module HTTPX
       def self.load_dependencies: (*untyped) -> void
 
       module InstanceMethods
-        def ntlm_authentication: (string user, string password, ?string? domain) -> instance
+        def ntlm_auth: (string user, string password, ?string? domain) -> instance
       end
 
     end
 
-    type sessionNTLMAuth = sessionAuthentication & NTLMAuth::InstanceMethods
+    type sessionNTLMAuth = sessionAuthorization & NTLMAuth::InstanceMethods
   end
 end

data/sig/plugins/oauth.rbs

@@ -43,7 +43,7 @@ module HTTPX
       end
 
       module InstanceMethods
-        def oauth_authentication: (**untyped args) -> instance
+        def oauth_auth: (**untyped args) -> instance
 
         def with_access_token: () -> instance
       end

data/sig/plugins/proxy/socks4.rbs

@@ -4,17 +4,16 @@ module HTTPX
   module Plugins
     module Proxy
       module Socks4
-      
+
         module ConnectionMethods
           def __socks4_proxy_connect: () ->  void
           def __socks4_on_packet: (String packet) ->  void
           def on_socks4_error: (string) -> void
         end
-        
+
         class SocksParser
           include Callbacks
 
-          def timeout: () -> Integer
           def close: () -> void
           def consume: (*untyped) -> void
           def empty: () -> bool

data/sig/plugins/proxy/socks5.rbs

@@ -16,7 +16,6 @@ module HTTPX
         class SocksParser
           include Callbacks
 
-          def timeout: () -> Integer
           def close: () -> void
           def consume: (*untyped) -> void
           def empty: () -> bool

data/sig/plugins/proxy/ssh.rbs

@@ -7,7 +7,7 @@ module HTTPX
         module InstanceMethods
           private
 
-          def build_gateway_socket: (int, URI::HTTP | URI::HTTPS, Options) ->  _ToIO
+          def build_gateway_socket: (int, http_uri, Options) ->  _ToIO
         end
       end
     end

data/sig/plugins/response_cache.rbs

@@ -2,9 +2,10 @@ module HTTPX
   module Plugins
     module ResponseCache
       CACHEABLE_VERBS: Array[verb]
+      CACHEABLE_STATUS_CODES: Array[Integer]
 
-      def self?.cacheable_request?: (Request request) -> bool
-      def self?.cacheable_response?: (response response) -> bool
+      def self?.cacheable_request?: (Request & RequestMethods request) -> bool
+      def self?.cacheable_response?: (::HTTPX::ErrorResponse | (Response & ResponseMethods) response) -> bool
       def self?.cached_response?: (response response) -> bool
 
       class Store
@@ -34,6 +35,8 @@ module HTTPX
       end
 
       module RequestMethods
+        @response_cache_key: String
+
         def response_cache_key: () -> String
       end
 

data/sig/request/body.rbs

@@ -0,0 +1,42 @@
+module HTTPX
+  class Request::Body
+    attr_reader threshold_size: Integer?
+
+    @headers: Headers
+    @body: body_encoder?
+    @unbounded_body: bool
+
+    def initialize: (Headers headers, Options options) -> void
+
+    def each: () { (String) -> void } -> void
+            | () -> Enumerable[String]
+
+    def rewind: () -> void
+
+    def empty?: () -> bool
+
+    def bytesize: () -> (Integer | Float)
+
+    def stream: (Transcoder::_Encoder) -> bodyIO
+
+    def unbounded_body?: () -> bool
+
+    def chunked?: () -> bool
+
+    def chunk!: () -> void
+
+    private
+
+    def initialize_body: (Options options) -> void
+
+    def self.initialize_deflater_body: (body_encoder body, Encoding | String encoding) -> body_encoder
+  end
+
+  class ProcIO
+    @block: ^(String) -> void
+
+    def initialize: (^(String) -> void) -> untyped
+
+    def write: (String data) -> Integer
+  end
+end

data/sig/request.rbs

@@ -7,7 +7,7 @@ module HTTPX
     USER_AGENT: String
 
     attr_reader verb: verb
-    attr_reader uri: URI::HTTP | URI::HTTPS
+    attr_reader uri: http_uri
     attr_reader headers: Headers
     attr_reader body: Body
     attr_reader state: Symbol
@@ -60,31 +60,5 @@ module HTTPX
 
     def initialize_body: (Options options) -> Transcoder::_Encoder?
 
-    class Body
-      @headers: Headers
-      @body: body_encoder?
-      @unbounded_body: bool
-
-      def initialize: (Headers, Options) -> untyped
-      def each: () { (String) -> void } -> void
-              | () -> Enumerable[String]
-
-      def rewind: () -> void
-      def empty?: () -> bool
-      def bytesize: () -> (Integer | Float)
-      def stream: (Transcoder::_Encoder) -> bodyIO
-      def unbounded_body?: () -> bool
-      def chunked?: () -> bool
-      def chunk!: () -> void
-      def inspect: () -> String
-    end
-
-    class ProcIO
-      @block: ^(String) -> void
-
-      def initialize: (^(String) -> void) -> untyped
-
-      def write: (String data) -> Integer
-    end
   end
 end

data/sig/resolver/resolver.rbs

@@ -30,7 +30,7 @@ module HTTPX
 
       def emit_resolve_error: (Connection connection, ?String hostname, ?StandardError) -> void
 
-      def resolve_error: (String hostname, ?StandardError?) -> ResolveError
+      def resolve_error: (String hostname, ?StandardError?) -> (ResolveError | ResolveTimeoutError)
     end
   end
 end

data/sig/response/body.rbs

@@ -0,0 +1,52 @@
+module HTTPX
+  class Response::Body
+    include _Reader
+    include _ToS
+    include _ToStr
+
+    attr_reader encoding: Encoding | String
+    attr_reader encodings: Array[Encoding | String]
+
+    @response: Response
+    @headers: Headers
+    @options: Options
+    @state: :idle | :memory | :buffer | :closed
+    @threshold_size: Integer
+    @window_size: Integer
+    @length: Integer
+    @buffer: StringIO | Tempfile | nil
+    @reader: StringIO | Tempfile | nil
+    @inflaters: Array[Transcoder::_Inflater]
+
+    def initialize: (Response, Options) -> void
+
+    def closed?: () -> bool
+
+    def write:(String chunk) -> Integer?
+
+    def filename: () -> String?
+
+    def bytesize: () -> Integer
+
+    def each: () { (String) -> void } -> void
+            | () -> Enumerable[String]
+
+    def empty?: () -> bool
+
+    def copy_to: (String | File | _Writer destination) -> void
+
+    def close: () -> void
+
+    def rewind: () -> void
+
+    private
+
+    def initialize_inflaters: () -> void
+
+    def self.initialize_inflater_by_encoding: (Encoding | String encoding, Response response, ?bytesize: Integer) -> Transcoder::GZIP::Inflater
+
+    def transition: (Symbol nextstate) -> void
+
+    def _with_same_buffer_pos: [A] () { () -> A } -> A
+  end
+end

data/sig/response/buffer.rbs

@@ -0,0 +1,24 @@
+module HTTPX
+  class Response::Buffer
+    @threshold_size: Integer
+    @bytesize: Integer
+    @encoding: Encoding
+    @buffer: StringIO | Tempfile
+
+    def initialize: (threshold_size: Integer, ?bytesize: Integer, ?encoding: Encoding | String) -> void
+
+    def size: () -> Integer
+
+    def write: (String) -> void
+
+    def to_s: () -> String
+
+    def close: () -> void
+
+    private
+
+    def try_upgrade_buffer: () -> void
+
+    def _with_same_buffer_pos: () { () -> void } -> void
+  end
+end

data/sig/response.rbs

@@ -43,45 +43,6 @@ module HTTPX
     def no_data?: () -> bool
 
     def decode:(Transcoder::_Decode transcoder, ?untyped options) -> untyped
-
-    class Body
-      include _Reader
-      include _ToS
-      include _ToStr
-
-      attr_reader encoding: Encoding | String
-
-      @response: Response
-      @headers: Headers
-      @options: Options
-      @state: :idle | :memory | :buffer | :closed
-      @threshold_size: Integer
-      @window_size: Integer
-      @length: Integer
-      @buffer: StringIO | Tempfile | nil
-      @reader: StringIO | Tempfile | nil
-
-      def write:(String chunk) -> Integer?
-
-      def each: () { (String) -> void } -> void
-              | () -> Enumerable[String]
-
-      def filename: () -> String?
-
-      def bytesize: () -> (Integer | Float)
-      def empty?: () -> bool
-      def copy_to: (String | File | _Writer destination) -> void
-      def close: () -> void
-      def closed?: () -> bool
-
-      def rewind: () -> void
-
-      private
-
-      def initialize: (Response, Options) -> void
-      def transition: () -> void
-      def _with_same_buffer_pos: [A] () { () -> A } -> A
-    end
   end
 
   class ContentType

data/sig/transcoder/body.rbs

@@ -7,13 +7,14 @@ module HTTPX
       class Encoder
         extend Forwardable
 
-        include _Encoder
-        include _ToS
-
         @raw: bodyIO
 
+        def bytesize: () -> (Integer | Float)
+
         def content_type: () -> String
 
+        def to_s: () -> String
+
         private
 
         def initialize: (untyped body) -> untyped

data/sig/transcoder/deflate.rbs

@@ -0,0 +1,11 @@
+module HTTPX
+  module Transcoder
+    module Deflate
+      def self?.encode: (_Encoder body) -> Deflater
+      def self?.decode: (Response body, ?bytesize: Integer) -> GZIP::Inflater
+
+      class Deflater < Transcoder::Deflater
+      end
+    end
+  end
+end

data/sig/transcoder/form.rbs

@@ -3,17 +3,19 @@ module HTTPX::Transcoder
 
   type form_nested_value = form_value | _ToAry[form_value] | _ToHash[string, form_value]
 
-  type urlencoded_input = Enumerable[[_ToS, form_nested_value]]
+  type urlencoded_input = Enumerable[[_ToS, form_nested_value | Multipart::multipart_nested_value]]
 
   module Form
-    def self?.encode: (urlencoded_input form) -> Encoder
+    def self?.encode: (urlencoded_input form) -> (Encoder | Multipart::Encoder)
     def self?.decode: (HTTPX::Response response) -> _Decoder
+    def self?.multipart?: (form_nested_value | Multipart::multipart_nested_value data) -> bool
 
     class Encoder
       extend Forwardable
-      include _Encoder
       include _ToS
 
+      def bytesize: () -> Integer
+
       def content_type: () -> String
 
       private

data/sig/transcoder/gzip.rbs

@@ -0,0 +1,24 @@
+module HTTPX
+  module Transcoder
+    module GZIP
+      def self?.encode: (_Encoder body) -> Deflater
+      def self?.decode: (Response response, ?bytesize: Integer) -> Inflater
+
+      class Deflater < Transcoder::Deflater
+        @compressed_chunk: String
+
+        private
+
+        def write: (String chunk) -> void
+
+        def compressed_chunk: () -> String
+      end
+
+      class Inflater
+        def initialize: (Integer | Float bytesize) -> void
+
+        def call: (String chunk) -> String
+      end
+    end
+  end
+end

data/sig/transcoder/json.rbs

@@ -10,14 +10,16 @@ module HTTPX::Transcoder
 
     class Encoder
       extend Forwardable
-      include _Encoder
-      include _ToS
 
       @raw: String
       @charset: String
 
+      def bytesize: () -> Integer
+
       def content_type: () -> String
 
+      def to_s: () -> String
+
       private
 
       def initialize: (_ToJson json) -> void

data/sig/{plugins → transcoder}/multipart.rbs

@@ -1,5 +1,5 @@
 module HTTPX
-  module Plugins
+  module Transcoder
     module Multipart
       interface _MultipartInput
         def filename: () -> String
@@ -9,13 +9,6 @@ module HTTPX
 
       MULTIPART_VALUE_COND: ^(_Reader | record_multipart_value value) -> bool
 
-      def self.load_dependencies: (singleton(Session)) -> void
-      def self.configure: (*untyped) -> void
-      def self?.encode: (untyped) -> (Encoder | Transcoder::Form::Encoder)
-      def self?.decode: (HTTPX::Response response) -> Transcoder::_Decoder
-
-      def self?.normalize_keys: [U] (_ToS key, _ToAry[untyped] | _ToHash[_ToS, untyped] | untyped value) { (String, ?untyped) -> U } -> U
-
       type multipart_value = string | Pathname | File | _Reader
 
       type record_multipart_value = { content_type: String, filename: String, body: multipart_value } |
@@ -24,8 +17,6 @@ module HTTPX
       type multipart_nested_value = multipart_value | _ToAry[multipart_value] | _ToHash[string, multipart_value]
 
       class Encoder
-        include Transcoder::_Encoder
-
         @boundary: String
         @part_index: Integer
         @buffer: String
@@ -33,6 +24,8 @@ module HTTPX
         @form: Enumerable[[Symbol | string, multipart_nested_value]]
         @parts: Array[_Reader]
 
+        def bytesize: () -> Integer
+
         def content_type: () -> String
 
         def read: (?int? length, ?string? buffer) -> String?

data/sig/transcoder/utils/body_reader.rbs

@@ -0,0 +1,15 @@
+module HTTPX
+  module Transcoder
+    class BodyReader
+      @body: _Reader | _Each[String]
+
+      def initialize: (bodyIO body) -> void
+
+      def bytesize: () -> (Integer | Float)
+
+      def read: (?int? length, ?string outbuf) -> String?
+
+      def close: () -> void
+    end
+  end
+end