Python3 support #1
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kipparker
commented
Mar 22, 2023
Comment on lines
+21
to
+38
| ## Usage | ||
|
|
||
| Create a new harvest source of type "Socrata" and enter the URL of the Socrata catalog you want to harvest from. The default base url to retrieve catalogues is "https://api.us.socrata.com/api/catalog/v1". You can provide a config object to the harvester to change this base url. For example: | ||
|
|
||
| ```json | ||
| { | ||
| "base_url": "https://api.eu.socrata.com/api/catalog/v1" | ||
| } | ||
| ``` | ||
|
|
||
| For local development, run | ||
|
|
||
| ```bash | ||
| ckan harvester gather-consumer | ||
| ckan harvester fetch-consumer | ||
| ``` | ||
|
|
||
| to see the harvest jobs being processed. |
There was a problem hiding this comment.
Adds information about the config object
Comment on lines
+7
to
+18
|
|
||
| try: | ||
| from urllib.parse import urlparse | ||
| except ImportError: | ||
| from urlparse import urlparse | ||
|
|
||
| try: | ||
| from json import JSONDecodeError | ||
| except ImportError: | ||
| from simplejson.scanner import JSONDecodeError | ||
|
|
||
|
|
There was a problem hiding this comment.
Try the python 3 import, fall back to python 2
|
|
||
| from ckan import model | ||
| from ckan.lib.munge import munge_title_to_name, munge_tag | ||
| from ckan.lib.munge import munge_tag |
There was a problem hiding this comment.
Removed an unused import
| @@ -205,11 +213,35 @@ def _build_package_dict(self, context, harvest_object): | |||
| 'url': DOWNLOAD_ENDPOINT_TEMPLATE.format( | |||
| domain=urlparse(harvest_object.source.url).hostname, | |||
| resource_id=res['resource']['id']), | |||
| 'format': 'CSV' | |||
| 'format': 'CSV', | |||
| 'name': res['resource']['name'] | |||
There was a problem hiding this comment.
Avoids all the data files being called "Unnamed Resource"
Comment on lines
+221
to
+244
|
|
||
| def _set_config(self, config_str): | ||
| self.config = {'base_api_endpoint':BASE_API_ENDPOINT} | ||
| if config_str: | ||
| self.config = json.loads(config_str) | ||
| if 'base_api_endpoint' in self.config: | ||
| self.base_api_endpoint = self.config['base_api_endpoint'] | ||
|
|
||
| log.debug('Using config: %r', self.config) | ||
|
|
||
| def validate_config(self, config): | ||
| if not config: | ||
| return config | ||
|
|
||
| config_obj = json.loads(config) | ||
| if 'base_api_endpoint' in config_obj: | ||
| try: | ||
| parsed = urlparse(config_obj['base_api_endpoint']) | ||
| except AttributeError: | ||
| raise ValueError('base_api_endpoint must be a valid URL') | ||
| if not parsed.scheme or not parsed.netloc: | ||
| raise ValueError('base_api_endpoint must be a valid URL') | ||
| return config | ||
|
|
There was a problem hiding this comment.
Add configuration for base_api_endpoint (we need to use the .eu version). _set_config is called by the gather stage, validate_config is called when the source is created
| @@ -266,8 +298,9 @@ def _page_datasets(domain, batch_number): | |||
| _request_datasets_from_socrata(domain, batch_number, | |||
| current_offset) | |||
| if datasets is None or len(datasets) == 0: | |||
| raise StopIteration | |||
| break | |||
There was a problem hiding this comment.
I found raising an error was just stopping the process
| @@ -396,7 +429,7 @@ def import_stage(self, harvest_object): | |||
|
|
|||
| else: | |||
| # We need to explicitly provide a package ID | |||
| package_dict['id'] = unicode(uuid.uuid4()) | |||
| package_dict['id'] = str(uuid.uuid4()) | |||
There was a problem hiding this comment.
Added for python 3 compatibility
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the plugin to: