Move to black / docformatter

rogerdahl · rogerdahl · commit 95dad6653eb7 · 2019-02-05T20:02:28.000-07:00
diff --git a/client_cli/src/__init__.py b/client_cli/src/__init__.py
@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+# This work was created by participants in the DataONE project, and is
+# jointly copyrighted by participating institutions in DataONE. For
+# more information on DataONE, see our web site at http://dataone.org.
+#
+#   Copyright 2009-2016 DataONE
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from d1_cli.version import __version__  # noqa: F401
diff --git a/client_onedrive/src/d1_onedrive/impl/drivers/dokan/solrclient.py b/client_onedrive/src/d1_onedrive/impl/drivers/dokan/solrclient.py
@@ -15,11 +15,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""This client code is built from: http://svn.apache.org/viewvc/lucene/solr/tag
-s/release-1.2.0/client/python/solr.py.
 
-though has been modified in many respects.
-"""
 # Licensed to the Apache Software Foundation (ASF) under one or more
 # contributor license agreements.  See the NOTICE file distributed with
 # this work for additional information regarding copyright ownership.
@@ -50,6 +46,12 @@
 # data = c.search(q='id:500', wt='python')
 # print 'first match=', eval(data)['response']['docs'][0]
 
+"""This client code is built from: http://svn.apache.org/viewvc/lucene/solr/tag
+s/release-1.2.0/client/python/solr.py.
+
+though has been modified in many respects.
+"""
+
 import codecs
 # ===============================================================================
 import datetime
@@ -595,8 +597,8 @@ def fieldAlphaHistogram(
     ):
         """Generates a histogram of values from a string field. Output is:
 
-        [[low, high, count, query],    ... ] Bin edges is determined
-        by equal division of the fields
+        [[low, high, count, query],    ... ] Bin edges is determined by
+        equal division of the fields
         """
         oldpersist = self.persistent
         self.persistent = True
diff --git a/dev_tools/src/d1_dev/src-format.py b/dev_tools/src/d1_dev/src-format.py
@@ -34,80 +34,79 @@
 
 
 def main():
-  """Format all tracked .py files.
-
-  Black + isort + docformatter.
-  """
-  parser = argparse.ArgumentParser(
-    description=__doc__,
-    formatter_class=argparse.RawDescriptionHelpFormatter,
-  )
-  parser.add_argument('path', nargs='+', help='File or directory path')
-  parser.add_argument('--exclude', nargs='+', help='Exclude glob patterns')
-  parser.add_argument(
-    '--no-recursive', dest='recursive', action='store_false',
-    help='Search directories recursively'
-  )
-  parser.add_argument(
-    '--ignore-invalid', action='store_true', help='Ignore invalid paths'
-  )
-  parser.add_argument(
-    '--pycharm', action='store_true', help='Enable PyCharm integration'
-  )
-  parser.add_argument(
-    '--debug', action='store_true', help='Debug level logging'
-  )
-
-  args = parser.parse_args()
-  d1_common.util.log_setup(args.debug)
-
-  repo_path = d1_dev.util.find_repo_root_by_path(__file__)
-  repo = git.Repo(repo_path)
-
-  specified_file_path_list = get_specified_file_path_list(args)
-  tracked_path_list = list(d1_dev.util.get_tracked_files(repo))
-  format_path_list = sorted(
-    set(specified_file_path_list).intersection(tracked_path_list)
-  )
-  format_all(args, format_path_list)
+    """Format all tracked .py files.
 
+    Black + isort + docformatter.
+    """
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
+    )
+    parser.add_argument('path', nargs='+', help='File or directory path')
+    parser.add_argument('--exclude', nargs='+', help='Exclude glob patterns')
+    parser.add_argument(
+        '--no-recursive',
+        dest='recursive',
+        action='store_false',
+        help='Search directories recursively',
+    )
+    parser.add_argument(
+        '--ignore-invalid', action='store_true', help='Ignore invalid paths'
+    )
+    parser.add_argument(
+        '--pycharm', action='store_true', help='Enable PyCharm integration'
+    )
+    parser.add_argument('--debug', action='store_true', help='Debug level logging')
 
-def get_specified_file_path_list(args):
-  specified_file_path_list = [
-    os.path.realpath(p)
-    for p in d1_common.iter.path.path_generator(
-      path_list=args.path,
-      include_glob_list=['*.py'],
-      exclude_glob_list=args.exclude,
-      recursive=args.recursive,
-      ignore_invalid=args.ignore_invalid,
-      default_excludes=False,
-      return_dir_paths=True,
+    args = parser.parse_args()
+    d1_common.util.log_setup(args.debug)
+
+    repo_path = d1_dev.util.find_repo_root_by_path(__file__)
+    repo = git.Repo(repo_path)
+
+    specified_file_path_list = get_specified_file_path_list(args)
+    tracked_path_list = list(d1_dev.util.get_tracked_files(repo))
+    format_path_list = sorted(
+        set(specified_file_path_list).intersection(tracked_path_list)
     )
-  ]
-  return specified_file_path_list
+    format_all(args, format_path_list)
+
+
+def get_specified_file_path_list(args):
+    specified_file_path_list = [
+        os.path.realpath(p)
+        for p in d1_common.iter.path.path_generator(
+            path_list=args.path,
+            include_glob_list=['*.py'],
+            exclude_glob_list=args.exclude,
+            recursive=args.recursive,
+            ignore_invalid=args.ignore_invalid,
+            default_excludes=False,
+            return_dir_paths=True,
+        )
+    ]
+    return specified_file_path_list
 
 
 def format_all(args, format_path_list):
-  for format_path in format_path_list:
-    logging.info('Formatting file. path="{}"'.format(format_path))
-    format_single(args, format_path)
+    for format_path in format_path_list:
+        logging.info('Formatting file. path="{}"'.format(format_path))
+        format_single(args, format_path)
 
 
 def format_single(args, format_path):
-  run_cmd('black', '--skip-string-normalization', format_path)
-  run_cmd('isort', format_path)
-  run_cmd('docformatter', '-i', format_path)
+    run_cmd('black', '--skip-string-normalization', format_path)
+    run_cmd('isort', format_path)
+    run_cmd('docformatter', '-i', format_path)
 
 
 def run_cmd(*cmd_list):
-  print('Running command: {}'.format(' '.join(cmd_list)))
-  try:
-    subprocess.check_call(cmd_list)
-  except subprocess.CalledProcessError as e:
-    print('Failed: {}'.format(str(e)))
-    raise
+    print('Running command: {}'.format(' '.join(cmd_list)))
+    try:
+        subprocess.check_call(cmd_list)
+    except subprocess.CalledProcessError as e:
+        print('Failed: {}'.format(str(e)))
+        raise
 
 
 if __name__ == '__main__':
-  sys.exit(main())
+    sys.exit(main())
diff --git a/gmn/src/d1_gmn/tests/gmn_test_case.py b/gmn/src/d1_gmn/tests/gmn_test_case.py
@@ -1,5 +1,23 @@
 # -*- coding: utf-8 -*-
 
+# This work was created by participants in the DataONE project, and is
+# jointly copyrighted by participating institutions in DataONE. For
+# more information on DataONE, see our web site at http://dataone.org.
+#
+#   Copyright 2009-2016 DataONE
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import copy
 import datetime
 import io
@@ -22,23 +40,6 @@
 
 import d1_common.checksum
 import d1_common.const
-# This work was created by participants in the DataONE project, and is
-# jointly copyrighted by participating institutions in DataONE. For
-# more information on DataONE, see our web site at http://dataone.org.
-#
-#   Copyright 2009-2016 DataONE
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
 import d1_common.resource_map
 import d1_common.types
 import d1_common.types.dataoneTypes
@@ -344,6 +345,7 @@ def call_d1_client(self, api_func, *arg_list, **arg_dict):
                 pytest.fail(
                     'Make sure: Test function is decorated with "@responses.activate", '
                     'class derives from GMNTestCase, '
+                    'The correct client fixture is used (mn_client / gmn_client), '
                     'class setup_method() calls super(). '
                     'error="{}"'.format(str(e))
                 )
diff --git a/gmn/src/d1_gmn/tests/test_cors.py b/gmn/src/d1_gmn/tests/test_cors.py
@@ -44,8 +44,10 @@ def test_1000(self, gmn_client_v1_v2):
     @responses.activate
     def test_1010(self, gmn_client_v1_v2):
         """Invalid method against endpoint raises 405 Method Not Allowed and
-        returns regular and CORS headers with allowed methods (POST
-        /object/invalid_pid)"""
+        returns regular and CORS headers with allowed methods (POST.
+
+        /object/invalid_pid)
+        """
         with d1_gmn.tests.gmn_mock.disable_auth():
             response = gmn_client_v1_v2.POST(['object', 'invalid_pid'])
         self.sample.assert_equals(response, 'post_object_pid', gmn_client_v1_v2)
diff --git a/lib_client/src/d1_client/baseclient_1_1.py b/lib_client/src/d1_client/baseclient_1_1.py
@@ -61,7 +61,9 @@ def queryResponse(
         """CNRead.query(session, queryEngine, query) → OctetStream
         https://releases.dataone.org/online/api-
         documentation-v2.0.1/apis/CN_APIs.html#CNRead.query
-        MNQuery.query(session, queryEngine, query) → OctetStream http://jenkins
+        MNQuery.query(session, queryEngine, query) → OctetStream
+        http://jenkins.
+
         -1.dataone.org/jenkins/job/API%20Documentation%20-%20trunk/ws/api-
         documentation/build/html/apis/MN_APIs.html#MNQuery.query.
 
diff --git a/lib_client/src/d1_client/cnclient.py b/lib_client/src/d1_client/cnclient.py
@@ -410,6 +410,7 @@ def getQueryEngineDescription(self, queryEngine, vendorSpecific=None, **kwargs):
 
     def setRightsHolderResponse(self, pid, userId, serialVersion, vendorSpecific=None):
         """CNAuthorization.setRightsHolder(session, pid, userId, serialVersion)
+
         → Identifier https://releases.dataone.org/online/api-
         documentation-v2.0.1/apis/CN_APIs.html#CNAuthorization.setRightsHolder.
 
diff --git a/lib_common/src/d1_common/types/generated/dataoneTypes_v1.py b/lib_common/src/d1_common/types/generated/dataoneTypes_v1.py
@@ -167,7 +167,8 @@ class CrontabEntrySeconds(pyxb.binding.datatypes.token):
 # Atomic simple type: {http://ns.dataone.org/service/types/v1}Event
 class Event(pyxb.binding.datatypes.string, pyxb.binding.basis.enumeration_mixin):
 
-    """The controlled list of events that are logged, which will include
+    """The controlled list of events that are logged, which will include.
+
     *create*, *update*, *delete*, *read*, *replicate*,
 
     *synchronization_failed* and *replication_failed*
@@ -561,7 +562,8 @@ class AccessRule(pyxb.binding.basis.complexTypeDefinition):
     If a subject is granted multiple permissions, the highest level of access
     applies. The resource on which the access control rules are being applied
     is determined by the containing :term:`SystemMetadata` document, or in the
-    case of methods such as :func:`CNAuthorization.setAccessPolicy`, by the
+    case of methods such as :func:`CNAuthorization.setAccessPolicy`, by the.
+
     :term:`pid` in the method parameters.Access control rules are specified by
     the.
 
@@ -1146,7 +1148,9 @@ class NodeList(pyxb.binding.basis.complexTypeDefinition):
 
 # Complex type {http://ns.dataone.org/service/types/v1}ObjectFormat with content type ELEMENT_ONLY
 class ObjectFormat(pyxb.binding.basis.complexTypeDefinition):
-    """One value from the DataONE Object Format Vocabulary which is returned by
+    """One value from the DataONE Object Format Vocabulary which is returned
+    by.
+
     :func:`CNCore.getFormat()`.An *ObjectFormat* is the structure returned from
     the.
 
@@ -1245,8 +1249,11 @@ class ObjectFormat(pyxb.binding.basis.complexTypeDefinition):
 
 # Complex type {http://ns.dataone.org/service/types/v1}ObjectInfo with content type ELEMENT_ONLY
 class ObjectInfo(pyxb.binding.basis.complexTypeDefinition):
-    """Metadata about an object, representing a subset of the metadata found in
-    :class:`Types.SystemMetadata`."""
+    """Metadata about an object, representing a subset of the metadata found
+    in.
+
+    :class:`Types.SystemMetadata`.
+    """
 
     _TypeDefinition = None
     _ContentTypeTag = pyxb.binding.basis.complexTypeDefinition._CT_ELEMENT_ONLY
@@ -1359,7 +1366,8 @@ class ObjectLocation(pyxb.binding.basis.complexTypeDefinition):
     """Portion of an :class:`Types.ObjectLocationList` indicating the node from
     which the object can be retrieved. The principal information on each
     location is found in the *nodeIdentifier*, all other fields are provided
-    for convenience, but could also be looked up from the
+    for convenience, but could also be looked up from the.
+
     :class:`Types.NodeList` information obtained from.
 
     :func:`CNCore.listNodes`.
@@ -1496,7 +1504,8 @@ class ObjectLocation(pyxb.binding.basis.complexTypeDefinition):
 
 # Complex type {http://ns.dataone.org/service/types/v1}ObjectLocationList with content type ELEMENT_ONLY
 class ObjectLocationList(pyxb.binding.basis.complexTypeDefinition):
-    """An *ObjectLocationList* is the structure returned from the
+    """An *ObjectLocationList* is the structure returned from the.
+
     :func:`CNRead.resolve` method of the CN REST interface.
 
     It provides a list of locations from which the specified object can
@@ -2264,7 +2273,8 @@ class Slice(pyxb.binding.basis.complexTypeDefinition):
 class Synchronization(pyxb.binding.basis.complexTypeDefinition):
     """Configuration information for the process by which metadata is harvested
     from Member Nodes to Coordinating Nodes, including the schedule on which
-    harvesting should occur, and information about the last
+    harvesting should occur, and information about the last.
+
     :term:`synchronization` attempts for the node. Member Nodes providing
     *Synchronization* information only need to provide the.
 
@@ -3699,7 +3709,8 @@ class Schedule(pyxb.binding.basis.complexTypeDefinition):
 
 # Complex type {http://ns.dataone.org/service/types/v1}Subject with content type SIMPLE
 class Subject(pyxb.binding.basis.complexTypeDefinition):
-    """An identifier for a Person (user), Group, Organization, or System.The
+    """An identifier for a Person (user), Group, Organization, or System.The.
+
     :term:`Subject` is a string that provides a formal name to identify a user
     or group in the DataONE Identity Management Service. The *subject* is
     represented by a unique, persistent, non-reassignable identifier string
diff --git a/lib_common/src/d1_common/types/generated/dataoneTypes_v2_0.py b/lib_common/src/d1_common/types/generated/dataoneTypes_v2_0.py
diff --git a/test_utilities/src/d1_test/replication_tester/replication_server.py b/test_utilities/src/d1_test/replication_tester/replication_server.py
