Skip to content

Commit

Permalink
Final fixes for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ocelotl committed Jan 27, 2020
1 parent 89082e5 commit 41b308f
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 123 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and integration packages.
:caption: OpenTelemetry API:

opentelemetry.context
opentelemetry.patcher
opentelemetry.metrics
opentelemetry.trace
opentelemetry.util.loader
Expand Down
8 changes: 8 additions & 0 deletions docs/opentelemetry.patcher.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
opentelemetry.patcher package
=============================


Module contents
---------------

.. automodule:: opentelemetry.patcher
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import opentelemetry.ext.wsgi as otel_wsgi
from opentelemetry import propagators, trace
from opentelemetry.ext.flask.version import __version__
from opentelemetry.patcher.base_patcher import BasePatcher
from opentelemetry.patcher import BasePatcher
from opentelemetry.util import time_ns

logger = getLogger(__name__)
Expand Down Expand Up @@ -105,7 +105,10 @@ def _teardown_flask_request(exc):

@BasePatcher.protect
class FlaskPatcher(BasePatcher):
"""A patcher for flask.Flask"""
"""A patcher for flask.Flask
See `BasePatcher`
"""

def __init__(self):
self._patched = False
Expand Down
89 changes: 89 additions & 0 deletions opentelemetry-api/src/opentelemetry/patcher/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,98 @@
# 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.
# type: ignore

"""
OpenTelemetry patcher
This includes the base patcher class and a no-op implementation.
"""

from abc import ABC, abstractmethod
from functools import wraps
from logging import getLogger

_LOG = getLogger(__name__)


class BasePatcher(ABC):
"""An ABC for patchers"""

@staticmethod
def protect(class_) -> None:
"""
Provides a class decorator that protects patch and unpatch methods
A protected patch method can't be called again until its corresponding
unpatch method has been called and vice versa. A protected patch method
must be called first before its corresponding unpatch method can be
called.
To use this decorator simply decorate the patcher class:
.. code-block:: python
from opentelemetry.patcher.base_patcher import BasePatcher
@BasePatcher.protect
class PatcherClass(BasePatcher):
...
"""

# pylint: disable=protected-access

class_._unprotected_patch = class_.patch
class_._unprotected_patch._protected = False

@wraps(class_.patch)
def protected_patch(self):
if not self._unprotected_patch.__func__._protected:
self._unprotected_patch.__func__._protected = True
self._unprotected_unpatch.__func__._protected = False

return self._unprotected_patch()

_LOG.warning("Attempting to patch while already patched")

return None

class_.patch = protected_patch

class_._unprotected_unpatch = class_.unpatch
class_._unprotected_unpatch._protected = True

@wraps(class_.unpatch)
def protected_unpatch(self):
if not self._unprotected_unpatch.__func__._protected:
self._unprotected_unpatch.__func__._protected = True
self._unprotected_patch.__func__._protected = False

return self._unprotected_unpatch()

_LOG.warning("Attempting to unpatch while already unpatched")

return None

class_.unpatch = protected_unpatch

return class_

@abstractmethod
def patch(self) -> None:
"""Patch"""

@abstractmethod
def unpatch(self) -> None:
"""Unpatch"""


class NoOpPatcher(BasePatcher):
def patch(self) -> None:
"""Patch"""

def unpatch(self) -> None:
"""Unpatch"""


__all__ = ["BasePatcher", "NoOpPatcher"]
94 changes: 0 additions & 94 deletions opentelemetry-api/src/opentelemetry/patcher/base_patcher.py

This file was deleted.

26 changes: 0 additions & 26 deletions opentelemetry-api/src/opentelemetry/patcher/no_op_patcher.py

This file was deleted.

2 changes: 1 addition & 1 deletion opentelemetry-api/tests/patcher/test_patcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

from unittest import TestCase

from opentelemetry.patcher.base_patcher import BasePatcher
from opentelemetry.patcher import BasePatcher


class TestSampler(TestCase):
Expand Down

0 comments on commit 41b308f

Please sign in to comment.