udata 9.1.2.dev30355__py2.py3-none-any.whl → 9.1.2.dev30454__py2.py3-none-any.whl

udata/core/reuse/api_fields.py

@@ -1,103 +1,138 @@
-from udata.api import api, fields, base_reference
-
+from udata.api import api, base_reference, fields
 from udata.core.badges.fields import badge_fields
 from udata.core.dataset.api_fields import dataset_fields
 from udata.core.organization.api_fields import org_ref_fields
 from udata.core.user.api_fields import user_ref_fields
 
-from .constants import REUSE_TOPICS, REUSE_TYPES, IMAGE_SIZES
+from .constants import IMAGE_SIZES, REUSE_TOPICS, REUSE_TYPES
 
 BIGGEST_IMAGE_SIZE = IMAGE_SIZES[0]
 
 
-reuse_fields = api.model('Reuse', {
-    'id': fields.String(description='The reuse identifier', readonly=True),
-    'title': fields.String(description='The reuse title', required=True),
-    'slug': fields.String(
-        description='The reuse permalink string', readonly=True),
-    'type': fields.String(
-        description='The reuse type', required=True, enum=list(REUSE_TYPES)),
-    'url': fields.String(
-        description='The reuse remote URL (website)', required=True),
-    'description': fields.Markdown(
-        description='The reuse description in Markdown', required=True),
-    'tags': fields.List(
-        fields.String, description='Some keywords to help in search'),
-    'badges': fields.List(fields.Nested(badge_fields),
-                          description='The reuse badges',
-                          readonly=True),
-    'topic': fields.String(
-        description='The reuse topic', required=True, enum=list(REUSE_TOPICS)),
-    'featured': fields.Boolean(
-        description='Is the reuse featured', readonly=True),
-    'private': fields.Boolean(
-        description='Is the reuse private to the owner or the organization'),
-    'image': fields.ImageField(description='The reuse thumbnail thumbnail (cropped) URL'),
-    'image_thumbnail': fields.ImageField(attribute='image', size=BIGGEST_IMAGE_SIZE,
-        description='The reuse thumbnail thumbnail URL. This is the square '
-        '({0}x{0}) and cropped version.'.format(BIGGEST_IMAGE_SIZE)),
-    'created_at': fields.ISODateTime(
-        description='The reuse creation date', readonly=True),
-    'last_modified': fields.ISODateTime(
-        description='The reuse last modification date', readonly=True),
-    'deleted': fields.ISODateTime(
-        description='The deletion date if deleted', readonly=True),
-    'datasets': fields.List(
-        fields.Nested(dataset_fields), description='The reused datasets'),
-    'organization': fields.Nested(
-        org_ref_fields, allow_null=True,
-        description='The publishing organization', readonly=True),
-    'owner': fields.Nested(
-        user_ref_fields, description='The owner user', readonly=True,
-        allow_null=True),
-    'metrics': fields.Raw(attribute=lambda o: o.get_metrics(),
-        description='The reuse metrics', readonly=True),
-    'uri': fields.UrlFor(
-        'api.reuse', lambda o: {'reuse': o},
-        description='The reuse API URI', readonly=True),
-    'page': fields.UrlFor(
-        'reuses.show', lambda o: {'reuse': o},
-        description='The reuse page URL', readonly=True, fallback_endpoint='api.reuse'),
-    'extras': fields.Raw(description='Extras attributes as key-value pairs'),
-}, mask='*,datasets{title,uri,page}')
+reuse_fields = api.model(
+    "Reuse",
+    {
+        "id": fields.String(description="The reuse identifier", readonly=True),
+        "title": fields.String(description="The reuse title", required=True),
+        "slug": fields.String(description="The reuse permalink string", readonly=True),
+        "type": fields.String(description="The reuse type", required=True, enum=list(REUSE_TYPES)),
+        "url": fields.String(description="The reuse remote URL (website)", required=True),
+        "description": fields.Markdown(
+            description="The reuse description in Markdown", required=True
+        ),
+        "tags": fields.List(fields.String, description="Some keywords to help in search"),
+        "badges": fields.List(
+            fields.Nested(badge_fields), description="The reuse badges", readonly=True
+        ),
+        "topic": fields.String(
+            description="The reuse topic", required=True, enum=list(REUSE_TOPICS)
+        ),
+        "featured": fields.Boolean(description="Is the reuse featured", readonly=True),
+        "private": fields.Boolean(
+            description="Is the reuse private to the owner or the organization"
+        ),
+        "image": fields.ImageField(description="The reuse thumbnail thumbnail (cropped) URL"),
+        "image_thumbnail": fields.ImageField(
+            attribute="image",
+            size=BIGGEST_IMAGE_SIZE,
+            description="The reuse thumbnail thumbnail URL. This is the square "
+            "({0}x{0}) and cropped version.".format(BIGGEST_IMAGE_SIZE),
+        ),
+        "created_at": fields.ISODateTime(description="The reuse creation date", readonly=True),
+        "last_modified": fields.ISODateTime(
+            description="The reuse last modification date", readonly=True
+        ),
+        "deleted": fields.ISODateTime(description="The deletion date if deleted", readonly=True),
+        "datasets": fields.List(fields.Nested(dataset_fields), description="The reused datasets"),
+        "organization": fields.Nested(
+            org_ref_fields,
+            allow_null=True,
+            description="The publishing organization",
+            readonly=True,
+        ),
+        "owner": fields.Nested(
+            user_ref_fields, description="The owner user", readonly=True, allow_null=True
+        ),
+        "metrics": fields.Raw(
+            attribute=lambda o: o.get_metrics(), description="The reuse metrics", readonly=True
+        ),
+        "uri": fields.UrlFor(
+            "api.reuse", lambda o: {"reuse": o}, description="The reuse API URI", readonly=True
+        ),
+        "page": fields.UrlFor(
+            "reuses.show",
+            lambda o: {"reuse": o},
+            description="The reuse page URL",
+            readonly=True,
+            fallback_endpoint="api.reuse",
+        ),
+        "extras": fields.Raw(description="Extras attributes as key-value pairs"),
+    },
+    mask="*,datasets{title,uri,page}",
+)
 
-reuse_page_fields = api.model('ReusePage', fields.pager(reuse_fields))
+reuse_page_fields = api.model("ReusePage", fields.pager(reuse_fields))
 
 
-reuse_ref_fields = api.inherit('ReuseReference', base_reference, {
-    'title': fields.String(description='The reuse title', readonly=True),
-    'image': fields.ImageField(description='The reuse thumbnail thumbnail (cropped) URL'),
-    'image_thumbnail': fields.ImageField(attribute='image', size=BIGGEST_IMAGE_SIZE,
-        description='The reuse thumbnail thumbnail URL. This is the square '
-        '({0}x{0}) and cropped version.'.format(BIGGEST_IMAGE_SIZE)),
-    'uri': fields.UrlFor(
-        'api.reuse', lambda o: {'reuse': o},
-        description='The reuse API URI', readonly=True),
-    'page': fields.UrlFor(
-        'reuses.show', lambda o: {'reuse': o},
-        description='The reuse page URL', readonly=True, fallback_endpoint='api.reuse'),
-})
+reuse_ref_fields = api.inherit(
+    "ReuseReference",
+    base_reference,
+    {
+        "title": fields.String(description="The reuse title", readonly=True),
+        "image": fields.ImageField(description="The reuse thumbnail thumbnail (cropped) URL"),
+        "image_thumbnail": fields.ImageField(
+            attribute="image",
+            size=BIGGEST_IMAGE_SIZE,
+            description="The reuse thumbnail thumbnail URL. This is the square "
+            "({0}x{0}) and cropped version.".format(BIGGEST_IMAGE_SIZE),
+        ),
+        "uri": fields.UrlFor(
+            "api.reuse", lambda o: {"reuse": o}, description="The reuse API URI", readonly=True
+        ),
+        "page": fields.UrlFor(
+            "reuses.show",
+            lambda o: {"reuse": o},
+            description="The reuse page URL",
+            readonly=True,
+            fallback_endpoint="api.reuse",
+        ),
+    },
+)
 
 
-reuse_type_fields = api.model('ReuseType', {
-    'id': fields.String(description='The reuse type identifier'),
-    'label': fields.String(description='The reuse type display name')
-})
+reuse_type_fields = api.model(
+    "ReuseType",
+    {
+        "id": fields.String(description="The reuse type identifier"),
+        "label": fields.String(description="The reuse type display name"),
+    },
+)
 
 
-reuse_suggestion_fields = api.model('ReuseSuggestion', {
-    'id': fields.String(description='The reuse identifier', readonly=True),
-    'title': fields.String(description='The reuse title', readonly=True),
-    'slug': fields.String(
-        description='The reuse permalink string', readonly=True),
-    'image_url': fields.ImageField(size=BIGGEST_IMAGE_SIZE, description='The reuse thumbnail URL', readonly=True),
-    'page': fields.UrlFor(
-        'reuses.show_redirect', lambda o: {'reuse': o['slug']},
-        description='The reuse page URL', readonly=True, fallback_endpoint='api.reuse')
-})
+reuse_suggestion_fields = api.model(
+    "ReuseSuggestion",
+    {
+        "id": fields.String(description="The reuse identifier", readonly=True),
+        "title": fields.String(description="The reuse title", readonly=True),
+        "slug": fields.String(description="The reuse permalink string", readonly=True),
+        "image_url": fields.ImageField(
+            size=BIGGEST_IMAGE_SIZE, description="The reuse thumbnail URL", readonly=True
+        ),
+        "page": fields.UrlFor(
+            "reuses.show_redirect",
+            lambda o: {"reuse": o["slug"]},
+            description="The reuse page URL",
+            readonly=True,
+            fallback_endpoint="api.reuse",
+        ),
+    },
+)
 
 
-reuse_topic_fields = api.model('ReuseTopic', {
-    'id': fields.String(description='The reuse topic identifier'),
-    'label': fields.String(description='The reuse topic display name')
-})
+reuse_topic_fields = api.model(
+    "ReuseTopic",
+    {
+        "id": fields.String(description="The reuse topic identifier"),
+        "label": fields.String(description="The reuse topic display name"),
+    },
+)

udata/core/reuse/apiv2.py

@@ -1,29 +1,30 @@
 from flask import request
 
 from udata import search
-from udata.api import apiv2, API
+from udata.api import API, apiv2
 from udata.utils import multi_to_dict
 
-from .api_fields import reuse_page_fields, reuse_fields
+from .api_fields import reuse_fields, reuse_page_fields
 from .search import ReuseSearch
 
-apiv2.inherit('ReusePage', reuse_page_fields)
-apiv2.inherit('Reuse', reuse_fields)
+apiv2.inherit("ReusePage", reuse_page_fields)
+apiv2.inherit("Reuse", reuse_fields)
 
-ns = apiv2.namespace('reuses', 'Reuse related operations')
+ns = apiv2.namespace("reuses", "Reuse related operations")
 
 search_parser = ReuseSearch.as_request_parser()
 
-DEFAULT_SORTING = '-created_at'
+DEFAULT_SORTING = "-created_at"
 
 
-@ns.route('/search/', endpoint='reuse_search')
+@ns.route("/search/", endpoint="reuse_search")
 class ReuseSearchAPI(API):
-    '''Reuses collection search endpoint'''
-    @apiv2.doc('search_reuses')
+    """Reuses collection search endpoint"""
+
+    @apiv2.doc("search_reuses")
     @apiv2.expect(search_parser)
     @apiv2.marshal_with(reuse_page_fields)
     def get(self):
-        '''Search all reuses'''
+        """Search all reuses"""
         search_parser.parse_args()
         return search.query(ReuseSearch, **multi_to_dict(request.args))

udata/core/reuse/constants.py

@@ -1,32 +1,32 @@
 from udata.i18n import lazy_gettext as _
 
 REUSE_TYPES = {
-    'api': _('API'),
-    'application': _('Application'),
-    'idea': _('Idea'),
-    'news_article': _('News Article'),
-    'paper': _('Paper'),
-    'post': _('Post'),
-    'visualization': _('Visualization'),
-    'hardware': _('Connected device'),
+    "api": _("API"),
+    "application": _("Application"),
+    "idea": _("Idea"),
+    "news_article": _("News Article"),
+    "paper": _("Paper"),
+    "post": _("Post"),
+    "visualization": _("Visualization"),
+    "hardware": _("Connected device"),
 }
 
 REUSE_TOPICS = {
-    'health': _('Health'),
-    'transport_and_mobility': _('Transport and mobility'),
-    'housing_and_development': _('Housing and development'),
-    'food_and_agriculture': _('Food and agriculture'),
-    'culture_and_recreation': _('Culture and recreation'),
-    'economy_and_business': _('Economy and business'),
-    'environment_and_energy': _('Environment and energy'),
-    'work_and_training': _('Work and training'),
-    'politics_and_public_life': _('Politics and public life'),
-    'safety_and_security': _('Safety and security'),
-    'education_and_research': _('Education and research'),
-    'society_and_demography': _('Society and demography'),
-    'law_and_justice': _('Law and justice'),
-    'open_data_tools': _('Open data tools'),
-    'others': _('Others'),
+    "health": _("Health"),
+    "transport_and_mobility": _("Transport and mobility"),
+    "housing_and_development": _("Housing and development"),
+    "food_and_agriculture": _("Food and agriculture"),
+    "culture_and_recreation": _("Culture and recreation"),
+    "economy_and_business": _("Economy and business"),
+    "environment_and_energy": _("Environment and energy"),
+    "work_and_training": _("Work and training"),
+    "politics_and_public_life": _("Politics and public life"),
+    "safety_and_security": _("Safety and security"),
+    "education_and_research": _("Education and research"),
+    "society_and_demography": _("Society and demography"),
+    "law_and_justice": _("Law and justice"),
+    "open_data_tools": _("Open data tools"),
+    "others": _("Others"),
 }
 
 

udata/core/reuse/csv.py

@@ -6,24 +6,24 @@ from .models import Reuse
 @csv.adapter(Reuse)
 class ReuseCsvAdapter(csv.Adapter):
     fields = (
-        'id',
-        'title',
-        'slug',
-        ('url', 'external_url'),
-        'type',
-        'description',
-        ('remote_url', 'url'),
-        ('organization', 'organization.name'),
-        ('organization_id', 'organization.id'),
-        ('owner', 'owner.slug'),  # in case it's owned by a user
-        ('owner_id', 'owner.id'),
-        ('image', lambda r: r.image(external=True)),
-        ('featured', lambda r: r.featured or False),
-        'created_at',
-        'last_modified',
-        'topic',
-        ('tags', lambda r: ','.join(r.tags)),
-        ('datasets', lambda r: ','.join([str(d.id) for d in r.datasets])),
+        "id",
+        "title",
+        "slug",
+        ("url", "external_url"),
+        "type",
+        "description",
+        ("remote_url", "url"),
+        ("organization", "organization.name"),
+        ("organization_id", "organization.id"),
+        ("owner", "owner.slug"),  # in case it's owned by a user
+        ("owner_id", "owner.id"),
+        ("image", lambda r: r.image(external=True)),
+        ("featured", lambda r: r.featured or False),
+        "created_at",
+        "last_modified",
+        "topic",
+        ("tags", lambda r: ",".join(r.tags)),
+        ("datasets", lambda r: ",".join([str(d.id) for d in r.datasets])),
     )
 
     def dynamic_fields(self):

udata/core/reuse/factories.py

@@ -1,30 +1,26 @@
 import factory
-
 from factory.fuzzy import FuzzyChoice
 
 from udata.core.dataset.factories import DatasetFactory
 from udata.factories import ModelFactory
 from udata.utils import faker
 
+from .constants import REUSE_TOPICS, REUSE_TYPES
 from .models import Reuse
-from .constants import REUSE_TYPES, REUSE_TOPICS
 
 
 class ReuseFactory(ModelFactory):
     class Meta:
         model = Reuse
 
-    title = factory.Faker('sentence')
-    description = factory.Faker('text')
-    url = factory.LazyAttribute(
-        lambda o: '/'.join([faker.url(), faker.unique_string()]))
+    title = factory.Faker("sentence")
+    description = factory.Faker("text")
+    url = factory.LazyAttribute(lambda o: "/".join([faker.url(), faker.unique_string()]))
     type = FuzzyChoice(REUSE_TYPES.keys())
     topic = FuzzyChoice(REUSE_TOPICS.keys())
 
     class Params:
-        visible = factory.Trait(
-            datasets=factory.LazyAttribute(lambda o: [DatasetFactory()])
-        )
+        visible = factory.Trait(datasets=factory.LazyAttribute(lambda o: [DatasetFactory()]))
 
 
 class VisibleReuseFactory(ReuseFactory):

udata/core/reuse/forms.py

@@ -1,41 +1,44 @@
+from udata.core.reuse.constants import REUSE_TOPICS, REUSE_TYPES
 from udata.forms import ModelForm, fields, validators
 from udata.i18n import lazy_gettext as _
 from udata.models import Reuse
-from udata.core.reuse.constants import REUSE_TYPES, REUSE_TOPICS
 
-from .constants import IMAGE_SIZES, TITLE_SIZE_LIMIT, DESCRIPTION_SIZE_LIMIT
+from .constants import DESCRIPTION_SIZE_LIMIT, IMAGE_SIZES, TITLE_SIZE_LIMIT
 
-__all__ = ('ReuseForm', )
+__all__ = ("ReuseForm",)
 
 
 def check_url_does_not_exists(form, field):
-    '''Ensure a reuse URL is not yet registered'''
+    """Ensure a reuse URL is not yet registered"""
     if field.data != field.object_data and Reuse.url_exists(field.data):
-        raise validators.ValidationError(_('This URL is already registered'))
+        raise validators.ValidationError(_("This URL is already registered"))
 
 
 class ReuseForm(ModelForm):
     model_class = Reuse
 
-    title = fields.StringField(_('Title'), [validators.DataRequired(), validators.Length(max=TITLE_SIZE_LIMIT)])
+    title = fields.StringField(
+        _("Title"), [validators.DataRequired(), validators.Length(max=TITLE_SIZE_LIMIT)]
+    )
     description = fields.MarkdownField(
-        _('Description'), [validators.DataRequired(), validators.Length(max=DESCRIPTION_SIZE_LIMIT)],
-        description=_('The details about the reuse (build process, specifics, '
-                      'self-critics...).'))
-    type = fields.SelectField(_('Type'), choices=list(REUSE_TYPES.items()))
-    url = fields.URLField(
-        _('URL'), [validators.DataRequired(), check_url_does_not_exists])
-    image = fields.ImageField(
-        _('Image'), sizes=IMAGE_SIZES, placeholder='reuse')
-    tags = fields.TagField(_('Tags'), description=_('Some taxonomy keywords'))
-    datasets = fields.DatasetListField(_('Used datasets'))
+        _("Description"),
+        [validators.DataRequired(), validators.Length(max=DESCRIPTION_SIZE_LIMIT)],
+        description=_(
+            "The details about the reuse (build process, specifics, " "self-critics...)."
+        ),
+    )
+    type = fields.SelectField(_("Type"), choices=list(REUSE_TYPES.items()))
+    url = fields.URLField(_("URL"), [validators.DataRequired(), check_url_does_not_exists])
+    image = fields.ImageField(_("Image"), sizes=IMAGE_SIZES, placeholder="reuse")
+    tags = fields.TagField(_("Tags"), description=_("Some taxonomy keywords"))
+    datasets = fields.DatasetListField(_("Used datasets"))
     private = fields.BooleanField(
-        _('Private'),
-        description=_('Restrict the dataset visibility to you or '
-                      'your organization only.'))
-    topic = fields.SelectField(_('Topic'), choices=list(REUSE_TOPICS.items()))
+        _("Private"),
+        description=_("Restrict the dataset visibility to you or " "your organization only."),
+    )
+    topic = fields.SelectField(_("Topic"), choices=list(REUSE_TOPICS.items()))
 
     owner = fields.CurrentUserField()
-    organization = fields.PublishAsField(_('Publish as'))
+    organization = fields.PublishAsField(_("Publish as"))
     deleted = fields.DateTimeField()
     extras = fields.ExtrasField()