This repository has been archived by the owner on Oct 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deprecate the repository and pip package (#231)
refactor: Deprecate the repository and pip package - Add deprecation warnings on the use of deprecated package import - Mention repo deprecation in the readme file
- Loading branch information
Showing
12 changed files
with
113 additions
and
864 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,4 +2,4 @@ | |
| Useful classes and functionality for building and testing XBlocks | ||
| """ | ||
|
|
||
| __version__ = '3.4.1' | ||
| __version__ = '4.0.0' | ||
Empty file.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| """ | ||
| Utilities for warning about the use of deprecated package | ||
| See https://github.com/openedx/xblock-utils/issues/197 for details. | ||
| """ | ||
|
|
||
| import warnings | ||
|
|
||
|
|
||
| class DeprecatedPackageWarning(DeprecationWarning): | ||
| """ | ||
| A warning that a deprecated package is being used. | ||
| """ | ||
|
|
||
| def __init__(self, old_import, new_import): | ||
| super().__init__() | ||
| self.old_import = old_import | ||
| self.new_import = new_import | ||
|
|
||
| def __str__(self): | ||
| return ( | ||
| "Please use import {self.new_import} instead of {self.old_import} because " | ||
| "the 'xblock-utils' package has been deprecated and migrated to within 'xblock' package. " | ||
| ).format(self=self) | ||
|
|
||
|
|
||
| def warn_deprecated_package(old_import, new_import): | ||
| """ | ||
| Warn that a package has been deprecated | ||
| """ | ||
| warnings.warn( | ||
| DeprecatedPackageWarning(old_import, new_import), | ||
| stacklevel=3, # Should surface the line that is doing the importing. | ||
| ) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,12 @@ | ||
| """ | ||
| Useful helper methods | ||
| """ | ||
| """Deprecated package support.""" | ||
| # pylint: disable=useless-suppression,line-too-long,redefined-builtin,wildcard-import, | ||
| # pylint: disable=wrong-import-position,wrong-import-order | ||
|
|
||
| from xblockutils.deprecation.warn import warn_deprecated_package | ||
|
|
||
| def child_isinstance(block, child_id, block_class_or_mixin): | ||
| """ | ||
| Efficiently check if a child of an XBlock is an instance of the given class. | ||
| warn_deprecated_package( | ||
| 'xblockutils.helpers', | ||
| 'xblock.utils.helpers' | ||
| ) | ||
|
|
||
| Arguments: | ||
| block -- the parent (or ancestor) of the child block in question | ||
| child_id -- the usage key of the child block we are wondering about | ||
| block_class_or_mixin -- We return true if block's child indentified by child_id is an | ||
| instance of this. | ||
| This method is equivalent to | ||
| isinstance(block.runtime.get_block(child_id), block_class_or_mixin) | ||
| but is far more efficient, as it avoids the need to instantiate the child. | ||
| """ | ||
| def_id = block.runtime.id_reader.get_definition_id(child_id) | ||
| type_name = block.runtime.id_reader.get_block_type(def_id) | ||
| child_class = block.runtime.load_block_type(type_name) | ||
| return issubclass(child_class, block_class_or_mixin) | ||
| from xblock.utils.helpers import * |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,12 @@ | ||
| # | ||
| # Copyright (C) 2014-2015 edX | ||
| # | ||
| # This software's license gives you freedom; you can copy, convey, | ||
| # propagate, redistribute and/or modify this program under the terms of | ||
| # the GNU Affero General Public License (AGPL) as published by the Free | ||
| # Software Foundation (FSF), either version 3 of the License, or (at your | ||
| # option) any later version of the AGPL published by the FSF. | ||
| # | ||
| # This program is distributed in the hope that it will be useful, but | ||
| # WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero | ||
| # General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU Affero General Public License | ||
| # along with this program in a file in the toplevel directory called | ||
| # "AGPLv3". If not, see <http://www.gnu.org/licenses/>. | ||
| # | ||
| """ | ||
| PublishEventMixin: A mixin for publishing events from an XBlock | ||
| """ | ||
| """Deprecated package support.""" | ||
| # pylint: disable=useless-suppression,line-too-long,redefined-builtin,wildcard-import, | ||
| # pylint: disable=wrong-import-position,wrong-import-order | ||
|
|
||
| from xblock.core import XBlock | ||
| from xblockutils.deprecation.warn import warn_deprecated_package | ||
|
|
||
| warn_deprecated_package( | ||
| 'xblockutils.publish_event', | ||
| 'xblock.utils.publish_event' | ||
| ) | ||
|
|
||
| class PublishEventMixin: | ||
| """ | ||
| A mixin for publishing events from an XBlock | ||
| Requires the object to have a runtime.publish method. | ||
| """ | ||
| additional_publish_event_data = {} | ||
|
|
||
| @XBlock.json_handler | ||
| def publish_event(self, data, suffix=''): # pylint: disable=unused-argument | ||
| """ | ||
| AJAX handler to allow client-side code to publish a server-side event | ||
| """ | ||
| try: | ||
| event_type = data.pop('event_type') | ||
| except KeyError: | ||
| return {'result': 'error', 'message': 'Missing event_type in JSON data'} | ||
|
|
||
| return self.publish_event_from_dict(event_type, data) | ||
|
|
||
| def publish_event_from_dict(self, event_type, data): | ||
| """ | ||
| Combine 'data' with self.additional_publish_event_data and publish an event | ||
| """ | ||
| for key, value in self.additional_publish_event_data.items(): | ||
| if key in data: | ||
| return {'result': 'error', 'message': f'Key should not be in publish_event data: {key}'} | ||
| data[key] = value | ||
|
|
||
| self.runtime.publish(self, event_type, data) | ||
| return {'result': 'success'} | ||
| from xblock.utils.publish_event import * |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,121 +1,12 @@ | ||
| # | ||
| # Copyright (C) 2014-2015 Harvard, edX, OpenCraft | ||
| # | ||
| # This software's license gives you freedom; you can copy, convey, | ||
| # propagate, redistribute and/or modify this program under the terms of | ||
| # the GNU Affero General Public License (AGPL) as published by the Free | ||
| # Software Foundation (FSF), either version 3 of the License, or (at your | ||
| # option) any later version of the AGPL published by the FSF. | ||
| # | ||
| # This program is distributed in the hope that it will be useful, but | ||
| # WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero | ||
| # General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU Affero General Public License | ||
| # along with this program in a file in the toplevel directory called | ||
| # "AGPLv3". If not, see <http://www.gnu.org/licenses/>. | ||
| # | ||
| """ | ||
| Helper class (ResourceLoader) for loading resources used by an XBlock | ||
| """ | ||
| """Deprecated package support.""" | ||
| # pylint: disable=useless-suppression,line-too-long,redefined-builtin,wildcard-import, | ||
| # pylint: disable=wrong-import-position,wrong-import-order | ||
|
|
||
| import os | ||
| import sys | ||
| import warnings | ||
| from xblockutils.deprecation.warn import warn_deprecated_package | ||
|
|
||
| import pkg_resources | ||
| warn_deprecated_package( | ||
| 'xblockutils.resources', | ||
| 'xblock.utils.resources' | ||
| ) | ||
|
|
||
| from django.template import Context, Template, Engine | ||
| from django.template.backends.django import get_installed_libraries | ||
|
|
||
| from mako.template import Template as MakoTemplate | ||
| from mako.lookup import TemplateLookup as MakoTemplateLookup | ||
|
|
||
|
|
||
| class ResourceLoader: | ||
| """Loads resources relative to the module named by the module_name parameter.""" | ||
| def __init__(self, module_name): | ||
| self.module_name = module_name | ||
|
|
||
| def load_unicode(self, resource_path): | ||
| """ | ||
| Gets the content of a resource | ||
| """ | ||
| resource_content = pkg_resources.resource_string(self.module_name, resource_path) | ||
| return resource_content.decode('utf-8') | ||
|
|
||
| def render_django_template(self, template_path, context=None, i18n_service=None): | ||
| """ | ||
| Evaluate a django template by resource path, applying the provided context. | ||
| """ | ||
| context = context or {} | ||
| context['_i18n_service'] = i18n_service | ||
| libraries = { | ||
| 'i18n': 'xblockutils.templatetags.i18n', | ||
| } | ||
|
|
||
| installed_libraries = get_installed_libraries() | ||
| installed_libraries.update(libraries) | ||
| engine = Engine(libraries=installed_libraries) | ||
|
|
||
| template_str = self.load_unicode(template_path) | ||
| template = Template(template_str, engine=engine) | ||
| rendered = template.render(Context(context)) | ||
|
|
||
| return rendered | ||
|
|
||
| def render_mako_template(self, template_path, context=None): | ||
| """ | ||
| Evaluate a mako template by resource path, applying the provided context | ||
| """ | ||
| context = context or {} | ||
| template_str = self.load_unicode(template_path) | ||
| lookup = MakoTemplateLookup(directories=[pkg_resources.resource_filename(self.module_name, '')]) | ||
| template = MakoTemplate(template_str, lookup=lookup) | ||
| return template.render(**context) | ||
|
|
||
| def render_template(self, template_path, context=None): | ||
| """ | ||
| This function has been deprecated. It calls render_django_template to support backwards compatibility. | ||
| """ | ||
| warnings.warn( | ||
| "ResourceLoader.render_template has been deprecated in favor of ResourceLoader.render_django_template" | ||
| ) | ||
| return self.render_django_template(template_path, context) | ||
|
|
||
| def render_js_template(self, template_path, element_id, context=None, i18n_service=None): | ||
| """ | ||
| Render a js template. | ||
| """ | ||
| context = context or {} | ||
| return "<script type='text/template' id='{}'>\n{}\n</script>".format( | ||
| element_id, | ||
| self.render_django_template(template_path, context, i18n_service) | ||
| ) | ||
|
|
||
| def load_scenarios_from_path(self, relative_scenario_dir, include_identifier=False): | ||
| """ | ||
| Returns an array of (title, xmlcontent) from files contained in a specified directory, | ||
| formatted as expected for the return value of the workbench_scenarios() method. | ||
| If `include_identifier` is True, returns an array of (identifier, title, xmlcontent). | ||
| """ | ||
| base_dir = os.path.dirname(os.path.realpath(sys.modules[self.module_name].__file__)) | ||
| scenario_dir = os.path.join(base_dir, relative_scenario_dir) | ||
|
|
||
| scenarios = [] | ||
| if os.path.isdir(scenario_dir): | ||
| for template in sorted(os.listdir(scenario_dir)): | ||
| if not template.endswith('.xml'): | ||
| continue | ||
| identifier = template[:-4] | ||
| title = identifier.replace('_', ' ').title() | ||
| template_path = os.path.join(relative_scenario_dir, template) | ||
| scenario = str(self.render_django_template(template_path, {"url_name": identifier})) | ||
| if not include_identifier: | ||
| scenarios.append((title, scenario)) | ||
| else: | ||
| scenarios.append((identifier, title, scenario)) | ||
|
|
||
| return scenarios | ||
| from xblock.utils.resources import * |
Oops, something went wrong.