Merge pull request #462 from weakish/flake8

flake8

Author: weakish

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203
+exclude = build,docs

.github/workflows/pythonpackage.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8]
+        python-version: [3.5]
 
     steps:
     - uses: actions/checkout@v2

README.md

@@ -46,6 +46,11 @@ Run tests:
 nosetests
 ```
 
+## Linter and Formatter
+
+Currently, flake8 (linter) and black (formatter) are used.
+But we are still exploring.
+
 ## Release a New Version
 
 1. Edit `changelog` and `setup.py` (`version`).

leancloud/__init__.py

@@ -12,10 +12,6 @@
 import sys
 import logging
 import warnings
-
-logger = logging.getLogger('iso8601.iso8601')
-logger.setLevel(logging.CRITICAL)
-
 from . import client
 from . import cloud
 from . import cloudfunc
@@ -25,15 +21,15 @@
 from .client import use_master_key
 from .client import use_production
 from .client import use_region
-from .conversation import Conversation
+from .conversation import Conversation  # noqa: F401
 from .engine import Engine
 from .engine import LeanEngineError
 from .engine.https_redirect_middleware import HttpsRedirectMiddleware
 from .errors import LeanCloudError
 from .errors import LeanCloudWarning
 from .file_ import File
 from .geo_point import GeoPoint
-from .message import Message
+from .message import Message    # noqa: F401
 from .object_ import Object
 from .push import Installation
 from .query import FriendshipQuery
@@ -46,45 +42,48 @@
 from .user import User
 
 
-__author__ = 'asaka <lan@leancloud.rocks>'
-__version__ = '2.1.9'
+logger = logging.getLogger("iso8601.iso8601")
+logger.setLevel(logging.CRITICAL)
+
+__author__ = "asaka <lan@leancloud.rocks>"
+__version__ = "2.1.9"
 
 
 __all__ = [
-    'ACL',
-    'Engine',
-    'File',
-    'FriendshipQuery',
-    'GeoPoint',
-    'HttpsRedirectMiddleware',
-    'InboxQuery',
-    'Installation',
-    'LeanCloudError',
-    'LeanEngineError',
-    'Object',
-    'Query',
-    'Relation',
-    'Role',
-    'Status',
-    'SysMessage',
-    'User',
-    'client',
-    'cloud',
-    'cloudfunc',
-    'init',
-    'push',
-    'use_master_key',
-    'use_production',
-    'use_region',
+    "ACL",
+    "Engine",
+    "File",
+    "FriendshipQuery",
+    "GeoPoint",
+    "HttpsRedirectMiddleware",
+    "InboxQuery",
+    "Installation",
+    "LeanCloudError",
+    "LeanEngineError",
+    "Object",
+    "Query",
+    "Relation",
+    "Role",
+    "Status",
+    "SysMessage",
+    "User",
+    "client",
+    "cloud",
+    "cloudfunc",
+    "init",
+    "push",
+    "use_master_key",
+    "use_production",
+    "use_region",
 ]
 
 
 version_info = sys.version_info
 
 
 if version_info.major == 2 and version_info.minor < 7:
-    warnings.warn('Python2 version less than 7 is not supported', LeanCloudWarning)
+    warnings.warn("Python2 version less than 7 is not supported", LeanCloudWarning)
 
 
 if version_info.minor == 3 and version_info.minor < 4:
-    warnings.warn('Python3 version less than 4 is not supported', LeanCloudWarning)
+    warnings.warn("Python3 version less than 4 is not supported", LeanCloudWarning)

leancloud/acl.py

@@ -9,10 +9,10 @@
 
 import leancloud
 
-__author__ = 'asaka <lan@leancloud.rocks>'
+__author__ = "asaka <lan@leancloud.rocks>"
 
 
-PUBLIC_KEY = '*'
+PUBLIC_KEY = "*"
 
 
 class ACL(object):
@@ -26,7 +26,7 @@ def _set_access(self, access_type, user_id, allowed):
         if isinstance(user_id, leancloud.User):
             user_id = user_id.id
         elif isinstance(user_id, leancloud.Role):
-            user_id = 'role:' + user_id.get_name()
+            user_id = "role:" + user_id.get_name()
         permissions = self.permissions_by_id.get(user_id)
         if permissions is None:
             if not allowed:
@@ -45,23 +45,23 @@ def _get_access(self, access_type, user_id):
         if isinstance(user_id, leancloud.User):
             user_id = user_id.id
         elif isinstance(user_id, leancloud.Role):
-            user_id = 'role:' + user_id.get_name()
+            user_id = "role:" + user_id.get_name()
         permissions = self.permissions_by_id.get(user_id)
         if not permissions:
             return False
         return permissions.get(access_type, False)
 
     def set_read_access(self, user_id, allowed):
-        return self._set_access('read', user_id, allowed)
+        return self._set_access("read", user_id, allowed)
 
     def get_read_access(self, user_id):
-        return self._get_access('read', user_id)
+        return self._get_access("read", user_id)
 
     def set_write_access(self, user_id, allowed):
-        return self._set_access('write', user_id, allowed)
+        return self._set_access("write", user_id, allowed)
 
     def get_write_access(self, user_id):
-        return self._get_access('write', user_id)
+        return self._get_access("write", user_id)
 
     def set_public_read_access(self, allowed):
         return self.set_read_access(PUBLIC_KEY, allowed)
@@ -79,26 +79,26 @@ def set_role_read_access(self, role, allowed):
         if isinstance(role, leancloud.Role):
             role = role.get_name()
         if not isinstance(role, six.string_types):
-            raise TypeError('role must be a leancloud.Role or str')
-        self.set_read_access('role:{0}'.format(role), allowed)
+            raise TypeError("role must be a leancloud.Role or str")
+        self.set_read_access("role:{0}".format(role), allowed)
 
     def get_role_read_access(self, role):
         if isinstance(role, leancloud.Role):
             role = role.get_name()
         if not isinstance(role, six.string_types):
-            raise TypeError('role must be a leancloud.Role or str')
-        return self.get_read_access('role:{0}'.format(role))
+            raise TypeError("role must be a leancloud.Role or str")
+        return self.get_read_access("role:{0}".format(role))
 
     def set_role_write_access(self, role, allowed):
         if isinstance(role, leancloud.Role):
             role = role.get_name()
         if not isinstance(role, six.string_types):
-            raise TypeError('role must be a leancloud.Role or str')
-        self.set_write_access('role:{0}'.format(role), allowed)
+            raise TypeError("role must be a leancloud.Role or str")
+        self.set_write_access("role:{0}".format(role), allowed)
 
     def get_role_write_access(self, role):
         if isinstance(role, leancloud.Role):
             role = role.get_name()
         if not isinstance(role, six.string_types):
-            raise TypeError('role must be a leancloud.Role or str')
-        return self.get_write_access('role:{0}'.format(role))
+            raise TypeError("role must be a leancloud.Role or str")
+        return self.get_write_access("role:{0}".format(role))

leancloud/app_router.py

@@ -20,26 +20,26 @@ def __init__(self, app_id, region):
         self.session = requests.Session()
         self.lock = threading.Lock()
         self.expired_at = 0
-        
+
         prefix = app_id[:8].lower()
-        domain = 'lncld.net'
+        domain = "lncld.net"
 
-        if region == 'US':
-            domain = 'lncldglobal.com'
-        elif region == 'CN':
-            if app_id.endswith('-9Nh9j0Va'):
-                domain = 'lncldapi.com'
-            elif app_id.endswith('-MdYXbMMI'):
-                domain = 'lncldglobal.com'
+        if region == "US":
+            domain = "lncldglobal.com"
+        elif region == "CN":
+            if app_id.endswith("-9Nh9j0Va"):
+                domain = "lncldapi.com"
+            elif app_id.endswith("-MdYXbMMI"):
+                domain = "lncldglobal.com"
             else:
-                domain = 'lncld.net'
+                domain = "lncld.net"
         else:
-            raise RuntimeError('invalid region: {}'.format(region))
+            raise RuntimeError("invalid region: {}".format(region))
 
-        self.hosts['api'] = '{}.api.{}'.format(prefix, domain)
-        self.hosts['engine'] = '{}.engine.{}'.format(prefix, domain)
-        self.hosts['stats'] = '{}.stats.{}'.format(prefix, domain)
-        self.hosts['push'] = '{}.push.{}'.format(prefix, domain)
+        self.hosts["api"] = "{}.api.{}".format(prefix, domain)
+        self.hosts["engine"] = "{}.engine.{}".format(prefix, domain)
+        self.hosts["stats"] = "{}.stats.{}".format(prefix, domain)
+        self.hosts["push"] = "{}.push.{}".format(prefix, domain)
 
     def get(self, type_):
         with self.lock:
@@ -49,17 +49,17 @@ def get(self, type_):
             return self.hosts[type_]
 
     def refresh(self):
-        url = 'https://app-router.com/2/route?appId={}'.format(self.app_id)
+        url = "https://app-router.com/2/route?appId={}".format(self.app_id)
         try:
             result = self.session.get(url, timeout=5).json()
             with self.lock:
                 self.update(result)
         except Exception as e:
-            print('refresh app router failed:', e, file=sys.stderr)
+            print("refresh app router failed:", e, file=sys.stderr)
 
     def update(self, content):
-        self.hosts['api'] = content['api_server']
-        self.hosts['engine'] = content['engine_server']
-        self.hosts['stats'] = content['stats_server']
-        self.hosts['push'] = content['push_server']
-        self.expired_at = time.time() + content['ttl']
+        self.hosts["api"] = content["api_server"]
+        self.hosts["engine"] = content["engine_server"]
+        self.hosts["stats"] = content["stats_server"]
+        self.hosts["push"] = content["push_server"]
+        self.expired_at = time.time() + content["ttl"]