a Nb @sddlZddlZddlmZddlZddlmZddlZddlZddlm Z m Z ddl m Z ddl mZddlmZddlmZddlmZmZz ddlZWneydZYn0dZeeZd ed ZGd d d eZdS) N) text_type) OrderedDict) HTTPBasicAuthAuthBase)OAuth1)Sleepers)parse_timestampread_in_chunksz0.10.1zmwclient/{} ({})z$https://github.com/mwclient/mwclientc@seZdZdZdZddddddd dd d d d ddddddddd fd dZddZed{ddZddddddddddddd d!d"d#d$d%d&Z d'd(Z d)d*Z d+d,Z d|d.d/Z d}d0d1Zed2d3Zd~d4d5Zdd6d7Zdd8d9Zdd:d;Zdd=d>Zdd?d@ZddAdBZddCdDZdEdFZddGdHZddLdMZddNdOZddQdRZddSdTZddUdVZddYdZZdd\d]Z dd_d`Z!ddadbZ"ddddeZ#ddgdhZ$ddidjZ%ddldmZ&ddndoZ'ddpdqZ(ddsdtZ)ddudvZ*ddwdxZ+ddydzZ,dS)SiteaA MediaWiki site identified by its hostname. >>> import mwclient >>> site = mwclient.Site('en.wikipedia.org') Do not include the leading "http://". Mwclient assumes that the script path (where index.php and api.php are located) is '/w/'. If the site uses a different script path, you must specify this (path must end in a '/'). Examples: >>> site = mwclient.Site('vim.wikia.com', path='/') >>> site = mwclient.Site('sourceforge.net', path='/apps/mediawiki/mwclient/') z/w/z.phpNcGsdSN)xrrL/var/www/html/diaryflask/venv/lib/python3.9/site-packages/mwclient/client.py5z Site.Thttpsc Cs||_||_||_d|_| |_t| |_| |_|p4i|_||_ d|jvrRd|jd<|durjt ||||}n:t | t t frt| }n"| dust | tfr| }ntdt||||_d|_d|_g|_g|_i|_d|_|j|_d|_|durHt|_||j_|r||j_|r"|dt }nt }||jj!d<|rN|jj!"|n||_t#$||_%t#j$|dd|_&t#j$|d d|_'|j%|_(|j&|_)|j'|_*d|_+d |_,| rz |-Wn\t.j/y }z@|j0d d krt.1||j2|j3|j0d d vrWYd}~n d}~00dS)Ntimeoutr z8Authentication is not a tuple or an instance of AuthBaseF z User-Agent namespaceirmwoauth-invalid-authorization>Z readapideniedZunknown_action)4hostpathext credentialscompressrmax_lag force_loginrequestsschemer isinstancelisttuplerr RuntimeErrorrsleepersblockedhasmsggroupsrightstokensversiondefault_namespaces namespaceswriteapiSession connectionauthcert USER_AGENTheadersupdatelistingZPageListpages categoriesZimagesZPagesZ CategoriesImages initialized chunk_size site_initerrorsAPIErrorargsZOAuthAuthorizationErrorcodeinfo)selfrrrpoolZ retry_timeout max_retriesZ wait_callbackZclients_useragentr"r!r#Zdo_initZhttpauthreqsZconsumer_tokenZconsumer_secretZ access_tokenZ access_secretZclient_certificateZcustom_headersr%r6Zuaerrr__init__4sn          z Site.__init__cCs|jrR|jdddd}|dd}|d|_|dg|_|dg|_i|_dS|jddd dd d }|dd |_d dt|ddD|_ d|jv|_ | |jd|_ | dd|dd}|d|_|dg|_|dg|_d|_dS)Nqueryuserinfoz groups|rights)metauipropnamer-r.zsiteinfo|userinfozgeneral|namespacesF)rOZsiproprPretry_on_errorZgeneralcSsi|]}|d|ddqS)id*get).0rrrr sz"Site.site_init..r2r3 generatorT)r?rWusernamer-r.r/sitesix itervaluesr2r3version_tuple_from_generatorr0require)rGrFrNrOrrrrAs0      zSite.site_init MediaWiki csv||std||t|dd}ddtfdd|Dd}t|d krrtd d||S) uReturn a version tuple from a MediaWiki Generator string. Example: "MediaWiki 1.5.1" → (1, 5, 1) Args: prefix (str): The expected prefix of the string zUnknown generator {}N.cSsrd}|t|kr4||dks4||dkr*q4|d7}q||dr\t|d|||dfSt|d|fSdS)zSplit the string on the first non-digit character. Returns: A tuple of the digit part as int and, if available, the rest of the string. r09r[N)lenint)sirrr split_nums   z4Site.version_tuple_from_generator..split_numc3s|]}|VqdSrr)rXrirkrr rz4Site.version_tuple_from_generator..rzUnknown MediaWiki {}) startswithrBMediaWikiVersionErrorformatrgsplitsumjoin)stringprefixr0Z version_tuplerrlrras  z!Site.version_tuple_from_generatorrUZTalkZUserz User talkZProjectz Project talkZImagez Image talkZ MediaWikizMediaWiki talkTemplatez Template talkZHelpz Help talkZCategoryz Category talkSpecialZMedia)rr[rnrr rcCsd|j|jfS)Nz)rr)rGrrr__repr__sz Site.__repr__cOs|j|dg|Ri|S)zPerform a generic API call using GET. This is just a shorthand for calling api() with http_method='GET'. All arguments will be passed on. Returns: The raw response from the API call, as a dictionary. GETapirGactionrDkwargsrrrrWs zSite.getcOs|j|dg|Ri|S)zPerform a generic API call using POST. This is just a shorthand for calling api() with http_method='POST'. All arguments will be passed on. Returns: The raw response from the API call, as a dictionary. POSTrrrrrposts z Site.postrcOs|||dkr"d|vr"d|d<|dkrnd|vrD|dd7<nd|d<d|vrf|dd7<nd |d<|j}|j||fi|}|si}|j||d rx|Sqxd S) aPerform a generic API call and handle errors. All arguments will be passed on. Example: To get coordinates from the GeoData MediaWiki extension at English Wikipedia: >>> site = Site('en.wikipedia.org') >>> result = site.api('query', prop='coordinates', titles='Oslo|Copenhagen') >>> for page in result['query']['pages'].values(): ... if 'coordinates' in page: ... print '{} {} {}'.format(page['title'], ... page['coordinates'][0]['lat'], ... page['coordinates'][0]['lon']) Oslo 59.95 10.75 Copenhagen 55.6761 12.5683 Returns: The raw response from the API call, as a dictionary. rMcontinuerUrOz |userinforNrPz|blockinfo|hasmsgzblockinfo|hasmsg)sleeperN)r:r*makeraw_apihandle_api_result)rGr http_methodrDrrrFrrrrs   zSite.apicCs|dur|j}z|dd}Wnty8d}Yn0d|vrZ|d|ddf|_nd|_d|v|_d |v|_d |vr|d D]\}}d |vrt |d qd |vr|d d dvr| dS|d d dkrd|d dvrt d| dSd|d vr2t d|d d|d |d vrft |d d |d d|d d t |d d |d d|dS)NrMrNrZ blockedbyZ blockreasonrUFmessagesZanonwarningsrTerrorrE>Z$internal_api_error_DBConnectionErrorZinternal_api_error_DBQueryErrorrzNonce already usedrFzIRetrying due to nonce error, seehttps://phabricator.wikimedia.org/T106066T) r*rKeyErrorrWr+r,Z logged_initemslogwarningsleeprBrC)rGrFrrrNmodulerrrrr#sH        zSite.handle_api_resultcOs>||ddt|D}ddt|D}t||S)NcSs g|]\}}|dvr||fqS>tokenZ wpEditTokenrrXkvrrr Tsz&Site._query_string..cSs g|]\}}|dvr||fqSrrrrrrrWs)r:r_ iteritemsr)rDrZqs1Zqs2rrr _query_stringQs zSite._query_stringcCsi}|jrtrd|d<|j||f}|j}|j} t| ttfrTt dt | \}} dj || |j ||jd} z||d} |jD]\} } | | | <q|dkr|| d<n|| d <|jj|| fi| }|jd rt|jd }td |||nd|jd kr|jWS|jdks(|jdkr2|n.|s@|tdj |j|jd|Wqltjjy|s~td|Yql0qldS)a Perform a generic request and return the raw text. In the event of a network problem, or a HTTP response with status code 5XX, we'll wait and retry the configured number of times before giving up if `retry_on_error` is True. `requests.exceptions.HTTPError` is still raised directly for HTTP responses with status codes in the 4XX range, and invalid HTTP responses. Args: script (str): Script name, usually 'api'. data (dict): Post data files (dict): Files to upload retry_on_error (bool): Retry on connection error http_method (str): The HTTP method, defaults to 'POST' Returns: The raw text response. gzipzAccept-EncodingzkSpecifying host as a tuple is deprecated as of mwclient 0.10.1. Please use the new scheme argument instead.z${scheme}://{host}{path}{script}{ext})r%rrscriptr)filesr9rparamsdatazx-database-lagz retry-afterz4Database lag exceeds max lag. Waiting for {} secondsr iWz9Received {status} response: {text}. Retrying in a moment.)statustextz'Connection error. Retrying in a moment.N)r!rr*rr%rr&r'r(rwarnDeprecationWarningrqrrr$rr5requestr9rWrhrrr status_coderraise_for_status exceptionsConnectionError)rGrrrrRrr9rr%rurlrDrrstreamZ wait_timerrrraw_call\s\          z Site.raw_callcOsz|d}Wnty$d}Yn0||d<d|d<|j|i|}|jd|||d}ztj|tdWSty|d rt j t |Yn0d S) zSend a call to the API.rRTrjsonrqr)rRr)object_pairs_hookz+MediaWiki API is not enabled for this site.N) poprrrrloadsr ValueErrorrorBZAPIDisabledErrorZInvalidResponse)rGrrrDrrRrresrrrrs      z Site.raw_apicOs2||d<|j|d<|j|i|}|jd||dS)z.Sends a call to index.php rather than the API.rZmaxlagindex)r)r"rr)rGrrrDrrrrr raw_indexs zSite.raw_indexcCs~|jdur&|durdStdt||durv|jdd||fkrHdS|rptdj||f|jdddqzdSntdS)Nz$Site %s has not yet been initializedrnTzZRequires version {required[0]}.{required[1]}, current version is {current[0]}.{current[1]})requiredcurrentF)r0r)reprrBrprqNotImplementedError)rGmajorminorrevisionZ raise_errorrrrrbs   z Site.requireFc Csz|d}z|jd|||||d}WnPtjyt}z6|jddkrVt||jdtj|WYd}~n d}~00|S)a Send email to a specified user on the wiki. >>> try: ... site.email('SomeUser', 'Some message', 'Some subject') ... except mwclient.errors.NoSpecifiedEmail: ... print('User does not accept email, or has no email address.') Args: user (str): User name of the recipient text (str): Body of the email subject (str): Subject of the email cc (bool): True to send a copy of the email to yourself (default is False) Returns: Dictionary of the JSON response Raises: NoSpecifiedEmail (mwclient.errors.NoSpecifiedEmail): User doesn't accept email EmailError (mwclient.errors.EmailError): Other email errors emailZ emailuser)targetsubjectrZccmerrZnoemailr[N) get_tokenrrBrCrDZNoSpecifiedEmailZ EmailError)rGuserrrccrrFrKrrrrs    z Site.emailc Cs>|r|r|||f|_|r&|jj||jr2|j}|jd|jdd}|jdrf|jd|d<z|d|d<Wn"tjt fyt dYn0|j di|}|dd d krq2q|dd d kr|dd |d<q|dd d kr| t|dddqt||dd |ddq|dS)a Login to the wiki using a username and password. The method returns nothing if the login was successful, but raises and error if it was not. Args: username (str): MediaWiki username password (str): MediaWiki password cookies (dict): Custom cookies to include with the log-in request. domain (str): Sends domain name for authentication; used by some MediaWiki plug-ins like the 'LDAP Authentication' extension. Raises: LoginError (mwclient.errors.LoginError): Login failed, the reason can be obtained from e.code and e.info (where e is the exception object) and will be one of the API:Login errors. The most common error code is "Failed", indicating a wrong username or password. MaximumRetriesExceeded: API call to log in failed and was retried until all retries were exhausted. This will not occur if the credentials are merely incorrect. See MaximumRetriesExceeded for possible reasons. APIError: An API error occurred. Rare, usually indicates an internal server error. rr[)ZlgnameZ lgpasswordrnZlgdomainloginZlgtokenz8Failed to get login token, MediaWiki is older than 1.27.resultSuccessZ NeedTokenrZ ThrottledwaitrzreasonN)r)r r5cookiesr:r*rrrBrCrrdebugrrrhrWZ LoginErrorrA)rGr]passwordrdomainrrrrrrrs4    z Site.logincCs|jdus|jdddkr(|dvr(d}||jvrrollbackrZpatrolZ userrightsZwatchZcsrfrerMrr/)rOtypez%stokenZTestrF)titlespropZintokenr<title)r0r/rWrrrr_r`)rGrforcerrFrjrrrr>s&    zSite.get_tokenc Cs|durtdt|dur$tdtdd|||fDdkrHtd|j|} | dsft||durx|}d} n|}|} |durt |d st |d }| d d } | d |j dd d kr| |j kr|||||| Sdd||| | dd} |rd| d<|r|| d<|j dd dkr2|| d<n|| d<| } d}|durXdd|fi}|j}|d| |}t|}|si}|j|| |drb|di}qqb|dur||S)aUpload a file to the site. Note that one of `file`, `filekey` and `url` must be specified, but not more than one. For normal uploads, you specify `file`. Args: file (str): File object or stream to upload. filename (str): Destination filename, don't include namespace prefix like 'File:' description (str): Wikitext for the file description page. ignore (bool): True to upload despite any warnings. file_size (int): Deprecated in mwclient 0.7 url (str): URL to fetch the file from. filekey (str): Key that identifies a previous upload that was stashed temporarily. comment (str): Upload comment. Also used as the initial page text for new files if `description` is not specified. Example: >>> client.upload(open('somefile', 'rb'), filename='somefile.jpg', description='Some description') Returns: JSON result from the API. Raises: errors.InsufficientPermission requests.exceptions.HTTPError Nz*file_size is deprecated since mwclient 0.7zfilename must be specifiedcSsg|]}|dur|qSrr)rXrrrrrrzSite.upload..r[zZcanrBZInsufficientPermissionhasattropenseekr0r@ chunk_uploadrr*rrrrrrWclose)rGrr descriptionignore file_sizerrrimager content_sizeZpredataZpostdatarrrrFresponserrrrdsn!               z Site.uploadc CsN|j|}|dd}|ddddd|||dd}|rFd|d <|j} d} t||jD]} |jd |d | id } t | } |j | || d rd| di}qqd| | 7} | td|| ||d|d<|ddkr|d|d<q`|ddkr | qq`| |Sq`|d=|d=|d=||d<||d<|jdi|S)avUpload a file to the site in chunks. This method is called by `Site.upload` if you are connecting to a newer MediaWiki installation, so it's normally not necessary to call this method directly. Args: file (file-like object): File object or stream to upload. params (dict): Dict containing upload parameters. rrnrrr[r)rrqstashoffsetrfilesizerrrrchunk)rrz%s: Uploaded %d of %d bytesrrContinuerrrrrr)r)r>rrr*rr r@rrrrrWtellrrrr)rGrrrrrrrrrrrrrFrrrrrsL           zSite.chunk_uploadc Csti}|dur||d<|dur$||d<|dur4||d<|durD||d<|rPd|d<|r\d|d<|jd i|}|dS) Nrrpager1 redirects mobileformatparse)r)r) rGrrrrrrrrrrrrsz Site.parsereall ascendingcCs`tjd| }ttjj|d|fd| f|||||||| | d }tj| |ddf| dd|S)z.Retrieve all pages on the wiki as a generator.Zapfromto) rvminsizemaxsizeprtypeprlevelr filterredirdirfilterlanglinksallpagesrlimitZ return_valuesr;ListZ get_prefixdictgenerate_kwargsZget_list)rGstartrvrrrrrrr r r rZendpfxrrrrr +sz Site.allpagesc CsZtjd| } ttjj| d|fd| f||||||d } tj| |ddf|dd| S)z/Retrieve all images on the wiki as a generator.Zairr)rvrrr sha1 sha1base36 allimagesz timestamp|urlr r) rGrrvrrr r rrrZrrrrrrr<szSite.allimagesrc Csdtjd|} ttjj| d|fd|f|||d} |rBd| | d<tj||ddf|dd | S) z8Retrieve a list of all links on the wiki as a generator.alrr)rvrrruniquealllinksrr r) rGrrvrrrr rZrrrrrrrJs z Site.alllinksc CsPtjd|}ttjj|d|fd|f||d}tj||ddfd|i|S)z3Retrieve all categories on the wiki as a generator.acrr)rvr  allcategoriesr r) rGrrvr r rZrrrrrrrWszSite.allcategoriesc CsDttjjdd|fd| f||||||d } tj|ddfd|i| S)z.Retrieve all users on the wiki as a generator.aurr)rvgrouprr. witheditsonly activeusersallusersr rr;rr) rGrrvrrr rr r.rrrrrr!asz Site.allusersolder(id|user|by|timestamp|expiry|reason|flagsc Cs8ttjjd||||||d}tj|ddfd|i|S)aRetrieve blocks as a generator. Returns: mwclient.listings.List: Generator yielding dicts, each dict containing: - user: The username or IP address of the user - id: The ID of the block - timestamp: When the block was added - expiry: When the block runs out (infinity for indefinite blocks) - reason: The reason they are blocked - allowusertalk: Key is present (empty string) if the user is allowed to edit their user talk page - by: the administrator who blocked the user - nocreate: key is present (empty string) if the user's ability to create accounts has been disabled. Zbk)rrr idsusersrblocksr r") rGrrr r%r&r rrrrrr'msz Site.blocks user|commentc Cs6ttjjd|||||d}tj|ddfd|i|S)NZdr)rrr rrZ deletedrevsr r")rGrrr rr rrrrrdeletedrevisionsszSite.deletedrevisionshttpcCs4ttjjd||||d}tj|ddfd|i|S)aRetrieve the list of pages that link to a particular domain or URL, as a generator. This API call mirrors the Special:LinkSearch function on-wiki. Query can be a domain like 'bbc.co.uk'. Wildcards can be used, e.g. '\*.bbc.co.uk'. Alternatively, a query can contain a full domain name and some or all of a URL: e.g. '\*.wikipedia.org/wiki/\*' See for details. Returns: mwclient.listings.List: Generator yielding dicts, each dict containing: - url: The URL linked to. - ns: Namespace of the wiki page - pageid: The ID of the wiki page - title: The page title. eu)rMrprotocolr exturlusager r")rGrMrr,rr rrrrr-s zSite.exturlusagec Cs<ttjjd|||||||| d } tj|ddfd|i| S)z"Retrieve logevents as a generator.le)rrrrr rrr logeventsr r") rGrrrrr rrr rrrrrr/s zSite.logeventsr~c Cs8ttjjd|||||d}tjd|ddfd|i|S)z+Retrieve checkuserlog items as a generator.Zcul)rrrr rentries checkuserlogr )rr;rrZ NestedList)rGrrr r rrrrrrr1szSite.checkuserlogrcCs.ttjjd|d}tj|ddfd|i|S)a Retrieve a generator of random pages from a particular namespace. limit specifies the number of random articles retrieved. namespace is a namespace identifier integer. Generator contains dictionary with namespace, page ID and title. Zrnrrandomr r")rGrr rrrrr2s z Site.randomc CsDttjjd|||||||| r dndd } tj|ddfd|i| S)uFList recent changes to the wiki, à la Special:Recentchanges. rcrN)rrr rrshowrtoponly recentchangesr r") rGrrr rrr4r rr5rrrrr6s  zSite.recentchanges ids|timestamp|flags|comment|usercCsd|dtt|d}g}|jd i|didi}|D]L}|ddD]:}|d|d<|d|d <t|d |d <||qTqD|S) aGet data about a list of revisions. See also the `Page.revisions()` method. API doc: https://www.mediawiki.org/wiki/API:Revisions Example: Get revision text for two revisions: >>> for revision in site.revisions([689697696, 689816909], prop='content'): ... print revision['*'] Args: revids (list): A list of (max 50) revisions. prop (str): Which properties to get for each revision. Returns: A list of revisions revisions|)rZrvproprevidsrMr<rZpageidrZ pagetitle timestamp)rM)rtmaprrWvaluesrappend)rGr:rrr8r<rrrrrr8s$zSite.revisionscCs>ttjjd|||d}|r$d|d<tj|ddfd|i|S)aPerform a full text search. API doc: https://www.mediawiki.org/wiki/API:Search Example: >>> for result in site.search('prefix:Template:Citation/'): ... print(result.get('title')) Args: search (str): The query string namespace (int): The namespace to search (default: 0) what (str): Search scope: 'text' for fulltext, or 'title' for titles only. Depending on the search backend, both options may not be available. For instance `CirrusSearch `_ doesn't support 'title', but instead provides an "intitle:" query string filter. redirects (bool): Include redirect pages in the search (option removed in MediaWiki 1.23). Returns: mwclient.listings.List: Search results iterator sr)searchrwhatrZ srredirectsr@r r")rGr@rrArr rrrrr@s  z Site.searchc Cs<ttjjd|||||||d} tj|ddf|| d| S)z List the contributions made by a given user to the wiki. API doc: https://www.mediawiki.org/wiki/API:Usercontribs Zuc)rrrr rrr4Z usercontribs)r uselangr") rGrrrr rrr4r rBrrrrusercontributionsszSite.usercontributionsblockinfo|groups|editcountcCstj|ddd||dS)zs Get information about a list of users. API doc: https://www.mediawiki.org/wiki/API:Users r&usr9)ZususersZusprop)r;rrt)rGr&rrrrr& sz Site.usersc CsDttjjd||||||d} |r*d| d<tj|ddfd|i| S)z List the pages on the current user's watchlist. API doc: https://www.mediawiki.org/wiki/API:Watchlist Zwl)rrrr rr4rZwlallrev watchlistr r") rGZallrevrrrr rr4r rrrrrF)szSite.watchlistcCs`i}|dur||d<|r d|d<|jd d|i|}|rP|dd|ddfS|ddSdS) z Takes wikitext (text) and expands templates. API doc: https://www.mediawiki.org/wiki/API:Expandtemplates Nrr generatexmlexpandtemplatesrrTZ parsetree)rHrV)rGrrrGrrrrrrH8szSite.expandtemplatesccsi}|dur||d<d}|dur|jddj||ddd|}|||d }|d d g}t|trd d |D}|D] }|VqqdS)ay Ask a query against Semantic MediaWiki. API doc: https://semantic-mediawiki.org/wiki/Ask_API Returns: Generator for retrieving all search results, with each answer as a dictionary. If the query is invalid, an APIError is raised. A valid query with zero results will not raise any error. Examples: >>> query = "[[Category:my cat]]|[[Has name::a name]]|?Has property" >>> for answer in site.ask(query): >>> for title, data in answer.items() >>> print(title) >>> print(data) Nrraskz{query}|offset={offset})rMrr)rMrzquery-continue-offsetrMresultscSsg|]}|qSrr)rXanswerrrrrorzSite.ask..)rI)rrqrrWr&rr=)rGrMrrrrJZanswersrKrrrrILs&    zSite.ask)rc)r)NN)NTr)r)r)NT)F)NNNN)FN)NNrUFNNNN)NNNNFF) NNrerNNNNNrrTN) NNNNNrNNTN)NNFrreNTN)NNrNTN) NNNNNFFNN)NNr#NNNr$)NNr#NNr()Nr*NN) NNNNr#NNNN)NNr~r#NN)r) NNr#NNNNNN)r7)reNFN)NNr#NNNNN)rD)FNNNr#NNN)NF)N)-__name__ __module__ __qualname____doc__Z api_limitrLrA staticmethodrar1rrWrrrrrrrrbrrrrrrr rrrr!r'r)r-r/r1r2r6r8r@rCr&rFrHrIrrrrr s   W# (   , . P    # ? & r=            #    r ) rloggingr_r collectionsrrr$Z requests.authrrZrequests_oauthlibrZmwclient.errorsrBZmwclient.listingr;Zmwclient.sleeprZ mwclient.utilrr r ImportError __version__ getLoggerrLrrqr8objectr rrrrs,