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

udata/utils.py

@@ -1,54 +1,54 @@
 import hashlib
 import math
 import re
+from datetime import date, datetime
+from math import ceil
+from uuid import UUID, uuid4
+from xml.sax.saxutils import escape
 
 import factory
-
 from bson import ObjectId
 from bson.errors import InvalidId
-from datetime import date, datetime
-from dateutil.relativedelta import relativedelta
 from dateutil.parser import parse as parse_dt
+from dateutil.relativedelta import relativedelta
 from faker import Faker
 from faker.config import PROVIDERS
 from faker.providers import BaseProvider
 from faker.providers.lorem.la import Provider as LoremProvider
 from flask import abort
-from math import ceil
-from uuid import uuid4, UUID
-from xml.sax.saxutils import escape
 
 
 def get_by(lst, field, value):
-    '''Find an object in a list given a field value'''
+    """Find an object in a list given a field value"""
     for row in lst:
-        if ((isinstance(row, dict) and row.get(field) == value) or
-                (getattr(row, field, None) == value)):
+        if (isinstance(row, dict) and row.get(field) == value) or (
+            getattr(row, field, None) == value
+        ):
             return row
 
 
 def multi_to_dict(multi):
-    '''Transform a Werkzeug multidictionnary into a flat dictionnary'''
+    """Transform a Werkzeug multidictionnary into a flat dictionnary"""
     return dict(
-        (key, value[0] if len(value) == 1 else value)
-        for key, value in multi.to_dict(False).items()
+        (key, value[0] if len(value) == 1 else value) for key, value in multi.to_dict(False).items()
     )
 
 
-FIRST_CAP_RE = re.compile('(.)([A-Z][a-z]+)')
-ALL_CAP_RE = re.compile('([a-z0-9])([A-Z])')
+FIRST_CAP_RE = re.compile("(.)([A-Z][a-z]+)")
+ALL_CAP_RE = re.compile("([a-z0-9])([A-Z])")
 UUID_LENGTH = 36
 
 
 def camel_to_lodash(name):
-    s1 = FIRST_CAP_RE.sub(r'\1_\2', name)
-    return ALL_CAP_RE.sub(r'\1_\2', s1).lower()
+    s1 = FIRST_CAP_RE.sub(r"\1_\2", name)
+    return ALL_CAP_RE.sub(r"\1_\2", s1).lower()
 
 
 class Paginable(object):
-    '''
+    """
     A simple helper mixin for pagination
-    '''
+    """
+
     @property
     def pages(self):
         if self.page_size:
@@ -75,14 +75,14 @@ class Paginable(object):
     def page_end(self):
         return min(self.total, self.page_size * self.page)
 
-    def iter_pages(self, left_edge=2, left_current=2, right_current=5,
-                   right_edge=2):
+    def iter_pages(self, left_edge=2, left_current=2, right_current=5, right_edge=2):
         last = 0
         for num in range(1, self.pages + 1):
-            if (num <= left_edge or
-                    (num > self.page - left_current - 1 and
-                        num < self.page + right_current) or
-                    num > self.pages - right_edge):
+            if (
+                num <= left_edge
+                or (num > self.page - left_current - 1 and num < self.page + right_current)
+                or num > self.pages - right_edge
+            ):
                 if last + 1 != num:
                     yield None
                 yield num
@@ -90,7 +90,8 @@ class Paginable(object):
 
 
 class Paginator(Paginable):
-    '''A simple paginable implementation'''
+    """A simple paginable implementation"""
+
     def __init__(self, page, page_size, total):
         self.page = page
         self.page_size = page_size
@@ -98,7 +99,7 @@ class Paginator(Paginable):
 
 
 def daterange_start(value):
-    '''Parse a date range start boundary'''
+    """Parse a date range start boundary"""
     if not value:
         return None
     elif isinstance(value, datetime):
@@ -107,7 +108,7 @@ def daterange_start(value):
         return value
 
     result = parse_dt(value).date()
-    dashes = value.count('-')
+    dashes = value.count("-")
 
     if dashes >= 2:
         return result
@@ -120,7 +121,7 @@ def daterange_start(value):
 
 
 def daterange_end(value):
-    '''Parse a date range end boundary'''
+    """Parse a date range end boundary"""
     if not value:
         return None
     elif isinstance(value, datetime):
@@ -129,7 +130,7 @@ def daterange_end(value):
         return value
 
     result = parse_dt(value).date()
-    dashes = value.count('-')
+    dashes = value.count("-")
 
     if dashes >= 2:
         # Full date
@@ -146,22 +147,18 @@ def to_naive_datetime(given_date):
     if isinstance(given_date, str):
         given_date = parse_dt(given_date)
     if isinstance(given_date, date) and not isinstance(given_date, datetime):
-        return datetime(
-            given_date.year,
-            given_date.month,
-            given_date.day
-        )
+        return datetime(given_date.year, given_date.month, given_date.day)
     elif isinstance(given_date, datetime):
         return given_date.replace(tzinfo=None)
     return given_date
 
 
 def to_iso(dt):
-    '''
+    """
     Format a date or datetime into an ISO-8601 string
 
     Support dates before 1900.
-    '''
+    """
     if isinstance(dt, datetime):
         return to_iso_datetime(dt)
     elif isinstance(dt, date):
@@ -169,43 +166,46 @@ def to_iso(dt):
 
 
 def to_iso_date(dt):
-    '''
+    """
     Format a date or datetime into an ISO-8601 date string.
 
     Support dates before 1900.
-    '''
+    """
     if dt:
-        return '{dt.year:04d}-{dt.month:02d}-{dt.day:02d}'.format(dt=dt)
+        return "{dt.year:04d}-{dt.month:02d}-{dt.day:02d}".format(dt=dt)
 
 
 def to_iso_datetime(dt):
-    '''
+    """
     Format a date or datetime into an ISO-8601 datetime string.
 
     Time is set to 00:00:00 for dates.
 
     Support dates before 1900.
-    '''
+    """
     if dt:
         date_str = to_iso_date(dt)
-        time_str = '{dt.hour:02d}:{dt.minute:02d}:{dt.second:02d}'.format(
-            dt=dt) if isinstance(dt, datetime) else '00:00:00'
-        return 'T'.join((date_str, time_str))
+        time_str = (
+            "{dt.hour:02d}:{dt.minute:02d}:{dt.second:02d}".format(dt=dt)
+            if isinstance(dt, datetime)
+            else "00:00:00"
+        )
+        return "T".join((date_str, time_str))
 
 
 def to_bool(value):
-    '''
+    """
     Transform a value into a boolean with the following rules:
 
     - a boolean is returned untouched
     - a string value should match any casinf of 'true' to be True
     - an integer should be superior to zero to be True
     - all other values are False
-    '''
+    """
     if isinstance(value, bool):
         return value
     elif isinstance(value, str):
-        return value.lower() == 'true' or value.lower() == 't'
+        return value.lower() == "true" or value.lower() == "t"
     elif isinstance(value, int):
         return value > 0
     else:
@@ -213,34 +213,34 @@ def to_bool(value):
 
 
 def clean_string(value):
-    '''
+    """
     Clean an user input string (Prevent it from containing XSS)
-    '''
+    """
     return escape(value)
 
 
 def not_none_dict(d):
-    '''Filter out None values from a dict'''
+    """Filter out None values from a dict"""
     return {k: v for k, v in d.items() if v is not None}
 
 
 def hash_url(url):
-    '''Hash an URL to make it indexable'''
-    return hashlib.sha1(url.encode('utf-8')).hexdigest() if url else None
+    """Hash an URL to make it indexable"""
+    return hashlib.sha1(url.encode("utf-8")).hexdigest() if url else None
 
 
 def recursive_get(obj, key):
-    '''
+    """
     Get an attribute or a key recursively.
 
     :param obj: The object to fetch attribute or key on
     :type obj: object|dict
     :param key: Either a string in dotted-notation ar an array of string
     :type key: string|list|tuple
-    '''
+    """
     if not obj or not key:
         return
-    parts = key.split('.') if isinstance(key, str) else key
+    parts = key.split(".") if isinstance(key, str) else key
     key = parts.pop(0)
     if isinstance(obj, dict):
         value = obj.get(key, None)
@@ -250,7 +250,7 @@ def recursive_get(obj, key):
 
 
 def unique_string(length=UUID_LENGTH):
-    '''Generate a unique string'''
+    """Generate a unique string"""
     # We need a string at least as long as length
     string = str(uuid4()) * int(math.ceil(length / float(UUID_LENGTH)))
     return string[:length] if length else string
@@ -263,7 +263,7 @@ def is_uuid(uuid_string, version=4):
         # to prevent this, we check the genuine version (without dashes)
         # with the generated hex code. They should be similar.
         uid = UUID(uuid_string, version=version)
-        return uid.hex == uuid_string.replace('-', '')
+        return uid.hex == uuid_string.replace("-", "")
     except ValueError:
         return False
 
@@ -271,9 +271,9 @@ def is_uuid(uuid_string, version=4):
 # This is the default providers list
 # We remove the lorum one to replace it
 # with a unicode enabled one below
-PROVIDERS.remove('faker.providers.lorem')
+PROVIDERS.remove("faker.providers.lorem")
 
-faker = Faker('fr_FR')  # Use a unicode/utf-8 based locale
+faker = Faker("fr_FR")  # Use a unicode/utf-8 based locale
 
 
 def faker_provider(provider):
@@ -284,27 +284,29 @@ def faker_provider(provider):
 
 @faker_provider
 class UDataProvider(BaseProvider):
-    '''
+    """
     A Faker provider for udata missing requirements.
 
     Might be conributed to upstream Faker project
-    '''
+    """
+
     def unique_string(self, length=UUID_LENGTH):
-        '''Generate a unique string'''
+        """Generate a unique string"""
         return unique_string(length)
 
 
 @faker_provider  # Replace the default lorem provider with a unicode one
 class UnicodeLoremProvider(LoremProvider):
-    '''A Lorem provider that forces unicode in words'''
-    word_list = [w + 'é' for w in LoremProvider.word_list]
+    """A Lorem provider that forces unicode in words"""
+
+    word_list = [w + "é" for w in LoremProvider.word_list]
 
 
 def safe_unicode(string):
-    '''Safely transform any object into utf8 decoded str'''
+    """Safely transform any object into utf8 decoded str"""
     if string is None:
         return None
-    return string.decode('utf8') if isinstance(string, bytes) else str(string)
+    return string.decode("utf8") if isinstance(string, bytes) else str(string)
 
 
 def id_or_404(object_id):

udata/wsgi.py

@@ -1,3 +1,3 @@
-from udata.app import standalone, create_app
+from udata.app import create_app, standalone
 
 app = standalone(create_app())

{udata-9.1.2.dev30355.dist-info → udata-9.1.2.dev30382.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata
-Version: 9.1.2.dev30355
+Version: 9.1.2.dev30382
 Summary: Open data portal
 Home-page: https://github.com/opendatateam/udata
 Author: Opendata Team
@@ -137,6 +137,7 @@ It is collectively taken care of by members of the
 
 ## Current (in progress)
 
+- Add linter and formatter with `pyproject.toml` config, add lint and formatting step in CI, add pre-commit hook to lint and format, update docs and lint and format the code [#3085](https://github.com/opendatateam/udata/pull/3085)
 - Update pinned dependencies according to project dependencies, without updating any project dependencies [#3089](https://github.com/opendatateam/udata/pull/3089)
 - Add "run" button to harvesters (configurable with `HARVEST_ENABLE_MANUAL_RUN`) [#3092](https://github.com/opendatateam/udata/pull/3092)
 
@@ -160,7 +161,7 @@ It is collectively taken care of by members of the
 - Prevent tagging as spam owners' messages [#3071](https://github.com/opendatateam/udata/pull/3071)[#3076](https://github.com/opendatateam/udata/pull/3076)
 - Add api endpoint /me/org_topics/ [#3070](https://github.com/opendatateam/udata/pull/3070)
 - Expose dataservices in RDF catalog [#3058](https://github.com/opendatateam/udata/pull/3058) [#3075](https://github.com/opendatateam/udata/pull/3075)
-- CORS: always returns 204 on OPTIONS request [#3046](https://github.com/opendatateam/udata/pull/3046) 
+- CORS: always returns 204 on OPTIONS request [#3046](https://github.com/opendatateam/udata/pull/3046)
 
 ## 9.0.0 (2024-06-07)