https://nonebot.dev/assets/js/f9268382.6de66603.js

1"use strict";(self.webpackChunknonebot=self.webpackChunknonebot||[]).push([["2234"],{86241(e,n,s){s.r(n),s.d(n,{metadata:()=>i,default:()=>x,frontMatter:()=>l,contentTitle:()=>c,toc:()=>h,assets:()=>o});var i=JSON.parse('{"id":"api/drivers/httpx","title":"nonebot.drivers.httpx","description":"nonebot.drivers.httpx \u6A21\u5757","source":"@site/versioned_docs/version-2.4.3/api/drivers/httpx.md","sourceDirName":"api/drivers","slug":"/api/drivers/httpx","permalink":"/docs/2.4.3/api/drivers/httpx","draft":false,"unlisted":false,"editUrl":"https://github.com/nonebot/nonebot2/edit/master/website/versioned_docs/version-2.4.3/api/drivers/httpx.md","tags":[],"version":"2.4.3","lastUpdatedBy":"StarHeart","lastUpdatedAt":1785574664000,"sidebarPosition":3,"frontMatter":{"mdx":{"format":"md"},"sidebar_position":3,"description":"nonebot.drivers.httpx \u6A21\u5757"},"sidebar":"api","previous":{"title":"nonebot.drivers.aiohttp","permalink":"/docs/2.4.3/api/drivers/aiohttp"},"next":{"title":"nonebot.drivers.websockets","permalink":"/docs/2.4.3/api/drivers/websockets"}}'),r=s(62540),d=s(43023);let l={mdx:{format:"md"},sidebar_position:3,description:"nonebot.drivers.httpx \u6A21\u5757"},c="nonebot.drivers.httpx",o={},h=[{value:"<em>class</em> <code>Session(params=None, headers=None, cookies=None, version=HTTPVersion.H11, timeout=None, proxy=None)</code>",id:"Session",level:2},{value:"<em>async method</em> <code>request(setup)</code>",id:"Session-request",level:3},{value:"<em>method</em> <code>stream_request(setup, *, chunk_size=1024)</code>",id:"Session-stream-request",level:3},{value:"<em>async method</em> <code>setup()</code>",id:"Session-setup",level:3},{value:"<em>async method</em> <code>close()</code>",id:"Session-close",level:3},{value:"<em>class</em> <code>Mixin(&lt;auto&gt;)</code>",id:"Mixin",level:2},{value:"<em>async method</em> <code>request(setup)</code>",id:"Mixin-request",level:3},{value:"<em>method</em> <code>stream_request(setup, *, chunk_size=1024)</code>",id:"Mixin-stream-request",level:3},{value:"<em>method</em> <code>get_session(params=None, headers=None, cookies=None, version=HTTPVersion.H11, timeout=None, proxy=None)</code>",id:"Mixin-get-session",level:3},{value:"<em>class</em> <code>Driver(env, config)</code>",id:"Driver",level:2}];function t(e){let n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"nonebotdrivershttpx",children:"nonebot.drivers.httpx"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.a,{href:"https://www.python-httpx.org/",children:"HTTPX"})," \u9A71\u52A8\u9002\u914D"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"nb driver install httpx\n# \u6216\u8005\npip install nonebot2[httpx]\n"})}),"\n",(0,r.jsx)(n.admonition,{title:"\u63D0\u793A",type:"tip",children:(0,r.jsx)(n.p,{children:"\u672C\u9A71\u52A8\u4EC5\u652F\u6301\u5BA2\u6237\u7AEF HTTP \u8FDE\u63A5"})}),"\n",(0,r.jsxs)(n.h2,{id:"Session",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"Session(params=None, headers=None, cookies=None, version=HTTPVersion.H11, timeout=None, proxy=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"\u53C2\u6570"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"params"})," (QueryTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"headers"})," (HeaderTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"cookies"})," (CookieTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"version"})," (str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#HTTPVersion",children:"HTTPVersion"}),")"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"timeout"})," (TimeoutTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"proxy"})," (str | None)"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Session-request",children:[(0,r.jsx)(n.em,{children:"async method"})," ",(0,r.jsx)(n.code,{children:"request(setup)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"setup"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Request",children:"Request"}),")"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Response",children:"Response"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Session-stream-request",children:[(0,r.jsx)(n.em,{children:"method"})," ",(0,r.jsx)(n.code,{children:"stream_request(setup, *, chunk_size=1024)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"setup"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Request",children:"Request"}),")"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"chunk_size"})," (int)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["AsyncGenerator[",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Response",children:"Response"}),", None]"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Session-setup",children:[(0,r.jsx)(n.em,{children:"async method"})," ",(0,r.jsx)(n.code,{children:"setup()"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"empty"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"None"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Session-close",children:[(0,r.jsx)(n.em,{children:"async method"})," ",(0,r.jsx)(n.code,{children:"close()"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"empty"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"None"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"Mixin",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"Mixin(<auto>)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," HTTPX Mixin"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"auto"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Mixin-request",children:[(0,r.jsx)(n.em,{children:"async method"})," ",(0,r.jsx)(n.code,{children:"request(setup)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"setup"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Request",children:"Request"}),")"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Response",children:"Response"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Mixin-stream-request",children:[(0,r.jsx)(n.em,{children:"method"})," ",(0,r.jsx)(n.code,{children:"stream_request(setup, *, chunk_size=1024)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"setup"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Request",children:"Request"}),")"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"chunk_size"})," (int)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["AsyncGenerator[",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#Response",children:"Response"}),", None]"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Mixin-get-session",children:[(0,r.jsx)(n.em,{children:"method"})," ",(0,r.jsx)(n.code,{children:"get_session(params=None, headers=None, cookies=None, version=HTTPVersion.H11, timeout=None, proxy=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"params"})," (QueryTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"headers"})," (HeaderTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"cookies"})," (CookieTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"version"})," (str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/drivers/#HTTPVersion",children:"HTTPVersion"}),")"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"timeout"})," (TimeoutTypes)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"proxy"})," (str | None)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"Session"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"Driver",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"Driver(env, config)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.strong,{children:"\u53C2\u6570"}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"env"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/config#Env",children:"Env"}),")"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"config"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.3/api/config#Config",children:"Config"}),")"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]})]})}function x(e={}){let{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(t,{...e})}):t(e)}},43023(e,n,s){s.d(n,{R:()=>l,x:()=>c});var i=s(63696);let r={},d=i.createContext(r);function l(e){let n=i.useContext(d);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]);