Merge pull request #471 from Shopify/paulinakhew-black-double-quotes

Run black to format all quotes

Author: Paulinakhew

bin/shopify_api.py

@@ -8,6 +8,6 @@
 project_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 sys.path.insert(0, project_root)
 
-with open(os.path.join(project_root, 'scripts', 'shopify_api.py')) as f:
-    code = compile(f.read(), f.name, 'exec')
+with open(os.path.join(project_root, "scripts", "shopify_api.py")) as f:
+    code = compile(f.read(), f.name, "exec")
     exec(code)

pyproject.toml

@@ -3,4 +3,3 @@ max_line_length = 120
 
 [tool.black]
 line-length = 120
-skip-string-normalization = true

scripts/shopify_api.py

@@ -16,7 +16,7 @@
 def start_interpreter(**variables):
     # add the current working directory to the sys paths
     sys.path.append(os.getcwd())
-    console = type('shopify ' + shopify.version.VERSION, (code.InteractiveConsole, object), {})
+    console = type("shopify " + shopify.version.VERSION, (code.InteractiveConsole, object), {})
     import readline
 
     console(variables).interact()
@@ -54,7 +54,7 @@ def filter_func(item):
         return cls
 
     def run_task(cls, task=None, *args):
-        if task in [None, '-h', '--help']:
+        if task in [None, "-h", "--help"]:
             cls.help()
             return
 
@@ -120,22 +120,22 @@ def add(cls, connection):
         if os.path.exists(filename):
             raise ConfigFileError("There is already a config file at " + filename)
         else:
-            config = dict(protocol='https')
+            config = dict(protocol="https")
             domain = input("Domain? (leave blank for %s.myshopify.com) " % (connection))
             if not domain.strip():
                 domain = "%s.myshopify.com" % (connection)
-            config['domain'] = domain
+            config["domain"] = domain
             print("")
             print("open https://%s/admin/apps/private in your browser to generate API credentials" % (domain))
-            config['api_key'] = input("API key? ")
-            config['password'] = input("Password? ")
-            config['api_version'] = input("API version? (leave blank for %s) " % (cls._default_api_version))
-            if not config['api_version'].strip():
-                config['api_version'] = cls._default_api_version
+            config["api_key"] = input("API key? ")
+            config["password"] = input("Password? ")
+            config["api_version"] = input("API version? (leave blank for %s) " % (cls._default_api_version))
+            if not config["api_version"].strip():
+                config["api_version"] = cls._default_api_version
 
             if not os.path.isdir(cls._shop_config_dir):
                 os.makedirs(cls._shop_config_dir)
-            with open(filename, 'w') as f:
+            with open(filename, "w") as f:
                 f.write(yaml.dump(config, default_flow_style=False, explicit_start="---"))
         if len(list(cls._available_connections())) == 1:
             cls.default(connection)

setup.py

@@ -1,8 +1,8 @@
 from setuptools import setup
 
-NAME = 'ShopifyAPI'
-exec(open('shopify/version.py').read())
-DESCRIPTION = 'Shopify API for Python'
+NAME = "ShopifyAPI"
+exec(open("shopify/version.py").read())
+DESCRIPTION = "Shopify API for Python"
 LONG_DESCRIPTION = """\
 The ShopifyAPI library allows python developers to programmatically
 access the admin section of stores using an ActiveResource like
@@ -15,38 +15,38 @@
     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',
+    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',
+        "pyactiveresource>=2.2.2",
+        "PyYAML",
+        "six",
     ],
-    test_suite='test',
+    test_suite="test",
     tests_require=[
-        'mock>=1.0.1',
+        "mock>=1.0.1",
     ],
-    platforms='Any',
+    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',
+        "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/api_version.py

@@ -30,13 +30,13 @@ def define_version(cls, version):
     def define_known_versions(cls):
         req = request.urlopen("https://app.shopify.com/services/apis.json")
         data = json.loads(req.read().decode("utf-8"))
-        for api in data['apis']:
-            if api['handle'] == 'admin':
-                for release in api['versions']:
-                    if release['handle'] == 'unstable':
+        for api in data["apis"]:
+            if api["handle"] == "admin":
+                for release in api["versions"]:
+                    if release["handle"] == "unstable":
                         cls.define_version(Unstable())
                     else:
-                        cls.define_version(Release(release['handle']))
+                        cls.define_version(Release(release["handle"]))
 
     @classmethod
     def clear_defined_versions(cls):
@@ -60,15 +60,15 @@ def __eq__(self, other):
 
 
 class Release(ApiVersion):
-    FORMAT = re.compile(r'^\d{4}-\d{2}$')
-    API_PREFIX = '/admin/api'
+    FORMAT = re.compile(r"^\d{4}-\d{2}$")
+    API_PREFIX = "/admin/api"
 
     def __init__(self, version_number):
         if not self.FORMAT.match(version_number):
             raise InvalidVersionError
         self._name = version_number
-        self._numeric_version = int(version_number.replace('-', ''))
-        self._path = '%s/%s' % (self.API_PREFIX, version_number)
+        self._numeric_version = int(version_number.replace("-", ""))
+        self._path = "%s/%s" % (self.API_PREFIX, version_number)
 
     @property
     def stable(self):
@@ -77,9 +77,9 @@ def stable(self):
 
 class Unstable(ApiVersion):
     def __init__(self):
-        self._name = 'unstable'
+        self._name = "unstable"
         self._numeric_version = 9000000
-        self._path = '/admin/api/unstable'
+        self._path = "/admin/api/unstable"
 
     @property
     def stable(self):

shopify/base.py

@@ -38,7 +38,7 @@ class ShopifyResourceMeta(ResourceMeta):
     def connection(cls):
         """HTTP connection for the current thread"""
         local = cls._threadlocal
-        if not getattr(local, 'connection', None):
+        if not getattr(local, "connection", None):
             # Make sure these variables are no longer affected by other threads.
             local.user = cls.user
             local.password = cls.password
@@ -54,7 +54,7 @@ def connection(cls):
         return local.connection
 
     def get_user(cls):
-        return getattr(cls._threadlocal, 'user', ShopifyResource._user)
+        return getattr(cls._threadlocal, "user", ShopifyResource._user)
 
     def set_user(cls, value):
         cls._threadlocal.connection = None
@@ -63,7 +63,7 @@ def set_user(cls, value):
     user = property(get_user, set_user, None, "The username for HTTP Basic Auth.")
 
     def get_password(cls):
-        return getattr(cls._threadlocal, 'password', ShopifyResource._password)
+        return getattr(cls._threadlocal, "password", ShopifyResource._password)
 
     def set_password(cls, value):
         cls._threadlocal.connection = None
@@ -72,7 +72,7 @@ def set_password(cls, value):
     password = property(get_password, set_password, None, "The password for HTTP Basic Auth.")
 
     def get_site(cls):
-        return getattr(cls._threadlocal, 'site', ShopifyResource._site)
+        return getattr(cls._threadlocal, "site", ShopifyResource._site)
 
     def set_site(cls, value):
         cls._threadlocal.connection = None
@@ -82,49 +82,49 @@ def set_site(cls, value):
             host = parts.hostname
             if parts.port:
                 host += ":" + str(parts.port)
-            new_site = urllib.parse.urlunparse((parts.scheme, host, parts.path, '', '', ''))
+            new_site = urllib.parse.urlunparse((parts.scheme, host, parts.path, "", "", ""))
             ShopifyResource._site = cls._threadlocal.site = new_site
             if parts.username:
                 cls.user = urllib.parse.unquote(parts.username)
             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)
+        return getattr(cls._threadlocal, "timeout", ShopifyResource._timeout)
 
     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'):
+        if not hasattr(cls._threadlocal, "headers"):
             cls._threadlocal.headers = ShopifyResource._headers.copy()
         return cls._threadlocal.headers
 
     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)
+        return getattr(cls._threadlocal, "format", ShopifyResource._format)
 
     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."""
         try:
             return cls.override_prefix()
         except AttributeError:
-            if hasattr(cls, '_prefix_source'):
+            if hasattr(cls, "_prefix_source"):
                 return cls.site + cls._prefix_source
             else:
                 return cls.site
@@ -133,33 +133,33 @@ 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:
-            return getattr(cls._threadlocal, 'version', ShopifyResource._version)
+        if hasattr(cls._threadlocal, "version") or ShopifyResource._version:
+            return getattr(cls._threadlocal, "version", ShopifyResource._version)
         elif ShopifyResource._site is not None:
-            return ShopifyResource._site.split('/')[-1]
+            return ShopifyResource._site.split("/")[-1]
 
     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)
+        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
 
@@ -182,7 +182,7 @@ def activate_session(cls, session):
         cls.user = None
         cls.password = None
         cls.version = session.api_version.name
-        cls.headers['X-Shopify-Access-Token'] = session.token
+        cls.headers["X-Shopify-Access-Token"] = session.token
 
     @classmethod
     def clear_session(cls):
@@ -191,7 +191,7 @@ def clear_session(cls):
         cls.user = None
         cls.password = None
         cls.version = None
-        cls.headers.pop('X-Shopify-Access-Token', None)
+        cls.headers.pop("X-Shopify-Access-Token", None)
 
     @classmethod
     def find(cls, id_=None, from_=None, **kwargs):

shopify/collection.py

@@ -30,11 +30,11 @@ def __init__(self, *args, **kwargs):
             super(PaginatedCollection, self).__init__(metadata=metadata or {}, *args, **kwargs)
 
         if not ("resource_class" in self.metadata):
-            raise AttributeError("Cursor-based pagination requires a \"resource_class\" attribute in the metadata.")
+            raise AttributeError('Cursor-based pagination requires a "resource_class" attribute in the metadata.')
 
         self.metadata["pagination"] = self.__parse_pagination()
-        self.next_page_url = self.metadata["pagination"].get('next', None)
-        self.previous_page_url = self.metadata["pagination"].get('previous', None)
+        self.next_page_url = self.metadata["pagination"].get("next", None)
+        self.previous_page_url = self.metadata["pagination"].get("previous", None)
 
         self._next = None
         self._previous = None

shopify/limits.py

@@ -11,7 +11,7 @@ class Limits(object):
 
     # num_requests_executed/max_requests
     # Eg: 1/40
-    CREDIT_LIMIT_HEADER_PARAM = 'X-Shopify-Shop-Api-Call-Limit'
+    CREDIT_LIMIT_HEADER_PARAM = "X-Shopify-Shop-Api-Call-Limit"
 
     @classmethod
     def response(cls):
@@ -22,14 +22,14 @@ def response(cls):
     @classmethod
     def api_credit_limit_param(cls):
         response = cls.response()
-        _safe_header = getattr(response, "headers", '')
+        _safe_header = getattr(response, "headers", "")
 
         if not _safe_header:
             raise Exception("No shopify headers found")
 
         if cls.CREDIT_LIMIT_HEADER_PARAM in response.headers:
             credits = response.headers[cls.CREDIT_LIMIT_HEADER_PARAM]
-            return credits.split('/')
+            return credits.split("/")
         else:
             raise Exception("No valid api call header found")
 

shopify/resources/api_permission.py

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