Change Details

Commons-query.wikipedia.org requires that user has been logged in and has authorized the use of Commons-query.wikipedia.org. However, currently the SPARQL-query returns None if there is any error. However, code should throw an exception and error message if there is authorization error from "Commons-query.wikipedia.org". In other cases keep returing None for backwards compability. **Pywikibot developing ** Gerrit * https://www.mediawiki.org/wiki/Manual:Pywikibot/Gerrit#For_developers Install development enviroment ``` python -m venv venv source venv/bin/activate git clone --recursive ssh://WIKITECH_USERNAME@gerrit.wikimedia.org:29418/pywikibot/core.git pywikibot-git cd pywikibot-git pip install --upgrade pip pip install -r requirements.txt cp user-config.py.sample user-config.py ``` Commit message format * https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines Zache's notes * https://docs.google.com/document/d/1DU8Y4GhsGeusrqh1xqxDTfqtGc6YG4AMaOrvDD36MIs/edit **Example code for sparql query ** ``` import pywikibot from pywikibot.data import sparql site = pywikibot.Site('commons', 'commons') ## Login or logout when needed #site.logout() #site.login() # Define the SPARQL query query = "SELECT ?item ?finna_id WHERE { ?item wdt:P9478 ?finna_id } LIMIT 4" # Set up the SPARQL endpoint and entity URL # Note: https://commons-query.wikimedia.org requires user to be logged in entity_url = 'https://commons.wikimedia.org/entity/' endpoint = 'https://commons-query.wikimedia.org/sparql' # Create a SparqlQuery object query_object = sparql.SparqlQuery(endpoint= endpoint, entity_url= entity_url) # Execute the SPARQL query and retrieve the data data = query_object.select(query, full_data=False) print(data) ``` Sparql queres are executed in SparqlQuery class function query() in pywikibot/data/sparql.py: * https://github.com/wikimedia/pywikibot/blob/master/pywikibot/data/sparql.py#L138 **Error messages ** Suitable error message for user not logged in could be ``` message='You need to log in to Wikimedia Commons and give OAUTH permission. Open https://commons-query.wikimedia.org using web browser to login and give permission.' raise NoUsernameError('User not logged in. ' + message) ``` And for missing OAUTH permission ``` message='You need to log in to Wikimedia Commons and give OAUTH permission. Open https://commons-query.wikimedia.org using web browser to login and give permission.' raise UserRightsError('User OAUTH authorization is missing. ' + message) ``` For other sites than commons-query.wikimedia.org keep existing return None for backwards compability **Tests ** Add test case for testing missing oauth permission to Pywikibot tests to tests/sparql_tests.py - https://github.com/wikimedia/pywikibot/blob/master/tests/sparql_tests.py ``` python -m unittest -v tests.sparql_tests ```

Commons-query.wikipedia.org requires that user has been logged in and has authorized the use of Commons-query.wikipedia.org. However, currently the SPARQL-query returns None if there is any error. However, code should throw an exception and error message if there is authorization error from "Commons-query.wikipedia.org". In other cases keep returing None for backwards compability. **Pywikibot developing ** Gerrit * https://www.mediawiki.org/wiki/Manual:Pywikibot/Gerrit#For_developers **Example code for queryInstall development enviroment **``` python -m venv venv source venv/bin/activate git clone --recursive ssh://WIKITECH_USERNAME@gerrit.wikimedia.org:29418/pywikibot/core.git pywikibot-git cd pywikibot-git pip install --upgrade pip pip install -r requirements.txt cp user-config.py.sample user-config.py ``` Commit message format * https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines Zache's notes * https://docs.google.com/document/d/1DU8Y4GhsGeusrqh1xqxDTfqtGc6YG4AMaOrvDD36MIs/edit **Example code for sparql query ** ``` import pywikibot from pywikibot.data import sparql site = pywikibot.Site('commons', 'commons') ## Login or logout when needed #site.logout() #site.login() # Define the SPARQL query query = "SELECT ?item ?finna_id WHERE { ?item wdt:P9478 ?finna_id } LIMIT 4" # Set up the SPARQL endpoint and entity URL # Note: https://commons-query.wikimedia.org requires user to be logged in entity_url = 'https://commons.wikimedia.org/entity/' endpoint = 'https://commons-query.wikimedia.org/sparql' # Create a SparqlQuery object query_object = sparql.SparqlQuery(endpoint= endpoint, entity_url= entity_url) # Execute the SPARQL query and retrieve the data data = query_object.select(query, full_data=False) print(data) ``` **Pywikibot code for SPARQL queries** Sparql queres are executed in Sparql queres are handled oQuery class function query() in pywikibot/data/sparql.py: Class SparqlQuery().query() * https://github.com/wikimedia/pywikibot/blob/master/pywikibot/data/sparql.py#L138 **Error messages ** Suitable error message for user not logged in could be ``` message='You need to log in to Wikimedia Commons and give OAUTH permission. Open https://commons-query.wikimedia.org using web browser to login and give permission.' raise NoUsernameError('User not logged in. ' + message) And for missing OAUTH permission raise UserRightsError('User OAUTH authorization is missing. ' + message) For other sites than commons-query.wikimedia.org keep existing return None for backwards compability``` ** Tests **And for missing OAUTH permission ``` Add test case for testing missing oauth permission to Pywikibot tests tomessage='You need to log in to Wikimedia Commons and give OAUTH permission. Open https://commons-query.wikimedia.org using web browser to login and give permission.' tests/sparql_tests.pyraise UserRightsError('User OAUTH authorization is missing. ' + message) - https://github.com/wikimedia/pywikibot/blob/master/tests/sparql_tests.py Running tests ``` python -m venv venv source venv/bin/activate git clone --recursive ssh://zache-tool@gerritFor other sites than commons-query.wikimedia.org:29418/pywikibot/core.git pywikibot-git cd pywikibot-gitorg keep existing return None for backwards compability **Tests ** pip install --upgrade pipAdd test case for testing missing oauth permission to Pywikibot tests to tests/sparql_tests.py pip install -r requirements.txt- https://github.com/wikimedia/pywikibot/blob/master/tests/sparql_tests.py cp user-config.py.sample user-config.py python -m unittest -v tests.file_tests ``` ** Pywikibot developer ** Gerritpython -m unittest -v tests.sparql_tests * https://www.mediawiki.org/wiki/Manual:Pywikibot/Gerrit#For_developers Commit message format * https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines``` Zache's notes * https://docs.google.com/document/d/1DU8Y4GhsGeusrqh1xqxDTfqtGc6YG4AMaOrvDD36MIs/edit