9cf2f9f298
This will remove imports from __future__ that are no longer needed. https://docs.python.org/3.5/library/2to3.html#2to3fixer-future
56 lines
2.2 KiB
Python
56 lines
2.2 KiB
Python
"""
|
|
License mixin for XBlocks and XModules
|
|
"""
|
|
|
|
from xblock.core import XBlockMixin
|
|
from xblock.fields import Scope, String
|
|
|
|
# Make '_' a no-op so we can scrape strings. Using lambda instead of
|
|
# `django.utils.translation.ugettext_noop` because Django cannot be imported in this file
|
|
_ = lambda text: text
|
|
|
|
|
|
class LicenseMixin(XBlockMixin):
|
|
"""
|
|
Mixin that allows an author to indicate a license on the contents of an
|
|
XBlock. For example, a video could be marked as Creative Commons SA-BY
|
|
licensed. You can even indicate the license on an entire course.
|
|
|
|
If this mixin is not applied to an XBlock, or if the license field is
|
|
blank, then the content is subject to whatever legal licensing terms that
|
|
apply to content by default. For example, in the United States, that content
|
|
is exclusively owned by the creator of the content by default. Other
|
|
countries may have similar laws.
|
|
"""
|
|
license = String(
|
|
display_name=_("License"),
|
|
help=_("A license defines how the contents of this block can be shared and reused."),
|
|
default=None,
|
|
scope=Scope.content,
|
|
)
|
|
|
|
@classmethod
|
|
def parse_license_from_xml(cls, definition, node):
|
|
"""
|
|
When importing an XBlock from XML, this method will parse the license
|
|
information out of the XML and attach it to the block.
|
|
It is defined here so that classes that use this mixin can simply refer
|
|
to this method, rather than reimplementing it in their XML import
|
|
functions.
|
|
"""
|
|
license = node.get('license', default=None) # pylint: disable=redefined-builtin
|
|
if license:
|
|
definition['license'] = license
|
|
return definition
|
|
|
|
def add_license_to_xml(self, node, default=None):
|
|
"""
|
|
When generating XML from an XBlock, this method will add the XBlock's
|
|
license to the XML representation before it is serialized.
|
|
It is defined here so that classes that use this mixin can simply refer
|
|
to this method, rather than reimplementing it in their XML export
|
|
functions.
|
|
"""
|
|
if getattr(self, "license", default):
|
|
node.set('license', self.license)
|