Convert logging doctest examples to testable snippets. by tseaver · Pull Request #2675 · googleapis/google-cloud-python

tseaver · 2016-11-03T19:15:43Z

Move usage docs for integration with Python stdlib 'logging' module into a separate file, sorted in front of the relevant API docs.

Reworks #2556 after other merges (iterators, doctest removal) made fixing that PRs branch too painful.

Move usage docs for integration with Python stdlib 'logging' module into a separate file, sorted in front of the relevant API docs.

Sign in to view

+
+
+It's possible to tie the Python :mod:`logging` module directly into Google Cloud Logging. To use it,
+create a :class:`CloudLoggingHandler <google.cloud.logging.CloudLoggingHandler>` instance from your


Sign in to view

+.. code-block:: python
+
+ >>> import logging
+ >>> import google.cloud.logging # Don't conflict with standard logging


Sign in to view

+ >>> client = google.cloud.logging.Client()
+ >>> handler = CloudLoggingHandler(client)
+ >>> cloud_logger = logging.getLogger('cloudLogger')
+ >>> cloud_logger.setLevel(logging.INFO) # defaults to WARN


Sign in to view

+
+.. code-block:: python
+
+ >>> handler = CloudLoggingHandler(client, name="mycustomlog")


Sign in to view

+ options, see the transports section.
+
+All logs will go to a single custom log, which defaults to "python". The name of the Python
+logger will be included in the structured log entry under the "python_logger" field. You can


Sign in to view

+ FILTER = 'textPayload:robot'
+
+ # [START sink_bigquery_create]
+ DESTINATION = 'bigquery.googleapis.com%s' % (dataset.path)


Sign in to view

+ UPDATED_FILTER = 'textPayload:robot'
+
+ # [START sink_pubsub_create]
+ DESTINATION = 'pubsub.googleapis.com/%s' % (topic.full_name)


Sign in to view

+def _find_examples():
+ funcs = [obj for obj in globals().values()
+ if getattr(obj, '_snippet', False)]
+ for func in sorted(funcs, key=_line_no):


Sign in to view

+
+
+def _line_no(func):
+ code = getattr(func, '__code__', None) or getattr(func, 'func_code')


Sign in to view

+ except AssertionError as e:
+ print(' FAIL: %s' % (e,))
+ except Exception as e: # pylint: disable=broad-except
+ print(' ERROR: %r' % (e,))


Convert logging doctest examples to testable snippets.

Convert logging doctest examples to testable snippets.
ccbddb7
Move usage docs for integration with Python stdlib 'logging' module into a separate file, sorted in front of the relevant API docs.

tseaver added docs testing api: logging Issues related to the Cloud Logging API. labels Nov 3, 2016

tseaver assigned daspecster and dhermes Nov 3, 2016

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Nov 3, 2016

dhermes reviewed Nov 3, 2016
View reviewed changes

tseaver added 2 commits November 3, 2016 17:09

Dedent literal-included code snippets.
b922161

Address review comments.
42ecc7e

tseaver merged commit 8b899d1 into googleapis:masterNov 7, 2016

tseaver deleted the logging-snippets branch November 7, 2016 20:55

richkadel pushed a commit to richkadel/google-cloud-python that referenced this pull request May 6, 2017
Merge pull requestgoogleapis#2675from tseaver/logging-snippets
735d8f1
Convert logging doctest examples to testable snippets.

theacodes unassigned daspecster and dhermes Sep 28, 2018



		It's possible to tie the Python :mod:`logging` module directly into Google Cloud Logging. To use it,
		create a :class:`CloudLoggingHandler <google.cloud.logging.CloudLoggingHandler>` instance from your


		.. code-block:: python

		>>> handler = CloudLoggingHandler(client, name="mycustomlog")



		def _line_no(func):
		code = getattr(func, '__code__', None) or getattr(func, 'func_code')

Uh oh!

Conversation

tseaver commented Nov 3, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants