python-requests-toolbelt-doc 0.6.0-2 / usr / share / doc / python-requests-toolbelt-doc / html / searchindex.js

Search.setIndex({envversion:46,filenames:["adapters","authentication","contributing","deprecated","downloadutils","dumputils","exceptions","formdata","index","threading","uploading-data","user","user-agent"],objects:{"requests_toolbelt.adapters.appengine":{AppEngineAdapter:[0,0,1,""]},"requests_toolbelt.adapters.fingerprint":{FingerprintAdapter:[0,0,1,""]},"requests_toolbelt.adapters.socket_options":{SocketOptionsAdapter:[0,0,1,""],TCPKeepAliveAdapter:[0,0,1,""]},"requests_toolbelt.adapters.source":{SourceAddressAdapter:[0,0,1,""]},"requests_toolbelt.adapters.ssl":{SSLAdapter:[0,0,1,""]},"requests_toolbelt.auth.guess":{GuessAuth:[1,0,1,""],GuessProxyAuth:[1,0,1,""]},"requests_toolbelt.auth.handler":{AuthHandler:[1,0,1,""]},"requests_toolbelt.auth.handler.AuthHandler":{add_strategy:[1,1,1,""],get_strategy_for:[1,1,1,""],remove_strategy:[1,1,1,""]},"requests_toolbelt.auth.http_proxy_digest":{HTTPProxyDigestAuth:[1,0,1,""]},"requests_toolbelt.downloadutils.stream":{stream_response_to_file:[4,2,1,""]},"requests_toolbelt.downloadutils.tee":{tee:[4,2,1,""],tee_to_bytearray:[4,2,1,""],tee_to_file:[4,2,1,""]},"requests_toolbelt.exceptions":{StreamingError:[6,4,1,""],VersionMismatchError:[6,4,1,""]},"requests_toolbelt.multipart.encoder":{MultipartEncoder:[10,0,1,""],MultipartEncoderMonitor:[10,0,1,""]},"requests_toolbelt.streaming_iterator":{StreamingIterator:[10,0,1,""]},"requests_toolbelt.threaded":{map:[9,2,1,""]},"requests_toolbelt.threaded.pool":{Pool:[9,0,1,""],ThreadException:[9,0,1,""],ThreadResponse:[9,0,1,""]},"requests_toolbelt.threaded.pool.Pool":{exceptions:[9,1,1,""],from_exceptions:[9,5,1,""],from_urls:[9,5,1,""],get_exception:[9,1,1,""],get_response:[9,1,1,""],join_all:[9,1,1,""],responses:[9,1,1,""]},"requests_toolbelt.threaded.pool.ThreadException":{exception:[9,6,1,""],request_kwargs:[9,6,1,""]},"requests_toolbelt.threaded.pool.ThreadResponse":{request_kwargs:[9,6,1,""],response:[9,6,1,""]},"requests_toolbelt.utils":{deprecated:[3,3,0,"-"]},"requests_toolbelt.utils.deprecated":{get_encodings_from_content:[3,2,1,""],get_unicode_from_response:[3,2,1,""]},"requests_toolbelt.utils.dump":{dump_all:[5,2,1,""],dump_response:[5,2,1,""]},"requests_toolbelt.utils.formdata":{urlencode:[7,2,1,""]},requests_toolbelt:{exceptions:[6,3,0,"-"],threaded:[9,3,0,"-"]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","function","Python function"],"3":["py","module","Python module"],"4":["py","exception","Python exception"],"5":["py","classmethod","Python class method"],"6":["py","attribute","Python attribute"]},objtypes:{"0":"py:class","1":"py:method","2":"py:function","3":"py:module","4":"py:exception","5":"py:classmethod","6":"py:attribute"},terms:{"1234abcdef":0,"__version__":12,"_build":2,"byte":[3,4,5,10],"case":[0,1,7,9,10],"catch":2,"class":[0,1,6,9,10],"default":[0,1,4,9,12],"final":[2,5,9],"function":[0,3,4,5,6,7,8,9,10,12],"import":[0,1,3,4,5,7,9,10,11,12],"int":[1,4,9],"na\u00efv":9,"new":[0,1,2,9,12],"public":[0,2],"return":[1,3,4,5,7,9,10,11],"short":9,"throw":9,"true":[0,4],"try":[4,9],"while":[4,10],abil:0,abl:[0,10],about:2,abov:[9,11],absolut:11,abus:2,accept:[0,9,10],access:[0,9],accident:1,accur:12,across:1,action:9,activ:[2,8],add:1,add_strategi:1,addit:[0,1,7,10],addition:10,address:[0,2],administ:12,adopt:2,advantag:[0,10],advis:9,after:[2,9],against:1,agent:[8,9],algorithm:0,align:2,aliv:0,all:[0,2,5,9,10,12],allow:[0,2,10,11],almost:5,alreadi:[2,9,10],also:[0,1,4,5,9,10,11,12],altern:[9,10],alwai:[0,9,11],amend:2,ani:[0,2,9,10],anyon:10,apassword:1,api:[0,1,5,8],app:0,appear:2,append:5,appengin:0,appli:2,applic:[2,7,9,10],approach:2,appropri:[2,6,7,10],apt:2,arbitrari:0,arg:[0,1,7],argument:[0,9,10],around:[0,9,11],arrai:4,asecrettoken:1,ask:2,aspect:2,assert:[1,4],assum:[9,10,11],attack:2,attempt:[0,3,4,9,10],attract:11,attribut:9,auth:[1,9],auth_gener:9,author:2,auto:8,autoclos:2,automat:[0,1,4],avail:[0,2,11],avoid:10,awar:2,back:3,ban:2,bar:[1,7,10],base:2,basic:[1,10],baz:7,becaus:[5,9,10],been:[0,3,9,10],befor:[0,2,10],behav:10,behavior:2,belong:[8,11],below:[2,4,6],benfield:[0,11],best:9,between:[1,2],bind:0,bit:9,biz:7,blatantli:9,blog:[0,11],bodi:[2,4,7,10],bool:4,both:[1,2,4],boundari:10,branch:2,broken:0,buffer:10,bug:[0,2,10,11],build_digest_head:1,built:4,bytearr:4,bytearrai:[4,5],bytes_read:10,bytesio:4,bytestr:3,call:[9,10],callabl:[1,9],callback:[9,10],can:[0,2,4,5,7,9,10,11,12],canon:0,capabl:0,captur:9,caus:[0,9,10],certain:1,certif:0,challeng:5,chang:[0,2,9,10],charact:2,check:[0,1,2,9],checkout:2,choic:0,choos:[0,11],chosen:0,chunk:[4,10],chunksiz:4,circumst:2,classmethod:9,clean:9,clearli:9,client:[1,12],clint:10,close:[2,4],cloud:0,code:0,collect:[1,3,6,8,9,11],colon:0,com:[0,1,2,5,9,11,12],come:0,comment:2,common:2,commun:2,complaint:2,compliant:0,compress:4,comput:[0,9],confidenti:2,confirm:10,connect:[0,11],connnect:0,consid:[10,11],consist:2,constant:0,construct:[0,10,11],constructor:[8,9],consult:8,contact:2,contain:[0,2,8,9,10],content:[3,4,7,10,11],content_typ:[10,11],continu:2,conveni:10,cooki:9,core:8,cori:[0,11],corner:9,correctli:0,could:[1,4,10,12],count:0,coupl:9,cours:10,coven:2,cpu:9,cpu_count:9,cpython:12,creat:[0,2,9,10,11],credenti:[1,9],current:10,custom:0,cut:9,cycl:5,darwin:12,data:[1,2,5],data_arrai:5,decid:3,decod:[4,5],decode_cont:4,deem:2,def:[1,9,10],default_opt:0,depend:2,deploi:0,derogatori:2,describ:2,detail:[2,4,6,10],detect:[1,9],determ:10,determin:[1,3,4,10],develop:[8,10],dict:9,dictionari:[1,9],did:0,didn:1,differ:[0,2,5],difficult:10,difficulti:0,digest:1,direct:9,directli:10,directori:2,disabl:[0,2],disk:10,displai:10,disposit:4,doc:2,docstr:2,doe:[0,7,9,12],doesn:0,domain:[0,1,9],don:[9,11],done:1,downloadutil:[4,6],drawn:9,drop:12,dump_al:5,dump_respons:5,dure:9,each:[0,1,2,5],earlier:0,eas:3,easili:[11,12],edit:2,effect:11,effort:9,either:[0,2,4],electron:2,element:[0,3],els:4,empti:2,enabl:0,encod:[3,7,8],encourag:2,encrypt:1,end:10,enforc:[0,2],engin:[0,10],ensur:[0,1,2],environ:2,error:[0,1,2,6,9],establish:0,etc:[2,9],ethnic:2,everi:[0,2,9,10],everyon:2,exactli:[5,10],examin:11,exampl:[0,1],exc:9,except:4,exceptions_gener:9,exist:[0,2],expand:9,expect:[0,4,7,9,10],experi:2,explicit:[0,2],explicitli:[0,1],expos:1,express:2,extend:4,extra:[0,1,8],extract:3,extrem:10,fail:[0,3,11],fairli:[0,2],fakepassword:1,familiar:2,featur:[1,2,6,10],feedback:2,feel:12,field0:[10,11],field1:[10,11],field2:[10,11],field:[10,11],file:[4,10,11],file_nam:10,filenam:[4,10,11],fileobject:4,files:10,find:[2,4,5],fingerprint:0,first:[0,3,7,9],fix:[2,11],flag:4,flake8:2,flatten:7,follow:[0,1,2,5,9,10,12],foo:[1,2,7],foobar:2,forc:10,fork:2,form:[0,2],format:[0,2,4,5,9,10],formdata:7,foster:2,found:0,free:2,friendli:2,frob:2,from:[0,1,2,3,4,5,7,8,9],from_except:9,from_field:10,from_url:9,full:1,futur:0,gae:0,gather:5,gender:2,gener:[0,4,8],geo:0,get:[0,1,3,4,5,7,8,9,10,11,12],get_encodings_from_cont:3,get_except:9,get_respons:9,get_strategy_for:1,get_unicode_from_respons:3,git:2,github:[0,1,2,5,9,11,12],gitlab:[1,2],gitlab_auth:1,given:[0,3],gmail:2,googl:[0,9],graffatcolmingov:2,guess:[1,10],handl:[7,9,10],handler:1,hang:0,happi:12,harass:2,hard:10,harm:2,have:[0,2,9,10,12],header:[1,3,4,7,9,10,11,12],help:5,here:[0,9,10],hexadecim:0,high:0,histori:5,hopefulli:0,host:1,hostnam:0,howev:0,hpcloudsvc:0,html:[2,3],http:[0,1,2,5,9,10,11,12],http_proxy_digest:1,httpadapt:0,httpbasicauth:1,httpbin:[1,5,9,10,11],httpconnect:0,httpdigestauth:1,httplib:10,httpsconnect:0,ident:2,idiosyncraci:11,idl:0,ignor:0,imageri:2,imper:2,implement:[0,9],imposs:10,inappropri:2,incid:2,includ:[0,2,5,12],increas:9,index:8,indic:[1,6],individu:2,inform:2,initi:9,initialize_sess:9,inspir:9,instal:[2,6],instanc:[1,2,9,10,11],instanti:1,instead:[0,4,9,10],insult:2,integ:9,interac:10,interact:0,interest:2,interfac:[0,9,10],interv:0,investig:2,ipproto_tcp:0,isinst:1,isn:[4,9],issu:[2,10],item:[0,9],iter:[9,10],itself:10,job:9,job_queu:9,join:9,join_al:9,json:[9,10],just:[9,10,11,12],keep:[0,2],keep_al:0,kei:0,kept:0,kerbero:1,keyword:[0,9],kind:1,know:[0,1,5,10],known:10,kwarg:[0,1,7,9],languag:2,larg:10,last:2,later:11,latter:0,least:2,leav:2,length:10,let:10,level:2,librari:[0,1,7,8,9,11],like:[0,1,4,9,10,11,12],line:[2,5],list:[0,7,9,10],live:[2,3],local:[0,2],localhost:2,locat:4,look:[0,5,11,12],loop:10,made:[0,11],mai:[0,1,2,5,10],main:11,maintain:[2,8],make:[1,2,7,9,10,12],manag:[2,4,9,10],mani:[9,10],manual:2,map:9,map_async:9,master:9,match:[0,1],mean:[0,9,10],member:8,memori:10,merg:2,method:[2,4,9,10],might:[0,2,8,9,10],mimic:10,minimum:11,minor:11,misbehav:0,mismatch:6,mode:4,model:[3,4],modifi:9,modul:[0,2,8],moment:0,monitor:8,monkei:0,monkeypatch:0,montior:10,more:[4,10],most:[2,8,9],mount:[0,11],move:3,msg:9,multipart:8,multipartencod:[10,11],multipartencodermonitor:10,multipl:[1,9],multiproccess:9,multiprocess:9,mung:2,must:[1,2,9,10],my_callback:10,my_dict:7,my_list:7,my_packag:[11,12],myfil:4,mypackag:12,nagl:0,name:[2,4,12],nation:2,natur:10,necessari:[0,2,12],need:[0,1,2,4,5,7,8,10],neg:0,negoti:0,neither:2,nest:7,new_pool:9,newer:[0,6],nice:12,non:0,none:[0,1,4,5,9,10],nor:2,normal:[9,10],noth:11,notifi:2,now:12,ntlm:1,num_process:9,num_thread:9,number:[0,1,9,12],oauth:1,object:[1,3,4,5,9,10,11],oblig:2,occasion:5,occur:2,offens:2,offer:0,offici:7,often:10,oject:10,onli:[0,2,5,10],open:[2,4,10,11],openssl:0,opinion:[2,10],opt:0,option:[0,4,5],order:[0,5,10],ordereddict:10,org:[1,2,5,9,10,11],orient:2,origin:[0,9,11],other:[0,2,9,12],other_field:10,other_valu:10,otherwis:[2,10],outgo:[0,11],output:12,over:[0,9],overrid:12,overridden:0,own:12,packag:[2,12],page:8,pair:[1,5],param:7,paramet:[0,1,3,4,5,7,9,10],pars:[4,9],part:10,parti:1,particip:2,particular:[0,11],pass:[0,4,9,10,11],passwd:1,password:1,past:0,patch:[0,2],path:[1,4],pattern:10,peopl:2,per:9,perfectli:9,perform:[0,2,9],perman:2,permiss:2,person:2,physic:2,piec:2,ping:2,pip:2,pipe:10,place:5,plain:[10,11],plan:0,platform:[0,12],pleas:[2,10,11],pledg:2,plug:0,pool:[0,9],poorli:10,port:0,portion:2,posit:9,possibl:[0,2],post:[0,2,7,10,11],potenti:2,practic:0,preempt:10,preemptiv:1,prefer:[0,2],prefix:[0,5],prepar:10,prevent:[10,11],principl:[0,2],print:[4,5,9],prior:0,privat:[1,2],probabl:10,probe:0,problem:0,process:9,produc:10,program:[1,12],progress:10,project:1,proper:[8,11,12],properli:[0,7],propos:0,protocol:[0,11],protocol_tlsv1:[0,11],provid:[0,1,4,6,9,10],proxi:[0,1,9],proxy_password:1,proxy_usernam:1,proxypass:1,proxyport:1,proxyserv:1,proxyusr:1,publish:[2,11],pull:2,push:2,put:9,py27:2,py34:2,pytest:2,python2:2,python3:2,python:[0,2,8,9,11,12],quantiti:10,queri:7,queue:9,race:2,rais:[1,4,6,9],random:0,rare:0,read:[2,4,10,11],readinto:4,readthedoc:1,realiti:11,realli:11,reason:10,rebas:2,receiv:[0,5,10],redirect:5,refer:9,reflect:[8,12],regard:2,regardless:2,region:0,regist:10,regular:9,reject:[1,2],relat:0,releas:11,reli:10,religion:2,remov:[1,2],remove_strategi:1,render:10,replac:[0,12],repo:9,report:[2,4],repositori:2,repres:[2,9],reprompt:1,request:[0,1,2],request_kwarg:9,request_prefix:5,requests_toolbelt:[0,1,3,4,5,6,7,9,10,11,12],requir:[0,1,6,11],resp:[4,5,7],respect:[0,2],respons:[1,2,3],response_prefix:5,responses_gener:9,result:[2,9],retri:[1,9],retriev:[1,3,5],review:2,right:[2,4],risk:0,rst:2,rule:2,safe:1,same:[2,9],sane:11,save:4,save_fil:4,scheme:[0,1],scraper:9,search:8,second:[0,9],secur:0,see:[2,4,5,7,9],select:[0,9],semi:0,send:[0,7,9,10],sens:10,sent:[1,5,7,10],server:[0,1,2,4,5,10,12],servic:0,session:[0,1,9,11,12],sesssion:9,set:[0,1,10],setup:0,sever:0,sexual:2,should:[0,1,2,9,10,11],shouldn:[0,10],sigmavirus24:[1,5,9],silent:0,similar:10,similarli:7,simpl:[9,10],simplehttpserv:2,simpli:[0,1,10],simplifi:2,sinc:0,singl:[1,5],situat:[9,10],size:[2,4,10],so_keepal:0,socket:[0,10],socket_opt:0,sol_socket:0,some:[0,1,3,8,10,11],some_funct:10,some_function_s:10,someth:[9,10],sourc:[0,9],source_address:0,space:2,specif:[0,10],specifi:[0,1,4,7,10],squash:2,ssl:[0,11],ssl_version:0,stale_reject:1,standard:[7,9,10,11],start:2,status_cod:9,stdin:10,step:2,still:9,store:11,str:[1,4],strategi:[1,2],stream_response_to_fil:4,streamer:10,streaming_iter:10,streamingerror:[4,6],streamingiter:10,string:[0,3,4,8,10,11],structur:7,stuff:4,style:[2,11],subclass:0,subject:2,submit:2,submodul:[2,9],subsequ:0,subset:2,succe:0,success:9,suffici:6,suggest:11,suppli:4,support:[0,1,10],suppos:0,sure:7,synchron:9,syntax:2,system:[2,12],take:[0,1,5,9,10],tcp:0,tcp_keepcnt:0,tcp_keepidl:0,tcp_keepintvl:0,tcp_nodelai:0,team:[2,8],tee:4,tee_to_bytearrai:4,tee_to_fil:4,temporarili:2,test_foo:2,text:[3,10,11],thei:[0,2,3,9,10],them:[2,4,7,10],themselv:2,thi:[0,1],thing:[9,12],third:1,those:1,thread:[1,8],thread_exc:9,thread_respons:9,threadexcept:9,threadrespons:9,threadsaf:9,threaten:2,three:[0,9],through:[0,2],time:[0,5,7,10],tlsv1:0,to_str:[10,11],token:1,toolbelt:[0,1,4],tox:2,track:10,transfer:10,treat:9,troll:2,tupl:[0,7,9,10],turn:0,twitter:0,twitter_fingerprint:0,two:[0,2,4,5],type:[1,4,5,7,9,10,11,12],typeerror:4,typo:2,unaccept:2,under:2,underli:0,underwhelm:9,uneth:2,unfortun:0,unicod:[3,11],unless:2,unnecessari:10,unprofession:2,until:10,updat:2,upgrad:11,upload:[2,8],url:[1,3,4,7,9,10],urlencod:7,urllib3:0,urls_to_get:9,usag:[0,4,10],user:[0,1,2,3,4,5,6,8,9,10],user_ag:[9,11,12],usernam:1,usual:1,utf:[5,10],valid:0,validate_certif:0,valu:[10,11],value0:10,verb:2,veri:10,verifi:0,version:[0,2,6,9,10,11,12],versionmismatcherror:6,via:[1,9,10],view:2,virtual:2,wai:[0,1,9,10],want:[4,9,10,12],wasn:4,web:12,websit:[1,2,7],weigh:10,welcom:2,well:[0,10,11,12],were:[9,12],what:[1,5,8,10],when:[0,1,2,7,10,11],where:[0,9,10],whether:1,which:[1,2,4,5,7,9,10],who:[2,10],why:[2,9],wiki:2,wish:[1,10],within:2,without:[0,1,2,9,10],word:9,work:[0,10,11],workflow:11,worri:9,would:[0,1,2,9,10],wrap:[2,9,10],wrapper:9,writabl:4,write:[2,4],www:[1,7],yet:1,yield:4,you:[0,1,2,4,5,7,9,10,11,12],your:[0,1,2,8,9],yourself:[2,4,10,12],yum:2},titles:["Transport Adapters","Authentication","Contributing to this project","Deprecated Requests Utilities","Utilities for Downloading Streaming Responses","Utilities for Dumping Information About Responses","Custom Toolbelt Exceptions","Utilities for Enhanced Form-Data Serialization","requests toolbelt","Using requests with Threading","Uploading Data","requests toolbelt","User-Agent Constructor"],titleterms:{about:5,adapt:0,add:2,agent:[11,12],api:9,appengineadapt:0,authent:1,authhandl:1,auto:9,build:2,checklist:2,code:2,commit:2,conduct:2,constructor:[11,12],contribut:[2,11],contributor:2,cooki:11,custom:6,data:[7,10,11],deprec:3,document:[2,8,9],download:4,dump:5,encod:[10,11],enhanc:7,exampl:2,except:6,extra:12,fingerprintadapt:0,footnot:2,forgetfulcookiejar:11,form:[7,11],from:10,full:8,gener:[9,10],guessauth:1,guessproxyauth:1,how:2,httpproxydigestauth:1,indic:8,inform:[5,12],issu:11,known:11,messag:2,modul:9,monitor:10,multipart:[10,11],overview:8,project:2,request:[3,8,9,11],respons:[4,5],run:2,serial:7,socketoptionsadapt:0,sourceaddressadapt:0,ssladapt:[0,11],stream:[4,10],string:12,tabl:8,tcpkeepaliveadapt:0,test:2,thi:2,thread:9,toolbelt:[6,8,11],transport:0,upload:10,user:[11,12],util:[3,4,5,7],your:[10,12]}})