Convert logging doctest examples to testable snippets. - #2675
Merged
tseaver merged 3 commits intoNov 7, 2016
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Move usage docs for integration with Python stdlib 'logging' module into a separate file, sorted in front of the relevant API docs.
dhermes
reviewed
Nov 3, 2016
Comment thread
docs/logging-stdlib-usage.rst
|
|
||
|
|
||
| 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 |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Comment thread
docs/logging-stdlib-usage.rst
| .. code-block:: python | ||
|
|
||
| >>> import logging | ||
| >>> import google.cloud.logging # Don't conflict with standard logging |
This comment was marked as spam.
Comment thread
docs/logging-stdlib-usage.rst
| >>> client = google.cloud.logging.Client() | ||
| >>> handler = CloudLoggingHandler(client) | ||
| >>> cloud_logger = logging.getLogger('cloudLogger') | ||
| >>> cloud_logger.setLevel(logging.INFO) # defaults to WARN |
This comment was marked as spam.
Comment thread
docs/logging-stdlib-usage.rst
|
|
||
| .. code-block:: python | ||
|
|
||
| >>> handler = CloudLoggingHandler(client, name="mycustomlog") |
This comment was marked as spam.
Comment thread
docs/logging-stdlib-usage.rst
| 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 |
This comment was marked as spam.
Comment thread
docs/logging_snippets.py
Outdated
| FILTER = 'textPayload:robot' | ||
|
|
||
| # [START sink_bigquery_create] | ||
| DESTINATION = 'bigquery.googleapis.com%s' % (dataset.path) |
This comment was marked as spam.
Comment thread
docs/logging_snippets.py
Outdated
| UPDATED_FILTER = 'textPayload:robot' | ||
|
|
||
| # [START sink_pubsub_create] | ||
| DESTINATION = 'pubsub.googleapis.com/%s' % (topic.full_name) |
This comment was marked as spam.
Comment thread
docs/logging_snippets.py
| def _find_examples(): | ||
| funcs = [obj for obj in globals().values() | ||
| if getattr(obj, '_snippet', False)] | ||
| for func in sorted(funcs, key=_line_no): |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Comment thread
docs/logging_snippets.py
Outdated
|
|
||
|
|
||
| def _line_no(func): | ||
| code = getattr(func, '__code__', None) or getattr(func, 'func_code') |
This comment was marked as spam.
This comment was marked as spam.
Comment thread
docs/logging_snippets.py
Outdated
| except AssertionError as e: | ||
| print(' FAIL: %s' % (e,)) | ||
| except Exception as e: # pylint: disable=broad-except | ||
| print(' ERROR: %r' % (e,)) |
This comment was marked as spam.
richkadel
pushed a commit
to richkadel/google-cloud-python
that referenced
this pull request
May 6, 2017
Convert logging doctest examples to testable snippets.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.