Skip to content

Commit de967ae

Browse files
committed
Rm ignore docs decorator (no longer needed)
1 parent c4b5c20 commit de967ae

File tree

5 files changed

+1
-16
lines changed

5 files changed

+1
-16
lines changed

src/apify/_actor.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
from apify_client import ApifyClientAsync
1515
from apify_shared.consts import ActorEnvVars, ActorExitCodes, ApifyEnvVars
16-
from apify_shared.utils import ignore_docs, maybe_extract_enum_member_value
16+
from apify_shared.utils import maybe_extract_enum_member_value
1717
from crawlee import service_locator
1818
from crawlee.events import (
1919
Event,
@@ -145,7 +145,6 @@ def __init__(
145145

146146
self._is_initialized = False
147147

148-
@ignore_docs
149148
async def __aenter__(self) -> Self:
150149
"""Initialize the Actor.
151150
@@ -157,7 +156,6 @@ async def __aenter__(self) -> Self:
157156
await self.init()
158157
return self
159158

160-
@ignore_docs
161159
async def __aexit__(
162160
self,
163161
_exc_type: type[BaseException] | None,

src/apify/_charging.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88

99
from pydantic import TypeAdapter
1010

11-
from apify_shared.utils import ignore_docs
1211
from crawlee._utils.context import ensure_context
1312

1413
from apify._models import ActorRun, PricingModel
@@ -90,7 +89,6 @@ class ActorPricingInfo:
9089
"""Price of every known event type."""
9190

9291

93-
@ignore_docs
9492
class ChargingManagerImplementation(ChargingManager):
9593
"""Implementation of the `ChargingManager` Protocol - this is only meant to be instantiated internally."""
9694

src/apify/_crypto.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
from cryptography.hazmat.primitives.asymmetric import padding, rsa
1313
from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
1414

15-
from apify_shared.utils import ignore_docs
1615
from crawlee._utils.crypto import crypto_random_object_id
1716

1817
from apify._consts import ENCRYPTED_INPUT_VALUE_REGEXP, ENCRYPTED_JSON_VALUE_PREFIX, ENCRYPTED_STRING_VALUE_PREFIX
@@ -22,7 +21,6 @@
2221
ENCRYPTION_AUTH_TAG_LENGTH = 16
2322

2423

25-
@ignore_docs
2624
def public_encrypt(value: str, *, public_key: rsa.RSAPublicKey) -> dict:
2725
"""Encrypts the given value using AES cipher and the password for encryption using the public key.
2826
@@ -66,7 +64,6 @@ def public_encrypt(value: str, *, public_key: rsa.RSAPublicKey) -> dict:
6664
}
6765

6866

69-
@ignore_docs
7067
def private_decrypt(
7168
encrypted_password: str,
7269
encrypted_value: str,
@@ -118,7 +115,6 @@ def private_decrypt(
118115
return decipher_bytes.decode('utf-8')
119116

120117

121-
@ignore_docs
122118
def load_private_key(private_key_file_base64: str, private_key_password: str) -> rsa.RSAPrivateKey:
123119
private_key = serialization.load_pem_private_key(
124120
base64.b64decode(private_key_file_base64.encode('utf-8')),
@@ -138,7 +134,6 @@ def _load_public_key(public_key_file_base64: str) -> rsa.RSAPublicKey:
138134
return public_key
139135

140136

141-
@ignore_docs
142137
def decrypt_input_secrets(private_key: rsa.RSAPrivateKey, input_data: Any) -> Any:
143138
"""Decrypt input secrets."""
144139
if not isinstance(input_data, dict):
@@ -180,7 +175,6 @@ def encode_base62(num: int) -> str:
180175
return res
181176

182177

183-
@ignore_docs
184178
def create_hmac_signature(secret_key: str, message: str) -> str:
185179
"""Generate an HMAC signature and encodes it using Base62. Base62 encoding reduces the signature length.
186180

src/apify/_proxy_configuration.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
import httpx
1111

1212
from apify_shared.consts import ApifyEnvVars
13-
from apify_shared.utils import ignore_docs
1413
from crawlee.proxy_configuration import ProxyConfiguration as CrawleeProxyConfiguration
1514
from crawlee.proxy_configuration import ProxyInfo as CrawleeProxyInfo
1615
from crawlee.proxy_configuration import _NewUrlFunction
@@ -28,7 +27,6 @@
2827
SESSION_ID_MAX_LENGTH = 50
2928

3029

31-
@ignore_docs
3230
def is_url(url: str) -> bool:
3331
"""Check if the given string is a valid URL."""
3432
try:
@@ -104,7 +102,6 @@ class ProxyConfiguration(CrawleeProxyConfiguration):
104102

105103
_configuration: Configuration
106104

107-
@ignore_docs
108105
def __init__(
109106
self,
110107
*,

src/apify/log.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import logging
44

5-
from apify_shared.utils import ignore_docs
65
from crawlee._log_config import CrawleeLogFormatter, configure_logger, get_configured_log_level
76

87
# Name of the logger used throughout the library (resolves to 'apify')
@@ -12,7 +11,6 @@
1211
logger = logging.getLogger(logger_name)
1312

1413

15-
@ignore_docs
1614
class ActorLogFormatter(CrawleeLogFormatter): # noqa: D101 (Inherited from parent class)
1715
pass
1816

0 commit comments

Comments
 (0)