Rename module and fcns

Author: pmcollins

docs/examples/patch_abc/langchain_example.py renamed to docs/examples/patch_leaf_subclasses/langchain_example.py

@@ -9,7 +9,7 @@
 from langchain_ollama import OllamaLLM
 from langchain_openai import ChatOpenAI
 
-from opentelemetry.util._wrap import patch_abc
+from opentelemetry.util._patch import patch_leaf_subclasses
 
 
 def parse_args():
@@ -66,10 +66,10 @@ def wrapped_fcn(self, *args, **kwargs):
         return wrapped_fcn
 
     # Patch traditional LLM models (Ollama, HuggingFace, etc.)
-    patch_abc(BaseLLM, "_generate", my_wrapper)
+    patch_leaf_subclasses(BaseLLM, "_generate", my_wrapper)
 
     # Patch chat models (OpenAI, Anthropic, Google, etc.)
-    patch_abc(BaseChatModel, "_generate", my_wrapper)
+    patch_leaf_subclasses(BaseChatModel, "_generate", my_wrapper)
 
 
 def main():

docs/examples/patch_abc/requirements.txt renamed to docs/examples/patch_leaf_subclasses/requirements.txt

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from opentelemetry.util._wrap import patch_abc
+from opentelemetry.util._patch import patch_leaf_subclasses
 
 
 class Greeter(ABC):
@@ -29,7 +29,7 @@ def wrapped_fcn(self, *args, **kwargs):
         return wrapped_fcn
 
 
-    patch_abc(Greeter, "greet", my_wrapper)
+    patch_leaf_subclasses(Greeter, "greet", my_wrapper)
 
     EngishGreeter().greet()
     SpanishGreeter().greet()

docs/examples/patch_abc/simple_example.py renamed to docs/examples/patch_leaf_subclasses/simple_example.py

@@ -1,26 +1,37 @@
-def patch_abc(abstract_base_class, method_name, w):
+def patch_leaf_subclasses(base_class, method_name, wrapper):
     """
-    Patches a method on leaf subclasses of an abstract base class.
+    Patches a method on leaf subclasses of a base class.
+
+    Args:
+        base_class: The base class whose leaf subclasses will be patched
+        method_name: Name of the method to patch
+        wrapper: Function that wraps the original method
 
     """
-    all_subclasses = recursively_get_all_subclasses(abstract_base_class)
-    leaf_subclasses = get_leaf_subclasses(all_subclasses)
+    all_subclasses = _get_all_subclasses(base_class)
+    leaf_subclasses = _get_leaf_subclasses(all_subclasses)
 
     for subclass in leaf_subclasses:
         # Patch if the subclass has the method (either defined or inherited)
         # and it's actually callable
         if hasattr(subclass, method_name) and callable(getattr(subclass, method_name)):
             old_method = getattr(subclass, method_name)
-            setattr(subclass, method_name, w(old_method))
+            setattr(subclass, method_name, wrapper(old_method))
 
     # This implementation does not work if the instrumented class is imported after the instrumentor runs.
     # However, that case can be handled by querying the gc module for all existing classes; this capability can be added
     # in a follow-up change.
 
 
-def get_leaf_subclasses(all_subclasses):
+def _get_leaf_subclasses(all_subclasses):
     """
     Returns only the leaf classes (classes with no subclasses) from a set of classes.
+
+    Args:
+        all_subclasses: Set of classes to filter
+
+    Returns:
+        set: Classes that have no subclasses within the provided set
     """
     leaf_classes = set()
     for cls in all_subclasses:
@@ -35,10 +46,18 @@ def get_leaf_subclasses(all_subclasses):
     return leaf_classes
 
 
+def _get_all_subclasses(cls):
+    """
+    Gets all subclasses of a given class.
+
+    Args:
+        cls: The base class to find subclasses for
 
-def recursively_get_all_subclasses(cls):
-    out = set()
+    Returns:
+        set: All subclasses (direct and indirect) of the given class
+    """
+    subclasses = set()
     for subclass in cls.__subclasses__():
-        out.add(subclass)
-        out.update(recursively_get_all_subclasses(subclass))
-    return out
+        subclasses.add(subclass)
+        subclasses.update(_get_all_subclasses(subclass))
+    return subclasses