IDEV-2204: Move all decorators to a separate file

Author: jbabac

domaintools/api.py

@@ -24,18 +24,15 @@
     Results,
     FeedsResults,
 )
+from domaintools.decorators import api_endpoint, auto_patch_docstrings
 from domaintools.filters import (
     filter_by_riskscore,
     filter_by_expire_date,
     filter_by_date_updated_after,
     filter_by_field,
     DTResultFilter,
 )
-from domaintools.utils import (
-    api_endpoint,
-    auto_patch_docstrings,
-    validate_feeds_parameters,
-)
+from domaintools.utils import validate_feeds_parameters
 
 
 AVAILABLE_KEY_SIGN_HASHES = ["sha1", "sha256"]

domaintools/decorators.py

@@ -0,0 +1,57 @@
+import functools
+
+from typing import List, Union
+
+from domaintools.docstring_patcher import DocstringPatcher
+
+
+def api_endpoint(spec_name: str, path: str, methods: Union[str, List[str]]):
+    """
+    Decorator to tag a method as an API endpoint.
+
+    Args:
+        spec_name: The key for the spec in api_instance.specs
+        path: The API path (e.g., "/users")
+        methods: A single method ("get") or list of methods (["get", "post"])
+                 that this function handles.
+    """
+
+    def decorator(func):
+        func._api_spec_name = spec_name
+        func._api_path = path
+
+        # Always store the methods as a list
+        if isinstance(methods, str):
+            func._api_methods = [methods]
+        else:
+            func._api_methods = methods
+
+        @functools.wraps(func)
+        def wrapper(self, *args, **kwargs):
+            return func(*args, **kwargs)
+
+        # Copy all tags to the wrapper
+        wrapper._api_spec_name = func._api_spec_name
+        wrapper._api_path = func._api_path
+        wrapper._api_methods = func._api_methods
+        return wrapper
+
+    return decorator
+
+
+def auto_patch_docstrings(cls):
+    original_init = cls.__init__
+
+    @functools.wraps(original_init)
+    def new_init(self, *args, **kwargs):
+        original_init(self, *args, **kwargs)
+        try:
+            # We instantiate our patcher and run it
+            patcher = DocstringPatcher()
+            patcher.patch(self)
+        except Exception as e:
+            print(f"Auto-patching failed: {e}")
+
+    cls.__init__ = new_init
+
+    return cls

domaintools/utils.py

@@ -1,11 +1,9 @@
-import functools
 import re
 
 from datetime import datetime
-from typing import List, Optional, Union
+from typing import Optional
 
 from domaintools.constants import Endpoint, OutputFormat
-from domaintools.docstring_patcher import DocstringPatcher
 
 
 def get_domain_age(create_date):
@@ -187,55 +185,3 @@ def validate_feeds_parameters(params):
     endpoint = params.get("endpoint")
     if endpoint == Endpoint.DOWNLOAD.value and format == OutputFormat.CSV.value:
         raise ValueError(f"{format} format is not available in {Endpoint.DOWNLOAD.value} API.")
-
-
-def api_endpoint(spec_name: str, path: str, methods: Union[str, List[str]]):
-    """
-    Decorator to tag a method as an API endpoint.
-
-    Args:
-        spec_name: The key for the spec in api_instance.specs
-        path: The API path (e.g., "/users")
-        methods: A single method ("get") or list of methods (["get", "post"])
-                 that this function handles.
-    """
-
-    def decorator(func):
-        func._api_spec_name = spec_name
-        func._api_path = path
-
-        # Always store the methods as a list
-        if isinstance(methods, str):
-            func._api_methods = [methods]
-        else:
-            func._api_methods = methods
-
-        @functools.wraps(func)
-        def wrapper(self, *args, **kwargs):
-            return func(*args, **kwargs)
-
-        # Copy all tags to the wrapper
-        wrapper._api_spec_name = func._api_spec_name
-        wrapper._api_path = func._api_path
-        wrapper._api_methods = func._api_methods
-        return wrapper
-
-    return decorator
-
-
-def auto_patch_docstrings(cls):
-    original_init = cls.__init__
-
-    @functools.wraps(original_init)
-    def new_init(self, *args, **kwargs):
-        original_init(self, *args, **kwargs)
-        try:
-            # We instantiate our patcher and run it
-            patcher = DocstringPatcher()
-            patcher.patch(self)
-        except Exception as e:
-            print(f"Auto-patching failed: {e}")
-
-    cls.__init__ = new_init
-
-    return cls