Gh-12: Clean up inconsistent use of quotes in gafferpy (#42)

* Replaces single quotations and doc strings to double quotes

* Updates copyright

* fixed copyright

docs/source/conf.py

@@ -12,33 +12,33 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../../src/'))
+sys.path.insert(0, os.path.abspath("../../src/"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'gafferpy'
-copyright = '2022, GCHQ'
-author = 'GCHQ'
+project = "gafferpy"
+copyright = "2022, GCHQ"
+author = "GCHQ"
 
 # The full version, including alpha/beta/rc tags
-release = '2.2.0'
+release = "2.2.0"
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
 # ones.
 extensions = [
-    'sphinx_rtd_theme',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon'
+    "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon"
 ]
 
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -51,9 +51,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

src/fishbowl/fishbowl.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2023 Crown Copyright
+# Copyright 2023-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -172,7 +172,7 @@ def _generate_operations(self) -> str:
 
         operation_summaries = sorted(operation_summaries, key=lambda op: op["name"])
 
-        op_names = [op['name'] for op in operation_summaries]
+        op_names = [op["name"] for op in operation_summaries]
 
         imports = self._generate_import_strings(op_names)
 
@@ -221,7 +221,7 @@ def _generate_import_strings(self,
             List of import strings e.g. `from gafferpy.gaffer_binaryoperators import BinaryOperator`
 
         """
-        get_field_types = self._get_function_dict()['get_field_types']
+        get_field_types = self._get_function_dict()["get_field_types"]
 
         class_names = [func.split(".")[-1] for func in funcs]
 
@@ -232,20 +232,20 @@ def _generate_import_strings(self,
         for func in funcs:
             for java_type in get_field_types(func).values():
                 python_type = parse_java_type_to_string(java_type)
-                if 'gafferpy' not in python_type:
+                if "gafferpy" not in python_type:
                     continue
 
                 gafferpy_import = re.findall("gafferpy[\\w+ \\.]*", python_type)[0]
                 gafferpy_import = gafferpy_import.replace("generated_api.", "gaffer_")
-                import_parts = gafferpy_import.split('.')
+                import_parts = gafferpy_import.split(".")
                 module = ".".join(import_parts[:-1])
                 _class = import_parts[-1]
                 # only import classes not already defined in the file in question
                 if _class not in class_names:
                     import_map[module].add(_class)
 
         return [
-            f"from {import_path} import {', '.join(sorted(classes))}" for import_path,
+            f"from {import_path} import {", ".join(sorted(classes))}" for import_path,
             classes in import_map.items()
         ]
 

src/gafferpy/client/base_client.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2022 Crown Copyright
+# Copyright 2022-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,22 +15,22 @@
 #
 
 class BaseClient:
-    '''
+    """
     This class handles the connection to a Gaffer server and handles operations.
     This class is initialised with a host to connect to.
-    '''
+    """
 
     def __init__(self, base_url, verbose=False, headers={}, **kwargs):
-        '''
+        """
         This initialiser sets up a connection to the specified Gaffer server.
 
         The host (and port) of the Gaffer server, should be in the form,
-        'hostname:1234/service-name/version'
-        '''
+        "hostname:1234/service-name/version"
+        """
         self.base_url = base_url
         self.verbose = verbose
         self.headers = headers
-        self.headers.setdefault('Content-Type', 'application/json;charset=utf-8')
+        self.headers.setdefault("Content-Type", "application/json;charset=utf-8")
 
     def perform_request(self, method, target, headers=None, body=None, json_result=True):
         raise NotImplementedError()

src/gafferpy/client/pki_client.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2022 Crown Copyright
+# Copyright 2022-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -22,12 +22,12 @@
 
 class PkiClient(UrllibClient):
     def __init__(self, base_url, verbose=False, headers={}, **kwargs):
-        '''
+        """
         This initialiser sets up a connection to the specified Gaffer server.
 
         The host (and port) of the Gaffer server, should be in the form,
-        'hostname:1234/service-name/version'
-        '''
+        "hostname:1234/service-name/version"
+        """
         super().__init__(base_url, verbose, headers, **kwargs)
 
         # Fail if none pki, protocol None

src/gafferpy/client/requests_client.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2016-2022 Crown Copyright
+# Copyright 2016-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,10 +23,10 @@
     _REQUESTS_AVAILABLE = True
 
     class SSLAdapter(HTTPAdapter):
-        '''
+        """
         A subclass of the HTTPS Transport Adapter that is used to
         setup an arbitrary SSL version for the requests session.
-        '''
+        """
 
         def __init__(self, ssl_version=None, **kwargs):
             self.ssl_version = ssl_version
@@ -48,10 +48,10 @@ def init_poolmanager(self, connections, maxsize, block=False):
 
 
 class RequestsClient(BaseClient):
-    '''
+    """
     This class handles the connection to a Gaffer server and handles operations.
     This class is initialised with a host to connect to.
-    '''
+    """
 
     def __init__(self, base_url, verbose=False, headers={}, **kwargs):
         if not _REQUESTS_AVAILABLE:
@@ -70,7 +70,7 @@ def __init__(self, base_url, verbose=False, headers={}, **kwargs):
         self._session.verify = kwargs.get("verify", True)
         self._session.proxies = kwargs.get("proxies", {})
         protocol = kwargs.get("protocol", None)
-        self._session.mount('https://', SSLAdapter(ssl_version=protocol))
+        self._session.mount("https://", SSLAdapter(ssl_version=protocol))
 
     def perform_request(self, method, target, headers=None, body=None, json_result=True):
         url = self.base_url + target
@@ -85,7 +85,7 @@ def perform_request(self, method, target, headers=None, body=None, json_result=T
             response.raise_for_status()
         except requests.exceptions.HTTPError as error:
             raise ConnectionError(
-                'HTTP error ' + str(error.response.status_code) + ': ' + error.response.text)
+                "HTTP error " + str(error.response.status_code) + ": " + error.response.text)
 
         if not json_result and method == "GET":
             return response.text
@@ -96,10 +96,10 @@ def perform_request(self, method, target, headers=None, body=None, json_result=T
             response_json = response.text
 
         if self.verbose:
-            print('\nQuery response:\n' +
-                  json.dumps(response_json, indent=4) + '\n')
+            print("\nQuery response:\n" +
+                  json.dumps(response_json, indent=4) + "\n")
 
-        if response_json is not None and response_json != '':
+        if response_json is not None and response_json != "":
             result = response_json
         else:
             result = None

src/gafferpy/client/urllib_client.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2016-2022 Crown Copyright
+# Copyright 2016-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,18 +24,18 @@
 
 
 class UrllibClient(BaseClient):
-    '''
+    """
     This class handles the connection to a Gaffer server and handles operations.
     This class is initialised with a host to connect to.
-    '''
+    """
 
     def __init__(self, base_url, verbose=False, headers={}, **kwargs):
-        '''
+        """
         This initialiser sets up a connection to the specified Gaffer server.
 
         The host (and port) of the Gaffer server, should be in the form,
-        'hostname:1234/service-name/version'
-        '''
+        "hostname:1234/service-name/version"
+        """
         super().__init__(base_url, verbose, headers, **kwargs)
 
         # Create the opener
@@ -52,22 +52,22 @@ def perform_request(self, method, target, headers=None, body=None, json_result=T
         try:
             response = self._opener.open(request)
         except urllib.error.HTTPError as error:
-            error_body = error.read().decode('utf-8')
-            new_error_string = ('HTTP error ' +
-                                str(error.code) + ' ' +
-                                error.reason + ': ' +
+            error_body = error.read().decode("utf-8")
+            new_error_string = ("HTTP error " +
+                                str(error.code) + " " +
+                                error.reason + ": " +
                                 error_body)
             raise ConnectionError(new_error_string)
 
-        response_text = response.read().decode('utf-8')
+        response_text = response.read().decode("utf-8")
 
         if not json_result and method == "GET":
             return response_text
 
         if self.verbose:
-            print('Query response: ' + response_text)
+            print("Query response: " + response_text)
 
-        if response_text is not None and response_text != '':
+        if response_text is not None and response_text != "":
             result = json.loads(response_text)
         else:
             result = None

src/gafferpy/fromJson.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2016-2019 Crown Copyright
+# Copyright 2016-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the 'License');
 # you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
 
 if __name__ == "__main__":
     if len(sys.argv) < 2:
-        raise TypeError('JSON str argument is required')
+        raise TypeError("JSON str argument is required")
 
     json_str = sys.argv[1]
     if len(sys.argv) > 2:
@@ -31,6 +31,6 @@
     pythonObj = g.JsonConverter.from_json(json_str,
                                           class_name=class_name)
     if not isinstance(pythonObj, g.ToCodeString):
-        raise TypeError('Unable to convert JSON to a Python: ' + json_str)
+        raise TypeError("Unable to convert JSON to a Python: " + json_str)
 
     print(pythonObj.to_code_string())

src/gafferpy/gaffer_binaryoperators.py

@@ -1,5 +1,5 @@
 #
-# Copyright 2016-2023 Crown Copyright
+# Copyright 2016-2024 Crown Copyright
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -34,9 +34,9 @@ def __init__(self, selection=None, binary_operator=None):
     def to_json(self):
         function_json = {}
         if self.selection is not None:
-            function_json['selection'] = self.selection
+            function_json["selection"] = self.selection
         if self.binary_operator is not None:
-            function_json['binaryOperator'] = self.binary_operator.to_json()
+            function_json["binaryOperator"] = self.binary_operator.to_json()
 
         return function_json
 
@@ -46,25 +46,25 @@ def to_json(self):
 
 
 def binary_operator_context_converter(obj):
-    if 'class' in obj:
+    if "class" in obj:
         binary_operator = dict(obj)
     else:
-        binary_operator = obj['binary_operator']
+        binary_operator = obj["binary_operator"]
         if isinstance(binary_operator, dict):
             binary_operator = dict(binary_operator)
 
     if not isinstance(binary_operator, BinaryOperator):
         binary_operator = JsonConverter.from_json(binary_operator)
         if not isinstance(binary_operator, BinaryOperator):
-            class_name = binary_operator.get('class')
-            binary_operator.pop('class', None)
+            class_name = binary_operator.get("class")
+            binary_operator.pop("class", None)
             binary_operator = BinaryOperator(
                 class_name=class_name,
                 fields=binary_operator
             )
 
     return BinaryOperatorContext(
-        selection=obj.get('selection'),
+        selection=obj.get("selection"),
         binary_operator=binary_operator
     )
 
@@ -78,8 +78,8 @@ def binary_operator_converter(obj):
     if not isinstance(binary_operator, BinaryOperator):
         binary_operator = JsonConverter.from_json(binary_operator)
         if not isinstance(binary_operator, BinaryOperator):
-            class_name = binary_operator.get('class')
-            binary_operator.pop('class', None)
+            class_name = binary_operator.get("class")
+            binary_operator.pop("class", None)
             binary_operator = BinaryOperator(
                 class_name=class_name,
                 fields=binary_operator
@@ -91,7 +91,7 @@ def binary_operator_converter(obj):
 def load_binaryoperator_json_map():
     for name, class_obj in inspect.getmembers(
             sys.modules[__name__], inspect.isclass):
-        if hasattr(class_obj, 'CLASS'):
+        if hasattr(class_obj, "CLASS"):
             JsonConverter.GENERIC_JSON_CONVERTERS[class_obj.CLASS] = \
                 lambda obj, class_obj=class_obj: class_obj(**obj)
             JsonConverter.CLASS_MAP[class_obj.CLASS] = class_obj