linting

Author: gkevinzheng

google/cloud/logging_v2/client.py

@@ -148,7 +148,7 @@ def __init__(
             self._use_grpc = _USE_GRPC
         else:
             self._use_grpc = _use_grpc
-        
+
         self._handlers = set()
 
     @property

google/cloud/logging_v2/handlers/handlers.py

@@ -216,8 +216,10 @@ def emit(self, record):
 
         # send off request
         if self.transport is None:
-            self.transport = self._transport_cls(self.client, self.name, resource=self.resource)
-        
+            self.transport = self._transport_cls(
+                self.client, self.name, resource=self.resource
+            )
+
         self.transport.send(
             record,
             message,
@@ -238,13 +240,13 @@ def flush(self):
         super(CloudLoggingHandler, self).flush()
         if self.transport is not None:
             self.transport.flush()
-    
+
     def close(self):
-        """Closes the log handler and cleans up all Transport objects used.
-        """
+        """Closes the log handler and cleans up all Transport objects used."""
         self.transport.close()
         self.transport = None
 
+
 def _format_and_parse_message(record, formatter_handler):
     """
     Helper function to apply formatting to a LogRecord message,

google/cloud/logging_v2/handlers/transports/background_thread.py

@@ -38,9 +38,11 @@
 _WORKER_TERMINATOR = object()
 _LOGGER = logging.getLogger(__name__)
 
-_CLOSE_THREAD_SHUTDOWN_ERROR_MSG = "CloudLoggingHandler shutting down, cannot send logs entries to Cloud Logging due to " \
-    "inconsistent threading behavior at shutdown. To avoid this issue, flush the logging handler " \
+_CLOSE_THREAD_SHUTDOWN_ERROR_MSG = (
+    "CloudLoggingHandler shutting down, cannot send logs entries to Cloud Logging due to "
+    "inconsistent threading behavior at shutdown. To avoid this issue, flush the logging handler "
     "manually or switch to StructuredLogHandler."
+)
 
 
 def _get_many(queue_, *, max_items=None, max_latency=0):
@@ -212,7 +214,7 @@ def _close(self):
         """Callback that attempts to send pending logs before termination."""
         if not self.is_alive:
             return
-        
+
         # Print different messages to the user depending on whether or not the
         # program is shutting down. This is because this function now handles both
         # the atexit handler and the regular close.
@@ -224,16 +226,22 @@ def _close(self):
                     file=sys.stderr,
                 )
             else:
-                print(_CLOSE_THREAD_SHUTDOWN_ERROR_MSG,file=sys.stderr,)
+                print(
+                    _CLOSE_THREAD_SHUTDOWN_ERROR_MSG,
+                    file=sys.stderr,
+                )
 
-        if self.stop(grace_period=self._grace_period) and threading.main_thread().is_alive():
+        if (
+            self.stop(grace_period=self._grace_period)
+            and threading.main_thread().is_alive()
+        ):
             print("Sent all pending logs.", file=sys.stderr)
         else:
             print(
                 "Failed to send %d pending logs." % (self._queue.qsize(),),
                 file=sys.stderr,
             )
-        
+
         self._thread = None
 
     def enqueue(self, record, message, **kwargs):
@@ -267,12 +275,13 @@ def flush(self):
 
     def close(self):
         """Signals the worker thread to stop, then closes the transport thread.
-        
+
         This call should be followed up by disowning the transport object.
         """
         atexit.unregister(self._close)
         self._close()
 
+
 class BackgroundThreadTransport(Transport):
     """Asynchronous transport that uses a background thread."""
 
@@ -332,4 +341,4 @@ def flush(self):
 
     def close(self):
         """Closes the worker thread."""
-        self.worker.stop(grace_period=self.grace_period)
+        self.worker.stop(grace_period=self.grace_period)

google/cloud/logging_v2/handlers/transports/base.py

@@ -58,4 +58,4 @@ def close(self):
 
         This call should be followed up by disowning the transport.
         """
-        pass
+        pass

google/cloud/logging_v2/handlers/transports/sync.py

@@ -65,4 +65,4 @@ def close(self):
 
         This call is usually followed up by cleaning up the reference to the transport.
         """
-        self.logger = None
+        self.logger = None

tests/unit/handlers/test_handlers.py

@@ -800,7 +800,7 @@ def test_emit_with_encoded_json(self):
                 None,
             ),
         )
-    
+
     def test_emit_after_close(self):
         from google.cloud.logging_v2.logger import _GLOBAL_RESOURCE
 
@@ -885,7 +885,7 @@ def test_format_with_arguments(self):
                 None,
             ),
         )
-    
+
     def test_close(self):
         from google.cloud.logging_v2.logger import _GLOBAL_RESOURCE
 
@@ -1234,6 +1234,6 @@ def send(
             http_request,
             source_location,
         )
-    
+
     def close(self):
         self.close_called = True

tests/unit/handlers/transports/test_background_thread.py

@@ -182,6 +182,7 @@ class Test_Worker(unittest.TestCase):
 
     def setUp(self):
         import sys
+
         print("In method", self._testMethodName, file=sys.stderr)
 
     @staticmethod
@@ -197,14 +198,16 @@ def _start_with_thread_patch(self, worker):
         with mock.patch("threading.Thread", new=_Thread) as thread_mock:
             worker.start()
             return thread_mock
-    
+
     @staticmethod
     @contextlib.contextmanager
     def _init_atexit_mock():
         atexit_mock = _AtexitMock()
-        with mock.patch.multiple("atexit", register=atexit_mock.register, unregister=atexit_mock.unregister):
+        with mock.patch.multiple(
+            "atexit", register=atexit_mock.register, unregister=atexit_mock.unregister
+        ):
             yield atexit_mock
-    
+
     @staticmethod
     @contextlib.contextmanager
     def _init_main_thread_is_alive_mock(is_alive):
@@ -214,7 +217,6 @@ def _init_main_thread_is_alive_mock(is_alive):
             main_thread_obj_mock.is_alive = mock.Mock(return_value=is_alive)
             yield
 
-
     def test_constructor(self):
         logger = _Logger(self.NAME)
         grace_period = 50
@@ -320,7 +322,10 @@ def test__close_did_not_join(self):
         self.assertFalse(worker.is_alive)
 
     def test__close_main_thread_not_alive(self):
-        from google.cloud.logging_v2.handlers.transports.background_thread import _CLOSE_THREAD_SHUTDOWN_ERROR_MSG
+        from google.cloud.logging_v2.handlers.transports.background_thread import (
+            _CLOSE_THREAD_SHUTDOWN_ERROR_MSG,
+        )
+
         worker = self._make_one(_Logger(self.NAME))
 
         with mock.patch("sys.stderr", new_callable=StringIO) as stderr_mock:
@@ -329,8 +334,11 @@ def test__close_main_thread_not_alive(self):
                     self._start_with_thread_patch(worker)
                     self._enqueue_record(worker, "test")
                     worker._close()
-            
-            self.assertRegex(stderr_mock.getvalue(), re.compile("^%s$" % _CLOSE_THREAD_SHUTDOWN_ERROR_MSG, re.MULTILINE))
+
+            self.assertRegex(
+                stderr_mock.getvalue(),
+                re.compile("^%s$" % _CLOSE_THREAD_SHUTDOWN_ERROR_MSG, re.MULTILINE),
+            )
 
     def test_close_unregister_atexit(self):
         worker = self._make_one(_Logger(self.NAME))
@@ -341,7 +349,6 @@ def test_close_unregister_atexit(self):
             worker.close()
             self.assertNotIn(worker._close, atexit_mock.registered_funcs)
 
-
     @staticmethod
     def _enqueue_record(worker, message, levelno=logging.INFO, **kw):
         record = logging.LogRecord("testing", levelno, None, None, message, None, None)
@@ -464,7 +471,7 @@ def test__thread_main_main_thread_terminated(self):
             self._enqueue_record(worker, "1")
             self._enqueue_record(worker, "2")
             worker._thread_main()
-        
+
         self.assertFalse(worker._cloud_logger._batch.commit_called)
 
     @mock.patch("time.time", autospec=True, return_value=1)
@@ -635,9 +642,9 @@ def logger(self, name, resource=None):  # pylint: disable=unused-argument
 class _AtexitMock(object):
     def __init__(self):
         self.registered_funcs = set()
-    
+
     def register(self, func):
         self.registered_funcs.add(func)
-    
+
     def unregister(self, func):
-        self.registered_funcs.remove(func)
+        self.registered_funcs.remove(func)

tests/unit/test_client.py

@@ -932,7 +932,7 @@ def test_setup_logging_w_extra_kwargs_structured_log(self):
         }
         self.assertEqual(kwargs, expected_kwargs)
         self.assertIn(handler, client._handlers)
-    
+
     def test_flush_handlers_cloud_logging_handler(self):
         import io
         from google.cloud.logging.handlers import CloudLoggingHandler
@@ -958,11 +958,11 @@ def test_flush_handlers_cloud_logging_handler(self):
 
         (handler,) = args
         self.assertIsInstance(handler, CloudLoggingHandler)
-        
+
         handler.flush = mock.Mock()
         client.flush_handlers()
         handler.flush.assert_called_once_with()
-    
+
     def test_flush_handlers_cloud_logging_handler_no_setup_logging(self):
         from google.cloud.logging.handlers import CloudLoggingHandler
 
@@ -973,7 +973,7 @@ def test_flush_handlers_cloud_logging_handler_no_setup_logging(self):
 
         handler = CloudLoggingHandler(client)
         self.assertIn(handler, client._handlers)
-        
+
         handler.flush = mock.Mock()
         client.flush_handlers()
         handler.flush.assert_called_once_with()
@@ -1035,7 +1035,7 @@ def test_close_cloud_logging_handler(self):
 
         (handler,) = args
         self.assertIsInstance(handler, CloudLoggingHandler)
-        
+
         handler.close = mock.Mock()
         with contextlib.closing(client):
             pass
@@ -1053,7 +1053,7 @@ def test_close_cloud_logging_handler_no_setup_logging(self):
 
         handler = CloudLoggingHandler(client)
         self.assertIn(handler, client._handlers)
-        
+
         handler.close = mock.Mock()
         with contextlib.closing(client):
             pass
@@ -1104,4 +1104,4 @@ def __init__(self, *responses):
     def api_request(self, **kw):
         self._called_with = kw
         response, self._responses = self._responses[0], self._responses[1:]
-        return response
+        return response