Files
witness-fracture/.venv/lib/python3.12/site-packages/internetarchive/__pycache__/session.cpython-312.pyc
T

303 lines
26 KiB
Plaintext
Raw Normal View History

2025-06-23 17:55:02 -05:00
Ë
“»Yh¦[ãób—dZddlmZddlZddlZddlZddlZddlZddlZddl m
Z
m Z m Z ddl
mZmZddlZddlZddlmZddlmZddlmZdd lmZdd
lmZdd lmZmZmZdd lm Z dd
l!m"Z"m#Z#ddl$m%Z%ddl&m'Z'm(Z(ejRe*«Z+Gd„dejXjZ«Z.y)a
internetarchive.session
~~~~~~~~~~~~~~~~~~~~~~~
This module provides an ArchiveSession object to manage and persist
settings across the internetarchive package.
:copyright: (C) 2012-2024 by Internet Archive.
:license: AGPL 3, see LICENSE for more details.
é)Ú annotationsN)ÚIterableÚMappingÚMutableMapping)ÚunquoteÚurlparse)ÚResponse)Ú HTTPAdapter)Ú
create_cookie)Údefault_headers)ÚRetry)Ú __version__ÚauthÚcatalog)Ú
get_config)Ú
CollectionÚItem©ÚSearch)Úparse_dict_cookiesÚreraise_modifycóÒ‡—eZdZdZdeiZ d dˆfd„
Zdd„Zˆfd„Z d dd„Z d dd„Z
dd„Z d dd „Z dd d
„Z
d! d"d „Zd#d „Zd$d%d
„Z d& d'd„Z d d(d„Z d# d(d„Z d) d*d„Z d) d+d„Z d d,d„Zdd-d„Zd.ˆfd„ ZˆxZS)/ÚArchiveSessionaçThe :class:`ArchiveSession <internetarchive.ArchiveSession>`
object collects together useful functionality from `internetarchive`
as well as important data such as configuration information and
credentials. It is subclassed from
:class:`requests.Session <requests.Session>`.
Usage::
>>> from internetarchive import ArchiveSession
>>> s = ArchiveSession()
>>> item = s.get_item('nasa')
Collection(identifier='nasa', exists=True)
Ú
collectionc
óŠ•—t‰ |�«|xsi}t|«}t||«|_||_|jj
di«j«D]v\}}|›d|›�}t|«}|j
|«sŒ*t||||j
dd«|j
dd«¬«} |jj| «Œx|jj
di«j
d d
«|_ |jj
di«j
d d «|_
d |jvr|xjdz
c_
|jrd
nd|_|jj
di«j
d«}
|
r|
jd«d}
t!|
«}
|
|_|jj
di«j
d«|_|jj
di«j
d«|_|xsi|_t+«|_|j,j/d|j1«i«|j,j/ddi«|j3«|jj
di«} | j
d«r||j5| j
dd«| j
dd««|st6j8dkr4|j5| j
dd«| j
dd«d«yyy) avInitialize :class:`ArchiveSession <ArchiveSession>` object with config.
:param config: A config dict used for initializing the
:class:`ArchiveSession <ArchiveSession>` object.
:param config_file: Path to config file used for initializing the
:class:`ArchiveSession <ArchiveSession>` object.
:param http_adapter_kwargs: Keyword arguments used to initialize the
:class:`requests.adapters.HTTPAdapter <HTTPAdapter>`
object.
:returns: :class:`ArchiveSession` object.
Úcookiesú=Údomainz .archive.orgÚpathú/)rrÚgeneralÚsecureTÚhostú archive.orgzhttps:úhttp:zlogged-in-userú;rÚs3ÚaccessÚsecretz
User-AgentÚ
ConnectionÚcloseÚloggingÚlevelÚNOTSETÚfilezinternetarchive.logé
Úurllib3N)ÚsuperÚ__init__ÚboolrÚconfigÚ config_fileÚgetÚitemsrr rÚ
set_cookier"r#ÚprotocolÚsplitrÚ
user_emailÚ
access_keyÚ
secret_keyÚhttp_adapter_kwargsr ÚheadersÚupdateÚ_get_user_agent_stringÚmount_http_adapterÚset_file_loggerÚloggerr-)
Úselfr5r6Údebugr?ÚckÚcvÚ
raw_cookieÚ cookie_dictÚcookier<Úlogging_configÚ __class__s
€ú`/mnt/c/fieldcraft/witness-fracture/.venv/lib/python3.12/site-packages/internetarchive/session.pyr3zArchiveSession.__init__LsÀø€ô& ‰ÑÔØ1Ò7°RÐÜ�U“ ˆä  ¨Ó5ˆŒ Ø&ˆÔØ—k‘k—o‘o i°Ó4×:Ñ:Ó<ò ,‰FˆB�ؘ4˜q  ˜ˆJÜ,¨ZÓ8ˆKØ—?‘? 2Ô&ØÜ" 2 {°2¡Ø*5¯/©/¸(ÀNÓ*SØ(3¯©¸ÀÓ(DôFˆFð
�L‰L× #Ñ # FÕ +ð ,ð!ŸK™KŸO™O¨I°rÓ:×>Ñ>¸xÈÓNˆŒ ØŸ™Ÿ™¨°BÓ7×;Ñ;¸FÀMÓRˆŒ Ø  § ¡ Ñ )Ø �IŠI˜Ñ '�IØ$(§K¢K™°WˆŒ
Ø—[‘[—_‘_ Y°Ó3×7Ñ7Ð8HÓIˆ
Ù Ø#×)Ñ)¨#Ó.¨qÑ1ˆJÜ  Ó,ˆJØ)ˆŒØ#Ÿ{™{Ÿ™¨t°RÓ8×<Ñ<¸XÓFˆŒØ#Ÿ{™{Ÿ™¨t°RÓ8×<Ñ<¸XÓFˆŒØ3FÒ3LÈ"ˆÔ ä&Ó(ˆŒ Ø � ‰ ×ј\¨4×+FÑ+FÓ+HÐIÔJØ � ‰ ×ј\¨7Ð3Ô4à ×ÑÔ!àŸ™Ÿ™¨°BÓ7ˆØ × Ñ ˜gÔ &Ø × Ñ  ×!3Ñ!3°G¸XÓ!FØ!/×!3Ñ!3°FÐ<QÓ!Rô
Tᜟ™¨Ò+Ø×$Ñ$ ^×%7Ñ%7¸ÀÓ%JØ%3×%7Ñ%7¸Ð@UÓ%VØ%.õ0ð,ð 'óc ó —tj«} tj«ddd}dj
t jŽ}dt›d|d›d|d ›d
|›d |j›d |›� S#t$rd}YŒRwxYw)
z;Generate a User-Agent string to be sent with every request.rNéÚz{}.{}.{}zinternetarchive/z (ú éÿÿÿÿz; N; z; z ) Python/)
ÚplatformÚunameÚlocaleÚ getlocaleÚ ExceptionÚformatÚsysÚ version_inforr=)rFrWÚlangÚ
py_versions rOrBz%ArchiveSession._get_user_agent_stringŒs¢€ä—‘Ó ˆð Ü×#Ñ#Ó% aÑ(¨¨!Ð,ˆDð'�Z×&Ñ&¬×(8Ñ(8Ð9ˆ
Ø"¤; -ð0ؘ!‘H�:˜Q˜u R™y˜k¨¨t¨f°B°t·±Ð6GðHØ$˜ð'ð (øôò ØŠDð ús–A5Á5 BÂBc󈕗t|j«}|jjd«ryt‰|�||«y)z1Never rebuild auth for archive.org URLs.
r$N)rÚurlÚnetlocÚendswithr2Ú rebuild_auth)rFÚprepared_requestÚresponseÚurNs €rOrdzArchiveSession.rebuild_auth˜s;ø€ô
Ð%×)Ñ)Ó *ˆØ �8‰8× Ñ ˜]Ô +Ø Ü
‰ÑÐ-¨xÕ8rPc ó~—|xs |j}|xsd}|€|jjdd«}|xsgd¢}|rDt|tt
f«r.t
|||dt j|d¬«|jd<n||jd<td
i|j¤Ž}|j|›d |›�|«y) aÐMount an HTTP adapter to the
:class:`ArchiveSession <ArchiveSession>` object.
:param protocol: HTTP protocol to mount your adapter to (e.g. 'https://').
:param max_retries: The number of times to retry a failed request.
This can also be an `urllib3.Retry` object.
:param status_forcelist: A list of status codes (as int's) to retry on.
:param host: The host to mount your adapter to.
r$NÚ max_retriesé)iôiõiöi÷iøFé)ÚtotalÚconnectÚreadÚredirectÚallowed_methodsÚstatus_forcelistÚbackoff_factorú//©)
r:r?r7Ú
isinstanceÚintÚfloatr
ÚDEFAULT_ALLOWED_METHODSr
Úmount)rFr:rirqr#Úmax_retries_adapters rOrCz!ArchiveSession.mount_http_adapter sÈ€ðÒ,˜tŸ}™}ˆØÒ$�}ˆØ Ð Ø×2Ñ2×6Ñ6°}ÀaÓHˆKà+ÒHÒ/HÐÙ œ: k´C¼°<Ô@Ü6;À+Ø(3Ø%0Ø).Ü05×0MÑ0MØ1AØ/0ô
72ˆD× $Ñ $ ]Ò 3ð7BˆD× $Ñ $ ]Ñ 3ä)ÑE¨D×,DÑ,DÑEÐð
�
‰
�h�Z˜r $ Ð(Ð*=Õ>rPcóF—dddddddœ}d}tj|«}|jtj«tj|d ¬
«}|j||«tj
|«}|j
|«|j|«y ) aSConvenience function to quickly configure any level of
logging to a file.
:param log_level: A log level as specified in the `logging` module.
:param path: Path to the log file. The file will be created if it doesn't already
exist.
:param logger_name: The name of the logger.
é2é(éér0r)ÚCRITICALÚERRORÚWARNINGÚINFOÚDEBUGr.z4%(asctime)s - %(name)s - %(levelname)s - %(message)szutf-8)ÚencodingN)r,Ú getLoggerÚsetLevelr„Ú FileHandlerÚ FormatterÚ setFormatterÚ
addHandler) rFÚ log_levelrÚ logger_nameÚ
_log_levelÚ
log_formatÚ_logÚfhÚ formatters rOrDzArchiveSession.set_file_loggerÅs�€ð"ØØØØØñ

ˆ
ðLˆ
ä× Ñ  Ó-ˆØ �
‰
”g—m‘mÔ$ä
×
Ñ
 °Ô
8ˆØ
� ‰ �J˜yÑ)Ô*ä×%Ñ% jÓ1ˆ Ø
�‰˜ Ô"à �‰˜ÕrPcó°—d}ddi}tj||tj|j|j
«d¬«}|j
«S)zfReturn the logged-in user email address.
:returns: The logged-in user email address.
z%https://archive.org/services/user.phpÚopÚwhoamié )ÚparamsrÚtimeout)Úrequestsr7rÚS3Authr=r>Újson)rFrgÚpÚrs rOr•zArchiveSession.whoamiësM€ð
4ˆØ
�8Ð ˆô
�L‰L˜ 1Ü!%§¡¨T¯_©_¸d¿o¹oÓ!NØ$&ô
(ˆð�v‰v‹xˆrPcó2—|xsi}|s/tjd|›d�«|j||«xsi}|jdi«jd«} |jj|t
«}||||«S#t $r t
}YŒwxYw)aQA method for creating :class:`internetarchive.Item <Item>` and
:class:`internetarchive.Collection <Collection>` objects.
:param identifier: A globally unique Archive.org identifier.
:param item_metadata: A metadata dict used to initialize the Item or
Collection object. Metadata will automatically be retrieved
from Archive.org if nothing is provided.
:param request_kwargs: Keyword arguments to be used in
:meth:`requests.sessions.Session.get` request.
zno metadata provided for "z", retrieving now.ÚmetadataÚ mediatype)rErGÚ get_metadatar7ÚITEM_MEDIATYPE_TABLErÚ TypeError)rFÚ
identifierÚ
item_metadataÚrequest_kwargsr Ú
item_classs rOÚget_itemzArchiveSession.get_itemûs €ð (Ò-¨2ˆÙÜ �L‰LÐ5°j°\ÐASÐTÔ UØ ×-Ñ-¨j¸.ÓIÒOÈRˆMØ!×%Ñ% j°"Ó5×9Ñ9¸+ÓFˆ ð Ø×2Ñ2×6Ñ6°yÄ$ÓGˆJñ˜$ 
¨MÓ:Ð:øôò ÜŠJð úsÁ BÂBÂBcóЗ|xsi}|j›d|j›d|›�}d|vrd|d< |jr7|jr+t j
|j|j«}nd}|j |fd|i|¤Ž}|j«|j«S#t$r3}d|›d|›�}tj|«t|«|«‚d}~wwxYw) zâGet an item's metadata from the `Metadata API
<http://blog.archive.org/2013/07/04/metadata-api/>`__
:param identifier: Globally unique Archive.org identifier.
:returns: Metadata API response.
rsz
/metadata/r˜r–NrzError retrieving metadata from z, )
r:r#r=r>rršr7Úraise_for_statusrZrEÚerrorÚtyper›)rFr¤r¦raÚs3_authÚrespÚexcÚ error_msgs rOr¡zArchiveSession.get_metadatasâ€ð(Ò-¨2ˆØ—‘�˜r $§)¡) ¨J°z°lÐCˆØ ˜NÑ *Ø(*ˆN˜9Ñ %ð
'Ø�Š 4§?¢?ÜŸ+™+ d§o¡o°t·±ÓG‘à�Ø�4—8‘8˜CÑ@ gÐ@°Ñ@ˆDØ × !Ñ !Ô #ð
�y‰y‹{Ðøô ò 'Ø9¸#¸¸bÀÀÐFˆIÜ �L‰L˜Ô #Ø”$�s“)˜IÓ&Ð &ûð 'ús¯A*B)Â) C%Â2.C à C%c ó6—|xsi}t|||||||||¬« S)a‚Search for items on Archive.org.
:param query: The Archive.org search query to yield results for. Refer to
https://archive.org/advancedsearch.php#raw for help formatting your
query.
:param fields: The metadata fields to return in the search results.
:param params: The URL parameters to send with each request sent to the
Archive.org Advancedsearch Api.
:param full_text_search: Beta support for querying the archive.org
Full Text Search API [default: False].
:param dsl_fts: Beta support for querying the archive.org Full Text
Search API in dsl (i.e. do not prepend ``!L `` to the
``full_text_search`` query [default: False].
:returns: A :class:`Search` object, yielding search results.
)ÚfieldsÚsortsr—Úfull_text_searchÚdsl_ftsr¦rir) rFÚqueryr²r³r—r´rµr¦ris rOÚ search_itemszArchiveSession.search_items/s4€ð:(Ò-¨2ˆÜ�d˜EØ#Ø!Ø#Ø'7Ø%Ø%3Ø"-ô/ð /rPcóÜ—|xsi}d|vrd|d<|j›d�}d||dœ}|j|fd|i|¤Ž} |j«}|jd«d k7S#t$rYywxYw)
Nr˜r–z//s3.us.archive.orgrk)Ú check_limitÚ accesskeyÚbucketr—TÚ
over_limitr)r:r7r›Ú
ValueError)rFr¤r=r¦rgrœr�Újs rOÚs3_is_overloadedzArchiveSession.s3_is_overloadedVs•€Ø'Ò-¨2ˆØ ˜NÑ *Ø(*ˆN˜9Ñ %à�}‰}ˆoÐ0Ð 1ˆàØ#Ø ñ
ˆð
ˆD�H‰H�QÑ 3˜qÐ 3 NÑ 3ˆð Ø—‘“ˆAð�u‰u�\Ó" aÑ'Ð'øôò Ùð ús»AÁ A+Á*A+cóN—tj||«j|¬«S)N)Úcmd)rÚCatalogÚget_rate_limit)rFrÁr¦s rOÚget_tasks_api_rate_limitz'ArchiveSession.get_tasks_api_rate_limiths!€Ü�‰˜t ^Ó4×CÑCÈÐCÓLÐLrPc óŽ—|xsi}|r|jddi«tj||«j||||||¬«S)aÉSubmit an archive.org task.
:param identifier: Item identifier.
:param cmd: Task command to submit, see
`supported task commands
<https://archive.org/services/docs/api/tasks.html#supported-tasks>`_.
:param comment: A reasonable explanation for why the
task is being submitted.
:param priority: Task priority from 10 to -10
(default: 0).
:param data: Extra POST data to submit with
the request. Refer to `Tasks API Request Entity
<https://archive.org/services/docs/api/tasks.html#request-entity>`_.
:param headers: Add additional headers to request.
:param reduced_priority: Submit your derive at a lower priority.
This option is helpful to get around rate-limiting.
Your task will more likely be accepted, but it might
not run for a long time. Note that you still may be
subject to rate-limiting. This is different than
``priority`` in that it will allow you to possibly
avoid rate-limiting.
:param request_kwargs: Keyword arguments to be used in
:meth:`requests.sessions.Session.post` request.
:returns: :class:`requests.Response`
zX-Accept-Reduced-PriorityÚ1)ÚcommentÚpriorityÚdatar@)rArrÂÚ submit_task) rFr¤rÁrÇrÈrÉr@Úreduced_priorityr¦s rOrÊzArchiveSession.submit_taskksY€ðT’-˜RˆÙ Ø �N‰NÐ7¸Ð=Ô >Ü�‰˜t ^Ó4×@Ñ@ÀÈSØAHØBJØ>BØAHð AóJð JrPc#ó¦K—|xsi}|j|ddddœ«tj||«}|j|«Ed{–—†y7Œ­w)aùA generator that returns completed tasks.
:param identifier: Item identifier.
:param params: Query parameters, refer to
`Tasks API
<https://archive.org/services/docs/api/tasks.html>`_
for available parameters.
:param request_kwargs: Keyword arguments to be used in
:meth:`requests.sessions.Session.get` request.
:returns: An iterable of completed CatalogTasks.
rrk©r¤rÚsummaryÚhistoryN©rArrÂÚ
iter_tasks©rFr¤r—r¦Úcs rOÚ iter_historyzArchiveSession.iter_historyžóIèø€ð$’˜2ˆØ�
‰
 Z¸AÈ!ÐXYÑZÔ[Ü �O‰O˜D .Ó 1ˆØ—<‘< Ó'×'Ò'úó‚AAÁ AÁ
Ac#ó¦K—|xsi}|j|ddddœ«tj||«}|j|«Ed{–—†y7Œ­w)a A generator that returns queued or running tasks.
:param identifier: Item identifier.
:param params: Query parameters, refer to
`Tasks API
<https://archive.org/services/docs/api/tasks.html>`_
for available parameters.
:param request_kwargs: Keyword arguments to be used in
:meth:`requests.sessions.Session.get` request.
:returns: An iterable of queued or running CatalogTasks.
rkrrÍNrÐrÒs rOÚ iter_catalogzArchiveSession.iter_catalogµrÕrÖcóP—tj||«j||¬«S)aXGet the total counts of catalog tasks meeting all criteria,
organized by run status (queued, running, error, and paused).
:param identifier: Item identifier.
:param params: Query parameters, refer to
`Tasks API
<https://archive.org/services/docs/api/tasks.html>`_
for available parameters.
:param request_kwargs: Keyword arguments to be used in
:meth:`requests.sessions.Session.get` request.
:returns: Counts of catalog tasks meeting all criteria.
©r¤r—)rrÂÚ get_summary©rFr¤r—r¦s rOÚget_tasks_summaryz ArchiveSession.get_tasks_summaryÌs&€ô$�‰˜t ^Ó4×@Ñ@ÈJÐ_eÐ@ÓfÐfrPcó’—|xsi}d|vrd|d<d|vrd|d<ttj||«j||¬««S)aÉGet a list of all tasks meeting all criteria.
The list is ordered by submission time.
:param identifier: The item identifier, if provided
will return tasks for only this item filtered by
other criteria provided in params.
:param params: Query parameters, refer to
`Tasks API
<https://archive.org/services/docs/api/tasks.html>`_