jsonpickle API�

jsonpickle API�

jsonpickle – hoyt niva API�

Returner en JSON formatert representasjon av verdi, et Python objekt.

unpicklable – Hvis satt til False, vil utdataene ikke inneholde den informasjonen som er nodvendig for a sla JSON-dataene tilbake i Python-objekter, men en enklere JSON-strom blir produsert. max_depth – Hvis satt til et ikke-negativt heltall vil ikke jsonpickle rekruttere dypere enn ‘max_depth’ trinnene i objektet. Alt dypere enn ‘max_depth’ er representert ved hjelp av en Python repr () av objektet. make_refs – Hvis satt til False, er jsonpickles referansestotte deaktivert. Objekter som er id () – identiske, vil ikke bli bevart pa tvers av koder () / dekode (), men den resulterende JSON-strommen vil bli konseptuelt enklere. jsonpickle oppdager sykliske gjenstander og vil bryte syklusen ved a ringe repr () i stedet for a gjenopprette nar make_refs er satt False. nokler – Hvis satt til True, vil jsonpickle kode for ikke-streng ordliste-taster i stedet for a tvinge dem til strengene via repr (). advarsel – Hvis satt til True, vil jsonpickle advare nar den returnerer Ingen for et objekt som det ikke kan plukke (for eksempel filbeskrivere). max_iter – Hvis det er satt til et ikke-negativt heltall, vil jsonpickle forbruke mest maks_iter elementer nar de plukker iteratorer.

Konverter en JSON-streng til et Python-objekt.

Sokeordets argument ‘nokler’ er standard for falsk. Hvis satt til True, vil jsonpickle dekode ikke-streng ordliste nokler i pythonobjekter via jsonpickle-protokollen.

Sokeordargumentet ‘klasser’ er som standard Ingen. Hvis det er satt til en enkelt klasse, eller en sekvens (liste, sett, tuple) av klasser, blir klassene gjort tilgjengelige nar du bygger objekter. Dette kan brukes til a gi jsonpickle tilgang til lokale klasser som ikke er tilgjengelige gjennom den globale modulen import omfanget.

Velge og laste bakover�s

jsonpickle gjor det mulig for brukeren a spesifisere hva JSON-backend skal brukes nar det kodes og dekodes. Som standard vil jsonpickle prove a bruke, i folgende rekkefolge: simplejson, json og demjson. Den foretrukne baksiden kan settes via jsonpickle.set_preferred_backend (). Ytterligere JSON backends kan brukes via jsonpickle.load_backend ().

For eksempel kan brukere av Django bruke versjonen av simplejson som er pakket i Django:

json i python 2.6+ simplejson demjson.

Sett den foretrukne json-baksiden.

Hvis en foretrukket tilbakestilling er satt, forsoker jsonpickle a bruke den for noen annen backend.

Hvis backend ikke er en av de innebygde jsonpickle-backendene (json / simplejson eller demjson), ma du laste opp backenden for du ringe set_preferred_backend.

AssertionError heves hvis backend ikke er lastet.

jsonpickle. load_backend (selv, navn, dumps = u’dumps ‘, masse = u’loads’, loads_exc = & lt; type ‘exceptions.ValueError’ & gt;) �

Legg inn en JSON-bakside ved navn.

Denne metoden laster en backend og setter opp referanser til den backendens laster / dumperfunksjoner og unntaksklasser.

dumper – er navnet pa backendens koder-metode. Metoden skal ta et objekt og returnere en streng. Standard til «dumper». laster – navngir backendens metode for omvendt operasjon – returnerer et Python-objekt fra en streng. Loads_exc – kan enten v re navnet pa unntaksklassen som brukes til a betegne dekodingsfeil, eller det kan v re en direkte referanse til den aktuelle unntaksklassen selv. Hvis det er et navn, er antagelsen at en unntaksklasse av det navnet kan bli funnet i backendmodulens navneomrade. last – navngi backendens «load» -metode. dump – heter backendens «dump» -metode.

Sann pa suksess, False hvis backend ikke kunne lastes.

Fjern alle oppforinger for en bestemt backend.

Tilknytt koder-spesifikke alternativer med en koder.

Etter at du har ringt til set_encoder_options, vil eventuelle samtaler til jsonpickle’s encode-metode sende de angitte args og kvargene sammen til den riktige backendens koder-metode.

Se den riktige koderenes dokumentasjon for detaljer om de stottede argumentene og sokeordargumentene.

Tilknytt dekoderspesifikke alternativer med en dekoder.

Etter at du har ringt til set_decoder_options, vil eventuelle anrop til jsonpickles avkodingsmetode passere de medfolgende args og kvargene sammen til den aktuelle backendens dekoderingsmetode.

Se den aktuelle dekoderens dokumentasjon for detaljer om de stottede argumentene og sokeordargumentene.

Tilpasse JSON output�

jsonpickle stotter standard pickle __getstate__ og __setstate__ protokollen for a representere objektet forekomster.

Klasser kan videre pavirke hvordan deres forekomster er syltet; Hvis klassen definerer metoden __getstate __ (), kalles den og returstatusen blir syltet som innholdet til forekomsten, i stedet for innholdet i forekomstens ordbok. Hvis det ikke er noen __getstate __ () -metode, er forekomsten __dict__ syltet.

gjenstand. __setstate__ (stat) �

Ved unpickling, hvis klassen ogsa definerer metoden __setstate __ (), kalles den med unpickled state. Hvis det ikke er noen __setstate __ () -metode, ma den sylte tilstanden v re en ordbok og elementene er tilordnet den nye instansens ordbok. Hvis en klasse definerer bade __getstate __ () og __setstate __ (), ma statobjektet ikke v re en ordliste, og disse metodene kan gjore det de vil.

jsonpickle.handlers – Custom Serialization Handlers�

Modulen jsonpickle.handlers gjor det mulig a plugge inn tilpassede serialiseringshandteringsprogrammer ved kjoretid. Denne funksjonen er nyttig nar jsonpickle ikke kan serialisere objekter som ikke er under din direkte kontroll.

Tilpassede handteringsprogrammer kan opprettes for a handtere andre objekter. Hver tilpasset handler ma stammer fra jsonpickle.handlers.BaseHandler og implementere flatt og gjenoppretting.

En handler kan v re bundet til andre typer ved a ringe jsonpickle.handlers.register ().

jsonpickle.customhandlers.SimpleReduceHandler er egnet for handtering av objekter som implementerer reduksjonsprotokollen:

Plasser obj i en json-vennlig form og skriv resultatet til data.

obj (objekt) – Objektet som skal serialiseres. data (dikt) – En delvis fylt ordbok som vil inneholde json-vennlig representasjon av obj nar denne metoden er ferdig.

Registrer denne handleren for den oppgitte klassen. Passer som dekorator, for eksempel:

Gjenopprett et objekt av den registrerte typen fra den json-vennlige representasjonen obj og returner den.

klasse jsonpickle.handlers. CloneFactory (eksemplar) �

Serialiserings-proxy for collections.defaultdict’s default_factory.

klasse jsonpickle.handlers. DatetimeHandler (kontekst) �

Tilpasset handterer for datetime objekter.

Datetime-objekter bruker __reduce__, og de genererer bin re strenger som koder for nyttelasten. Denne handteringen koder for nyttelast for a rekonstruere objektet.

flate (obj, data) � gjenopprette (data) � klasse jsonpickle.handlers. QueueHandler (kontekst) �

Serier ser utilsiktet pa koobjekter.

Koer inneholder mutex- og betingelsesvariabler som ikke kan serialiseres. Konstruer en ny Que-instans nar du gjenoppretter.

flate (obj, data) � gjenopprette (data) � klasse jsonpickle.handlers. RegexHandler (kontekst) �

Flatt _sre.SRE_Pattern (kompilert regex) objekter.

flate (obj, data) � gjenopprette (data) � klasse jsonpickle.handlers. Register � fa (cls_or_name, default = None) �

cls_or_name – typen eller dens fullt kvalifiserte navn standard – standard verdi, hvis en matchende handler ikke ble funnet.

Ser opp en handler etter type referanse eller sitt fullt kvalifiserte navn. Hvis en direkte kamp ikke blir funnet, blir soket utfort over alle handtere registrert med base = True.

Registrer en tilpasset handler for en klasse.

cls – Den egendefinerte objektklassen som handterer handler – Den tilpassede handlerklasse (hvis None, en decorator wrapper returneres) base – Angir om handler skal registreres for alle underklasser.

Denne funksjonen kan ogsa brukes som dekorator ved a utelate handteringsargumentet:

Serialiser uuid.UUID objekter.

Low Level API�

Vanligvis er denne lavnivafunksjonaliteten ikke nodvendig av klienter.

Legg merke til at argumenter som safe = True gjor det ikke trygt a laste en usikker jsonpickle-streng.

jsonpickle.pickler – Python til JSON�

Tar en gjenstand og returnerer en JSON-sikker representasjon av den.

Returnerer bare noen av de grunnleggende innebygde datatyper.

jsonpickle.unpickler – JSON til Python�

Registrer en eller flere klasser.

Tilbakestiller objektets interne tilstand.

Gjenoppretter et flatt objekt til sin opprinnelige python-tilstand.

Returnerer bare noen av de grunnleggende innebygde typene.

Retur argumenter egnet for __new __ ()

jsonpickle.unpickler. has_tag (obj, tag) �

Hjelperklasse som tester for a se om obj er en ordbok og inneholder en bestemt nokkel / tag.

Laster modulen og returnerer klassen.

Returnerer en forekomst av objektet fra objektets repr (string). Det inneb rer den dynamiske spesifikasjonen av kode.

Implementer den mandatte strategien for a handtere klassiske klasser som ikke kan bli instantiated uten __getinitargs__ fordi de tar parametere.

jsonpickle.backend – JSON Backend Management�

Administrerer koding og dekoding ved hjelp av ulike backends.

Det prover disse modulene i denne rekkefolgen: simplejson, json, demjson.

simplejson er en rask og popul r backend og er forst provd. json kommer med python2.6 og er provd andre. demjson er den mest permissive backend og er provd sist.

Forsok a dekode et objekt fra en JSON-streng.

Dette forsoker de lastede bakoverene i rekkefolge og gar forbi det siste unntaket hvis ingen backender er i stand til a dekode strengen.

Forsok a kode inn et objekt i JSON.

Dette forsoker de lastede bakoverene i rekkefolge og gar langs det siste unntaket hvis ingen backend er i stand til a kode inn objektet.

Deaktiver jsonpickles gjennomgripende oppforsel.

Som standard forsoker jsonpickle neste backend nar dekoding eller koding ved hjelp av en backend mislykkes.

Dette kan gjore det vanskelig a tvinge jsonpickle til a bruke en bestemt backend, og ta feil, fordi feilen blir undertrykt og ikke kan heves av den etterfolgende backend.

Ringe enable_backend (False) vil gjore jsonpickle umiddelbart gjenoppheve eventuelle unntak opphevet av backends.

Forsok a kode inn et objekt i JSON.

Dette forsoker de lastede bakoverene i rekkefolge og gar langs det siste unntaket hvis ingen backend er i stand til a kode inn objektet.

load_backend (navn, dumper = u’dumps ‘, masse = u’loads’, loads_exc = & lt; type ‘exceptions.ValueError’ & gt;) �

Legg inn en JSON-bakside ved navn.

Denne metoden laster en backend og setter opp referanser til den backendens laster / dumperfunksjoner og unntaksklasser.

dumper – er navnet pa backendens koder-metode. Metoden skal ta et objekt og returnere en streng. Standard til «dumper». laster – navngir backendens metode for omvendt operasjon – returnerer et Python-objekt fra en streng. Loads_exc – kan enten v re navnet pa unntaksklassen som brukes til a betegne dekodingsfeil, eller det kan v re en direkte referanse til den aktuelle unntaksklassen selv. Hvis det er et navn, er antagelsen at en unntaksklasse av det navnet kan bli funnet i backendmodulens navneomrade. last – navngi backendens «load» -metode. dump – heter backendens «dump» -metode.

Sann pa suksess, False hvis backend ikke kunne lastes.

Forsok a dekode et objekt fra en JSON-streng.

Dette forsoker de lastede bakoverene i rekkefolge og gar forbi det siste unntaket hvis ingen backender er i stand til a dekode strengen.

Fjern alle oppforinger for en bestemt backend.

Tilknytt dekoderspesifikke alternativer med en dekoder.

Etter at du har ringt til set_decoder_options, vil eventuelle anrop til jsonpickles avkodingsmetode passere de medfolgende args og kvargene sammen til den aktuelle backendens dekoderingsmetode.

Se den aktuelle dekoderens dokumentasjon for detaljer om de stottede argumentene og sokeordargumentene.

Tilknytt koder-spesifikke alternativer med en koder.

Etter at du har ringt til set_encoder_options, vil eventuelle samtaler til jsonpickle’s encode-metode sende de angitte args og kvargene sammen til den riktige backendens koder-metode.

Se den riktige koderenes dokumentasjon for detaljer om de stottede argumentene og sokeordargumentene.

Sett den foretrukne json-baksiden.

Hvis en foretrukket tilbakestilling er satt, forsoker jsonpickle a bruke den for noen annen backend.

Hvis backend ikke er en av de innebygde jsonpickle-backendene (json / simplejson eller demjson), ma du laste opp backenden for du ringe set_preferred_backend.

AssertionError heves hvis backend ikke er lastet.

jsonpickle.util – Hjelperfunksjoner�

Hjelperfunksjoner for pickling og unpickling. De fleste funksjoner hjelper til med a bestemme typen av en gjenstand.

jsonpickle.util. b64decode (nyttelast) � jsonpickle.util. b64encode (data) � jsonpickle.util. has_method (obj, navn) � jsonpickle.util. has_reduce (obj) �

Tester om __reduce__ eller __reduce_ex__ finnes i objektdiktet eller i klassediktene i hver klasse i MRO unntatt objekt.

Returnerer en tuple booleans (has_reduce, has_reduce_ex)

jsonpickle.util. importable_name (cls) �

Returnerer sant hvis nokkel finnes i obj .__ dict__; falsk hvis ikke inn. Hvis obj .__ dict__ er frav rende, returner standard.

jsonpickle.util. in_slots (obj, key, default = False) �

Returnerer sant hvis nokkel finnes i obj .__ slots__; falsk hvis ikke inn. Hvis obj .__ slots__ er frav rende, returner standard.

jsonpickle.util. is_bytes (obj) �

Hjelpermetode for a se om objektet er en bytestring.

Hjelpermetode for a teste om objektet er en ordbok.

Returnerer True hvis obj er en underklasse av diktypen. Obj ma v re en underklasse og ikke den faktiske innebygde dikten.

Returnerer sant hvis bestatt en funksjon.

Tester for a se om modulen er tilgjengelig pa sys.path.

Hjelpermetode for a se om objektet er en Python-liste.

Returnerer True hvis det bestas en modul.

Return True hvis obj er en modul-global funksjon.

Returnerer True hvis obj er en spesiell (rare) klasse, som er mer kompleks enn primitive datatyper, men er ikke en full gjenstand. Gjelder ogsa:

Returnerer True er obj er en referanse til en objekt-forekomst.

Retur True hvis et objekt kan syltes.

Hjelpermetode for a se om objektet er en grunnleggende datatype. Unicode-strenger, heltal, lengder, flyter, boolesker og Ingen betraktes som primitive og kommer tilbake Sann nar de passeres til is_primitive ()

Returnerer falsk hvis av en type som har spesielle omslag, og bor ikke ha sine __reduce__ metoder brukt.

jsonpickle.util. is_sequence (obj) �

Hjelpermetode for a se om objektet er en sekvens (liste, sett eller tuple).

Returnerer True hvis obj er en underklasse av liste, sett eller tuple.

obj ma v re en underklasse og ikke selve innebygd, for eksempel liste, sett, tuple, etc ..

Hjelpermetode for a se om objektet er et Python-sett.

Hjelpermetode for a se om objektet er en Python tuple.

Returnerer True er obj er en referanse til en type.

Hjelpermetode for a se om objektet er en unicode-streng.

jsonpickle.util. itemgetter (obj, getter = & lt; operator.itemgetter object & gt;) � jsonpickle.util. translate_module_name (modul) �

Gi nytt navn til innebygde moduler til et konsistent (Python2) modulnavn.

Dette brukes slik at referanser til Python’s builtins modul kan lastes inn i bade Python 2 og 3. Vi remap til navnet «__builtin__» og unmap det nar du importerer.

Se untranslate_module_name () for omvendt operasjon.

jsonpickle.util. untranslate_module_name (modul) �

Gi navn pa navn pa navn i JSON til navn som vi kan importere.

Dette reverserer oversettelsen som brukes av translate_module_name () til et modulnavn som er tilgjengelig for den nav rende versjonen av Python.