Internal docs (#181)

Author: droserasprout

src/dipdup/__init__.py

@@ -1,3 +1,6 @@
+import os
+import sys
+
 __version__ = '3.1.3'
 __spec_version__ = '1.2'
 spec_version_mapping = {
@@ -12,3 +15,5 @@
     '1.1': True,
     '1.2': True,
 }
+
+sys.path.append(os.getcwd())

src/dipdup/config.py

@@ -4,7 +4,6 @@
 import logging.config
 import os
 import re
-import sys
 from abc import ABC
 from abc import abstractmethod
 from collections import Counter
@@ -56,7 +55,6 @@
 DEFAULT_RETRY_COUNT = 3
 DEFAULT_RETRY_SLEEP = 1
 
-sys.path.append(os.getcwd())
 _logger = logging.getLogger('dipdup.config')
 
 
@@ -71,6 +69,7 @@ class SqliteDatabaseConfig:
     """
     SQLite connection config
 
+    :param kind: always 'sqlite'
     :param path: Path to .sqlite3 file, leave default for in-memory database
     """
 
@@ -86,13 +85,15 @@ def connection_string(self) -> str:
 class PostgresDatabaseConfig:
     """Postgres database connection config
 
+    :param kind: always 'postgres'
     :param host: Host
     :param port: Port
     :param user: User
     :param password: Password
     :param database: Database name
     :param schema_name: Schema name
     :param immune_tables: List of tables to preserve during reindexing
+    :param connection_timeout: Connection timeout
     """
 
     kind: Literal['postgres']
@@ -121,6 +122,18 @@ def valid_immune_tables(cls, v):
 
 @dataclass
 class HTTPConfig:
+    """Advanced configuration of HTTP client
+    
+    :param cache: Whether to cache responses
+    :param retry_count: Number of retries before giving up
+    :param retry_sleep: Sleep time between retries
+    :param retry_multiplier: Multiplier for sleep time between retries
+    :param ratelimit_rate: Number of requests per `ratelimit_period`
+    :param ratelimit_period: Time period for rate limiting
+    :param connection_limit: Number of simultaneous connections
+    :param connection_timeout: Connection timeout
+    :param batch_size: Number of items fetched in a single request 
+    """
     cache: Optional[bool] = None
     retry_count: Optional[int] = None
     retry_sleep: Optional[float] = None
@@ -186,7 +199,9 @@ def valid_address(cls, v):
 class TzktDatasourceConfig(NameMixin):
     """TzKT datasource config
 
-    :param url: Base API url
+    :param kind: always 'tzkt'
+    :param url: Base API URL, e.g. https://api.tzkt.io/
+    :param http: HTTP client configuration
     """
 
     kind: Literal['tzkt']
@@ -212,7 +227,10 @@ def __post_init_post_parse__(self) -> None:
 class BcdDatasourceConfig(NameMixin):
     """BCD datasource config
 
-    :param url: Base API url
+    :param kind: always 'bcd'
+    :param url: Base API URL
+    :param network: Network name, e.g. mainnet, hangzhounet, etc.
+    :param http: HTTP client configuration
     """
 
     kind: Literal['bcd']
@@ -233,6 +251,14 @@ def valid_url(cls, v):
 
 @dataclass
 class CoinbaseDatasourceConfig(NameMixin):
+    """Coinbase datasource config
+
+    :param kind: always 'coinbase'
+    :param api_key: API key
+    :param secret_key: API secret key
+    :param passphrase: API passphrase
+    :param http: HTTP client configuration
+    """
     kind: Literal['coinbase']
     api_key: Optional[str] = None
     secret_key: Optional[str] = None
@@ -394,8 +420,11 @@ def transaction_id(self) -> int:
 class OperationHandlerTransactionPatternConfig(PatternConfig, StorageTypeMixin, ParameterTypeMixin, TransactionIdMixin):
     """Operation handler pattern config
 
-    :param destination: Alias of the contract to match
-    :param entrypoint: Contract entrypoint
+    :param type: always 'transaction'
+    :param source: Source contract alias to filter operations with
+    :param destination: Destination contract alias to filter operations with
+    :param entrypoint: Contract entrypoint to filter operations with
+    :param optional: Whether can operation be missing in operation group
     """
 
     type: Literal['transaction'] = 'transaction'
@@ -442,10 +471,15 @@ def destination_contract_config(self) -> ContractConfig:
 
 @dataclass
 class OperationHandlerOriginationPatternConfig(PatternConfig, StorageTypeMixin):
+    """Origination handler pattern config
+
+    :param source: Source contract alias to filter operations with
+    :param similar_to: Alias of contract having the same code/signature (depending on `strict` field)
+    """
+    type: Literal['origination'] = 'origination'
     source: Optional[Union[str, ContractConfig]] = None
     similar_to: Optional[Union[str, ContractConfig]] = None
     originated_contract: Optional[Union[str, ContractConfig]] = None
-    type: Literal['origination'] = 'origination'
     optional: bool = False
     strict: bool = False