Merge pull request #467 from Shopify/paulinakhew-pre-commit-black

Add black hook and run on all files

Author: Paulinakhew

.pre-commit-config.yaml

@@ -10,3 +10,7 @@ repos:
     rev: v1.5.4
     hooks:
     -   id: autopep8
+-   repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+    -   id: black

pyproject.toml

@@ -1,2 +1,6 @@
 [tool.autopep8]
 max_line_length = 120
+
+[tool.black]
+line-length = 120
+skip-string-normalization = true

scripts/shopify_api.py

@@ -18,6 +18,7 @@ def start_interpreter(**variables):
     sys.path.append(os.getcwd())
     console = type('shopify ' + shopify.version.VERSION, (code.InteractiveConsole, object), {})
     import readline
+
     console(variables).interact()
 
 
@@ -27,9 +28,11 @@ class ConfigFileError(Exception):
 
 def usage(usage_string):
     """Decorator to add a usage string to a function"""
+
     def decorate(func):
         func.usage = usage_string
         return func
+
     return decorate
 
 
@@ -44,6 +47,7 @@ def __new__(mcs, name, bases, new_attrs):
 
         def filter_func(item):
             return not item.startswith("_") and hasattr(getattr(cls, item), "__call__")
+
         tasks = filter(filter_func, tasks)
         cls._tasks = sorted(tasks)
 
@@ -84,7 +88,7 @@ def help(cls, task=None):
                 if desc:
                     line = "%s%s  # %s" % (line, " " * (max_len - len(line)), desc)
                 if len(line) > cols:
-                    line = line[:cols - 3] + "..."
+                    line = line[: cols - 3] + "..."
                 print(line)
         else:
             task_func = getattr(cls, task)
@@ -217,8 +221,10 @@ def version(cls, connection=None):
 
     @classmethod
     def _available_connections(cls):
-        return map(lambda item: os.path.splitext(os.path.basename(item))[0],
-              glob.glob(os.path.join(cls._shop_config_dir, "*.yml")))
+        return map(
+            lambda item: os.path.splitext(os.path.basename(item))[0],
+            glob.glob(os.path.join(cls._shop_config_dir, "*.yml")),
+        )
 
     @classmethod
     def _default_connection_target(cls):

setup.py

@@ -10,40 +10,43 @@
 requests to Shopify in order to list, create, update, or delete
 resources (e.g. Order, Product, Collection)."""
 
-setup(name=NAME,
-      version=VERSION,
-      description=DESCRIPTION,
-      long_description=LONG_DESCRIPTION,
-      author='Shopify',
-      author_email='developers@shopify.com',
-      url='https://github.com/Shopify/shopify_python_api',
-      packages=['shopify', 'shopify/resources'],
-      scripts=['scripts/shopify_api.py'],
-      license='MIT License',
-      install_requires=[
-          'pyactiveresource>=2.2.2',
-          'PyYAML',
-          'six',
-      ],
-      test_suite='test',
-      tests_require=[
-          'mock>=1.0.1',
-      ],
-      platforms='Any',
-      classifiers=['Development Status :: 5 - Production/Stable',
-                   'Intended Audience :: Developers',
-                   'License :: OSI Approved :: MIT License',
-                   'Operating System :: OS Independent',
-                   'Programming Language :: Python',
-                   'Programming Language :: Python :: 2',
-                   'Programming Language :: Python :: 2.7',
-                   'Programming Language :: Python :: 3',
-                   'Programming Language :: Python :: 3.4',
-                   'Programming Language :: Python :: 3.5',
-                   'Programming Language :: Python :: 3.6',
-                   'Programming Language :: Python :: 3.8',
-                   'Programming Language :: Python :: 3.9',
-                   'Topic :: Software Development',
-                   'Topic :: Software Development :: Libraries',
-                   'Topic :: Software Development :: Libraries :: Python Modules']
-      )
+setup(
+    name=NAME,
+    version=VERSION,
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
+    author='Shopify',
+    author_email='developers@shopify.com',
+    url='https://github.com/Shopify/shopify_python_api',
+    packages=['shopify', 'shopify/resources'],
+    scripts=['scripts/shopify_api.py'],
+    license='MIT License',
+    install_requires=[
+        'pyactiveresource>=2.2.2',
+        'PyYAML',
+        'six',
+    ],
+    test_suite='test',
+    tests_require=[
+        'mock>=1.0.1',
+    ],
+    platforms='Any',
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Topic :: Software Development',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+    ],
+)

shopify/base.py

@@ -17,8 +17,7 @@
 class ShopifyConnection(pyactiveresource.connection.Connection):
     response = None
 
-    def __init__(self, site, user=None, password=None, timeout=None,
-                 format=formats.JSONFormat):
+    def __init__(self, site, user=None, password=None, timeout=None, format=formats.JSONFormat):
         super(ShopifyConnection, self).__init__(site, user, password, timeout, format)
 
     def _open(self, *args, **kwargs):
@@ -30,11 +29,11 @@ def _open(self, *args, **kwargs):
             raise
         return self.response
 
+
 # Inherit from pyactiveresource's metaclass in order to use ShopifyConnection
 
 
 class ShopifyResourceMeta(ResourceMeta):
-
     @property
     def connection(cls):
         """HTTP connection for the current thread"""
@@ -51,8 +50,7 @@ def connection(cls):
             local.url = cls.url
             if cls.site is None:
                 raise ValueError("No shopify session is active")
-            local.connection = ShopifyConnection(
-                cls.site, cls.user, cls.password, cls.timeout, cls.format)
+            local.connection = ShopifyConnection(cls.site, cls.user, cls.password, cls.timeout, cls.format)
         return local.connection
 
     def get_user(cls):
@@ -62,8 +60,7 @@ def set_user(cls, value):
         cls._threadlocal.connection = None
         ShopifyResource._user = cls._threadlocal.user = value
 
-    user = property(get_user, set_user, None,
-                    "The username for HTTP Basic Auth.")
+    user = property(get_user, set_user, None, "The username for HTTP Basic Auth.")
 
     def get_password(cls):
         return getattr(cls._threadlocal, 'password', ShopifyResource._password)
@@ -72,8 +69,7 @@ def set_password(cls, value):
         cls._threadlocal.connection = None
         ShopifyResource._password = cls._threadlocal.password = value
 
-    password = property(get_password, set_password, None,
-                        "The password for HTTP Basic Auth.")
+    password = property(get_password, set_password, None, "The password for HTTP Basic Auth.")
 
     def get_site(cls):
         return getattr(cls._threadlocal, 'site', ShopifyResource._site)
@@ -93,8 +89,7 @@ def set_site(cls, value):
             if parts.password:
                 cls.password = urllib.parse.unquote(parts.password)
 
-    site = property(get_site, set_site, None,
-                    'The base REST site to connect to.')
+    site = property(get_site, set_site, None, 'The base REST site to connect to.')
 
     def get_timeout(cls):
         return getattr(cls._threadlocal, 'timeout', ShopifyResource._timeout)
@@ -103,8 +98,7 @@ def set_timeout(cls, value):
         cls._threadlocal.connection = None
         ShopifyResource._timeout = cls._threadlocal.timeout = value
 
-    timeout = property(get_timeout, set_timeout, None,
-                       'Socket timeout for HTTP requests')
+    timeout = property(get_timeout, set_timeout, None, 'Socket timeout for HTTP requests')
 
     def get_headers(cls):
         if not hasattr(cls._threadlocal, 'headers'):
@@ -114,8 +108,7 @@ def get_headers(cls):
     def set_headers(cls, value):
         cls._threadlocal.headers = value
 
-    headers = property(get_headers, set_headers, None,
-                       'The headers sent with HTTP requests')
+    headers = property(get_headers, set_headers, None, 'The headers sent with HTTP requests')
 
     def get_format(cls):
         return getattr(cls._threadlocal, 'format', ShopifyResource._format)
@@ -124,8 +117,7 @@ def set_format(cls, value):
         cls._threadlocal.connection = None
         ShopifyResource._format = cls._threadlocal.format = value
 
-    format = property(get_format, set_format, None,
-                      'Encoding used for request and responses')
+    format = property(get_format, set_format, None, 'Encoding used for request and responses')
 
     def get_prefix_source(cls):
         """Return the prefix source, by default derived from site."""
@@ -141,8 +133,7 @@ def set_prefix_source(cls, value):
         """Set the prefix source, which will be rendered into the prefix."""
         cls._prefix_source = value
 
-    prefix_source = property(get_prefix_source, set_prefix_source, None,
-                             'prefix for lookups for this type of object.')
+    prefix_source = property(get_prefix_source, set_prefix_source, None, 'prefix for lookups for this type of object.')
 
     def get_version(cls):
         if hasattr(cls._threadlocal, 'version') or ShopifyResource._version:
@@ -153,25 +144,22 @@ def get_version(cls):
     def set_version(cls, value):
         ShopifyResource._version = cls._threadlocal.version = value
 
-    version = property(get_version, set_version, None,
-                      'Shopify Api Version')
+    version = property(get_version, set_version, None, 'Shopify Api Version')
 
     def get_url(cls):
         return getattr(cls._threadlocal, 'url', ShopifyResource._url)
 
     def set_url(cls, value):
         ShopifyResource._url = cls._threadlocal.url = value
 
-    url = property(get_url, set_url, None,
-                   'Base URL including protocol and shopify domain')
+    url = property(get_url, set_url, None, 'Base URL including protocol and shopify domain')
 
 
 @six.add_metaclass(ShopifyResourceMeta)
 class ShopifyResource(ActiveResource, mixins.Countable):
     _format = formats.JSONFormat
     _threadlocal = threading.local()
-    _headers = {
-        'User-Agent': 'ShopifyPythonAPI/%s Python/%s' % (shopify.VERSION, sys.version.split(' ', 1)[0])}
+    _headers = {'User-Agent': 'ShopifyPythonAPI/%s Python/%s' % (shopify.VERSION, sys.version.split(' ', 1)[0])}
     _version = None
     _url = None
 

shopify/collection.py

@@ -56,13 +56,11 @@ def __parse_pagination(self):
         return result
 
     def has_previous_page(self):
-        """Returns true if the current page has any previous pages before it.
-        """
+        """Returns true if the current page has any previous pages before it."""
         return bool(self.previous_page_url)
 
     def has_next_page(self):
-        """Returns true if the current page has any pages beyond the current position.
-        """
+        """Returns true if the current page has any pages beyond the current position."""
         return bool(self.next_page_url)
 
     def previous_page(self, no_cache=False):

shopify/limits.py

@@ -8,6 +8,7 @@ class Limits(object):
 
     Conversion of lib/shopify_api/limits.rb
     """
+
     # num_requests_executed/max_requests
     # Eg: 1/40
     CREDIT_LIMIT_HEADER_PARAM = 'X-Shopify-Shop-Api-Call-Limit'

shopify/mixins.py

@@ -2,7 +2,6 @@
 
 
 class Countable(object):
-
     @classmethod
     def count(cls, _options=None, **kwargs):
         if _options is None:
@@ -11,7 +10,6 @@ def count(cls, _options=None, **kwargs):
 
 
 class Metafields(object):
-
     def metafields(self, _options=None, **kwargs):
         if _options is None:
             _options = kwargs
@@ -32,6 +30,5 @@ def add_metafield(self, metafield):
 
 
 class Events(object):
-
     def events(self):
         return shopify.resources.Event.find(resource=self.__class__.plural, resource_id=self.id)

shopify/resources/api_permission.py

@@ -2,7 +2,6 @@
 
 
 class ApiPermission(ShopifyResource):
-
     @classmethod
     def delete(cls):
         cls.connection.delete(cls.site + '/api_permissions/current.' + cls.format.extension, cls.headers)

shopify/resources/application_charge.py

@@ -2,6 +2,5 @@
 
 
 class ApplicationCharge(ShopifyResource):
-
     def activate(self):
         self._load_attributes_from_response(self.post("activate"))